Use ModifyInstanceAttribute to change instance attributes - ENS

Operation description

You cannot reset the instance password while the instance is in the Starting state.
You cannot modify the instance password while the instance is in the Running state.
After you reset the password, you must reboot the instance from the console or by calling the RebootInstance API operation to apply the new password. Rebooting the instance from within its operating system does not apply the new password.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ens:ModifyInstanceAttribute

update

*Instance

acs:ens:*:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance. You can modify only one instance per request.	i-instanc****
Password	string	No	The password for 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 and cannot start with `http://` or `https://`. The name can contain digits, colons (:), underscores (_), and hyphens (-).	i-instanceidname
HostName	string	No	The hostname of the instance. The hostname must be 2 to 64 characters in length. You can use periods to separate the name into segments. Each segment can contain letters, digits, and hyphens. The hostname cannot start or end with a period or a hyphen, and it cannot contain consecutive periods or hyphens.	testHostName
UserData	string	No	The Base64-encoded user data for the instance. 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 and then Base64-encode it. You can then decode and decrypt this data from within the instance.	/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgK****
DeletionProtection	boolean	No	Specifies whether to enable deletion protection for the instance. Set this parameter to `true` to enable this feature, or `false` to disable it.

Response elements

Element	Type	Description	Example
	object	The response object.
Code	integer	The status code. A value of `0` indicates that the request was successful.	200
RequestId	string	The ID of the request.	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.