tencent cloud

All product documents
APIs
DocumentationAPIsVirtual Private CloudElastic IPv6 APIsDescribeIPv6Addresses
DescribeIPv6Addresses
Last updated: 2025-02-18 10:40:31
DescribeIPv6Addresses
Last updated: 2025-02-18 10:40:31

1. API Description

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

This API is used to query detailed information of one or more EIPv6 instances.

  • You can query EIPv6 and traditional EIPv6 instance information in a specified region.
  • The system returns a certain number (as specified by the Limit, the default value is 20) of EIPv6 instances of the current user if the parameter is empty.

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: DescribeIPv6Addresses.
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.
IPv6AddressIds.N No Array of String Unique ID column identifying IPv6.

- Unique ID of the traditional EIPv6, such as eip-11112222
- Unique ID of the EIPv6, such as eipv6-11112222

Note: IPv6AddressIds and Filters cannot be specified at the same time.
Filters.N No Array of Filter Each request can have up to 10 Filters and 100 Filter.Values. IPv6AddressIds and Filters cannot be specified at the same time. The detailed filter conditions are as follows:

- address-id - String - Required: No - (Filter condition) Filter by the unique ID of the EIPv6.
- public-ipv6-address - String - Required: No - (Filter condition) Filter by the public IPv6 address.
- network-interface-id - String - Required: No - (Filter condition) Filter by the unique ID of the ENI.
- instance-id - String - Required: No - (Filter condition) Filter by the unique ID of the bound instance.
- charge-type - String - Required: No - (Filter condition) Filter by the billing type.
- private-ipv6-address - String - Required: No - (Filter condition) Filter by the bound private IPv6 address.
- egress - String - Required: No - (Filter condition) Filter by the egress.
- address-type - String - Required: No - (Filter condition) Filter by the IPv6 type. Valid values: 'EIP6', 'EIPv6', 'WanIPv6', and 'HighQualityEIPv6'. Default: 'EIPv6'.
- address-isp - String - Required: No - (Filter condition) Filter by the ISP type. Valid values: 'BGP', 'CMCC', 'CUCC', and 'CTCC'.
- address-status - String - Required: No - (Filter condition) Filter by the EIP status. Valid values: 'CREATING', 'BINDING', 'BIND', 'UNBINDING', 'UNBIND', 'OFFLINING', 'BIND_ENI', and 'PRIVATE'.
- address-name - String - Required: No - (Filter condition) Filter by the EIP name. Fuzzy filtering is not supported.
- tag-key - String - Required: No - (Filter condition) Filter by the tag key.
- tag-value - String - Required: No - (Filter condition) Filter by the tag value.
- tag:tag-key - String - Required: No - (Filter condition) Filter by the tag-key - value pair. Replace tag-key with a specific tag key.
Traditional No Boolean Indicates whether to query the traditional IPv6 address information.
Offset No Integer Offset. Default: 0. For more information on Offset, see the relevant section in the API Overview.
Limit No Integer Number of returned results. Default: 20. Maximum: 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 Querying the IPv6 Information Based on IPv6AddressIds

This example shows you how to query the IPv6 information based on IPv6AddressIds.

Input Example

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

{
    "IPv6AddressIds": [
        "eipv6-11112222"
    ]
}

Output Example

{
    "Response": {
        "TotalCount": 0,
        "AddressSet": [
            {
                "AddressId": "eipv6-11112222",
                "AddressName": "abc",
                "AddressStatus": "abc",
                "AddressIp": "abc",
                "InstanceId": "abc",
                "CreatedTime": "2020-09-22T00:00:00+00:00",
                "NetworkInterfaceId": "abc",
                "PrivateAddressIp": "abc",
                "IsArrears": true,
                "IsBlocked": true,
                "IsEipDirectConnection": true,
                "AddressType": "abc",
                "CascadeRelease": true,
                "EipAlgType": {
                    "Ftp": true,
                    "Sip": true
                },
                "InternetServiceProvider": "abc",
                "LocalBgp": true,
                "Bandwidth": 1,
                "InternetChargeType": "abc",
                "TagSet": [
                    {
                        "Key": "abc",
                        "Value": "abc"
                    }
                ],
                "DeadlineDate": "2020-09-22",
                "InstanceType": "abc",
                "Egress": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

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
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.LimitExceeded The parameter value exceeds the limit.
InvalidParameterValue.Malformed Invalid input parameter format.
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