调用DescribeCenBandwidthPackages接口查询带宽包实例的信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
IncludeReservationData Boolean false

是否包含未生效的订单数据。取值:

  • true:是。
  • false(默认值):否。
Action String DescribeCenBandwidthPackages

要执行的操作。取值:DescribeCenBandwidthPackages

PageNumber Integer 1

查询页码。默认值为1

PageSize Integer 10

分页查询时每页显示的条目数。默认值为10,取值范围:1~50

IsOrKey Boolean false

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

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

过滤条件。

您可以通过过滤条件筛选要查看的带宽包实例。系统支持以下过滤条件:

  • CenId:云企业网实例ID。
  • Status:带宽包实例的状态,取值:
    • Idle:未绑定。
    • InUse:已绑定。
  • CenBandwidthPackageId:带宽包实例ID。
  • Name:带宽包实例的名称。

支持输入一个或多个过滤条件,N的最大值为5

Filter.N.Value.N String cen-xxjsjfkffkfkfjkf****

根据过滤条件的Key指定过滤值。

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

返回数据

名称 类型 示例值 描述
PageSize Integer 10

分页查询时每页显示的条目数。

RequestId String 9D7E2400-2755-4AF5-9B73-12565E4F73A0

请求ID。

PageNumber Integer 1

查询页码。

TotalCount Integer 1

总条目数。

CenBandwidthPackages Array of CenBandwidthPackage

带宽包实例信息列表。

CenBandwidthPackage
ReservationActiveTime String 2022-08-30T16:00Z

未生效订单的生效时间。

时间按照ISO8601标准表示,并使用UTC时间。格式为:YYYY-MM-DDThh:mmZ。

Status String InUse

带宽包实例的状态。

  • Idle:未绑定。
  • InUse:已绑定。
CreationTime String 2021-02-01T11:14Z

带宽包实例的创建时间。

时间按照ISO8601标准表示,并使用UTC时间。格式为:YYYY-MM-DDThh:mmZ。

ReservationOrderType String UPGRADE

未生效订单的变配方式。

  • TEMP_UPGRADE:临时升配。
  • UPGRADE:升配。
  • RENEW:续费变配。
BandwidthPackageChargeType String PREPAY

带宽包实例的计费方式。

  • POSTPAY:后付费。
  • PREPAY:预付费。
CenBandwidthPackageId String cenbwp-4c2zaavbvh5x****

带宽包实例ID。

ReservationInternetChargeType String PayByBandwidth

未生效订单的计费项。默认值:PayByBandwidth,按带宽值计费。

GeographicRegionAId String china

带宽包实例的一个互通区域ID。

  • China:中国内地。
  • North-America:北美。
  • Asia-Pacific:亚太。
  • Europe:欧洲。
  • Australia:澳洲。
Bandwidth Long 1

带宽包实例的带宽峰值。单位:Mbps。

Description String testdesc

带宽包实例的描述信息。

ExpiredTime String 2029-09-08T16:00Z

带宽包实例的到期时间。

时间按照ISO8601标准表示,并使用UTC时间。格式为:YYYY-MM-DDThh:mmZ。

ReservationBandwidth String 10

未生效订单的带宽峰值。单位:Mbps。

GeographicSpanId String north-america_china

带宽包实例的互通区域ID。

GeographicRegionBId String north-america

带宽包实例的另一个互通区域ID。

  • China:中国内地。
  • North-America:北美。
  • Asia-Pacific:亚太。
  • Europe:欧洲。
  • Australia:澳洲。
IsCrossBorder Boolean false

是否为跨境带宽包实例。

  • false:否。
  • true:是。
BusinessStatus String Normal

带宽包实例的业务状态。

  • Normal:正常。
  • FinancialLocked:欠费锁定。
  • SecurityLocked:安全风控锁定。
Name String test

带宽包实例的名称。

HasReservationData String false

是否包含未生效的订单数据,取值:

  • true:是。
  • false:否。
说明 仅请求参数 IncludeReservationData取值为 true,且有未生效订单数据时该参数的返回值才会为 true
OrginInterRegionBandwidthLimits Array of OrginInterRegionBandwidthLimit

带宽包实例下已设置的跨地域互通带宽信息列表。

OrginInterRegionBandwidthLimit
BandwidthLimit String 1

互通地域间的带宽峰值。单位:Mbps。

OppositeRegionId String us-west-1

对端地域ID。

GeographicSpanId String north-america_china

互通地域ID。

LocalRegionId String cn-hangzhou

本端地域ID。

您可以通过调用DescribeRegions接口获取地域ID及其对应的地域信息。

CenIds Array of String cen-xxjsjfkffkfkfjkf****

带宽包绑定的云企业网实例的列表。

示例

请求示例

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

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCenBandwidthPackagesResponse>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>9D7E2400-2755-4AF5-9B73-12565E4F73A0</RequestId>
    <CenBandwidthPackages>
        <CenBandwidthPackage>
            <CreationTime>2021-02-01T11:14Z</CreationTime>
            <GeographicSpanId>north-america_china</GeographicSpanId>
            <IsCrossBorder>false</IsCrossBorder>
            <HasReservationData>false</HasReservationData>
            <Status>InUse</Status>
            <GeographicRegionBId>north-america</GeographicRegionBId>
            <BusinessStatus>Normal</BusinessStatus>
            <BandwidthPackageChargeType>PREPAY</BandwidthPackageChargeType>
            <GeographicRegionAId>china</GeographicRegionAId>
            <CenBandwidthPackageId>cen-xxjsjfkffkfkfjkf****</CenBandwidthPackageId>
            <CenIds>
                <CenId>cen-kojok19x3j0q6k****</CenId>
            </CenIds>
            <ExpiredTime>2029-09-08T16:00Z</ExpiredTime>
            <Bandwidth>1</Bandwidth>
        </CenBandwidthPackage>
    </CenBandwidthPackages>
</DescribeCenBandwidthPackagesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageNumber" : 1,
  "TotalCount" : 1,
  "PageSize" : 10,
  "RequestId" : "9D7E2400-2755-4AF5-9B73-12565E4F73A0",
  "CenBandwidthPackages" : {
    "CenBandwidthPackage" : [ {
      "CreationTime" : "2021-02-01T11:14Z",
      "GeographicSpanId" : "north-america_china",
      "IsCrossBorder" : false,
      "HasReservationData" : false,
      "Status" : "InUse",
      "GeographicRegionBId" : "north-america",
      "BusinessStatus" : "Normal",
      "BandwidthPackageChargeType" : "PREPAY",
      "GeographicRegionAId" : "china",
      "CenBandwidthPackageId" : "cen-xxjsjfkffkfkfjkf****",
      "CenIds" : {
        "CenId" : [ "cen-kojok19x3j0q6k****" ]
      },
      "ExpiredTime" : "2029-09-08T16:00Z",
      "Bandwidth" : 1
    } ]
  }
}

错误码

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