锁定一个或者多个便捷账号。锁定后的便捷账号无法登录无影终端。
接口说明
出于安全考虑,您可以锁定便捷账号。被锁定的便捷用户无法登录无影终端,因此也无法访问任何无影云资源。
您可以调用 DescribeUsers 查询便捷账号信息。若返回数据中Status取值为 0,表示该便捷账号未被锁定;若Status取值为 9,表示该便捷账号已被锁定。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecd:LockUsers |
update |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Users |
array |
是 |
要锁定的便捷账号的用户名列表。 |
test1 |
|
string |
是 |
要锁定的便捷账号的用户名。 |
alice |
|
| LogoutSession |
boolean |
否 |
锁定便捷账号时是否同时注销该账号的当前会话。 |
|
| BusinessChannel |
string |
否 |
渠道 |
ENTERPRISE |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回信息集合。 |
||
| RequestId |
string |
请求 ID。 |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
| LockUsersResult |
object |
锁定便捷账号操作的结果。 |
|
| LockedUsers |
array |
锁定成功的便捷账号列表。 |
|
|
string |
锁定成功的便捷账号。 |
alice |
|
| FailedUsers |
array<object> |
锁定失败的便捷账号列表。 |
|
|
object |
锁定失败的便捷账号信息集合。 |
||
| EndUserId |
string |
锁定失败的便捷账号。 |
alice |
| ErrorCode |
string |
错误码。 |
InvalidUsername |
| ErrorMessage |
string |
错误信息。 |
test123 is an invalid username. |
示例
正常返回示例
JSON格式
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"LockUsersResult": {
"LockedUsers": [
"alice"
],
"FailedUsers": [
{
"EndUserId": "alice",
"ErrorCode": "InvalidUsername",
"ErrorMessage": "test123 is an invalid username."
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。