All Products
Search
Document Center

Global Accelerator:ListBandwidthPackages

Last Updated:Jul 31, 2024

Queries bandwidth plans.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ga:ListBandwidthPackageslist
  • BandwidthPackage
    acs:ga:{#regionId}:{#accountId}:bandwidthpackage/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the GA instance is deployed. Set the value to cn-hangzhou.

cn-hangzhou
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Maximum value: 100. Default value: 10.

10
StatestringNo

The status of the bandwidth plan. Valid values:

  • init: The bandwidth plan is being initialized.
  • active: The bandwidth plan is available.
  • binded: The bandwidth plan is associated.
  • binding: The bandwidth plan is being associated.
  • unbinding: The bandwidth plan is being disassociated.
  • updating: The bandwidth plan is being updated.
  • finacialLocked: The bandwidth plan is locked due to overdue payments.
  • locked: The bandwidth plan is locked.
active
TypestringNo

The type of the bandwidth plan. Valid values:

  • Basic: a basic bandwidth plan
  • CrossDomain: a cross-border acceleration bandwidth plan

If you call this operation on the China site (aliyun.com), you can set Type only to Basic.

Basic
BandwidthPackageIdstringNo

The ID of the bandwidth plan.

gbwp-bp1sgzldyj6b4q7cx****
ResourceGroupIdstringNo

The ID of the resource group.

rg-aek2ry6mp2c****
Tagarray<object>No

The tag of the bandwidth plan.

objectNo

The tag of the bandwidth plan.

KeystringNo

The tag key of the bandwidth plan. The tag key cannot be an empty string.

The tag key can be up to 64 characters in length and cannot contain http:// or https://. It cannot start with aliyun or acs:.

You can specify up to 20 tag keys.

tag-key
ValuestringNo

The tag value of the bandwidth plan. The tag value can be an empty string.

The tag value can be up to 128 characters in length and cannot contain http:// or https://. It cannot start with aliyun or acs:.

You can specify up to 20 tag values.

tag-value

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

TotalCountinteger

The total number of entries returned.

1
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The ID of the request.

4B6DBBB0-2D01-4C6A-A384-4129266E6B78
PageNumberinteger

The page number of the returned page.

1
BandwidthPackagesarray<object>

The details of the bandwidth plans.

object

Details about the bandwidth plans.

Typestring

The type of the bandwidth plan. Valid values:

  • Basic: a basic bandwidth plan.
  • CrossDomain: a cross-region acceleration bandwidth plan.

If you call the operation on the China site (aliyun.com), Basic is returned.

Basic
BandwidthTypestring

The type of the bandwidth. Valid values:

  • Basic
  • Enhanced
  • Advanced
Basic
Statestring

The status of the bandwidth plan. Valid values:

  • init: The bandwidth plan is being initialized.
  • active: The bandwidth plan is available.
  • binded: The bandwidth plan is associated with a GA instance.
  • binding: The bandwidth plan is being associated with a GA instance.
  • unbinding: The bandwidth plan is being disassociated from a GA instance.
  • updating: The bandwidth plan is being updated.
  • finacialLocked: The bandwidth plan is locked due to overdue payments.
  • locked: The bandwidth plan is locked.
active
CreateTimestring

The time when the bandwidth plan was created.

1578966918000
ChargeTypestring

The billing method of the bandwidth plan.

  • PREPAY: subscription. This is the default value.
  • POSTPAY: pay-as-you-go.
PREPAY
RegionIdstring

The ID of the region where the GA instance is deployed. cn-hangzhou is returned.

cn-hangzhou
CbnGeographicRegionIdAstring

Area A of the cross-region acceleration bandwidth plan. China-mainland is returned.

This parameter is returned only if you call the operation on the international site (alibabacloud.com).

China-mainland
BandwidthPackageIdstring

The ID of the bandwidth plan.

gbwp-bp1sgzldyj6b4q7cx****
Bandwidthinteger

The bandwidth value of the bandwidth plan. Unit: Mbit/s.

2
Descriptionstring

The description of the bandwidth plan.

testDescription
ExpiredTimestring

The expiration time of the bandwidth plan.

1578966918000
Acceleratorsarray

The IDs of the GA instances that are associated with the bandwidth plans.

string

The ID of the GA instance that is associated with the bandwidth plan.

ga-bp1qe94o52ot4pkfn****
CbnGeographicRegionIdBstring

Area B of the cross-region acceleration bandwidth plan. Global is returned.

This parameter is returned only if you call the operation on the international site (alibabacloud.com).

Global
Namestring

The name of the bandwidth plan.

testName
BillingTypestring

The metering method that is used when you use the pay-as-you-go billing method.

  • PayByTraffic: pay-by-data-transfer.
  • PayBY95: pay-by-95th-percentile.
PayByTraffic
Ratiointeger

The percentage of the guaranteed minimum bandwidth if the pay-by-95th-percentile metering method is used.

30
ResourceGroupIdstring

The ID of the resource group.

rg-aek2ry6mp2c****
Tagsarray<object>

The tag of the bandwidth plan.

object

The tag of the bandwidth plan.

Keystring

The tag key of the bandwidth plan.

tag-key
Valuestring

The tag value of the bandwidth plan.

tag-value

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "4B6DBBB0-2D01-4C6A-A384-4129266E6B78",
  "PageNumber": 1,
  "BandwidthPackages": [
    {
      "Type": "Basic",
      "BandwidthType": "Basic",
      "State": "active",
      "CreateTime": "1578966918000",
      "ChargeType": "PREPAY",
      "RegionId": "cn-hangzhou",
      "CbnGeographicRegionIdA": "China-mainland",
      "BandwidthPackageId": "gbwp-bp1sgzldyj6b4q7cx****",
      "Bandwidth": 2,
      "Description": "testDescription",
      "ExpiredTime": "1578966918000",
      "Accelerators": [
        "ga-bp1qe94o52ot4pkfn****"
      ],
      "CbnGeographicRegionIdB": "Global",
      "Name": "testName",
      "BillingType": "PayByTraffic",
      "Ratio": 30,
      "ResourceGroupId": "rg-aek2ry6mp2c****",
      "Tags": [
        {
          "Key": "tag-key",
          "Value": "tag-value"
        }
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-07-20The internal configuration of the API is changed, but the call is not affectedView Change Details