Modifies the attributes of an instance, including the instance password and name.
Operation description
-
You cannot reset the password of an instance when the instance status is Starting.
-
You cannot modify the password of an instance when the instance status is Running.
-
After you reset the password, you must restart the instance in the console or invoke the RebootInstance operation for the changes to take effect. Restarting the instance from within the operating system does not take effect.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ens:ModifyInstanceAttribute |
update |
*Instance
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The ID of the instance to modify. Only a single instance ID is supported. |
i-instanc**** |
| Password |
string |
No |
The password of the instance. |
yourPassword |
| InstanceName |
string |
No |
The name of the instance. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character, and cannot start with |
i-instanceidname |
| HostName |
string |
No |
The hostname of the ECS instance. The hostname must be 2 to 64 characters in length. You can use periods (.) to separate the hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-). Consecutive periods (.) or hyphens (-) are not allowed. The hostname cannot start or end with a period (.) or a hyphen (-). |
testHostName |
| UserData |
string |
No |
The instance user data. The user data must be encoded in Base64. Before encoding, the raw data cannot exceed 16 KB in size. Do not pass sensitive information such as passwords and private keys in plaintext. If you must pass sensitive information, encrypt the information before you encode it in Base64, and then decrypt the information in the same way within the instance. |
/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgK**** |
| DeletionProtection |
boolean |
No |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Code |
integer |
The business return code. A value of 0 indicates success. |
200 |
| RequestId |
string |
The request ID. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
Examples
Success response
JSON format
{
"Code": 200,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | MissingParameter | The input parameter that is mandatory for processing this request is not supplied. | |
| 400 | InstanceIdNotFound | The input parameter InstanceId that is not found. | |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. | |
| 400 | NoPermission | Permission denied. | |
| 400 | InvalidDeletionAppointmentNotSupported | The scheduled release time of the current instance is set to prohibit this operation. | The scheduled release time of the current instance is set to prohibit this operation. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.