Locks multiple user accounts on a bastion host at a time.

Operation description

Description

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.

Limits

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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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:LockUsers		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host to which the users to be locked belong. 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 to which the users to be locked belong. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
UserIds	string	Yes	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 (,). Note You can call the ListUsers operation to query the ID of the user.	["1","2","3"]

All Alibaba Cloud API requests 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

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Results	array<object>	The result of the call.
Item	object
Code	string	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. Note Make 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. Note Check 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.	OK
Message	string	This parameter is deprecated.	N/A
UserId	string	The ID of the user.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Results": [
    {
      "Code": "OK",
      "Message": "N/A\n",
      "UserId": "1"
    }
  ]
}

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.

For a list of error codes, visit the Service error codes.