You need to enable JavaScript to run this app.
文档中心
IPv6网关

IPv6网关

复制全文
下载 pdf
IPv6公网带宽
DescribeIpv6AddressBandwidths - 查询IPv6公网带宽
复制全文
下载 pdf
DescribeIpv6AddressBandwidths - 查询IPv6公网带宽
调用 DescribeIpv6AddressBandwidths 接口,查询满足指定条件的IPv6公网带宽。​
使用说明​
  • 传入多个请求参数,按照传入的参数进行查询,返回符合所有条件的IPv6公网带宽,若没有符合条件的IPv6公网带宽,则返回空值。​
  • 若请求参数非必选参数均未传入,则按照当前登录账号查询,返回当前账号下的所有IPv6公网带宽。​
请求参数​
Action String 必选 示例值:DescribeIpv6AddressBandwidths​
要执行的操作,取值:DescribeIpv6AddressBandwidths。​
​
Version String 必选 示例值:2020-04-01​
API的版本信息,当前版本为 2020-04-01。​
​
VpcId String 可选 示例值:vpc-bp1opxu1zkhn00gzv****​
VPC的ID。​
​
AllocationIds.N String 可选 示例值:eip-2zaiwb7ujxscd****​
IPv6公网带宽的ID。​
  • 参数 - N:表示IPv6公网带宽ID的序号,取值范围为1 ~ 100,表示指定IPv6公网带宽ID时最多可查询100个。​
  • 多个IPv6公网带宽ID间使用&分隔。​
​
Ipv6Addresses.N String 可选 示例值:2408::153:3921:XX:XX:7b12:1c5f​
IPv6地址。​
  • 参数 - N:表示待开通IPv6公网带宽的IPv6地址序号,取值范围为1 ~ 100,表示指定IPv6地址时最多可查询100个。​
  • 多个IPv6地址间使用&分隔。​
​
ISP String 可选 示例值:BGP​
IPv6公网带宽的线路类型。​
  • BGP:BGP(多线)。​
​
AssociatedInstanceType String 可选 示例值:EcsInstance​
IPv6公网带宽关联的实例类型。​
  • EcsInstance:ECS实例。​
​
AssociatedInstanceId String 可选 示例值:i-3tm18xqalm4e8i4q****​
IPv6公网带宽关联的实例ID。​
​
NetworkType String 可选 示例值:Public​
要查询的IPv6地址的通信类型。​
  • Private:私网通信类型。​
  • Public:公网通信类型。​
​
BandwidthPackageId String 可选 示例值:bwp-2zeo05qre24nhrqpy****​
IPv6共享带宽包的ID。​
​
TagFilters.N.Key String 可选 示例值:k1​
标签的标签键。​
  • 参数 - N:表示标签键的序号,取值范围:1~10。​
  • 多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与(AND)”,即查询同时添加多个标签键的IPv6公网带宽。​
​
PageNumber Integer 可选 示例值:1​
列表的页码。默认值为1。​
说明​
本参数即将下线,建议您使用NextToken和MaxResults进行分页查询。​
​
PageSize Integer 可选 示例值:20​
分页查询时每页的行数。最大值为100,默认值为20。​
​
NextToken String 可选 示例值:caeba0bbb2be03f84eb48b699f0a****​
分页查询凭证,用于标记分页的位置。​
  • 不填则从头开始查询。​
  • 传入之前调用本API返回的NextToken,则从该次API调用标记分页的位置往后开始查询。​
​
MaxResults Integer 可选 示例值:50​
查询的数量,默认为 10,最大为100。​
​
TagFilters.N.Values.N String 可选 示例值:v1​
标签的标签值。​
  • 第一个N:表示标签键的序号。​
  • 第二个N:表示标签值的序号,取值范围:1~3。同一标签键多个标签值之间的关系为逻辑“或(OR)”,即查询同一标签键下添加其中一个标签值的IPv6公网带宽。​
  • 多个标签值之间用&分隔。​
说明​
  • 若传入该参数,则必须先传入TagFilters.N.Key。​
  • 传入空字符串时,表示查询标签值为空的IPv6公网带宽。​
​
​
​
返回参数​
RequestId String 示例值:2021062415303301022514515207C4****​
请求ID。​
​
TotalCount Integer 示例值:2​
符合条件的IPv6公网带宽总数。​
说明​
本参数即将下线,使用NextToken和MaxResults分页查询时,此参数无意义。​
​
PageNumber Integer 示例值:1​
当前页码。​
说明​
本参数即将下线,建议您使用NextToken和MaxResults进行分页查询。​
​
PageSize Integer 示例值:10​
当前分页的行数。​
说明​
本参数即将下线,建议您使用NextToken和MaxResults进行分页查询。​
​
NextToken String 示例值:caeba0bbb2be03f84eb48b699f0a****​
本次API调用返回的查询凭证,标记分页的位置,用于下一次查询。返回为空表示没有下一页。​
​
Ipv6AddressBandwidths Object[] 示例值:-​
符合条件的IPv6公网带宽的详细信息。​
Ipv6GatewayId String 示例值:ipv6gw-hp3y0l3ln89j8cdvf****​
IPv6网关的ID。​
​
IsBlocked Boolean 示例值:true​
是否被封禁。​
  • true:是。​
  • false:否。​
​
AllocationId String 示例值:eip-2zaiwb7ujxscd****​
IPv6公网带宽的ID。​
该参数仅开通了IPv6公网带宽的IPv6地址才有返回值。​
​
UpdateTime String 示例值:2019-04-29T01:37:38+08:00​
IPv6公网带宽的更新时间。​
​
CreationTime String 示例值:2019-04-29T01:37:38+08:00​
IPv6公网带宽的开通时间。​
​
OverdueTime String 示例值:2021-05-07 01:00:00​
IPv6公网带宽欠费关停的时间。​
​
DeleteTime String 示例值:2021-05-07 23:23:23​
IPv6公网带宽的删除时间。​
​
Bandwidth Integer 示例值:5​
IPv6公网带宽的带宽上限,单位为Mbps。​
​
BandwidthPackageId String 示例值:bwp-2zeo05qre24nhrqpy****​
IPv6共享带宽包的ID。​
​
Status String 示例值:Available​
IPv6公网带宽的状态。​
  • Creating:创建中。​
  • Available:可用。​
​
ISP String 示例值:BGP​
IPv6公网带宽的线路类型。​
​
InstanceId String 示例值:i-3tm18xqalm4e8i4q****​
IPv6公网带宽关联的实例ID。​
​
InstanceType String 示例值:EcsInstance​
IPv6公网带宽关联的实例类型。​
​
Ipv6Address String 示例值:2408::153:3921:XX:XX:7b12:1c5f​
IPv6地址。​
​
BusinessStatus String 示例值:Normal​
IPv6公网带宽是否被锁定。​
  • Normal:正常。​
  • FinancialLocked:被锁定。​
​
NetworkType String 示例值:Public​
IPv6地址的通信类型。​
​
LockReason String 示例值:Financial​
IPv6公网带宽被锁定的原因。​
该参数只有IPv6公网带宽处于FinancialLocked状态时才有返回值。​
  • Financial:因欠费被锁定。​
  • Security:因安全被锁定。​
​
BillingType Integer 示例值:3​
IPv6公网带宽的计费方式。​
  • 2:按量计费-按带宽上限计费。​
  • 3:按量计费-按实际流量计费。​
​
ProjectName String 示例值:project_01​
IPv6公网带宽所在项目的名称。​
​
Tags Object[] 示例值:-​
IPv6公网带宽的标签信息。​
Key String 示例值:k1​
标签键。​
​
Value String 示例值:v1​
标签值。​
​
​
​
​
​
请求示例​
​
GET /?Action=DescribeIpv6AddressBandwidths&Version=2020-04-01&VpcId=vpc-bp1opxu1zkhn00gzv**** HTTP/1.1​
Host: vpc.cn-beijing.volcengineapi.com​
Region: cn-beijing​
Service: vpc​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeIpv6AddressBandwidths",​
"Version": "2020-04-01",​
"Service": "vpc",​
"Region": "cn-beijing"​
},​
"Result": {​
"Ipv6AddressBandwidths": [​
{​
"ISP": "BGP",​
"Tags": [​
{​
"Key": "k1",​
"Value": "v1"​
}​
],​
"Status": "Available",​
"Bandwidth": 5,​
"IsBlocked": true,​
"DeleteTime": "2021-05-07 23:23:23",​
"InstanceId": "i-3tm18xqalm4e8i4q****",​
"LockReason": "Financial",​
"UpdateTime": "2019-04-29T01:37:38+08:00",​
"BillingType": 3,​
"Ipv6Address": "2408::153:3921:XX:XX:7b12:1c5f",​
"NetworkType": "Public",​
"OverdueTime": "2021-05-07 01:00:00",​
"ProjectName": "project_01",​
"AllocationId": "eip-2zaiwb7ujxscd****",​
"CreationTime": "2019-04-29T01:37:38+08:00",​
"InstanceType": "EcsInstance",​
"Ipv6GatewayId": "ipv6gw-hp3y0l3ln89j8cdvf****",​
"BusinessStatus": "Normal",​
"BandwidthPackageId": "bwp-2zeo05qre24nhrqpy****"​
}​
],​
"NextToken": "caeba0bbb2be03f84eb48b699f0a****",​
"PageNumber": 1,​
"PageSize": 10,​
"RequestId": "2021062415303301022514515207C4****",​
"TotalCount": 2​
}​
}​
​
错误码​
公共错误码请参见公共错误码。​
​
状态码​
错误码​
错误信息​
说明​
400​
DryRunOperation​
Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.​
该请求设置为DryRun操作,操作授权已获得许可,但未被实际执行。​
400​
IdempotentParameterMismatch​
Arguments on this idempotent request are inconsistent with arguments used in previous request(s).​
此幂等请求的参数与前一个请求中使用的参数不一致。​
400​
InvalidMaxResults.Malformed​
The specified parameter MaxResults is malformed.​
查询数量不合法。​
400​
InvalidNextToken.Malformed​
The specified parameter NextToken is invalid.​
查询 NextToken 不合法。​
400​
InvalidPage.Malformed​
The specified page is malformed.​
指定的分页参数不合法。​
400​
InvalidParameter.ClientTokenMalformed​
The specified parameter ClientToken is malformed.​
指定的参数ClientToken格式不合法,长度不能超过64个ASCII字符。​
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.AllocationId​
You've reached the limit on the number of allocation IDs that you can describe.​
已达到可查询的Allocation ID数量上限。​
400​
LimitExceeded.Ipv6Address​
You've reached the limit on the number of IPv6 addresses that you can describe.​
已达到可查询的IPv6地址数量上限。​
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.​
已达到单次可指定过滤标签值数量的上限。​
400​
MissingParameter​
The request is missing a required parameter.​
该请求缺少必要参数。​
409​
InvalidOperation.Conflict​
The specified resource operation conflicts.​
指定的资源操作冲突。​
412​
IdempotentProcessing​
The request uses the same client token as a previous one that is still in process.​
幂等请求处理中。​
500​
InternalError​
An internal error has occurred.​
发生内部错误。​
​
​
最近更新时间:2026.01.23 15:55:57
这个页面对您有帮助吗?
有用
有用
无用
无用