All Products
Document Center


Last Updated:Jan 31, 2023

Locks one or more users of a bastion host.

Operation Description

Usage notes

You can call this operation to lock one or more users of a bastion host. If a user does not need to use a bastion host to perform O&M operations within a specific period of time, you can lock the user. The locked user can no longer log on to or perform O&M operations on the hosts on which the user is granted permissions. If you want to unlock the user later, you can call the UnlockUsers operation.

QPS limit

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
    All resources

Request parameters


The ID of the bastion host to which the users to be locked belong.

NoteYou can call the DescribeInstances operation to query the ID of the bastion host.

The region ID of the bastion host to which the users to be locked belong.

NoteFor more information about the mapping between region IDs and region names, see Regions and zones.

The ID of the user to be locked. The value is a JSON string. You can add up to 100 user IDs. If you specify multiple IDs, separate the IDs with commas (,).

NoteYou can call the ListUsers operation to query the IDs of users.

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters


The ID of the request, which is used to locate and troubleshoot issues.


The result of the call.


The return code that indicates whether the call was successful. Valid values:

  • OK: The call was successful.

  • UNEXPECTED: An unknown error occurred.

  • INVALID_ARGUMENT: A request parameter is invalid.

NoteMake sure that the request parameters are valid and call the operation again.
  • OBJECT_NOT_FOUND: The specified object on which you want to perform the operation does not exist.
NoteCheck whether the specified ID of the bastion host exists, whether the specified hosts exist, and whether the specified host IDs are valid. Then, call the operation again.
  • OBJECT_AlREADY_EXISTS: The specified object on which you want to perform the operation already exists.

This parameter is deprecated.


The ID of the user.



Normal return example


  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Results": [
      "Code": "OK",
      "Message": "",
      "UserId": "1"

Error codes

Http codeError codeError messageDescription
400InvalidParameterThe argument is invalid.The argument is invalid.
500InternalErrorAn unknown error occurred.An unknown error occurred.

For a list of error codes, visit the API error center.