Queries the IPv6 addresses in a specified region.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeIpv6Addresses |
The operation that you want to perform. Set the value to DescribeIpv6Addresses. |
RegionId | String | Yes | cn-huhehaote |
The ID of the region in which you want to query IPv6 addresses. You can call the DescribeRegions operation to query the most recent region list. |
Ipv6AddressId | String | No | ipv6-2zen5j4axcp5l5qyy**** |
The IDs of the IPv6 addresses that you want to query. You can enter at most 20 IPv6 IDs in each API request. Separate IPv6 IDs with commas (,). |
Ipv6Address | String | No | 2408:XXXX:153:3921:851c:c435:7b12:1c5f |
The IPv6 address that you want to query. |
Name | String | No | test |
The name of the IPv6 address that you want to query. |
AssociatedInstanceId | String | No | i-2ze72wuqj4y3jl4f**** |
The ID of the instance that is assigned the IPv6 address. |
AssociatedInstanceType | String | No | EcsInstance |
The type of the instance that is assigned the IPv6 address. Set the value to EcsInstance, which indicates an Elastic Compute Service (ECS) instance in a VPC. This is the default value. |
NetworkType | String | No | Private |
The type of communication supported by the IPv6 address. Valid values:
|
VpcId | String | No | vpc-bp15zckdt37pq72zv**** |
The ID of the VPC to which the IPv6 address belongs. |
VSwitchId | String | No | vsw-25navfgbue4g**** |
The ID of the vSwitch to which the IPv6 address belongs. |
Ipv6InternetBandwidthId | String | No | 5 |
The public bandwidth of the IPv6 address. Unit: Mbit/s. |
PageNumber | Integer | No | 1 |
The number of the page to return. Default value: 1. |
PageSize | Integer | No | 10 |
The number of entries to return on each page. Maximum value: 50. Default value: 10. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Ipv6Addresses | Array of Ipv6Address |
The details about the IPv6 addresses. |
|
Ipv6Address | |||
AllocationTime | String | 2020-12-20T14:56:09Z |
The time when the IPv6 address was created. |
AssociatedInstanceId | String | i-2ze72wuqj4y3jl4f**** |
The ID of the instance that is assigned the IPv6 address. |
AssociatedInstanceType | String | EcsInstance |
The type of the instance that is assigned the IPv6 address. |
Ipv6Address | String | 2408:XXXX:153:3921:851c:c435:7b12:1c5f |
The IPv6 address. |
Ipv6AddressId | String | ipv6-2zen5j4axcp5l5qyy**** |
The ID of the IPv6 address. |
Ipv6AddressName | String | test |
The name of the IPv6 address. |
Ipv6GatewayId | String | ipv6gw-2zewg0l66s73b4k2q**** |
The ID of the IPv6 gateway to which the IPv6 address belongs. |
Ipv6InternetBandwidth | Struct |
The information about the public bandwidth of the IPv6 address. |
|
Bandwidth | Integer | 5 |
The exclusive public bandwidth of the IPv6 address. Unit: Mbit/s. |
BusinessStatus | String | Normal |
The status of the public bandwidth of the IPv6 address. Valid values:
|
InstanceChargeType | String | PostPaid |
The billing method of the public bandwidth of the IPv6 address. Valid values: PostPaid: pay-as-you-go |
InternetChargeType | String | PayByTraffic |
The billing method of the public bandwidth of the IPv6 address. Valid values:
|
Ipv6InternetBandwidthId | String | ipv6bw-hp3b35oq1fj50kbv**** |
The instance ID of the public bandwidth of the IPv6 address. |
Ipv6Isp | String | BGP |
The service provider of the IPv6 address:
|
NetworkType | String | Private |
The type of communication supported by the IPv6 address. Valid values:
|
RealBandwidth | Integer | 5 |
The peak bandwidth value of the IPv6 address. Valid value:
|
Status | String | Available |
The status of the IPv6 address. Valid values:
|
VSwitchId | String | vsw-25navfgbue4g**** |
The ID of the vSwitch to which the IPv6 address belongs. |
VpcId | String | vpc-bp15zckdt37pq72zv**** |
The ID of the VPC to which the IPv6 address belongs. |
PageNumber | Integer | 1 |
The number of the page returned. Default value: 1. |
PageSize | Integer | 10 |
The number of entries returned on each page. Maximum value: 50. Default value: 10. |
RequestId | String | AA4486A8-B6AE-469E-AB09-820EF8ECFA2B |
The ID of the request. |
TotalCount | Integer | 2 |
The number of returned entries. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeIpv6Addresses
&RegionId=cn-huhehaote
&<Common request parameters>
Sample success responses
XML
format
<DescribeIpv6AddressesResponse>
<TotalCount>2</TotalCount>
<PageSize>10</PageSize>
<RequestId>AA4486A8-B6AE-469E-AB09-820EF8ECFA2B</RequestId>
<PageNumber>1</PageNumber>
<Ipv6Addresses>
<Ipv6Address>
<AllocationTime>2020-12-20T14:56:09Z</AllocationTime>
<Status>Available</Status>
<Ipv6Isp>BGP</Ipv6Isp>
<AssociatedInstanceId>i-2ze72wuqj4y3jl4f****</AssociatedInstanceId>
<VpcId>vpc-bp15zckdt37pq72zv****</VpcId>
<NetworkType>Private</NetworkType>
<VSwitchId>vsw-25navfgbue4g****</VSwitchId>
<Ipv6AddressId>ipv6-2zen5j4axcp5l5qyy****</Ipv6AddressId>
<Ipv6GatewayId>ipv6gw-2zewg0l66s73b4k2q****</Ipv6GatewayId>
<RealBandwidth>5</RealBandwidth>
<AssociatedInstanceType>EcsInstance</AssociatedInstanceType>
<Ipv6Address>2408:XXXX:153:3921:851c:c435:7b12:1c5f</Ipv6Address>
<Ipv6AddressName>test</Ipv6AddressName>
<Ipv6InternetBandwidth>
<InstanceChargeType>PostPaid</InstanceChargeType>
<Bandwidth>5</Bandwidth>
<Ipv6InternetBandwidthId>ipv6bw-hp3b35oq1fj50kbv****</Ipv6InternetBandwidthId>
<BusinessStatus>Normal</BusinessStatus>
<InternetChargeType>PayByTraffic</InternetChargeType>
</Ipv6InternetBandwidth>
</Ipv6Address>
</Ipv6Addresses>
</DescribeIpv6AddressesResponse>
JSON
format
{
"TotalCount": 2,
"PageSize": 10,
"RequestId": "AA4486A8-B6AE-469E-AB09-820EF8ECFA2B",
"PageNumber": 1,
"Ipv6Addresses": {
"Ipv6Address": {
"AllocationTime": "2020-12-20T14:56:09Z",
"Status": "Available",
"Ipv6Isp": "BGP",
"AssociatedInstanceId": "i-2ze72wuqj4y3jl4f****",
"VpcId": "vpc-bp15zckdt37pq72zv****",
"NetworkType": "Private",
"VSwitchId": "vsw-25navfgbue4g****",
"Ipv6AddressId": "ipv6-2zen5j4axcp5l5qyy****",
"Ipv6GatewayId": "ipv6gw-2zewg0l66s73b4k2q****",
"RealBandwidth": 5,
"AssociatedInstanceType": "EcsInstance",
"Ipv6Address": "2408:XXXX:153:3921:851c:c435:7b12:1c5f",
"Ipv6AddressName": "test",
"Ipv6InternetBandwidth": {
"InstanceChargeType": "PostPaid",
"Bandwidth": 5,
"Ipv6InternetBandwidthId": "ipv6bw-hp3b35oq1fj50kbv****",
"BusinessStatus": "Normal",
"InternetChargeType": "PayByTraffic"
}
}
}
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | The error message returned because the specified region ID does not exist. |
For a list of error codes, visit the API Error Center.