Domain name for API request: vpc.tencentcloudapi.com.
This API (DescribeAddresses) is used to query the information of one or multiple Elastic IPs.
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: vpc.ap-shanghai-fsi.tencentcloudapi.com
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:eip-11112222 .ins-11112222 .eni-11112222 . |
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. |
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. |
https://vpc.tencentcloudapi.com/?Action=DescribeAddresses
&AddressIds.0=eip-hxlqja90
&<Common request parameters>
{
"Response": {
"TotalCount": 1,
"AddressSet": [
{
"AddressId": "eip-hxlqja90",
"AddressName": "test",
"AddressIp": "123.121.34.33",
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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?