1. API Description
Domain name for API request: vpc.intl.tencentcloudapi.com.
This API (DescribeVpcIpv6Addresses) is used to query VPC IPv6 information.
This API is used to query only the information of IPv6 addresses that are already in use. When querying IPs that have not yet been used, this API will not report an error, but the IPs will not appear in the returned results.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name |
Required |
Type |
Description |
| Action |
Yes |
String |
Common Params. The value used for this API: DescribeVpcIpv6Addresses. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2017-03-12. |
| Region |
Yes |
String |
Common Params. For more information, please see the list of regions supported by the product. |
| VpcId |
Yes |
String |
The ID of the VPC, such as vpc-f49l6u0z. |
| Ipv6Addresses.N |
No |
Array of String |
The IP address list. Each request supports a maximum of 10 batch querying. |
| Offset |
No |
Integer |
Offset. |
| Limit |
No |
Integer |
The returned quantity. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| Ipv6AddressSet |
Array of VpcIpv6Address |
The IPv6 address list. |
| TotalCount |
Integer |
The total number of IPv6 addresses. |
| RequestId |
String |
The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Querying the IPv6 address list of a VPC
https:
&VpcId=vpc-rkxd3pgh
&<Common request parameters>
Output Example
{
"Response": {
"Ipv6AddressSet": [
{
"Ipv6Address": "2402:4e00:1000:101:0:8d1a:6c7b:c0e8",
"Ipv6AddressType": "CVM",
"CidrBlock": "2402:4e00:1000:101::/64",
"CreatedTime": "2019-03-01 21:18:07"
},
{
"Ipv6Address": "2402:4e00:1000:101:0:8d20:3e2:683",
"Ipv6AddressType": "CVM",
"CidrBlock": "2402:4e00:1000:101::/64",
"CreatedTime": "2019-03-04 16:00:36"
},
{
"Ipv6Address": "2402:4e00:1000:101:0:8d20:3f5:8b0f",
"Ipv6AddressType": "CVM",
"CidrBlock": "2402:4e00:1000:101::/64",
"CreatedTime": "2019-03-04 16:00:48"
},
{
"Ipv6Address": "2402:4e00:1000:101:0:8d24:30a5:d9f3",
"Ipv6AddressType": "CVM",
"CidrBlock": "2402:4e00:1000:101::/64",
"CreatedTime": "2019-03-06 17:49:05"
},
{
"Ipv6Address": "2402:4e00:1000:101:0:8d2e:133c:e12c",
"Ipv6AddressType": "CVM",
"CidrBlock": "2402:4e00:1000:101::/64",
"CreatedTime": "2019-03-11 15:45:07"
},
{
"Ipv6Address": "2402:4e00:1000:108:0:8d24:690c:59c6",
"Ipv6AddressType": "CVM",
"CidrBlock": "2402:4e00:1000:108::/64",
"CreatedTime": "2019-03-06 20:26:47"
}
],
"TotalCount": 6,
"RequestId": "ee464fec-e13e-401b-87f0-f93f047550c2"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code |
Description |
| InvalidParameterValue.Malformed |
Invalid input parameter format. |
| InvalidParameterValue.Range |
The parameter value is not in the specified range. |
| ResourceNotFound |
The resource does not exist. |