ListUsersAsync - 异步查询集群用户列表

调用ListUsersAsync异步查询集群中的用户列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ehpc:ListUsersAsyncget
*全部资源
*

请求参数

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

集群 ID。您可以通过调用 ListClusters 获取集群 ID。

ehpc-hz-vu7c2WkVGx
PageNumberinteger

当前页码。
起始值:1。
默认值:1。

1
PageSizeinteger

每页显示的条数。
取值范围:1~50。
默认值:10。

10
AsyncIdstring

异步任务 ID。

t-hz02xltxaex1q80

返回参数

名称类型描述示例值
object
PageSizeinteger

每页显示的条数。

10
RequestIdstring

请求 ID。

9A05F620-ED46-4A57-95F1-C67D6D3C5DD2
PageNumberinteger

显示的页码,起始值为 1。

1
TotalCountinteger

用户总数。

1
Usersarray<object>

用户列表。

UserInfoobject

用户信息。

Namestring

用户名。

testuser
AddTimestring

创建时间。

2022-09-28T09:05:26.000Z
Groupstring

用户组。

wheel
UserIdstring

用户 ID。

1000
GroupIdstring

用户组 ID。

10
AsyncIdstring

异步任务 ID。

t-sh03egi3mls****
AsyncStatusstring

异步任务状态。

Success

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "9A05F620-ED46-4A57-95F1-C67D6D3C5DD2",
  "PageNumber": 1,
  "TotalCount": 1,
  "Users": {
    "UserInfo": [
      {
        "Name": "testuser",
        "AddTime": "2022-09-28T09:05:26.000Z",
        "Group": "wheel",
        "UserId": "1000",
        "GroupId": "10"
      }
    ]
  },
  "AsyncId": "t-sh03egi3mls****",
  "AsyncStatus": "Success"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe specified parameter %s is invalid.指定的参数 %s 无效。
403InvalidClusterStatusThe operation failed due to invalid cluster status.集群状态不允许执行本次操作。
404ManagerNotFoundThe manager nodes do not exist or their status is abnormal.管理节点不存在或状态异常。
404ClusterNotFoundThe specified cluster does not exist.指定的集群不存在,请您检查该参数是否正确。
406AgentErrorThe agent service request failed.集群侧命令运行失败。%s
406AgentError.Account.DomainNotExistThe specified domain does not exist: %s.域服务不存在:{},请您检查该参数是否正确。
406AgentError.Account.GetentPasswdFailureFailed to get the user list: %s.获取域用户列表失败:{}
406AgentError.Account.GetUserListFailureGet user list fail: %s获取用户列表失败:%s
406EcsErrorAn error occurred while calling the ECS API operation.ECS API调用出错. %s
407NotAuthorizedYou are not authorized by RAM for this request.此请求未获得RAM授权
500UnknownErrorAn unknown error occurred.未知错误
503ServiceUnavailableThe request has failed due to a temporary failure of the server请求失败,服务暂时不可用

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