Reset Host Account Credentials via API - Bastionhost - Alibaba Cloud - Bastionhost

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

yundun-bastionhost:ResetHostAccountCredential

update

*Instance

acs:yundun-bastionhost:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID of the Bastionhost instance to which the host account whose logon credentials you want to purge belongs. Note You can invoke the DescribeInstances operation to obtain the value of this parameter.	bastionhost-cn-rp640dg****
RegionId	string	No	The region ID of the Bastionhost instance to which the host account whose logon credentials you want to purge belongs. 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 logon credentials you want to purge. Note You can call the ListHostAccounts operation to obtain the value of this parameter.	1
CredentialType	string	Yes	The type of the logon credential to purge. Valid values: Password: password PrivateKey: SSH private key	Password
ProjectId	integer	No	The project ID.	3

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique identifier generated by Alibaba Cloud for the request.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

Examples

Success response

JSON format

{
  "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.
500	InternalError	An unknown error occurred.	An unknown error occurred.
404	HostAccountNotFound	The host account is not found.	The host account is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.