调用DescribeCenBandwidthPackage查询账户下所有带宽包的详细信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCenBandwidthPackages

要执行的操作,取值:DescribeCenBandwidthPackages

IncludeReservationData Boolean true

是否包含续费数据,取值:

  • true:包含续费数据。
  • false:不包含续费数据。
PageNumber Integer 1

列表的页码,默认值为1

PageSize Integer 2

分页查询时每页的行数,最大值为50,默认值为10

Filter.N.Key String status

过滤条件,最多可提供5个过滤条件。支持如下过滤条件。

  • CenId:云企业网实例的ID。
  • Status:带宽包被使用的状态(Idle/InUse)。
  • CenBandwidthPackageId:带宽包的ID。
  • Name:带宽包的名称。
Filter.N.Value.N RepeatList Idle

根据Key指定过滤值。一个Key支持指定多个过滤值,每个过滤值之间是的关系,即只要符合其中一个过滤值,则视为匹配该过滤条件。

IsOrKey Boolean false

过滤条件之间的关系,取值:

  • false(默认):过滤条件之间是的关系。即必须符合所有过滤条件,才视为匹配过滤条件。
  • true:过滤条件之间是的关系。即只要符合其中一个过滤条件,则视为匹配过滤条件。

返回数据

名称 类型 示例值 描述
RequestId String 9D7E2400-2755-4AF5-9B73-12565E4F73A0

请求ID。

TotalCount Integer 2

列表条目数。

PageNumber Integer 1

当前页码。

PageSize Integer 2

每页包含的条目数。

CenBandwidthPackages Array

带宽包的详细信息。

CenBandwidthPackageId String cenbwp-4c2zaavbvh5x****

带宽包的ID。

Name String test

带宽包的名称。

Description String cen

带宽包描述。

Bandwidth Long 2

带宽包的峰值带宽。

BandwidthPackageChargeType String PREPAY

带宽包的计费方式。

GeographicRegionAId String china

参与互连的区域。

GeographicRegionBId String north-america

参与互连的区域。

GeographicSpanId String north-america_china

区域对应的ID。

BusinessStatus String Normal

带宽包的状态。

  • Normal:正常。
  • FinancialLocked:欠费锁定。
  • SecurityLocked:安全风控锁定。
CreationTime String 2019-02-01T11:14Z

带宽包的创建时间,采用ISO8601格式表示,格式为:YYYY-MM-DDThh:mmZ。

ExpiredTime String 2999-09-08T16:00Z

带宽包超时时间。

Status String InUse

带宽包在云企业网中的状态。

  • Idle:未绑定。
  • InUse:已绑定。
IsCrossBorder Boolean false

是否是跨境带宽包。

  • false:不是跨境带宽包。
  • true:是跨境带宽包。
TypeFor95 String 111
Ratio String 111
HasReservationData String false

是否有续费数据。

  • true:有续费数据。
  • false:没有续费数据。
说明 仅入参IncludeReservationData取值为true,且有未生效订购数据时才会为true
ReservationBandwidth String 10

临时升配结束后恢复的带宽。

ReservationInternetChargeType String PREPAY

变配之后的计费方式。

ReservationActiveTime String 2018-08-30T16:00Z

临时升配到期时间。

ReservationOrderType String UPGRADE

续费变配方式。

  • TEMP_UPGRADE:短时升配。
  • UPGRADE:升配。
OrginInterRegionBandwidthLimits Array

互通地域的详细信息。

LocalRegionId String cn-hangzhou

本端地域ID。

OppositeRegionId String us-west-1

对端地域ID。

GeographicSpanId String north-america_china

互通地域。

BandwidthLimit String 1

互通地域间的带宽峰值。

CenIds List cen-xxjsjfkffkfkfjkf****

带宽包对应的云企业网实例的列表。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeCenBandwidthPackages
&<公共请求参数>

正常返回示例

XML 格式

<DescribeCenBandwidthPackageResponse>
	  <PageNumber>1</PageNumber>
	  <TotalCount>5</TotalCount>
	  <PageSize>10</PageSize>
	  <RequestId>9D7E2400-2755-4AF5-9B73-12565E4F73A0</RequestId>
	  <CenBandwidthPackages>
		    <CenBandwidthPackage>
			      <CreationTime>2018-02-07T02:19Z</CreationTime>
			      <Status>InUse</Status>
			      <GeographicRegionBId>china</GeographicRegionBId>
			      <BusinessStatus>Normal</BusinessStatus>
			      <BandwidthPackageChargeType>PREPAY</BandwidthPackageChargeType>
			      <GeographicRegionAId>china</GeographicRegionAId>
			      <CenBandwidthPackageId>cenbwp-oq2ehpxq4zhwp7****</CenBandwidthPackageId>
			      <CenIds>
				        <CenId>cen-kojok19x3j0q6k****</CenId>
			      </CenIds>
			      <ExpiredTime>2018-03-07T16:00Z</ExpiredTime>
			      <Bandwidth>1</Bandwidth>
		    </CenBandwidthPackage>
	  </CenBandwidthPackages>
</DescribeCenBandwidthPackageResponse>

JSON 格式

{
    "PageNumber": 1,
    "TotalCount": 5,
    "PageSize": 10,
    "RequestId": "9D7E2400-2755-4AF5-9B73-12565E4F73A0",
    "CenBandwidthPackages": {
        "CenBandwidthPackage": [
            {
                "CreationTime": "2018-02-07T02:19Z",
                "Status": "InUse",
                "GeographicRegionBId": "china",
                "BusinessStatus": "Normal",
                "BandwidthPackageChargeType": "PREPAY",
                "GeographicRegionAId": "china",
                "CenBandwidthPackageId": "cenbwp-oq2ehpxq4zhwp7****",
                "CenIds": {
                    "CenId": [
                        "cen-kojok19x3j0q6k****"
                    ]
                },
                "ExpiredTime": "2018-03-07T16:00Z",
                "Bandwidth": 1
            }
        ]
    }
}

错误码

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