Domain name for API request: cvm.tencentcloudapi.com.
This API is used to modify the attributes of an instance. Currently you can only use the API to modify the name and the associated security groups of the instance.
A maximum of 10 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: ModifyInstancesAttribute. |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| InstanceIds.N | Yes | Array of String | Instance ID(s). To obtain the instance IDs, you can call DescribeInstances and look for InstanceId in the response. The maximum number of instances in each request is 100. |
| InstanceName | No | String | Instance name. You can specify any name you like, but its length cannot exceed 60 characters. |
| SecurityGroups.N | No | Array of String | ID list of security groups of the instance. The instance will be associated with the specified security groups and will be disassociated from the original security groups. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to modify the names of two instances.
GET https://cvm.tencentcloudapi.com/?Action=ModifyInstancesAttribute
&InstanceIds.0=ins-r8hr2upy
&InstanceIds.1=ins-5d8a23rs
&InstanceName=Mysql_Server
&<Common request parameters>{
"Response": {
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}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 |
|---|---|
| AuthFailure.CamRoleNameAuthenticateFailed | Role name authentication failed. |
| FailedOperation.SecurityGroupActionFailed | Security group operation failed. |
| InternalServerError | Internal error. |
| InvalidInstance.NotSupported | This instance is not supported. |
| InvalidInstanceId.Malformed | Invalid instance ID. The specified instance ID has an invalid format. For example, ins-1122 has an invalid ID length. |
| InvalidInstanceId.NotFound | No instance found. |
| InvalidInstanceName.TooLong | The specified InstanceName exceeds the maximum length of 60 bytes. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.LimitExceeded | The number of parameter values exceeds the limit. |
| InvalidSecurityGroupId.NotFound | The specified security group ID does not exist. |
| LimitExceeded.AssociateUSGLimitExceeded | An instance can be bound with up to 5 security groups. |
| MissingParameter | Missing parameter. |
| MutexOperation.TaskRunning | An identical job is running. |
| OperationDenied.InstanceOperationInProgress | The instance has an operation in progress. Please try again later. |
| UnsupportedOperation.InstanceStateEnterRescueMode | Instances are entering the rescue mode, and this operation is not supported. |
| UnsupportedOperation.InstanceStateIsolating | Unable to isolate: the instance is isolated |
| UnsupportedOperation.InstanceStatePending | The instances are being created, and this operation is not supported. |
| UnsupportedOperation.InstanceStateRebooting | The instances are being restarted, and this operation is not supported. |
| UnsupportedOperation.InstanceStateRescueMode | Instances in the rescue mode are not available for this operation. |
| UnsupportedOperation.InstanceStateServiceLiveMigrate | The instances are being migrated, and this operation is not supported. |
| UnsupportedOperation.InstanceStateShutdown | Isolated instances do not support this operation. |
| UnsupportedOperation.InstanceStateStopping | The instance is being shut down, and this operation is not supported. |
| UnsupportedOperation.InstanceStateTerminated | Terminated instances are not supported. |
| UnsupportedOperation.InstanceStateTerminating | The instance is being terminated, and the operation is not supported. |
| UnsupportedOperation.StoppedModeStopCharging | The instance does not support the no charges when shut down feature. |
Was this page helpful?