调用ListUsers查询集群中的用户列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListUsers

系统规定参数。取值:ListUsers

ClusterId String ehpc-hz-FYUr32****

集群ID。

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

PageNumber Integer 1

当前页码。

起始值:1

默认值:1

PageSize Integer 10

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

默认值:10

返回数据

名称 类型 示例值 描述
PageSize Integer 1

本页条数。

RequestId String 04F0F334-1335-436C-A1D7-6C044FE7****

请求ID。

PageNumber Integer 1

当前页码。

TotalCount Integer 1

列表条目总数。

Users Array of UserInfo

用户列表信息。

UserInfo
Name String user1

用户名。

AddTime String 2018-07-18T17:46:47

添加用户的时间。

Group String wheel

用户组。可能值:

  • users:普通权限组,适用于只有提交、调试作业需求的普通用户。
  • wheel:sudo权限组,适用于需要管理集群的管理员,除提交、调试作业外,还可以执行sudo命令进行安装软件、重启节点等操作。

示例

请求示例

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListUsers
&ClusterId=ehpc-hz-FYUr32****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListUsersResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>
    <TotalCount>1</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>1</PageSize>
    <Users>
        <UserInfo>
            <Name>user1</Name>
            <Group>users</Group>
        </UserInfo>
        <UserInfo>
            <Name>user2</Name>
            <Group>wheel</Group>
        </UserInfo>
    </Users>
</ListUsersResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "04F0F334-1335-436C-A1D7-6C044FE7****",
  "TotalCount" : 1,
  "PageNumber" : 1,
  "PageSize" : 1,
  "Users" : {
    "UserInfo" : [ {
      "Name" : "user1",
      "Group" : "users"
    }, {
      "Name" : "user2",
      "Group" : "wheel"
    } ]
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParams The specified parameter %s is invalid. 无效的参数:%s
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. 指定的集群不存在,请您检查该参数是否正确。
406 AgentError The agent service request failed. 代理请求失败
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
407 NotAuthorized You are not authorized by RAM for this request. 此请求未获得RAM授权
500 UnknownError An unknown error occurred. 未知错误,请您稍后再试,若还出现相同的错误请提交工单处理。
503 ServiceUnavailable The request has failed due to a temporary failure of the server 请求失败,服务暂时不可用

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