调用DescribeCenBandwidthPackage接口查询当前登录账户下云企业网的带宽包的详细信息。

调试

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

请求参数

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

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

  • true:包含续费数据。
  • false:不包含续费数据。
Action String DescribeCenBandwidthPackages

系统规定参数。取值:DescribeCenBandwidthPackages

PageNumber Integer 1

列表的页码,默认值为1

PageSize Integer 2

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

IsOrKey Boolean false

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

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

过滤条件。

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

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

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

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

根据Key指定过滤值。

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

返回数据

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

每页包含的条目数。

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

请求ID。

PageNumber Integer 1

当前页码。

TotalCount Integer 2

列表条目数。

CenBandwidthPackages Array of CenBandwidthPackage

带宽包的详细信息。

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

临时升配到期时间。

Status String InUse

带宽包是否已绑定云企业网实例。

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

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

ReservationOrderType String UPGRADE

续费变配方式。

  • TEMP_UPGRADE:短时升配。
  • UPGRADE:升配。
BandwidthPackageChargeType String PREPAY

带宽包的计费方式。

CenBandwidthPackageId String cenbwp-4c2zaavbvh5x****

带宽包的ID。

ReservationInternetChargeType String PREPAY

变配之后的计费方式。

GeographicRegionAId String china

要查询的区域ID。取值:

  • china:中国内地。
  • asia-pacific:亚太。
  • europe:欧洲。
  • australia:澳洲。
  • north-america:北美。
Bandwidth Long 2

带宽包的峰值带宽。

Description String cen

带宽包描述。

ExpiredTime String 2021-09-08T16:00Z

带宽包超时时间。

ReservationBandwidth String 10

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

GeographicSpanId String north-america_china

区域对应的ID。

GeographicRegionBId String north-america

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

  • china:中国内地。
  • asia-pacific:亚太。
  • europe:欧洲。
  • australia:澳洲。
  • north-america:北美。
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

互通地域间的带宽峰值。

OppositeRegionId String us-west-1

对端地域ID。

GeographicSpanId String north-america_china

互通地域。

LocalRegionId String cn-hangzhou

本端地域ID。

CenIds Array of String cen-xxjsjfkffkfkfjkf****

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

示例

请求示例

http(s)://[Endpoint]/?IncludeReservationData=true
&Action=DescribeCenBandwidthPackages
&PageNumber=1
&PageSize=2
&IsOrKey=false
&Filter=[{"Key":"CenId","Value":["cen-xxjsjfkffkfkfjkf****"]}]
&公共请求参数

正常返回示例

XML格式

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

<DescribeCenBandwidthPackagesResponse>
    <PageSize>2</PageSize>
    <RequestId>9D7E2400-2755-4AF5-9B73-12565E4F73A0</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>2</TotalCount>
    <CenBandwidthPackages>
        <ReservationActiveTime>2021-08-30T16:00Z</ReservationActiveTime>
        <Status>InUse</Status>
        <CreationTime>2021-02-01T11:14Z</CreationTime>
        <ReservationOrderType>UPGRADE</ReservationOrderType>
        <BandwidthPackageChargeType>PREPAY</BandwidthPackageChargeType>
        <CenBandwidthPackageId>cenbwp-4c2zaavbvh5x****</CenBandwidthPackageId>
        <ReservationInternetChargeType>PREPAY</ReservationInternetChargeType>
        <GeographicRegionAId>china</GeographicRegionAId>
        <Bandwidth>2</Bandwidth>
        <Description>cen</Description>
        <ExpiredTime>2021-09-08T16:00Z</ExpiredTime>
        <ReservationBandwidth>10</ReservationBandwidth>
        <GeographicSpanId>north-america_china</GeographicSpanId>
        <GeographicRegionBId>north-america</GeographicRegionBId>
        <IsCrossBorder>false</IsCrossBorder>
        <BusinessStatus>Normal</BusinessStatus>
        <Name>test</Name>
        <HasReservationData>false</HasReservationData>
        <OrginInterRegionBandwidthLimits>
            <BandwidthLimit>1</BandwidthLimit>
            <OppositeRegionId>us-west-1</OppositeRegionId>
            <GeographicSpanId>north-america_china</GeographicSpanId>
            <LocalRegionId>cn-hangzhou</LocalRegionId>
        </OrginInterRegionBandwidthLimits>
        <CenIds>cen-xxjsjfkffkfkfjkf****</CenIds>
    </CenBandwidthPackages>
</DescribeCenBandwidthPackagesResponse>

JSON格式

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

{
  "PageSize" : 2,
  "RequestId" : "9D7E2400-2755-4AF5-9B73-12565E4F73A0",
  "PageNumber" : 1,
  "TotalCount" : 2,
  "CenBandwidthPackages" : [ {
    "ReservationActiveTime" : "2021-08-30T16:00Z",
    "Status" : "InUse",
    "CreationTime" : "2021-02-01T11:14Z",
    "ReservationOrderType" : "UPGRADE",
    "BandwidthPackageChargeType" : "PREPAY",
    "CenBandwidthPackageId" : "cenbwp-4c2zaavbvh5x****",
    "ReservationInternetChargeType" : "PREPAY",
    "GeographicRegionAId" : "china",
    "Bandwidth" : 2,
    "Description" : "cen",
    "ExpiredTime" : "2021-09-08T16:00Z",
    "ReservationBandwidth" : "10",
    "GeographicSpanId" : "north-america_china",
    "GeographicRegionBId" : "north-america",
    "IsCrossBorder" : false,
    "BusinessStatus" : "Normal",
    "Name" : "test",
    "HasReservationData" : "false",
    "OrginInterRegionBandwidthLimits" : [ {
      "BandwidthLimit" : "1",
      "OppositeRegionId" : "us-west-1",
      "GeographicSpanId" : "north-america_china",
      "LocalRegionId" : "cn-hangzhou"
    } ],
    "CenIds" : [ "cen-xxjsjfkffkfkfjkf****" ]
  } ]
}

错误码

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