Tenant Cloud Network Virtual Private Cloud IPv6 Translation Service APIs DescribeIp6Translators

DescribeIp6Translators

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

1. Interface Description

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

  1. This API is used to query the IPv6 translation instances under the account and their bound translation rule information.
  2. Filter queries are supported.

Default interface request rate limit: 20 times per second.

Interface update time: 2019-01-24 23:59:19.

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: DescribeIp6Translators
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
Ip6TranslatorIds No No Array of String An array of unique IDs for IPv6 translation instances, such as ip6-37xao8t.
Example: ip6-demoag78
Filters No No Array of Filter The upper limit per request is 10 for Filters, and 5 for Filter.Values. Parameters Ip6TranslatorIds and Filters must not be specified simultaneously. Detailed filter criteria are as follows:
  •  ip6-translator-id - String - Required or Not: No - (Filter criteria) Filter by the unique ID of the IPv6 translation instance, e.g., ip6-xxxxxxx.
  •  ip6-translator-vip6 - String - Required or Not: No - (Filter criteria) Filter by IPv6 address. Fuzzy filtering is not supported.
  •  ip6-translator-name - String - Required or Not: No - (Filter criteria) Filter by the name of the IPv6 translation instance. Fuzzy filtering is not supported.
  •  ip6-translator-status - String - Required or Not: No - (Filter criteria) Filter by the status of the IPv6 translation instance. The status values are CREATING, RUNNING, DELETING, and MODIFYING.
    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: 0
    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: 1

    3. Output Parameters

    Parameter name Type Description
    TotalCount Int64 Number of IPv6 translation instances that meet the filtering criteria.
    Example:
    Ip6TranslatorSet Array of Ip6Translator Eligible IPv6 translation instance details
    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
    InvalidParameter Invalid input parameters.
    InternalServerError Internal operation error.