Domain name for API request: edgezone.intl.tencentcloudapi.com.
This API is used to query physical machine instance list, support by instance ID, instance name, availability zone, instance status with conditional filtering, and support paging query.
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: DescribeInstances. |
| 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. |
| InstanceIds.N | No | Array of String | Instance ID list for filtering by instance ID |
| InstanceName | No | String | Instance name, supports fuzzy matching |
| Zone | No | String | Availability zone code for filtering instances in the specified availability zone |
| InstanceStatus.N | No | Array of String | Instance status list for status filtering. Available values: allocating, running, isolating, isolated, terminating, error. |
| PublicIps.N | No | Array of String | Public IPv4 address list, used for filtering instances by public IP address |
| Offset | No | Integer | Offset. Default value: 0 |
| Limit | No | Integer | Number of returned results. Default 20. Maximum 100. |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceSet | Array of Instance | Instance detail list |
| TotalCount | Integer | Number of Eligible Instances |
| 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. |
Query running instances in Guangzhou Zone 1
POST / HTTP/1.1
Host: edgezone.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances
<Common request parameters>
{
"Zone": "ap-guangzhou-1",
"InstanceStatus": [
"running"
],
"Offset": 0,
"Limit": 20
}
{
"Response": {
"InstanceSet": [
{
"InstanceId": "bms-efgh5678",
"InstanceName": "web-server-01",
"MachineId": "srv-efgh5678",
"InstanceType": "BM.S5.LARGE8",
"Zone": "ap-guangzhou-1",
"ImageId": "img-ubuntu-20.04",
"VersionNumber": "20.04",
"InstanceStatus": "running",
"OperateStatus": "normal",
"PrivateNetworkId": "net-private-002",
"PrivateIp": "10.0.0.2",
"PrivateIpV6": "",
"PublicNetworkId": "net-public-002",
"PublicIp": "203.0.113.20",
"PublicIpV6": "",
"CreatedTime": "2026-02-15T14:30:00Z"
}
],
"TotalCount": 1,
"RequestId": "b5d7f3a2-c418-4b9e-9c72-4a1e6d3f8b90"
}
}
Query instance list by instance ID
POST / HTTP/1.1
Host: edgezone.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances
<Common request parameters>
{
"InstanceIds": [
"bms-abcd1234"
],
"Offset": 0,
"Limit": 20
}
{
"Response": {
"InstanceSet": [
{
"InstanceId": "bms-abcd1234",
"InstanceName": "my-epm-instance",
"MachineId": "srv-abcd1234",
"InstanceType": "BM.S5.LARGE8",
"Zone": "ap-guangzhou-1",
"ImageId": "img-centos-7.9",
"VersionNumber": "7.9.2009",
"InstanceStatus": "running",
"OperateStatus": "normal",
"PrivateNetworkId": "net-private-001",
"PrivateIp": "10.0.0.1",
"PrivateIpV6": "fd00::1",
"PublicNetworkId": "net-public-001",
"PublicIp": "203.0.113.10",
"PublicIpV6": "2001:db8::1",
"CreatedTime": "2026-01-13T10:00:00Z"
}
],
"TotalCount": 1,
"RequestId": "eac6b301-a322-493a-8e36-83b295459397"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
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