vpc · 2017-03-12

DescribeAddresses

POST

Query the information of one or multiple Elastic IPs.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /vpc/DescribeAddresses path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl

curl -sS https://vpc.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/vpc/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: vpc.api3.convergecloud.com' \
  -H 'X-TC-Action: DescribeAddresses' \
  -H 'X-TC-Version: 2017-03-12' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"Offset":0,"Limit":20}'

Request parameters

Field	Type	Required	Description
AddressIds	string[]	—	List of unique IDs for identifying Elastic IP (EIP). The EIP unique ID is in the format of `eip-11112222`. You can use the DescribeAddresses API to obtain the AddressId. The parameters `AddressIds` and `Filters.address-id` cannot be specified simultaneously.
Filters	Filter[]	—	The maximum number of `Filters` per request is 10, and the maximum number of `Filter.Values` per request is 100. The detailed filter conditions are as follows:
Offset	integer	—	The Offset. The default value is 0. For more information on Offset, see the relevant section in the API Introduction.
Limit	integer	—	Number of returned results. Default value: 20. Maximum value: 100. For more information on Limit, see the relevant section in the API Introduction.

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

Field	Type	Description
TotalCount	integer	Number of EIPs meeting the condition.
AddressSet	Address[]	List of EIPs details.
RequestId	string	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Success

{
  "Response": {
    "TotalCount": …,
    "AddressSet": …,
    "RequestId": "…"
  }
}

Error

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/vpc.

SecretIdSecretKey

Request bodyvalid JSONPOST vpc.api3.convergecloud.com · DescribeAddresses

{
  "Offset": 0,
  "Limit": 20
}

Read-only. Creates nothing.

Recorded example response — captured 2026-09-17

{
  "Response": {
    "TotalCount": 1,
    "AddressSet": [
      {
        "AddressId": "eip-g6vsqjt0",
        "AddressName": "nat-eip-0a1b2c3d",
        "AddressIp": "203.0.113.240",
        "AddressStatus": "UNBIND",
        "AddressType": "EIP",
        "InstanceId": null,
        "NetworkInterfaceId": null,
        "PrivateAddressIp": null,
        "IsArrears": false,
        "IsBlocked": false,
        "IsEipDirectConnection": false,
        "EipAlgType": {
          "Ftp": true,
          "Sip": true
        },
        "LocalBgp": false,
        "CascadeRelease": false,
        "ApplicableForCLB": false,
        "IsFromWanIP": false,
        "IsNewGeneration": false,
        "IsActiveAccessEip": false,
        "CreatedTime": "2026-09-11T12:45:02Z",
        "TagSet": [],
        "NetworkGroup": "luzon",
        "Zone": null,
        "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
        "Bandwidth": 100,
        "UpdatedTime": "2026-09-11T12:45:03Z",
        "PayMode": "TRAFFIC_POSTPAID_BY_HOUR",
        "DeadlineDate": null,
        "IsEip": true,
        "InternetServiceProvider": "BGP"
      }
    ],
    "RequestId": "bf4c3394-7806-6265-7fb2-6feffaf1e304"
  }
}

Behaviour

Unknown or released address ids return an empty set rather than an error. AddressStatus values include UNBIND, BIND and BIND_ENI.