tencent cloud

All product documents
APIs
DocumentationAPIsVirtual Private CloudElastic IPv6 APIsDescribeIp6Addresses
DescribeIp6Addresses
Last updated: 2025-02-18 10:40:30
DescribeIp6Addresses
Last updated: 2025-02-18 10:40:30

1. API Description

Domain name for API request: vpc.intl.tencentcloudapi.com.

This API is used to query the detailed information on one or multiple classic elastic public IPv6 instances.

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.

2. Input Parameters

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: DescribeIp6Addresses.
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.
Ip6AddressIds.N No Array of String List of unique IDs that identify IPv6 instances. The unique ID of an IPv6 instance is in the format of eip-11112222. Parameters Ip6AddressIds and Filters cannot be specified at the same time.
Filters.N No Array of Filter Each request can have up to 10 Filters values and 100 Filter.Values values. Parameters AddressIds and Filters cannot be specified at the same time. The specific filter conditions are as follows:
  • address-ip - String - Required: No - (Filter condition) Filter by the IP address of IPv6 instances.
  • network-interface-id - String - Required: No - (Filter condition) Filter by the unique ID of ENIs.
    		•
    Offset No Integer Offset. Default value: 0. For more information on Offset, see the relevant section in the API overview.
    Limit No Integer Number of returned results. Default value: 20. Maximum value: 100. For more information on Limit, see the relevant section in the API overview.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of IPv6 meeting conditions.
    AddressSet Array of Address IPv6 detailed information list.
    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 Query IPv6 information based on the filter

    Query IPv6 information based on the filter

    Input Example

    POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIp6Addresses
<Common request parameters>

{
    "Filters": [
        {
            "Values": [
                "2402:4e00:1000:2d00:0:8f3f:6:9895"
            ],
            "Name": "address-ip"
        }
    ]
}

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "AddressSet": [
            {
                "AddressId": "eip-lrhy2lpe",
                "AddressName": "demo",
                "AddressStatus": "BIND",
                "AddressIp": "2402:4e00:1000:2d00:0:8f3f:6:9895",
                "InstanceId": "ins-0cu6wix4",
                "CreatedTime": "2020-09-22T00:00:00+00:00",
                "NetworkInterfaceId": "eni-85sohtb7",
                "PrivateAddressIp": "2402:4e00:1000:2d00:0:8f3f:6:9895",
                "IsArrears": true,
                "IsBlocked": true,
                "IsEipDirectConnection": true,
                "AddressType": "EIP6",
                "CascadeRelease": true,
                "EipAlgType": {
                    "Ftp": true,
                    "Sip": true
                },
                "InternetServiceProvider": "BGP",
                "LocalBgp": true,
                "Bandwidth": 1,
                "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
                "TagSet": [
                    {
                        "Key": "role",
                        "Value": "developer"
                    }
                ],
                "DeadlineDate": "2020-09-22",
                "InstanceType": "CVM",
                "Egress": "center_egress1"
            }
        ],
        "RequestId": "64b212c4-d541-44c3-80ff-1131967a77c5"
    }
}

    Example2 Query IPv6 information based on Ip6AddressIds

    Query IPv6 information based on Ip6AddressIds

    Input Example

    POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIp6Addresses
<Common request parameters>

{
    "Ip6AddressIds": [
        "eip-lrhy2lpe"
    ]
}

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "AddressSet": [
            {
                "AddressId": "eip-lrhy2lpe",
                "AddressName": "demo",
                "AddressStatus": "BIND",
                "AddressIp": "2402:4e00:1000:2d00:0:8f3f:6:9895",
                "InstanceId": "ins-0cu6wix4",
                "CreatedTime": "2020-09-22T00:00:00+00:00",
                "NetworkInterfaceId": "eni-85sohtb7",
                "PrivateAddressIp": "2402:4e00:1000:2d00:0:8f3f:6:9895",
                "IsArrears": true,
                "IsBlocked": true,
                "IsEipDirectConnection": true,
                "AddressType": "EIP6",
                "CascadeRelease": true,
                "EipAlgType": {
                    "Ftp": true,
                    "Sip": true
                },
                "InternetServiceProvider": "BGP",
                "LocalBgp": true,
                "Bandwidth": 1,
                "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
                "TagSet": [
                    {
                        "Key": "role",
                        "Value": "developer"
                    }
                ],
                "DeadlineDate": "2020-09-22",
                "InstanceType": "CVM",
                "Egress": "center_egress1"
            }
        ],
        "RequestId": "64b212c4-d541-44c3-80ff-1131967a77c5"
    }
}

    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
    InternalServerError Internal error.
    InvalidAddressId.NotFound The specified EIP does not exist.
    InvalidParameter A parameter error occurred.
    InvalidParameter.Coexist The parameters cannot be specified at the same time.
    InvalidParameter.InvalidFilter The filter rule is invalid.
    InvalidParameterValue The parameter value is invalid.
    InvalidParameterValue.AddressIpNotPublic This IPv6 address is not published.
    InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
    InvalidParameterValue.Malformed Invalid input parameter format.
    InvalidParameterValue.NetworkInterfaceIdMalformed Incorrect network interface ID.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback

    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Hong Kong, China
    +852 800 906 020 (Toll Free)
    United States
    +1 844 606 0804 (Toll Free)
    United Kingdom
    +44 808 196 4551 (Toll Free)
    Canada
    +1 888 605 7930 (Toll Free)
    Australia
    +61 1300 986 386 (Toll Free)
    EdgeOne hotline
    +852 300 80699
    More local hotlines coming soon