DescribeCenBandwidthPackages--云企业网-火山引擎

文档中心

立即注册

导航

DescribeCenBandwidthPackages

最近更新时间：2024.10.18 15:45:55首次发布时间：2022.04.28 07:28:31

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

使用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的带宽包，若没有符合条件的带宽包，则返回空值。
若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有带宽包。
使用标签查询带宽包时，最多可查询指定标签关联的1000个带宽包。如果指定标签关联的带宽包超过1000个，则只返回前1000个。此时请使用ListTagsForResources接口查询。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeCenBandwidthPackages	要执行的操作，取值为DescribeCenBandwidthPackages。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
CenId	String	否	cen-7qthudw0ll6jmc****	绑定的云企业网实例ID。您可以调用 DescribeCens 接口，查询云企业网实例ID。
CenBandwidthPackageIds.N	String	否	CenBandwidthPackageIds.1=cbp-bp1o94dp5**&CenBandwidthPackageIds.2=cbp-13fszmm1x**	带宽包的ID。参数 - N：表示带宽包ID的序号，取值范围为1～100。多个带宽包ID之间用&分隔。
CenBandwidthPackageName	String	否	cbp-test	带宽包的名称。
LocalGeographicRegionSetId	String	否	China	云企业网互通的本端地理区域ID。 China：中国大陆。 Asia：亚太。
PeerGeographicRegionSetId	String	否	China	云企业网互通的对端地理区域ID。 China：中国大陆。 Asia：亚太。
ProjectName	String	否	default	带宽包所属项目的名称。
TagFilters.N.Key	String	否	TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3	标签的标签键。参数 - N：表示标签键的序号，取值范围：1～10。多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的带宽包。不允许重复。
TagFilters.N.Values.N	String	否	TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=v1	标签的标签值。第一个N：表示标签键的序号，取值范围：1～10。第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的带宽包。多个标签值之间用&分隔。说明若传入该参数，则必须先传入`TagFilters.N.Key`。传入空字符串时，表示查询标签值为空的带宽包。
PageNumber	Integer	否	1	列表的页码，默认值为1。
PageSize	Integer	否	10	分页查询时每页显示的行数。取值范围为1~50，默认值为10。

返回参数

参数名称	类型	示例值	描述
TotalCount	Integer	1	符合条件的带宽包总数。
PageNumber	Integer	1	当前页码。
PageSize	Integer	10	当前分页的行数。
CenBandwidthPackages	Array of Struct	-	带宽包的详情。具体请参见“CenBandwidthPackage结构”。

CenBandwidthPackage结构

参数名称	类型	示例值	描述
AccountId	String	210000****	带宽包所属的账号ID。
CenBandwidthPackageId	String	cbp-4c2zaavbvh5x****	带宽包ID。
CenBandwidthPackageName	String	cbp-test	带宽包的名称。
Description	String	testdesc	带宽包的描述。
BillingType	Integer	1	带宽包的计费类型。 1：包年包月 4：按量计费-按95峰值计费说明按量计费-按95峰值计费正在邀测中，暂仅支持完成企业认证的账号申请试用，如需试用，请联系客户经理。
LocalGeographicRegionSetId	String	China	带宽包互通的本端地理区域ID。 China：中国大陆。 Asia：亚太。
PeerGeographicRegionSetId	String	China	带宽包互通的对端地理区域ID。 China：中国大陆。 Asia：亚太。
LineOperator	String	ChinaUnicom	跨境带宽包的线路运营商。 ChinaUnicom：中国联通。
Bandwidth	Integer	10	带宽包的带宽峰值，单位为Mbps。
RemainingBandwidth	Integer	10	带宽包剩余未分配带宽，单位为Mbps。
CenIds	List of String	["cen-7qthudw0ll6jmc**","cen-13fszmm1xdssg3n6nu4x9**"]	带宽包绑定的云企业网实例ID。
Status	String	Available	带宽包的状态。取值如下： Creating：创建中。 Deleting：删除中。 Pending：操作中。 Available：未绑定。 InUse：已绑定。
Business	String	Normal	带宽包的业务状态。取值如下： Normal：正常。 FinancialLocked：已冻结。
ProjectName	String	default	带宽包所属项目的名称。
Tags	Array of Struct	-	带宽包的标签信息。具体请参见下表“Tag结构”。
CreationTime	String	2018-04-18T15:02:37+08:00	带宽包的创建时间。
UpdateTime	String	2018-04-18T15:02:37+08:00	带宽包实例的更新时间。
ExpiredTime	String	2021-05-07 23:59:59	带宽包的到期时间。
DeletedTime	String	2021-05-22 00:00:00	带宽包的删除时间。

Tag结构

参数名称	类型	示例值	描述
Key	String	k1	带宽包标签的标签键。
Value	String	v1	带宽包标签的标签值。

请求示例

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": {
		    "TotalCount": 1,
        "PageNumber": 1,
        "PageSize": 10,
        "CenBandwidthPackages": [
            {
		            "AccountId": "210000****",
                "CenBandwidthPackageId": "cbp-4c2zaavbvh5x****",
                "BillingType": 1,
                "CenBandwidthPackageName": "cbp-test",
                "Description": "cen-bwp",
                "LocalGeographicRegionSetId": "China",
                "PeerGeographicRegionSetId": "China",
                "Bandwidth": 10,
                "RemainingBandwidth": 10,
                "CenIds": [
                    "cen-7qthudw0ll6jmc****"
                ],
                "Status": "Available",
                "Business": "Normal",
                "ProjectName": "default", 
                "Tags": [ 
                    {
                        "Key": "k1",
                        "Value": "v1" 
                    }, 
                    { 
                        "Key": "k2", 
                        "Value": "v2" 
                    } 
                ],
                "CreationTime": "2018-04-18T15:02:37+08:00",
                "UpdateTime": "2018-04-18T15:02:37+08:00",
                "ExpiredTime": "2021-05-07 23:59:59",
                "DeletedTime": "2021-05-22 00:00:00"
               
            }
        ]
    }
}

错误码

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

HttpCode	错误码	错误信息	描述
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	InvalidParameter	A parameter specified in the request is not valid, is unsupported or cannot be used.	该请求传入了非法或不支持的参数。
400	InvalidTagFilter.Disorder	The specified index order of tag filter is malformed.	指定标签过滤项的索引顺序参数格式不合法。
400	InvalidTagFilterKey.Malformed	The specified parameter tag filter key is invalid.	过滤标签键不合法。
400	InvalidTagFilterValue.Malformed	The specified parameter tag filter value is invalid.	过滤标签值不合法。
400	LimitExceeded.ResourceIds	You've reached the limit of 100 resource IDs that can be specified in this request.	已达到单次可查询的实例数量上限。
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	已达到单次可指定过滤标签键数量的上限。
400	LimitExceeded.TagFilterValue	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签值数量的上限。