Domain name for API request: edgezone.intl.tencentcloudapi.com.
Query the public network Ip information of the user. For public network instances with routing mode set to Static, return all applied public network Ip information. For public network instances with routing mode set to Ospf and Bgp, return Ip range information directly.
A maximum of 20 requests can be initiated per second for this API.
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: DescribePublicIps. |
| Version | Yes | String | Common Params. The value used for this API: 2026-04-01. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| NetworkInstanceId.N | No | Array of String | Filter by public network instance ID (substring match, union of multiple values) |
| ZoneId | No | String | Filter by availability zone/IDC |
| Ip.N | No | Array of String | Filter by IP (substring match, union of multiple values) |
| State.N | No | Array of String | Filter by status, available values: InUse, Unbound (multiple values are combined with OR) |
| Type.N | No | Array of String | Filter by IP version. Available values: Ipv4, Ipv6 (multiple values are combined). |
| OrderByCreateTime | No | String | Sort by creation time, available values: asc, desc (default desc) |
| OrderByUpdateTime | No | String | Sort by update time, available values: asc, desc (priority is higher than sort by creation time) |
| Offset | No | Integer | Pagination offset, default 0 |
| Limit | No | Integer | Number of items per page. Default 20. Maximum 100. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of EIPs |
| IpInfoSet | Array of IpInfo | Assigned public network IP address list |
| 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. |
POST / HTTP/1.1
Host: edgezone.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePublicIps
<Common request parameters>
{
"ZoneId": "ap-beijing",
"State": [
"InUse"
],
"Type": [
"Ipv4"
],
"Offset": 0,
"Limit": 20
}
{
"Response": {
"RequestId": "test-req-028",
"TotalCount": 2,
"IpInfoSet": [
{
"Ip": "10.0.0.200",
"NetworkInstanceId": "epn-xxxxxxxx",
"InstanceId": "ins-001",
"State": "InUse",
"Type": "Ipv4",
"CreatedAt": "2026-04-07T00:00:00",
"UpdatedAt": "2026-04-07T00:00:00"
},
{
"Ip": "10.0.0.201",
"NetworkInstanceId": "epn-xxxxxxxx",
"InstanceId": "",
"State": "Unbound",
"Type": "Ipv4",
"CreatedAt": "2026-04-07T00:00:00",
"UpdatedAt": "2026-04-07T00:00:00"
}
]
}
}
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 |
|---|---|
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback