1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API (DescribeVpcIpv6Addresses) is used to query VPC IPv6 information.
Only used IPv6 addresses can be queried. When an unused IP is queried, this API does not report an error, but it does not appear in the return result.
Default interface request rate limit: 20 times per second.
Interface update time: 2019-03-13 02:10:08.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DescribeVpcIpv6Addresses |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| VpcId | Yes | No | String | VPC instance ID, e.g., vpc-f49l6u0z. Example: vpc-rkxd3pgh |
| Ipv6Addresses | No | No | Array of String | IP address list. Batch query supports up to 10 items in a single request. Example: ["2402:4e00:1015:4a00::/56"] |
| Offset | No | No | Uint64 | Offset. Example: 0 |
| Limit | No | No | Uint64 | Returned quantity. Example: 20 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| Ipv6AddressSet | Array of VpcIpv6Address | IPv6 address list. Example:View |
| TotalCount | Uint64 | Total number of IPv6 addresses. Example: 6 |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
There is no error code related to business logic for this interface, For other error codes, see public ErrorCode.