产品动态
公共镜像更新动态
操作系统官方停止维护计划
产品公告
Domain name for API request: cvm.intl.tencentcloudapi.com.
This API is used to reset the password of the operating system instances to a user-specified password.
Administrator; in Ubuntu, it is ubuntu; in Linux, it is root.ForceStop to True for a forced shutdown. If not, only passwords of stopped instances can be reset.LatestOperationState. If the value is SUCCESS, the operation is successful.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: ResetInstancesPassword. |
| 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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| 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. |
| Password | Yes | String | Login password of the instance. The password requirements vary among different operating systems: For a Linux instance, the password must be 8 to 30 characters in length; password with more than 12 characters is recommended. It cannot begin with "/", and must contain at least one character from three of the following categories: For a Windows CVM, the password must be 12 to 30 characters in length. It cannot begin with "/" or contain a username. It must contain at least one character from three of the following categories: Linux and Windows instances, you will need to follow the password requirements for Windows instances. |
| UserName | No | String | Username of the instance operating system for which the password needs to be reset. This parameter is limited to 64 characters. |
| ForceStop | No | Boolean | Whether to force shut down a running instances. It is recommended to manually shut down a running instance before resetting the user password. Valid values: Default value: FALSE. A forced shutdown is similar to switching off the power of a physical computer. It may cause data loss or file system corruption. Be sure to only force shut down a CVM when it cannot be shut down normally. |
| 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 reset the password of a Linux/Windows instance, and then use the new password to log in to the instance.
POST / HTTP/1.1
Host: cvm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ResetInstancesPassword
<Common request parameters>
{
"InstanceIds": [
"ins-r8hr2upy"
],
"Password": "abc123ABC!@#",
"ForceStop": false
}{
"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 |
|---|---|
| FailedOperation.InvalidInstanceApplicationRole | The applicationRole instance does not support the operation. |
| 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. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.InstanceIdMalformed | Invalid instance ID. Please enter a valid ID, such as ins-xxxxxxxx (“x” represents a lower-case letter or a number). |
| InvalidParameterValue.InvalidPassword | Invalid password. The specified password does not meet the complexity requirements (e.g., too long or too short) |
| InvalidParameterValue.LimitExceeded | The number of parameter values exceeds the limit. |
| InvalidParameterValue.TooLong | Invalid parameter value: parameter value is too long. |
| MissingParameter | Missing parameter. |
| MutexOperation.TaskRunning | An identical job is running. |
| OperationDenied.InstanceOperationInProgress | The instance has an operation in progress. Please try again later. |
| UnauthorizedOperation.MFAExpired | Unauthorized operation. Make sure Multi-Factor Authentication (MFA) is valid. |
| UnauthorizedOperation.MFANotFound | Unauthorized operation. Make sure Multi-Factor Authentication (MFA) exists. |
| UnsupportedOperation.InstanceReinstallFailed | The current instance is in a failed OS reinstallation state and does not support this operation. We recommend reinstalling the operating system again. Alternatively, you may terminate/return the instance or submit a support ticket. |
| UnsupportedOperation.InstanceStateEnterRescueMode | Instances are entering the rescue mode, and this operation is not supported. |
| UnsupportedOperation.InstanceStateExitRescueMode | Instances are exiting from the rescue mode, and this operation 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.InstanceStateRunning | Running instances do not support 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.InstanceStateTerminating | The instance is being terminated, and the operation is not supported. |
| UnsupportedOperation.SpecialInstanceType | This special instance type does not support the operation. |
| UnsupportedOperation.StoppedModeStopCharging | The instance does not support the no charges when shut down feature. |
文档反馈