ListInstancesTrafficPackages - Simple Application Server

Operation description

You can query the details of data transfer plans of simple application servers, including the total quota, used quota, unused quota, and excess data transfers in the current month.

Simple Application Server provides data transfer plans that can be used to offset data transfer fees. You are charged for excess data transfers. Take note of the following items:

Only outbound data transfers of simple application servers over the Internet are calculated. Outbound data transfers include the data transfer quota and the excess data transfers beyond the quota. Inbound data transfers of simple application servers over the Internet are not calculated.
Outbound data transfers from simple application servers to other Alibaba Cloud services over the Internet first consume data transfer quotas. If the quotas are exhausted, you are charged for excess data transfers.
You are not charged for data transfers between simple application servers within the same virtual private cloud (VPC).

For more information, see Quotas and billing of data transfers.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

swas-open:ListInstancesTrafficPackages

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the simple application servers. You can call the ListRegions operation to query the most recent region list.	cn-hangzhou
InstanceIds	string	Yes	The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs. Separate multiple server IDs with commas (,).	["2ad1ae67295445f598017499dc****","2ad1ae67295445f598017499dc****"]

Response elements

Element	Type	Description	Example
	object
InstanceTrafficPackageUsages	array<object>	The data transfers that exceed the quota of the data transfer plan in the current month. Unit: bytes.
	object
InstanceId	string	The ID of the simple application server.	ccscqwqwqqqw****
TrafficUsed	integer	The used quota of the data transfer plan in the current month. Unit: Byte.	10000
TrafficPackageTotal	integer	The quota of the data transfer plan in the current month. Unit: Byte. Note TrafficPackageTotal = TrafficUsed + TrafficPackageRemaining	20000
TrafficPackageRemaining	integer	The unused quota of the data transfer plan in the current month. Unit: Byte.	10000
TrafficOverflow	integer	The data transfers that exceeds the quota of the data transfer plan in the current month. Unit: Byte.	0
RequestId	string	The request ID.	20758A-585D-4A41-A9B2-28DA8F4F****

Examples

Success response

JSON format

{
  "InstanceTrafficPackageUsages": [
    {
      "InstanceId": "ccscqwqwqqqw****",
      "TrafficUsed": 10000,
      "TrafficPackageTotal": 20000,
      "TrafficPackageRemaining": 10000,
      "TrafficOverflow": 0
    }
  ],
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	RegionIdNotMatchHost	The parameter regionId does not match the endpoint host.
500	InternalError	An error occurred while processing your request.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.