tencent cloud



最后更新时间:2022-06-28 17:00:19

    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.

    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: DescribeAddresses.
    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.
    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 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"

    Example2 Querying public IPs

    Input Example

    &<Common request parameters>

    Output Example

    "Response": {
      "TotalCount": 1,
      "AddressSet": [
          "AddressId": "eip-7fid2cge",
          "AddressName": null,
          "AddressIp": "",
          "AddressStatus": "BIND",
          "AddressType": "WanIP",
          "InstanceId": "ins-ywxt3tlk",
          "NetworkInterfaceId": "eni-hrw4cw93",
          "PrivateAddressIp": "",
          "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


    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.
    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.
    UnsupportedOperation Unsupported operation.




    7x24 电话支持