LockUsers - 批量锁定堡垒机用户 - 运维安全中心（堡垒机）

批量锁定堡垒机用户。

接口说明

使用说明

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

QPS 限制

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-bastionhost:LockUsers		全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	要锁定的用户所在堡垒机实例的 ID。说明您可以调用 DescribeInstances 接口获取该参数。	bastionhost-cn-st220aw****
RegionId	string	否	指定要锁定的用户所在堡垒机的区域 ID。说明区域 ID 和区域名称的对应关系，请参见地域和可用区。	cn-hangzhou
UserIds	string	是	要锁定的用户 ID。该参数为 JSON 格式的字符串，最多支持添加 100 个用户 ID，多个 ID 之间使用半角逗号（,）隔开。说明您可以调用 ListUsers 接口获取用户 ID。	["1","2","3"]

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

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Results	array<object>	接口的调用结果。
Item	object
Code	string	接口调用的结果。取值： OK：操作成功。 UNEXPECTED：未知错误。 INVALID_ARGUMENT：请求参数设置错误。说明请检查请求参数，确保参数正确后重新调用接口。 OBJECT_NOT_FOUND：操作的对象不存在。说明请检查该堡垒机实例的 ID 是否存在，主机是否存在，主机 ID 是否填写正确，然后重新调用接口。 OBJECT_AlREADY_EXISTS ：操作的对象已存在。	OK
Message	string	该参数已废弃，无需关注。	无
UserId	string	用户 ID。	1

示例

正常返回示例

JSON格式

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

错误码

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

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