DescribeCommonBandwidthPackages - 查询指定地域中共享带宽实例列表 - 共享带宽

调用DescribeCommonBandwidthPackages接口查询指定地域中共享带宽实例列表及其信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vpc:DescribeCommonBandwidthPackages	get	CommonBandwidthPackage acs:vpc:{#regionId}:{#accountId}:combandwidthpackage/*	无	无

请求参数

名称	类型	必填	描述	示例值
IncludeReservationData	boolean	否	是否包含未生效的订购数据。取值： false（默认值）：不包含。 true：包含。	false
RegionId	string	是	共享带宽所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
BandwidthPackageId	string	否	共享带宽实例的 ID。	cbwp-2ze2ic1xd2qeqk145****
ResourceGroupId	string	否	资源组 ID。	rg-acfmxazb4ph****
Name	string	否	共享带宽实例名称。长度为 0-128 个字符，不能以`http://`或`https://`开头。	test123
PageNumber	integer	否	列表的页码。默认值：1。	1
PageSize	integer	否	分页查询时每页的行数。最大值：50。默认值：10。	10
DryRun	boolean	否	是否只预检此次请求。取值： true：发送检查请求，不会查询实例信息。检查项包括是否填写了必需参数、请求格式、实例状态。如果检查不通过，则返回对应错误。如果检查通过，则返回`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接进行操作。	false
Tag	array<object>	否	共享带宽实例的标签列表。
	object	否	共享带宽实例的标签列表。
Key	string	否	资源的标签键。最多支持输入 20 个标签键。如需传入该值，则不能输入空字符串。一个标签键最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	KeyTest
Value	string	否	资源的标签值。最多支持输入 20 个标签值。如需传入该值，可以输入空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	ValueTest
SecurityProtectionEnabled	boolean	否	是否开启 DDoS 防护（增强版）。取值： false：不开启。 true：开启。说明该参数已废弃。	false

返回参数

名称	类型	描述	示例值
	object	返回参数列表。
PageSize	integer	分页查询时每页的行数。	10
RequestId	string	请求 ID。	20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33
PageNumber	integer	列表的页码。	1
TotalCount	integer	列表条目数。	1
CommonBandwidthPackages	array<object>	共享带宽的详细信息。
CommonBandwidthPackage	object	共享带宽的详细信息。
ReservationActiveTime	string	续费生效时间，格式为`YYYY-MM-DDThh:mm:ssZ`。	2018-08-30T16:00:00Z
Status	string	共享带宽实例的状态。 Available：可用。 Modifying：修改中。	Available
CreationTime	string	共享带宽实例创建的时间，格式为`YYYY-MM-DDThh:mm:ssZ`。	2017-06-28T06:39:20Z
ReservationOrderType	string	续费变配方式。 RENEWCHANGE：续费变配。 TEMP_UPGRADE：短时升配。 UPGRADE：升级。	RENEWCHANGE
DeletionProtection	boolean	是否开启删除保护。 true：开启。 false：关闭。	true
ReservationInternetChargeType	string	变配之后的计费方式。 PayByTraffic：按流量计费。	PayByBandwidth
Ratio	integer	共享带宽的保底百分比，仅返回：20。说明仅中国站支持该参数。	20
InstanceChargeType	string	共享带宽实例的计费类型。 PostPaid：按量计费。	PostPaid
RegionId	string	共享带宽实例所在的地域 ID。	cn-hangzhou
BandwidthPackageId	string	共享带宽的 ID。	cbwp-bp1t3sm1ffzmshdki****
ServiceManaged	integer	是否为服务账号创建的资源。 0：非服务账号创建。 1：服务账号创建。	1
Bandwidth	string	共享带宽的带宽峰值，单位：Mbps。	20
Description	string	共享带宽的描述信息。	none
ExpiredTime	string	共享带宽实例的过期时间，格式为`YYYY-MM-DDThh:mm:ssZ`。	2019-01-15T03:08:37Z
ReservationBandwidth	string	变配之后的带宽值，单位：Mbps。	1000
ResourceGroupId	string	资源组 ID。	rg-acfmxazb4ph****
InternetChargeType	string	共享带宽的计费方式。 PayByTraffic：按流量计费。	PayByBandwidth
BusinessStatus	string	共享带宽实例的业务状态。 Normal：正常状态。 FinancialLocked：欠费。 Unactivated：未激活。	Normal
Name	string	共享带宽的名称。	abc
ISP	string	线路类型。 BGP：BGP（多线）线路。目前全部地域都支持 BGP（多线）线路。 BGP_PRO：BGP（多线）_精品线路。目前仅中国香港、新加坡、日本（东京）、菲律宾（马尼拉）、马来西亚（吉隆坡）、印度尼西亚（雅加达）和泰国（曼谷）地域支持 BGP（多线）_精品线路共享带宽。如果您是单线带宽的白名单用户，返回类型还可能为： ChinaTelecom：中国电信 ChinaUnicom：中国联通 ChinaMobile：中国移动 ChinaTelecom_L2：中国电信 L2 ChinaUnicom_L2：中国联通 L2 ChinaMobile_L2：中国移动 L2 如果您是杭州金融云用户，返回BGP_FinanceCloud。	BGP
HasReservationData	string	是否有待生效的订单。 false：没有待生效的订单。 true：有待生效的订单。	false
PublicIpAddresses	array<object>	共享带宽实例中的公网 IP 地址。
PublicIpAddresse	object	共享带宽实例中的公网 IP 地址。
IpAddress	string	公网 IP 地址。	47.95.XX.XX
AllocationId	string	公网 IP 的实例 ID。	eip-bp13e9i2qst4g6jzi****
BandwidthPackageIpRelationStatus	string	共享带宽和 EIP 的关联状态。 BINDED：EIP 与共享带宽关联完成。 BINDING：关联中。	BINDED
SecurityProtectionTypes	array	安全防护级别。返回为空时，表示默认的 DDoS 防护（基础版）。返回AntiDDoS_Enhanced时，表示 DDoS 防护（增强版）。说明该参数已废弃。
SecurityProtectionType	string	安全防护级别。返回为空时，表示默认的 DDoS 防护（基础版）。返回AntiDDoS_Enhanced时，表示 DDoS 防护（增强版）。说明该参数已废弃。	AntiDDoS_Enhanced
Tags	array<object>	共享带宽实例的标签列表。
Tag	object	共享带宽实例的标签列表。
Key	string	共享带宽实例的标签键。	KeyTest
Value	string	共享带宽实例的标签值。	ValueTest
BizType	string	共享带宽的业务类型。 CloudBox：云盒。仅云盒用户支持该类型。 Default（默认值）：默认，表示非特殊类型。	CloudBox
Zone	string	共享带宽的可用区。当可用区资源过载时，为保证服务稳定性，共享带宽可能会被调度至其他可用区。	ap-southeast-1-lzdvn-cb

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33",
  "PageNumber": 1,
  "TotalCount": 1,
  "CommonBandwidthPackages": {
    "CommonBandwidthPackage": [
      {
        "ReservationActiveTime": "2018-08-30T16:00:00Z",
        "Status": "Available",
        "CreationTime": "2017-06-28T06:39:20Z",
        "ReservationOrderType": "RENEWCHANGE",
        "DeletionProtection": true,
        "ReservationInternetChargeType": "PayByBandwidth",
        "Ratio": 20,
        "InstanceChargeType": "PostPaid",
        "RegionId": "cn-hangzhou",
        "BandwidthPackageId": "cbwp-bp1t3sm1ffzmshdki****",
        "ServiceManaged": 1,
        "Bandwidth": "20",
        "Description": "none",
        "ExpiredTime": "2019-01-15T03:08:37Z",
        "ReservationBandwidth": "1000",
        "ResourceGroupId": "rg-acfmxazb4ph****",
        "InternetChargeType": "PayByBandwidth",
        "BusinessStatus": "Normal",
        "Name": "abc",
        "ISP": "BGP",
        "HasReservationData": "false",
        "PublicIpAddresses": {
          "PublicIpAddresse": [
            {
              "IpAddress": "47.95.XX.XX",
              "AllocationId": "eip-bp13e9i2qst4g6jzi****",
              "BandwidthPackageIpRelationStatus": "BINDED"
            }
          ]
        },
        "SecurityProtectionTypes": {
          "SecurityProtectionType": [
            "AntiDDoS_Enhanced"
          ]
        },
        "Tags": {
          "Tag": [
            {
              "Key": "KeyTest",
              "Value": "ValueTest"
            }
          ]
        },
        "BizType": "CloudBox",
        "Zone": "ap-southeast-1-lzdvn-cb"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidBandwidthPackageIdNumber.NotSupported	The number of BandwidthPackageIds exceeds the limit.	共享带宽包的数量超过Quota限制。
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	资源组ID不存在。
400	OperationUnsupported.ResourceGroupId	ResourceGroup is not supported in this region.	资源组功能未打开。
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	指定的RegionId不存在。

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

变更历史

变更时间	变更内容概要	操作
2023-08-08	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-06-12	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-05-17	OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情