Tenant Cloud Network Virtual Private Cloud Elastic IP APIs DescribeAddresses

DescribeAddresses

Last Updated At: 2026-08-02 00:06:17

1. Interface Description

Interface request domain name: vpc.api3.convergecloud.com.

This API (DescribeAddresses) is used to query the details of one or more EIPs.

  • If the parameter is null, it returns a certain number (as specified by Limit, 20 by default) of EIPs for the current user.

Default interface request rate limit: 10 times per second.

Interface update time: 2023-01-07 03:39:59.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeAddresses
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
AddressIds No No Array of String A list of unique IDs identifying the EIPs. Each EIP unique ID is in the format eip-jrkzpvgt. The parameters AddressIds and Filters cannot be specified simultaneously.
Example: eip-jrkzpvgt
Filters No No Array of Filter Each request can include up to 10 Filters, with a maximum of 5 values for each Filter.Values. The parameters AddressIds and Filters cannot be specified simultaneously. Detailed filtering conditions are as follows:
  •  address-id - String - required or not: no - (filtering condition) filters by the unique ID of the EIP. The EIP unique ID is in the format eip-jrkzpvgt.
  •  dedicated-cluster-id - String - required or not: no - (filtering condition) filters by the unique ID of the CDC. The CDC unique ID is in the format cluster-jrkzpvgt.
  •  address-name - String - required or not: no - (filtering condition) filters by the name of the EIP. Fuzzy filtering is not supported.
  •  address-ip - String - required or not: no - (filtering condition) filters by the IP address of the EIP.
  •  address-status - String - required or not: no - (filtering condition) filters by the status of the EIP. Possible statuses include 'CREATING', 'BINDING', 'BIND', 'UNBINDING', 'UNBIND', 'OFFLINING', and 'BIND_ENI'.
  •  instance-id - String - required or not: no - (filtering condition) filters by the instance ID bound to the EIP. The instance ID is in the format ins-jrkzpvgt.
  •  private-ip-address - String - required or not: no - (filtering condition) filters by the private IP address bound to the EIP.
  •  network-interface-id - String - required or not: no - (filtering condition) filters by the ENI ID bound to the EIP. The ENI ID is in the format eni-jrkzpvgt.
  •  is-arrears - String - required or not: no - (filtering condition) filters by whether the EIP is in arrears. (TRUE: The EIP is in arrears 
    		•
    Offset No No Int64 The offset, with a default value of 0. For more details about Offset, see the relevant section in the API introduction.
    Example: 0
    Limit No No Int64 The number of returned results, with a default value of 20 and a maximum value of 100. For more details about Limit, see the relevant section in the API Overview.
    Example: 20
    ContainsCdc No No Array of String Whether the query results should include EIP information within the CDC. ALL: Include all EIPs. NO_CDC: Exclude EIPs within the CDC. ONLY_CDC: Include only EIPs within the CDC.
    Example: ALL

    3. Output Parameters

    Parameter name Type Description
    TotalCount Int64 Number of eligible EIPs.
    Example:
    AddressSet Array of Address EIP detail list.
    Example:View
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidParameter Invalid input parameters.