Locks one or more users of a bastion host.

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes LockUsers

The operation that you want to perform.

Set the value to LockUsers.

InstanceId String Yes bastionhost-cn-st220aw****

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.
UserIds String Yes ["1","2","3"]

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 IDs of users.
RegionId String No cn-hangzhou

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.

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

Parameter Type Example Description
RequestId String EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

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

Results Array of Item

The result of the call.

Code String OK

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.
Message String None

This parameter is deprecated.

UserId String 1

The ID of the user.

Examples

Sample requests

http(s)://[Endpoint]/?Action=LockUsers
&InstanceId=bastionhost-cn-st220aw****
&UserIds= ["1","2","3"]
&<Common request parameters>

Sample success responses

XML format 

<LockUsersResponse>
      <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
      <Results>
            <Message></Message>
            <UserId>1</UserId>
            <Code>OK</Code>
      </Results>
</LockUsersResponse>

JSON format 

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

Error codes

HTTP status code Error code Error message Description
500 InternalError An unknown error occurred. The error message returned because an unknown error occurred.
400 InvalidParameter The argument is invalid. The error message returned because one or more parameters are invalid.

For a list of error codes, visit the API Error Center.