调用LockUsers接口批量锁定堡垒机用户。

使用说明

本接口用于批量锁定堡垒机用户。如果某个用户在一段时间内无需使用堡垒机进行运维操作，您可以使用本接口锁定该用户，被锁定的用户将无法登录服务器进行运维操作。如果后续需要解锁该用户，您可使用UnlockUsers接口来解锁。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 LockUsers

需要执行的操作。

取值：LockUsers。

InstanceId String 是 bastionhost-cn-st220aw****

要锁定的用户所在堡垒机实例的ID。

说明 您可以调用DescribeInstances接口获取该参数。
UserIds String 是 ["1","2","3"]

要锁定的用户ID。该参数为JSON格式的字符串，最多支持添加100个用户ID，多个ID之间使用半角逗号（,）隔开。

说明 您可以调用ListUsers接口获取用户ID。
RegionId String 否 cn-hangzhou

指定要锁定的用户所在堡垒机的区域ID。

说明 区域ID和区域名称的对应关系，请参见地域和可用区。

调用API时，除了本文中该API的请求参数，还需加入阿里云API公共请求参数。公共请求参数的详细介绍，请参见公共参数。

调用API的请求格式，请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
RequestId String EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。
Results Array of Item

接口的调用结果。
Code String OK

接口调用的结果。取值：

  • OK：操作成功。
  • UNEXPECTED：未知错误。
  • INVALID_ARGUMENT：请求参数设置错误。
    说明 请检查请求参数，确保参数正确后重新调用接口。
  • OBJECT_NOT_FOUND：操作的对象不存在。
    说明 请检查该堡垒机实例的ID是否存在，主机是否存在，主机ID是否填写正确，然后重新调用接口。
  • OBJECT_AlREADY_EXISTS ：操作的对象已存在。
Message String 无

该参数已废弃，无需关注。
UserId String 1

用户ID。

示例

请求示例

http(s)://[Endpoint]/?Action=LockUsers
&InstanceId=bastionhost-cn-st220aw****
&UserIds= ["1","2","3"]
&<公共请求参数>

正常返回示例

XML格式 

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

JSON格式 

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

错误码

HttpCode 错误码 错误信息 描述
500 InternalError An unknown error occurred. 未知错误
400 InvalidParameter The argument is invalid. 参数错误

访问错误中心查看更多错误码。