You need to enable JavaScript to run this app.
导航
DescribeCenBandwidthPackages
最近更新时间:2024.04.22 17:42:22首次发布时间:2022.04.28 07:28:31

调用 DescribeCenBandwidthPackages 接口,查询满足指定条件的带宽包实例信息。

使用说明

  • 使用标签查询带宽包时,最多可查询指定标签关联的1000个带宽包。如果指定标签关联的带宽包超过1000个,则只返回前1000个。此时请使用ListTagsForResources接口查询。
  • a.N.b类型的参数中,“N”表示标签信息的序号,需按照数字顺序从1开始填写,单次调用数量上限10个。多个标签之间使用&分隔。

调试

请求参数

参数名称
类型
是否必选
示例值
描述
ActionStringDescribeCenBandwidthPackages要执行的操作,取值为DescribeCenBandwidthPackages。
VersionString2020-04-01API版本信息,当前版本为2020-04-01。
PageSizeInteger10分页查询时每页显示的行数。取值范围为1~50,默认值为10。
PageNumberInteger1列表的页码,默认值为1。

CenBandwidthPackageIds.N

String

CenBandwidthPackageIds.1=cbp-bp1o94dp5****&CenBandwidthPackageIds.2=cbp-13fszmm1x****

带宽包的ID。您可以调用DescribeCenBandwidthPackages接口获取带宽包ID。

  • 参数 - N:表示带宽包ID的序号,取值范围为1~100。
  • 多个带宽包ID之间用&分隔。

LocalGeographicRegionSetId

String

China

云企业网互通的本端地理区域ID。

  • China:中国大陆。
  • Asia:亚太。

PeerGeographicRegionSetId

String

China

云企业网互通的对端地理区域ID。

  • China:中国大陆。
  • Asia:亚太。
CenIdStringcen-7qthudw0ll6jmc****绑定的云企业网实例ID。您可以调用DescribeCens接口获取云企业网实例ID。
CenBandwidthPackageNameStringcbp-test带宽包的名称。

ProjectName

String

default

带宽包所属项目的名称。

  • 该参数不传入或传入为空时,表示查询所有的带宽包。
  • 该参数传入不为空时,表示查询属于指定项目的带宽包。

TagFilters.N.Key

String

TagFilters.1.Key=k1&TagFilters.2.Key=k2

带宽包标签的标签键。
指定多个标签键时,表示查询同时包含所有指定标签键的带宽包。

TagFilters.N.Values.N

String

TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.2.Values.1=v3

带宽包标签的标签值。每个标签键最多可指定3个标签值。

  • 未传入该参数时,表示查询指定标签键下所有标签值对应的标签所关联的带宽包。
  • 该参数取值为空时,表示查询指定标签键下标签值为空的标签所关联的带宽包。
  • 同一个标签键指定多个标签值时,表示查询各个标签值对应标签所关联带宽包的集合。

如果传入该参数,则必须先传入TagFilters.N.Key

返回参数

参数名称
类型
示例值
描述
RequestIdString2021081115253901022514606****请求ID。
PageSizeInteger10当前分页的行数。
PageNumberInteger1当前页码。
TotalCountInteger1符合条件的带宽包实例总数。
CenBandwidthPackagesArray of Struct-带宽包实例的详细信息。具体请参见“CenBandwidthPackage结构”。

CenBandwidthPackage结构

参数名称
类型
示例值
描述
CenBandwidthPackageIdStringcbp-4c2zaavbvh5x****带宽包实例ID。
CenBandwidthPackageNameStringcbp-test带宽包实例的名称。
DescriptionStringtestdesc带宽包实例的描述信息。

LocalGeographicRegionSetId

String

China

带宽包互通的本端地理区域ID。

  • China:中国大陆。
  • Asia:亚太。

PeerGeographicRegionSetId

String

China

带宽包互通的对端地理区域ID。

  • China:中国大陆。
  • Asia:亚太。
BandwidthInteger10带宽包实例的带宽峰值,单位为Mbps。
RemainingBandwidthInteger10带宽包剩余未分配带宽,单位为Mbps。
CenIdsList of String["cen-7qthudw0ll6jmc****","cen-13fszmm1xdssg3n6nu4x9****"]带宽包绑定的云企业网实例ID的列表。

Status

String

Available

带宽包实例的状态。取值如下:

  • Creating:创建中。
  • Deleting:删除中。
  • Pending:操作中。
  • Available:未绑定。
  • InUse:已绑定。
CreationTimeString2018-04-18T15:02:37+08:00带宽包实例的创建时间。
UpdatedAtString2018-04-18T15:02:37+08:00带宽包实例的更新时间。
AccountIdString210000****带宽包实例所属的账号ID。

Business

String

Normal

带宽包实例的业务状态。取值如下:

  • Normal:正常。
  • FinancialLocked:已冻结。

BillingType

Integer

1

带宽包实例的计费类型。

  • 1:包年包月
ExpiredTimeString2021-05-07 23:59:59带宽包实例的到期时间。
DeletedTimeString2021-05-22 00:00:00带宽包实例的删除时间。
ProjectNameStringdefault带宽包所属项目的名称。
TagsArray of Struct-带宽包的标签信息。具体请参见下表“Tag结构”。

Tag结构

参数名称
类型
示例值
描述
KeyStringk1
ValueStringv1

请求示例

GET /?Action=DescribeCenBandwidthPackages&Version=2020-04-01&PageSize=10&CenBandwidthPackageIds.1=cbp-bp1o94dp5****&CenId=cen-7qthudw0ll6jmc**** HTTP/1.1
Host: open.volcengineapi.com
Service: cen
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021081115253901022514606****",
        "Action": "DescribeCenBandwidthPackages",
        "Version": "2020-04-01",
        "Service": "cen",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "CenBandwidthPackages": [
            {
                "CenBandwidthPackageId": "cbp-4c2zaavbvh5x****",
                "CenBandwidthPackageName": "cbp-test",
                "Description": "testdesc",
                "LocalGeographicRegionSetId": "China",
                "PeerGeographicRegionSetId": "China",
                "Bandwidth": 10,
                "RemainingBandwidth": 10,
                "CenIds": [
                    "cen-7qthudw0ll6jmc****"
                ],
                "Status": "Available",
                "CreationTime": "2018-04-18T15:02:37+08:00",
                "UpdateTime": "2018-04-18T15:02:37+08:00",
                "AccountId": "210000****",
                "Business": "Normal",
                "BillingType": 1,
                "ExpiredTime": "2021-05-07 23:59:59",
                "DeletedTime": "2021-05-22 00:00:00",
                "ProjectName": "default", 
                "Tags": [ 
                    {
                        "Key": "k1",
                        "Value": "v1" 
                    }, 
                    { 
                        "Key": "k2", 
                        "Value": "v2" 
                    } 
                ]
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode错误码错误信息描述
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。
400LimitExceeded.ResourceIdsYou've reached the limit of 100 resource IDs that can be specified in this request.已达到单次可查询的实例数量上限。
400InvalidTagFilterKey.MalformedThe specified parameter tag filter key is invalid.过滤标签键不合法。
400InvalidTagFilterValue.MalformedThe specified parameter tag filter value is invalid.过滤标签值不合法。
400LimitExceeded.TagFilterKeyYou've reached the limit on the number of tag keys that you can filter.已达到单次可指定过滤标签键数量的上限。
400LimitExceeded.TagFilterValueYou've reached the limit on the number of tag values that you can filter.已达到单次可指定过滤标签值数量的上限。
400InvalidTagFilter.DisorderThe specified index order of tag filter is malformed.指定标签过滤项的索引顺序参数格式不合法。