DescribeBandwidthPackages - Elastic Compute Service - Alibaba Cloud Documentation Center

DescribeBandwidthPackages

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

vpc:DescribeBandwidthPackages

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the bandwidth package is located.
BandwidthPackageId	string	No	The ID of the bandwidth package.
NatGatewayId	string	No	The ID of the nat gateway. If specified, the operation returns only bandwidth packages associated with the specified nat gateway.
PageNumber	integer	No	The page number. Starting value: 1. Default value: 1.
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Default value: 20.

Response elements

Element	Type	Description	Example
	object	The response data.
PageSize	integer	The number of entries per page.
RequestId	string	The request ID.
PageNumber	integer	The page number.
TotalCount	integer	The total number of matching entries.
BandwidthPackages	object	Details of the queried bandwidth packages.
BandwidthPackage	array<object>	An array of bandwidth packages.
	array<object>
Status	string	The status of the bandwidth package. Valid values: `Available`, `Pending`, `Modifying`, `Deleting`, and `Deleted`.
CreationTime	string	The time when the bandwidth package was created. The time is in UTC and is formatted as `YYYY-MM-DDThh:mm:ssZ`.
IpCount	string	The number of public IP addresses in the bandwidth package.
RegionId	string	The ID of the region to which the bandwidth package belongs.
InstanceChargeType	string	The billing method for the bandwidth package. Valid values: `PostPaid` and `PrePaid`.
BandwidthPackageId	string	The ID of the bandwidth package.
Description	string	The description of the bandwidth package.
Bandwidth	string	The bandwidth of the bandwidth package, in Mbit/s.
NatGatewayId	string	The ID of the NAT Gateway that uses the bandwidth package.
ZoneId	string	The ID of the zone to which the bandwidth package belongs.
InternetChargeType	string	The billing method for network usage. Valid values: `PayByTraffic` and `PayByBandwidth`.
BusinessStatus	string	The service status of the bandwidth package. Valid values: `Normal` and `FinancialLocked`.
Name	string	The name of the bandwidth package.
ISP	string	The line type. Valid values: `BGP` and `BGP_PRO`.
PublicIpAddresses	object	The public IP addresses in the bandwidth package.
PublicIpAddresse	array<object>	An array of public IP addresses.
	object
IpAddress	string	The public IP address.
AllocationId	string	The ID of the EIP associated with the public IP address.

Examples

Success response

JSON format

{
  "PageSize": 0,
  "RequestId": "",
  "PageNumber": 0,
  "TotalCount": 0,
  "BandwidthPackages": {
    "BandwidthPackage": [
      {
        "Status": "",
        "CreationTime": "",
        "IpCount": "",
        "RegionId": "",
        "InstanceChargeType": "",
        "BandwidthPackageId": "",
        "Description": "",
        "Bandwidth": "",
        "NatGatewayId": "",
        "ZoneId": "",
        "InternetChargeType": "",
        "BusinessStatus": "",
        "Name": "",
        "ISP": "",
        "PublicIpAddresses": {
          "PublicIpAddresse": [
            {
              "IpAddress": "",
              "AllocationId": ""
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidAliuid	User Id is not valid.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	The specified RegionId parameter does not exist. Check whether the service is available in the specified region.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.