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

更新时间:
复制 MD 格式

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ehpc:ListUsersAsync

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

ClusterId

string

是

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

ehpc-hz-vu7c2WkVGx

PageNumber

integer

否

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




1

PageSize

integer

否

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




10

AsyncId

string

否

异步任务 ID。

t-hz02xltxaex1q80

返回参数

名称

类型

描述

示例值

object

PageSize

integer

每页显示的条数。

10

RequestId

string

请求 ID。

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

PageNumber

integer

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

1

TotalCount

integer

用户总数。

1

Users

object

UserInfo

array<object>

用户列表。

object

用户信息。

Name

string

用户名。

testuser

AddTime

string

创建时间。时间格式为 ISO 8601,使用 UTC 时区。

2022-09-28T09:05:26.000Z

Group

string

用户组。

wheel

UserId

string

用户 ID。

1000

GroupId

string

用户组 ID。

10

AsyncId

string

异步任务 ID。

t-sh03egi3mls****

AsyncStatus

string

异步任务状态。

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

错误码

错误信息

描述

400 InvalidParams The specified parameter %s is invalid. 指定的参数 %s 无效。
500 UnknownError An unknown error occurred. 未知错误
403 InvalidClusterStatus The operation failed due to invalid cluster status. 集群状态不允许执行本次操作。
404 ManagerNotFound The manager nodes do not exist or their status is abnormal. 管理节点不存在或状态异常。
404 ClusterNotFound The specified cluster does not exist. 指定的集群不存在,请您检查该参数是否正确。
503 ServiceUnavailable The request has failed due to a temporary failure of the server 请求失败,服务暂时不可用
406 AgentError The agent service request failed. 集群侧命令运行失败。%s
406 AgentError.Account.DomainNotExist The specified domain does not exist: %s. 域服务不存在:{},请您检查该参数是否正确。
406 AgentError.Account.GetentPasswdFailure Failed to get the user list: %s. 获取域用户列表失败:{}
406 AgentError.Account.GetUserListFailure Get user list fail: %s 获取用户列表失败:%s
406 EcsError An error occurred while calling the ECS API operation. ECS API调用出错. %s
407 NotAuthorized You are not authorized by RAM for this request. 此请求未获得RAM授权

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

变更历史

更多信息,参考变更详情。