Last updated: 2020-12-07 11:21:58

    1. API Description

    Domain name for API request:

    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 10 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:

    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, such as eip-11112222. AddressIds and Filters cannot be specified at the same time.
    Filters.N No Array of Filter The upper limit for Filters in each request is 10 and 5 for Filter.Values. AddressIds and Filters cannot be specified at the same time. Detailed filter conditions are as follows:
  • address-id - String - Required: no - (Filter condition) The unique EIP ID, such as eip-11112222.
  • address-name - String - Required: no - (Filter condition) The EIP name. Fuzzy filtering is not supported.
  • address-ip - String - Required: no - (Filter condition) Filters by EIP.
  • address-status - String - Required: no - (Filter condition) The EIP state. Possible EIP states are: 'CREATING', 'BINDING', 'BIND', 'UNBINDING', 'UNBIND', 'OFFLINING', and 'BIND_ENI'.
  • instance-id - String - Required: no - (Filter condition) The ID of the instance bound to the EIP, such as ins-11112222.
  • private-ip-address - String - Required: no - (Filter condition) The private IP address bound to the EIP.
  • network-interface-id - String - Required: no - (Filter condition) The ID of the ENI bound to the EIP, such as eni-11112222.
  • is-arrears - String - Required: no - (Filter condition) Whether the EIP is in arrears. (TRUE: the EIP is in arrears | FALSE: the billing status of the EIP is normal)
  • Offset No Integer The Offset. The default value is 0.
    Limit No Integer Number of returned results. The default value is 20. The maximum is 100.

    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
    &<Common request parameters>

    Output Example

      "Response": {
        "TotalCount": 1,
        "AddressSet": [
            "AddressId": "eip-hxlqja90",
            "AddressName": "test",
            "AddressIp": "",
            "AddressStatus": "BINDED",
            "InstanceId": "ins-m2j0thu6",
            "NetworkInterfaceId": null,
            "PrivateAddressIp": null,
            "IsArrears": false,
            "IsBlocked": false,
            "CreatedTime": "2017-09-12T07:52:00Z"
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"

    5. Developer Resources


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

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback