Domain name for API request: edgezone.intl.tencentcloudapi.com.
This API is used to create a physical machine instance. The system automatically allocates physical machine resources and completes installation. If the user is not in the current availability zone, the system automatically enables billing. It supports concurrent allocation of physical machine resources and async execution of network assignment and installation tasks.
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: CreateInstances. |
| 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. |
| Zone | Yes | String | Availability zone code, such as ap-guangzhou-1. |
| InstanceType | Yes | String | Model specifications, such as BMS5.MEDIUM8. |
| PrivateNetworkId | Yes | String | Private network instance ID in the format of net-xxx. |
| PublicNetworkId | Yes | String | Public network instance ID, in the format of net-xxx. |
| InstanceName | No | String | Instance name. |
| ImageId | No | String | Image ID, for example img-centos-7.9. |
| InstanceCount | No | Integer | Specify the quantity. Default is 1. Maximum is 50. |
| Password | No | String | Login password. Either it or SSHKey is required. |
| SSHKey | No | String | Public key string of the SSH key. Either this parameter or Password must be specified. |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceIdSet | Array of String | List of successfully created instance IDs. |
| FailedCount | Integer | Count of failed instances. This field is returned only when partially failed, not returned when all successful. |
| 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. |
Create a physical machine instance in Guangzhou Zone 1, use the CentOS 7.9 mirror, and enable IPv6.
POST / HTTP/1.1
Host: edgezone.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstances
<Common request parameters>
{
"Zone": "ap-guangzhou-1",
"InstanceType": "BMS5.MEDIUM8",
"ImageId": "img-hmk3il0q",
"InstanceName": "my-epm-instance",
"InstanceCount": 1,
"PrivateNetworkId": "net-private-001",
"PublicNetworkId": "net-public-001"
}{
"Response": {
"InstanceIdSet": [
"epm-abcd1234"
],
"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.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| InvalidParameterValue | Parameter value error. |
| LimitExceeded.InstanceQuota | LimitExceeded.InstanceQuota |
| ResourceInsufficient | Insufficient resources. |
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