调用ListBandwidthPackages查询带宽包列表_全球加速(GA)-阿里云帮助中心

调用ListBandwidthPackages接口查询带宽包列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ga:ListBandwidthPackages	list	BandwidthPackage acs:ga:{#regionId}:{#accountId}:bandwidthpackage/*	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	全球加速实例所在的地域 ID，仅取值cn-hangzhou。	cn-hangzhou
PageNumber	integer	否	列表的页码，默认值为 1。	1
PageSize	integer	否	分页查询时每页的行数，最大值为 100，默认值为 10。	10
State	string	否	带宽包的状态，取值： init：初始化。 active：可用。 binded：已绑定。 binding：绑定中。 unbinding：解绑中。 updating：更新中。 finacialLocked：欠费锁定。 locked：已锁定。	active
Type	string	否	带宽包的类型，取值： Basic：基础带宽包。 CrossDomain：跨地域加速包。中国站仅支持取值 Basic。	Basic
BandwidthPackageId	string	否	带宽包 ID。	gbwp-bp1sgzldyj6b4q7cx****
ResourceGroupId	string	否	资源组 ID。	rg-aek2ry6mp2c****
Tag	array<object>	否	带宽包的标签。
	object	否	带宽包的标签。
Key	string	否	带宽包的标签键。一旦输入该值，则不允许为空字符串。最多支持 64 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。最多支持输入 20 个标签键。	tag-key
Value	string	否	带宽包的标签值。一旦输入该值，可以为空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。最多支持输入 20 个标签值。	tag-value

返回参数

名称	类型	描述	示例值
	object	返回信息列表。
TotalCount	integer	列表条目数。	1
PageSize	integer	每页包含的条目数。	10
RequestId	string	请求 ID。	4B6DBBB0-2D01-4C6A-A384-4129266E6B78
PageNumber	integer	当前页码。	1
BandwidthPackages	array<object>	带宽包详情。
	object	带宽包详情。
Type	string	带宽包的类型。 Basic：基础带宽包。 CrossDomain：跨地域加速包。中国站仅支持返回 Basic。	Basic
BandwidthType	string	带宽类型。 Basic：标准加速带宽。 Enhanced：增强加速带宽。 Advanced：精品加速带宽。	Basic
State	string	带宽包的状态。 init：初始化。 active：可用。 binded：已绑定。 binding：绑定中。 unbinding：解绑中。 updating：更新中。 finacialLocked：欠费锁定。 locked：已锁定。	active
CreateTime	string	带宽包的创建时间。	1578966918000
ChargeType	string	付费类型。 PREPAY（默认值）：预付费，即包年包月。 POSTPAY：后付费，即按量付费。	PREPAY
RegionId	string	全球加速实例所在的地域 ID，仅返回cn-hangzhou。	cn-hangzhou
CbnGeographicRegionIdA	string	跨地域加速包的互通区域 A。仅返回为China-mainland（中国内地）。仅国际站支持返回该参数。	China-mainland
BandwidthPackageId	string	带宽包 ID。	gbwp-bp1sgzldyj6b4q7cx****
Bandwidth	integer	带宽包的带宽值，单位为 Mbps。	2
Description	string	带宽包的描述。	testDescription
ExpiredTime	string	带宽包到期时间的时间戳。	1578966918000
Accelerators	array	带宽包绑定的全球加速实例 ID。
	string	带宽包绑定的全球加速实例 ID。	ga-bp1qe94o52ot4pkfn****
CbnGeographicRegionIdB	string	跨地域加速包的互通区域 B。仅返回为 Global（全球）。仅国际站支持返回该参数。	Global
Name	string	带宽包的名称。	testName
BillingType	string	后付费计费方式。 PayByTraffic：流量计费。 PayBY95：95 计费。	PayByTraffic
Ratio	integer	95 计费保底百分比。	30
ResourceGroupId	string	资源组 ID。	rg-aek2ry6mp2c****
Tags	array<object>	带宽包的标签。
	object	带宽包的标签。
Key	string	带宽包的标签键。	tag-key
Value	string	带宽包的标签值。	tag-value

示例

正常返回示例

JSON格式

{
  "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"
        }
      ]
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-07-20	API 内部配置变更，不影响调用	查看变更详情