DescribeIpv6AddressBandwidths--IPv6网关-火山引擎

文档中心

立即注册

导航

DescribeIpv6AddressBandwidths

最近更新时间：2023.11.07 08:12:35首次发布时间：2022.10.10 09:46:29

调用 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	否	AllocationIds.1=eip-2zaiwb7ujxscd**&AllocationIds.2=eip-2wrfgeb3efghxs**	IPv6公网带宽的ID。参数 - N：表示IPv6公网带宽ID的序号，取值范围为1 ～ 100，表示指定IPv6公网带宽ID时最多可查询100个。多个IPv6公网带宽ID间使用&分隔。
Ipv6Addresses.N	String	否	Ipv6Addresses.1=2408::153:3921:XX:XX:7b12:1c5f&Ipv6Addresses.2=2408:4008:2cf:XX:XX:dd1e:2a22:5ddf	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。
PageNumber	Integer	否	1	列表页码，起始值为1，默认值为1。
PageSize	Integer	否	20	分页查询时每页的行数，取值范围为1～100，默认值为20。
PageNumber	Integer	否	1	列表的页码。默认值为1。说明本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。
PageSize	Integer	否	20	分页查询时每页的行数。最大值为100，默认值为20。说明本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。
NextToken	String	否	caeba0bbb2be03f84eb48b699f0a****	分页查询凭证，用于标记分页的位置。不填则从头开始查询。传入之前调用本API返回的`NextToken`，则从该次API调用标记分页的位置往后开始查询。
MaxResults	Integer	否	50	查询的数量，默认为 10，最大为100。

返回数据

参数名称	类型	示例值	描述
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	Array of Struct	-	符合条件的IPv6公网带宽的详细信息。具体请参见下表“ Ipv6AddressBandwidths结构 ”。

Ipv6AddressBandwidths结构

参数名称	类型	示例值	描述
Ipv6GatewayId	String	ipv6gw-hp3y0l3ln89j8cdvf****	IPv6网关的ID。
AllocationId	String	eip-2zaiwb7ujxscd****	IPv6公网带宽的ID。该参数仅开通了IPv6公网带宽的IPv6地址才有返回值。
UpdatedAt	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公网带宽欠费关停的时间。
DeletedTime	String	2021-05-08 01:00:00	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：按量计费-按实际流量计费。

请求示例

GET /?Action=DescribeIpv6AddressBandwidths&Version=2020-04-01&VpcId=vpc-bp1opxu1zkhn00gzv**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-guangzhou
Service: vpc

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribeIpv6AddressBandwidths",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-guangzhou"
    }, 
    "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "TotalCount":2,
        "PageNumber": 1,
        "PageSize": 20,
        "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
        "Ipv6AddressBandwidths": [
            {
		            "Ipv6GatewayId": "ipv6gw-hp3y0l3ln89j8cdvf****",
                "AllocationId": "eip-2zaiwb7ujxscd****",
                "UpdatedAt": "2022-04-29T01:37:38+08:00",
                "CreationTime": "2022-04-29T01:37:38+08:00",
                "OverdueTime": "2022-05-07 01:00:00",
                "DeletedTime": "2022-05-08 01:00:00",
                "Bandwidth": 5,
                "BandwidthPackageId": "bwp-2zeo05qre24nhrqpy****",
                "ISP": "BGP",
                "InstanceId": "i-3tm18xqalm4e8i4q****",
                "InstanceType": "EcsInstance",
                "Ipv6Address": "2408::153:3921:XX:XX:7b12:1c5f",
                "BusinessStatus": "Normal",
                "NetworkType": "Public",
                "LockReason": "",
                "BillingType": 3,
                "Status": "Available"
            },
            {
		            "Ipv6GatewayId": "ipv6gw-hp3y0l3ln89j8cdvf****",
                "AllocationId": "eip-2wrfgeb3efghxs****",
                "UpdatedAt": "2022-04-29T01:37:38+08:00",
                "CreationTime": "2022-04-29T01:37:38+08:00",
                "OverdueTime": "2022-05-07 01:00:00",
                "DeletedTime": "2022-05-08 01:00:00",
                "Bandwidth": 5,
                "BandwidthPackageId": "bwp-2zeo05qre24nhrqpy****",
                "ISP": "BGP",
                "InstanceId": "i-2zebbhyczzaweeval****",
                "InstanceType": "EcsInstance",
                "Ipv6Address": "2408:4008:2cf:XX:XX:dd1e:2a22:5ddf",
                "BusinessStatus": "FinancialLocked",
                "NetworkType": "Private",
                "LockReason": "Financial",
                "BillingType": 3,
                "Status": "Available"
            }
        ]
    }
}

错误码

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

HttpCode	错误码	错误信息	描述
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	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地址数量上限。