Tenant Cloud Network Virtual Private Cloud Elastic IPv6 APIs DescribeIp6Addresses

DescribeIp6Addresses

Last Updated At: 2026-08-02 00:06:18

1. Interface Description

Interface request domain name: vpc.api3.convergecloud.com.

This API is used to query the IPv6 address information.

Default interface request rate limit: 20 times per second.

Interface update time: 2020-04-03 07:43:27.

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: DescribeIp6Addresses
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
Ip6AddressIds No No Array of String A list of unique IDs identifying IPv6. Each IPv6 unique ID is in the format eip-jrkzpvgt. The parameters Ip6AddressIds and Filters cannot be specified simultaneously.
Example: eip-37xao8t
Filters No No Array of Filter For each request, the upper limit is 10 for Filters and 5 for Filter.Values. Parameters AddressIds and Filters cannot be specified at the same time. Detailed filtering conditions are as follows:
  •  address-ip - String - Required: No - (Filtering condition) Filter by EIP.
  •  network-interface-id - String - Required: No - (Filtering condition) Filter by unique ENI ID.
  •  bind-resource-type - String - Required: No - (Filtering condition) Filter by bound resource type. BIND_BMS: bound to the IPv6 address of a BMS instance; BIND_INSTANCE_OR_EIP: bound to the IPv6 address of a CVM instance or an ENI.

    • Example:View
    Offset No No Int64 The offset, with a default value of 0. For more details about Offset, see the relevant section in the API introduction.
    Example: 10
    Limit No No Int64 The number of returned results, with a default value of 20 and a maximum value of 100. For more details about Limit, see the relevant section in the API Overview.
    Example: 10

    3. Output Parameters

    Parameter name Type Description
    TotalCount Int64 Number of eligible IPv6.
    Example:
    AddressSet Array of Address IPv6 details list.
    Example:View
    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

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidParameterValue The parameter value is invalid.
    InvalidParameter Invalid input parameters.
    InvalidParameterValue.Malformed Invalid input format.
    InvalidParameter.Coexist The parameters must not be specified simultaneously.
    InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
    InternalServerError Internal operation error.
    InvalidAddressId.NotFound The specified EIP does not exist.