DescribeAddresses

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: DescribeAddresses.
Version	Yes	String	Common parameter. The value used for this API: 2017-03-12.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
AddressIds.N	No	Array of String	The list of unique IDs of EIPs in the format of `eip-11112222`. `AddressIds` and `Filters.address-id` 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`. Detailed filter conditions: address-id - String - Optional - Filter by unique EIP ID, such as `eip-11112222`. address-name - String - Optional - Filter by EIP name. Fuzzy filtering is not supported. address-ip - String - Optional - Filter by EIP address. address-status - String - Optional - Filter by EIP status. Valid values: `CREATING`, `BINDING`, `BIND`, `UNBINDING`, `UNBIND`, `OFFLINING`, and `BIND_ENI`. instance-id - String - Optional - Filter by the ID of the instance bound to the EIP, such as `ins-11112222`. private-ip-address - String - Optional - Filter by the private IP address bound to the EIP. network-interface-id - String - Optional - Filter by ID of the ENI bound to the EIP, such as `eni-11112222`. is-arrears - String - Optional - Filter by the fact whether the EIP is overdue (TRUE: the EIP is overdue
Offset	No	Integer	The Offset. The default value is 0. For more information on `Offset`, see the relevant sections in API Overview.
Limit	No	Integer	Number of returned results. The default value is 20. The maximum is 100. For more information on `Limit`, see the relevant sections in API Overview.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Number of EIPs meeting the condition.
AddressSet	Array of Address	List of EIPs details.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying EIPs

Input Example

https://vpc.tencentcloudapi.com/?Action=DescribeAddresses
&AddressIds.0=eip-hxlqja90
&<Common request parameters>

Output Example

{
"Response": {
  "TotalCount": 2,
  "AddressSet": [
    {
      "AddressId": "eip-76w7384s",
      "AddressName": null,
      "AddressIp": "106.55.251.58",
      "AddressStatus": "UNBIND",
      "AddressType": "EIP",
      "InstanceId": null,
      "NetworkInterfaceId": null,
      "PrivateAddressIp": null,
      "IsArrears": false,
      "IsBlocked": false,
      "IsEipDirectConnection": false,
      "EipAlgType": {
        "Ftp": false,
        "Sip": false
      },
      "LocalBgp": false,
      "CascadeRelease": false,
      "CreatedTime": "2020-10-20T08:19:31Z",
      "InternetChargeType": "BANDWIDTH_PACKAGE",
      "Bandwidth": 65535,
      "InternetServiceProvider": "BGP",
      "TagSet": [
        {
          "Key": "tag1",
          "Value": "value1"
        }
      ]
    },
    {
      "AddressId": "eip-lshmvwlc",
      "AddressName": null,
      "AddressIp": "81.71.146.150",
      "AddressStatus": "UNBIND",
      "AddressType": "EIP",
      "InstanceId": null,
      "NetworkInterfaceId": null,
      "PrivateAddressIp": null,
      "IsArrears": false,
      "IsBlocked": false,
      "IsEipDirectConnection": false,
      "EipAlgType": {
        "Ftp": false,
        "Sip": false
      },
      "LocalBgp": false,
      "CascadeRelease": false,
      "CreatedTime": "2020-10-20T08:19:29Z",
      "InternetChargeType": "BANDWIDTH_PACKAGE",
      "Bandwidth": 65535,
      "InternetServiceProvider": "BGP",
      "TagSet": [
        {
          "Key": "tag2",
          "Value": "value2"
        }
      ]
    }
  ],
  "RequestId": "42bc5893-70ff-4f13-bcc3-1308dedab8f6"
}
}

Example2 Querying public IPs

Input Example

https://vpc.tencentcloudapi.com/?Action=DescribeAddresses
&Filters.0.Name=address-type
&Filters.0.Values.0=WanIP
&<Common request parameters>

Output Example

{
"Response": {
  "TotalCount": 1,
  "AddressSet": [
    {
      "AddressId": "eip-7fid2cge",
      "AddressName": null,
      "AddressIp": "43.132.1.131",
      "AddressStatus": "BIND",
      "AddressType": "WanIP",
      "InstanceId": "ins-ywxt3tlk",
      "NetworkInterfaceId": "eni-hrw4cw93",
      "PrivateAddressIp": "172.16.0.103",
      "IsArrears": false,
      "IsBlocked": false,
      "IsEipDirectConnection": false,
      "EipAlgType": {
        "Ftp": true,
        "Sip": true
      },
      "LocalBgp": false,
      "CascadeRelease": false,
      "CreatedTime": "2021-07-30T07:15:47Z",
      "TagSet": [],
      "InternetChargeType": "BANDWIDTH_POSTPAID_BY_HOUR",
      "Bandwidth": 10,
      "InternetServiceProvider": "BGP"
    }
  ],
  "RequestId": "2f73635c-6d4d-4f83-8cc5-48d952fbe04b"
}
}

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

Tencent Cloud CLI 3.0

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
InvalidParameter	A parameter error occurred.
InvalidParameter.InvalidFilter	The filter rule is invalid.
InvalidParameterValue.AddressIdMalformed	This IP address ID is invalid.
InvalidParameterValue.LimitExceeded	The parameter value exceeds the limit.
LimitExceeded.NumberOfFilters	Exceeded the character limit of a filter name.

Contact Us

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

Technical Support

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

7x24 Phone Support

tencent cloud

Tencent Cloud Partner Network

Become a Partner

International Partner Academy

Recent Pages