DescribeAddresses

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-09-30 18:04:08

Download PDF

1. API Description

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

This API (DescribeAddresses) is used to query the information of one or multiple Elastic IPs.

If the parameter is empty, a number (as specified by the Limit, the default value is 20) of EIPs will be returned.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

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 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 5 `Filter.Values`. `AddressIds` and `Filters` cannot be specified at the same time. The specific filter conditions are as follows: address-id - String - Required: No - (Filter condition) Filter by the unique EIP ID, such as `eip-11112222`. address-name - String - Required: No - (Filter condition) Filter by the EIP name. Fuzzy filtering is not supported. address-ip - String - Required: No - (Filter condition) Filter by EIP. address-status - String - Required: No - (Filter condition) Filter by the EIP state. Valid values: `CREATING`, `BINDING`, `BIND`, `UNBINDING`, `UNBIND`, `OFFLINING`, and `BIND_ENI`. instance-id - String - Required: No - (Filter condition) Filter by the ID of the instance bound to the EIP, such as `ins-11112222`. private-ip-address - String - Required: No - (Filter condition) Filter by the private IP address bound to the EIP. network-interface-id - String - Required: No - (Filter condition) Filter by ID of the ENI bound to the EIP, such as `eni-11112222`. is-arrears - String - Required: No - (Filter condition) 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 using AddressIds

Input Example

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

Output Example

{
"Response": {
  "TotalCount": 385,
  "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"
    },
    {
      "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"
    }
  ],
  "RequestId": "42bc5893-70ff-4f13-bcc3-1308dedab8f6"
}
}

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

Recent Pages