Modify the Instance Password
Last Updated:2020-10-20
Change the Admin password of specified virtual machine.
- This API can be called only when the instance is in the Running or Stopped status. Otherwise, it prompts an error 409.
Request Structure
PUT /v{version}/instance/{instanceId}?{action} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"adminPass": adminPass
}
Request Header Field
There are no other special header fields except the public header field.
Request Parameters
Parameter Name | Type | Required | Parameter Position | Description |
---|---|---|---|---|
version | String | Yes | URL parameter | API version number |
instanceId | String | Yes | URL parameter | Specified instance ID |
action | String | Yes | Query Parameter | Actions on instance, whose current value is changePass. |
adminPass | String | Yes | Request Body Parameter | Admin password of instance to specify, which must contain 8-32-bit characters, English, numbers and symbols, and the symbols are only limited to!@#$%^*() . The password needs to be encrypted for transmission. For more information, see Definition of Encryption Transmission Specification for Password. |
Return Header Field
There are no other special header fields except the common header field.
Return Parameter
No specific parameters are returned.
Error Code
Error Code | Error Description | HTTP Status Code | Explanations |
---|---|---|---|
Instance.PasswordOperationForbidden | Instance not stopped when changing password. | 409 | You can change the password only when the instance is in the Stopped status. |
Request Instance
PUT /v2/instance/i-YufwpQAe?changePass HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"adminPass": "c5b31add-ffe0-44b0-86eb-063109a1b6fe"
}
Return Instance
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS