Modifies the information about a host account, such as the username, password, and private key of the host account.
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 |
|---|---|---|---|---|
| yundun-bastionhost:ModifyHostAccount | update |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The ID of the bastion host in which you want to modify the information about the host account. Note
You can call the DescribeInstances operation to query the ID of the bastion host.
| bastionhost-cn-st220aw**** |
| RegionId | string | No | The region ID of the bastion host in which you want to query the details of the host account. Note
For more information about the mapping between region IDs and region names, see Regions and zones.
| cn-hangzhou |
| HostAccountId | string | Yes | The ID of the host account whose information you want to modify. Note
You can call the ListHostAccounts operation to query the ID of the host account.
| 1 |
| HostAccountName | string | No | The new name of the host account. The name can be up to 128 characters in length. | abc |
| Password | string | No | The new password of the host account. | **** |
| PrivateKey | string | No | The new private key of the host account. Specify a Base64-encoded string. Note
This parameter takes effect only if the protocol used by the host is SSH. You do not need to configure this parameter if the protocol used by the host is Remote Desktop Protocol (RDP). You can call the GetHostAccount operation to query the protocol used by the host. You can configure a password and a private key for the host account at the same time. If both a password and a private key are configured for the host account, Bastionhost preferentially uses the private key for logon.
| **** |
| PassPhrase | string | No | The passphrase for the new private key of the host account. Note
This parameter is valid only if the protocol used by the host is SSH. You do not need to configure this parameter if the protocol used by the host is Remote Desktop Protocol (RDP).
| **** |
| HostShareKeyId | string | No | The ID of the shared key that is associated with the host. Note
You can call the ListHostShareKeys operation to query the shared key ID.
| 1 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidParameter | The argument is invalid. | The argument is invalid. |
| 404 | HostAccountNotFound | The host account is not found. | The host account is not found. |
| 500 | InternalError | An unknown error occurred. | An unknown error occurred. |
For a list of error codes, visit the Service error codes.