文档

LockUsers - 锁定便捷用户

锁定一个或者多个便捷用户。

接口说明

出于安全考虑,您可以锁定便捷用户。被锁定的便捷用户无法登录云桌面。

说明 您可以调用 DescribeUsers 查询便捷用户信息。返回数据中Status取值为 0,表示该便捷用户未被锁定;Status取值为 9,表示该便捷用户已被锁定。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Usersarray

要锁定的便捷用户的用户名列表。

string

要锁定的便捷用户的用户名。

test1

返回参数

名称类型描述示例值
object

返回信息集合。

RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
LockUsersResultobject

锁定便捷用户操作的结果。

LockedUsersarray

锁定成功的便捷用户。

string

锁定成功的便捷用户。

test1
FailedUsersobject []

锁定失败的便捷用户信息集合。

EndUserIdstring

锁定失败的便捷用户。

test123
ErrorCodestring

错误码。

InvalidUsername
ErrorMessagestring

错误信息。

test123 is an invalid username.

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "LockUsersResult": {
    "LockedUsers": [
      "test1"
    ],
    "FailedUsers": [
      {
        "EndUserId": "test123",
        "ErrorCode": "InvalidUsername",
        "ErrorMessage": "test123 is an invalid username."
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)