全部产品
Search
文档中心

云企业网:DescribeCenBandwidthPackages - 查询账户下所有带宽包的详细信息

更新时间:Mar 01, 2024

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
IncludeReservationDataboolean

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

  • true:包含续费数据。

  • false:不包含续费数据。

true
PageNumberinteger

列表的页码,默认值为 1

1
PageSizeinteger

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

2
IsOrKeyboolean

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

  • false(默认):过滤条件之间是的关系。即必须符合所有过滤条件,才视为匹配过滤条件。

  • true:过滤条件之间是的关系。即只要符合其中一个过滤条件,则视为匹配过滤条件。

false
ResourceGroupIdstring

资源组 ID。

rg-acfnwjeo4tv****
Filterobject []

过滤信息

Keystring

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

  • CenId:云企业网实例的 ID。

  • Status:带宽包实例的状态,取值:

    • Idle:未绑定。
    • InUse:已绑定。
  • CenBandwidthPackageId:带宽包的 ID。

  • Name:带宽包的名称。 支持输入一个或多个过滤条件,N 的最大值为 5

CenId
Valuearray

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

string

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

cen-xxjsjfkffkfkfjkf****
Tagobject []

标签信息列表。

一次最多支持输入 20 个标签信息。

Keystring

资源的标签键。

一旦传入该值,则不允许为空字符串。最多支持 64 个字符,不能以aliyun或者acs:开头,不能包含http://或者https://

一次最多支持输入 20 个标签的标签键。

TagKey
Valuestring

资源的标签值。

标签值可以为空或输入不超过 128 个字符的字符串,不能以aliyun或者acs:开头,不能包含http://或者https://

每一个标签键对应一个标签值,一次最多支持输入 20 个标签键对应的标签值。

TagValue

返回参数

名称类型描述示例值
object
PageSizeinteger

每页包含的条目数。

2
RequestIdstring

请求 ID。

9D7E2400-2755-4AF5-9B73-12565E4F73A0
PageNumberinteger

当前页码。

1
TotalCountinteger

列表条目数。

2
CenBandwidthPackagesobject []

带宽包的详细信息。

ReservationActiveTimestring

临时升配到期时间。

2021-08-30T16:00Z
Statusstring

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

  • Idle:未绑定。

  • InUse:已绑定。

InUse
CreationTimestring

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

2021-02-01T11:14Z
ReservationOrderTypestring

续费变配方式。

  • TEMP_UPGRADE:短时升配。

  • UPGRADE:升配。

UPGRADE
BandwidthPackageChargeTypestring

带宽包的计费方式。

PREPAY
CenBandwidthPackageIdstring

带宽包的 ID。

cenbwp-4c2zaavbvh5x****
ReservationInternetChargeTypestring

变配之后的计费方式。

PREPAY
GeographicRegionAIdstring

要查询的区域 ID。取值:

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

带宽包的峰值带宽。

2
Descriptionstring

带宽包描述。

cen
ExpiredTimestring

带宽包超时时间。

2021-09-08T16:00Z
ReservationBandwidthstring

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

10
GeographicSpanIdstring

区域对应的 ID。

north-america_china
GeographicRegionBIdstring

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

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

资源组 ID。

rg-aekzoyr5k36****
IsCrossBorderboolean

是否是跨境带宽包。

  • false:不是跨境带宽包。

  • true:是跨境带宽包。

false
BusinessStatusstring

带宽包的状态。

  • Normal:正常。

  • FinancialLocked:欠费锁定。

  • SecurityLocked:安全风控锁定。

Normal
Namestring

带宽包的名称。

test
HasReservationDatastring

是否有续费数据。

  • true:有续费数据。

  • false:没有续费数据。

说明 仅入参 IncludeReservationData 取值为 true,且有未生效订购数据时才会为 true
false
OrginInterRegionBandwidthLimitsobject []

互通地域的详细信息。

BandwidthLimitstring

互通地域间的带宽峰值。

1
OppositeRegionIdstring

对端地域 ID。

us-west-1
GeographicSpanIdstring

互通地域。

north-america_china
LocalRegionIdstring

本端地域 ID。

cn-hangzhou
Tagsobject []

带宽包的标签信息。

Keystring

标签键。

TagKey
Valuestring

标签值。

TagValue
CenIdsarray

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

string

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

cen-xxjsjfkffkfkfjkf****

示例

正常返回示例

JSON格式

{
  "PageSize": 2,
  "RequestId": "9D7E2400-2755-4AF5-9B73-12565E4F73A0",
  "PageNumber": 1,
  "TotalCount": 2,
  "CenBandwidthPackages": {
    "CenBandwidthPackage": [
      {
        "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",
        "ResourceGroupId": "rg-aekzoyr5k36****",
        "IsCrossBorder": false,
        "BusinessStatus": "Normal",
        "Name": "test",
        "HasReservationData": "false",
        "OrginInterRegionBandwidthLimits": {
          "OrginInterRegionBandwidthLimit": [
            {
              "BandwidthLimit": "1",
              "OppositeRegionId": "us-west-1",
              "GeographicSpanId": "north-america_china",
              "LocalRegionId": "cn-hangzhou"
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "Key": "TagKey",
              "Value": "TagValue"
            }
          ]
        },
        "CenIds": {
          "CenId": [
            "cen-xxjsjfkffkfkfjkf****"
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400IllegalParam.TagValueThe tag values are not valid.参数中指定的tag value不合法。
400IllegalParam.TagKeyThe tag keys are not valid.参数中指定的tag key不合法。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

变更历史

变更时间变更内容概要操作
2023-03-08OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
    新增入参:Tag
出参OpenAPI 返回结构发生变更