Domain name for API request: edgezone.intl.tencentcloudapi.com.
This API is used to modify the attributes of a physical machine instance, supporting modification of the instance name and update of the public IP address (IPv4/IPv6). At least one of InstanceName and NewPublicIp must be input.
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: ModifyInstanceAttribute. |
| 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. |
| InstanceId | Yes | String | Instance ID. |
| InstanceName | No | String | New instance name, 1-60 characters. Import at least one with NewPublicIp. |
| NewPublicIp | No | String | New public IP address (select from available IP addresses of the public network instance bound to the instance). Provide at least one of this or InstanceName. |
| IpType | No | String | IP type, ipv4 or ipv6. Default is ipv4. Valid only when NewPublicIp is specified. |
| Parameter Name | Type | Description |
|---|---|---|
| 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. |
Modify the specified instance name.
POST / HTTP/1.1
Host: edgezone.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstanceAttribute
<Common request parameters>
{
"InstanceId": "bms-abcd1234",
"InstanceName": "new-instance-name"
}
{
"Response": {
"RequestId": "e5f6a789-4c3d-5b2e-af01-8d7c6b5a4e3f"
}
}
Update the public IPv4 address of a specified instance.
POST / HTTP/1.1
Host: edgezone.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstanceAttribute
<Common request parameters>
{
"InstanceId": "bms-abcd1234",
"NewPublicIp": "203.0.113.20",
"IpType": "ipv4"
}
{
"Response": {
"RequestId": "e5f6a789-4c3d-5b2e-af01-8d7c6b5a4e3f"
}
}
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. |
| InvalidParameter | Parameter error. |
| ResourceNotFound.Instance | Physical machine instance does not exist |
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