You need to enable JavaScript to run this app.
导航

DescribeBandwidthPackages

最近更新时间2024.01.02 10:48:24

首次发布时间2022.03.01 09:32:28

调用 DescribeBandwidthPackages 接口,查询满足指定条件的共享带宽包。

调用说明

  • 传入多个请求参数,按照传入的参数进行查询,返回符合所有条件的共享带宽包,若没有符合条件的共享带宽包,则返回空值。

  • 若请求参数非必选参数均未传入,则按照当前登录账号查询,返回当前账号下的所有共享带宽包。

  • 使用标签过滤共享带宽包实例时,最多可查询指定标签关联的1000个共享带宽包实例。如果指定标签关联的共享带宽包实例超过1000个,则请您使用 ListTagsForResources 接口查询。

请求参数

参数名称
类型
是否必选
示例值
描述
ActionStringDescribeBandwidthPackages要执行的操作,取值:DescribeBandwidthPackages。
VersionString2020-04-01API的版本信息,当前版本为2020-04-01。

BandwidthPackageIds.N

String

BandwidthPackageIds.1=bwp-2zeo05qre24nhrqpy****
&BandwidthPackageIds.2=bwp-1231283asdasd2312***

要查询的共享带宽包实例ID。

  • 参数 - N:表示共享带宽包ID的序号。
  • 多个共享带宽包的 ID之间用&分隔。
BandwidthPackageNameStringbwp-01共享带宽包的名称。

ISP

string

BGP

共享带宽包的线路类型。取值如下:

  • BGP:BGP(多线)。
  • 若您的账号已申请并开通了静态单线权限,则可传入如下取值:
    • ChinaMobile:中国移动静态单线。
    • ChinaTelecom:中国电信静态单线。
    • ChinaUnicom:中国联通静态单线。
  • 若您的账号已申请并开通了BGP单线权限,则可传入SingleLine_BGP。
  • 若您的账号已申请并开通了融合BGP权限,则可传入Fusion_BGP。
  • 若您的账号已申请并开通了惠选型静态单线权限,则可传入如下取值:
    • ChinaMobile_Value:中国移动惠选型静态单线。
    • ChinaUnicom_Value:中国联通惠选型静态单线。
    • ChinaTelecom_Value:中国电信惠选型静态单线。

Protocol

String

IPv4

共享带宽包的IP协议,取值如下:

  • IPv4:IPv4协议。
  • IPv6:IPv6协议。

SecurityProtectionEnabled

Boolean

true

共享带宽包的安全防护类型。

  • true:增强防护。
  • false:基础防护。
ProjectNameStringProject_1共享带宽包所属项目的名称。

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。

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

PageSize

Integer

20

分页查询时每页的行数。最大值为100,默认值为20。

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

NextToken

String

caeba0bbb2be03f84eb48b699f0a****

分页查询凭证,用于标记分页的位置。

  • 不填则从头开始查询。
  • 传入之前调用本API返回的NextToken,则从该次API调用标记分页的位置往后开始查询。
MaxResultsInteger50查询的数量,默认为 10,最大为100。

返回数据

参数名称
类型
示例值
描述
RequestIdString2021062415303301022514515207C4****请求ID。

TotalCount

Integer

2

符合条件的共享带宽包总数。

说明

本参数即将下线,使用NextTokenMaxResults分页查询时,此参数无意义。

PageNumber

Integer

1

当前页码。

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

PageSize

Integer

10

当前分页的行数。

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

NextTokenStringcaeba0bbb2be03f84eb48b699f0a****本次API调用返回的查询凭证,标记分页的位置,用于下一次查询。返回为空表示没有下一页。
BandwidthPackagesArray of struct-BandwidthPackages的详细信息列表。具体请见下表“BandwidthPackage结构”。

BandwidthPackage结构

参数名称
类型
示例值
描述
BandwidthPackageIdStringbwp-2zeo05qre24nhrqpy****共享带宽包的ID。
BandwidthPackageNameStringbwp-test共享带宽包的名称。
DescriptionStringtest共享带宽包的描述信息。
ISPStringBGP线路类型。

BillingType

string

2

共享带宽包的计费方式。

  • 1:包年包月。
  • 2 : 按带宽上限计费。
  • 3:按主流量计费。
  • 4 : 按传统95计费。
BandwidthInteger20共享带宽包的带宽值,单位Mbps。
ProtocolStringIPv4共享带宽包的IP协议。

SecurityProtectionTypes

List

["AntiDDoS_Enhanced"]

共享带宽包的安全防护类型。

  • AntiDDoS_Enhanced:增强防护。
  • 空值: 基础防护。
ProjectNameStringProject_1共享带宽包所属项目的名称。
TagsArray of struct-共享带宽包的标签信息。具体请参见下表“Tags结构”。
EipAddressesArray of struct-加入共享带宽包的公网IP信息列表。具体请见下表“EipAddresses结构”。

Status

String

Available

共享带宽包的状态。

  • Creating:创建中。
  • Available:可用。
  • Deleting:删除中。
BusinessStatusStringNormal计费状态。
CreationTimeString2022-02-20T01:37:38+08:00创建共享带宽包的时间。
UpdateTimeString2022-02-20T01:37:38+08:00更新共享带宽包的时间。
ExpiredTimestring2022-05-07 23:59:59共享带宽包到期时间。
OverdueTimeString2023-02-20T01:00:00+08:00欠费关停时间。
DeletedTimeString2023-02-22T01:00:00+08:00欠费关停回收时间。

EipAddresses结构

参数名称
类型
示例值
描述
EipAddressString180.XX.XX.54公网IP的地址。
AllocationIdStringeip-sdsdsd23233****公网IP的ID。

Tags结构

参数名称
类型
示例值
描述
KeyStringk1标签键。
ValueStringv1标签值。

请求示例

GET /?Action=DescribeBandwidthPackages&Version=2020-04-01&ISP=BGP HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribeBandwidthPackages",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result":{
        "RequestId": "2021062415303301022514515207C4****",
        "TotalCount":2,
        "PageNumber": 1,
        "PageSize": 20,
        "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
        "BandwidthPackages":[
            {
                "BandwidthPackageId":"bwp-2zeo05qre24nhrqpy****",
                "BandwidthPackageName":"bwp-01",               
                "Description":"This  is  a bandwithpackage",                
                "ISP":"BGP",               
                "BillingType": 2, 
                "Bandwidth":20,
                "Protocol":"IPv4",  
                "SecurityProtectionTypes":[
                "AntiDDoS_Enhanced"
                ],              
                "ProjectName":"Project_1",
                "Tags":[
                    {
                        "Key":"k1",
                        "Value":"v1"
                    },
                    {
                        "Key":"k2",
                        "Value":""
                    }
                ],   
                "EipAddresses":[
                    {
                        "EipAddress":"180.XX.XX.54",
                        "AllocationId":"eip-sdsdsd23233****"
                    }     
                ],                
                "Status":"Available",  
                "BusinessStatus": "",                            
                "CreationTime":"2022-02-20T01:37:38+08:00",
                "UpdateTime":"2022-02-20T01:37:38+08:00",
                "ExpiredTime":"2022-05-07 23:59:59",
                "OverdueTime":"",                              
                "DeletedTime":"" 

            }
        ]
    }
}

错误码

公共错误码,请参见 公共错误码 。

HttpCode
错误码
错误信息
描述
400InvalidMaxResults.MalformedThe specified parameter MaxResults is malformed.查询数量不合法。
400InvalidNextToken.MalformedThe specified parameter NextToken is invalid.查询 NextToken 不合法。
400InvalidName.MalformedThe specified name is malformed. Ensure the maximum length of name is 128.指定的名称格式不合法。名称长度不能超过128个字符。
400InvalidName.MalformedThe specified name is malformed.指定的名称格式不合法。请修复名称格式后重试。
400InvalidTagFilter.DisorderThe specified index order of tag filter is malformed.指定标签过滤项的索引顺序参数格式不合法。
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.已达到单次可指定过滤标签值数量的上限。