Modifies the information of a simple application server, including the server name and the password that you use to log on to the server.
Operation description
Usage notes
After you change the password of a simple application server, you must restart the server by calling the RebootInstance operation for the new password to take effect.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| swas-open:UpdateInstanceAttribute | update |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The ID of the simple application server. | ace0706b2ac4454d984295a94213**** |
| RegionId | string | Yes | The region ID of the simple application server. | cn-hangzhou |
| Password | string | No | The new password of the simple application server. The password must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The password can contain the following special characters: For Windows instances, the password cannot start with a forward slash (/). Note
For security reasons, we recommend that you use HTTPS to send requests if Password is specified.
| Test123! |
| InstanceName | string | No | The name of the simple application server. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with | test-InstanceName |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of ClientToken can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence. | 123e4567-e89b-12d3-a456-426655440000 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | InvalidPassword.ValueNotSupported | The specified parameter Password is invalid. |
| 400 | InvalidInstanceName.ValueNotSupported | The specified parameter InstanceName is invalid. |
| 400 | RegionIdNotMatchHost | The parameter regionId does not match the endpoint host. |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. |
| 500 | InternalError | An error occurred while processing your request. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-09-18 | API Description Update. The Error code has changed | View Change Details |