Domain name for API request: edgezone.intl.tencentcloudapi.com.
Query private network instances, support through parameters such as private network instance ID, instance name, and availability zone id.
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: DescribePrivateNetworkInstances. |
| 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 | No | String | Private network instance Id |
| NetworkInstanceName | No | String | New instance name |
| ZoneId | No | String | Availability zone ID. |
| 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 private network instances |
| PrivateNetworkInstanceSet | Array of PrivateNetworkInstanceInfo | Private network instance set |
| 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: DescribePrivateNetworkInstances
<Common request parameters>
{
"ZoneId": "ap-beijing",
"Offset": 0,
"Limit": 10
}
{
"Response": {
"RequestId": "test-req-013",
"TotalCount": 1,
"PrivateNetworkInstanceSet": [
{
"NetworkInstanceId": "ein-a1b2c3d4",
"ZoneId": "ap-beijing-a",
"NetworkInstanceName": "test-pri-instance",
"Network": "10.0.0.0",
"Mask": 24,
"ServerCount": 3,
"AvailableIpCount": 251,
"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