Domain name for API request: cvm.tencentcloudapi.com.
The API is used to modify the attributes of an instance. Only the name and the associated security groups can be modified for now.
A maximum of 10 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: ModifyInstancesAttribute. |
Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
Region | Yes | String | Common Params. 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 | The instance name, which can not exceed 60 charactersEither InstanceName or SecurityGroups must be specified, but they can not be both specified. |
UserData | No | String | User data provided to an instance, which needs to be encoded in Base64 format with a maximum size of 16 KB. For details on obtaining this parameter, refer to the startup commands for Windows and Linux. |
SecurityGroups.N | No | Array of String | IDs of security groups associated with the specified instance. You can associate with a security group by adding its ID, or cancel the association with a security group by removing its ID. Either InstanceName or SecurityGroups must be specified, but they cannot be both set. |
CamRoleName | No | String | The role bound with the instance. If it is not specified, it indicates to unbind the current role of the CVM. |
HostName | No | String | Modified hostname of an instance. |
DisableApiTermination | No | Boolean | Instance termination protection flag, indicating whether an instance is allowed to be deleted through an API. Valid values: |
CamRoleType | No | String | The role type, which is used in conjunction with CamRoleName . The value is obtained in RoleType field, returning by CAM DescribeRoleList and GetRole APIs. Valid value: user , system and service_linked .For example, when LinkedRoleIn is contained in CamRoleName (such as TKE_QCSLinkedRoleInPrometheusService ), the returned RoleType of DescribeRoleList and GetRoleis is service_linked , and the CamRoleType service_linked .When the value obtained in RoleType is user (default) or system , CamRoleType can be left empty. |
AutoReboot | No | Boolean | Whether to automatically restart an instance when modifying a hostname. If not specified, the instance will automatically restart by default. - true: Modify the hostname and automatically restart the instance. - false: Modify the hostname without automatically restarting the instance. A manual restart is required for the new hostname to take effect. Note: This parameter is valid only when a hostname is modified. |
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. |
This example shows you how to rename two instances.
POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstancesAttribute
<Common request parameters>
{
"InstanceName": "Mysql_Server",
"InstanceIds": [
"ins-5d8a23rs",
"ins-r8hr2upy"
]
}
{
"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.InvalidInstanceApplicationRole | |
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. |
InvalidParameter.HostNameIllegal | The specified HostName is invalid. |
InvalidParameterValue | Incorrect parameter value. |
InvalidParameterValue.CamRoleNameMalformed | Invalid CamRoleName . This parameter must contain only letters, numbers and symbols (+ , = , , , . , @ , _ , - ). |
InvalidParameterValue.IllegalHostName | The value of HostName is invalid. |
InvalidParameterValue.InstanceIdMalformed | Invalid instance ID. Please enter a valid ID, such as ins-xxxxxxxx (“x” represents a lower-case letter or a number). |
InvalidParameterValue.InvalidUserDataFormat | Incorrect UserData format. Use the Base64-encoded format. |
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. |
LimitExceeded.CvmsVifsPerSecGroupLimitExceeded | The CVM ENIs associated with the security group has exceeded the limit. |
LimitExceeded.SingleUSGQuota | The number of security groups exceeds the quota limit. |
MissingParameter | Missing parameter. |
MutexOperation.TaskRunning | An identical job is running. |
OperationDenied.InstanceOperationInProgress | The instance has an operation in progress. Please try again later. |
UnauthorizedOperation.MFANotFound | Unauthorized operation. Make sure Multi-Factor Authentication (MFA) exists. |
UnsupportedOperation.InstanceReinstallFailed | |
UnsupportedOperation.InstanceStateEnterRescueMode | Instances are entering the rescue mode, and this operation is not supported. |
UnsupportedOperation.InstanceStateEnterServiceLiveMigrate | The instance ins-xxxxxx in the ENTER_SERVICE_LIVE_MIGRATE status is not supported. |
UnsupportedOperation.InstanceStateExitRescueMode | Instances are exiting from the rescue mode, and this operation is not supported. |
UnsupportedOperation.InstanceStateExitServiceLiveMigrate | The instance ins-xxxxxx in the EXIT_SERVICE_LIVE_MIGRATE status is not supported. |
UnsupportedOperation.InstanceStateFreezing | The operation is not supported for the frozen instances. |
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.InstanceStateStarting | The instance is starting up, and this operation is not supported. |
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.InstanceTypeNotSupportJumboFrame | The instance type does not support setting the EnableJumboFrame status. |
UnsupportedOperation.InstancesEnableJumboWithoutReboot | Modifying Jumbo Frame status without a restart is not supported. |
UnsupportedOperation.InvalidInstanceNotSupportedProtectedInstance | This operation is not supported for the instance with a termination schedule. Please cancel the scheduled termination time in the instance details page and try again. |
UnsupportedOperation.StoppedModeStopCharging | The instance does not support the no charges when shut down feature. |
Was this page helpful?