Queries the users in a cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListUsers

The operation that you want to perform. Set the value to ListUsers.

ClusterId String Yes ehpc-hz-FYUr32****

The ID of the cluster.

You can call the ListClusters operation to query the cluster ID.

PageNumber Integer No 1

The number of the page to return.

Pages start from page 1.

Default value: 1

PageSize Integer No 10

The number of entries to return on each page. Valid values: 1 to 50.

Default value: 10

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 1

The number of entries returned per page.

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

The ID of the request.

TotalCount Integer 1

The total number of entries.

Users Array of UserInfo

The list of users.

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

The time when the user was created.

Group String wheel

The name of the permission group. Valid values:

  • users: an ordinary permission group. It is applicable to ordinary users that need only to submit and debug jobs.
  • wheel: a sudo permission group. It is applicable to the administrator who needs to manage the cluster. In addition to submitting and debugging jobs, users who have sudo permissions can run sudo commands to install software and restart nodes.
Name String user1

The name of the user.

Examples

Sample requests

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListUsers
&ClusterId=ehpc-hz-FYUr32****
&<Common request parameters>

Sample success responses

XML format

<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 format

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

Error codes

HttpCode Error code Error message Description
406 AgentError.Account.DomainNotExist Specific domain not exists: %s The error message returned because the following domains do not exist: {}.
406 AgentError.Account.GetentPasswdFailure Failed to get the user list: %s The error message returned because the list of domain users {} has failed to be obtained.
503 ServiceUnavailable The request has failed due to a temporary failure of the server The error message returned because the request has failed. The service is temporarily unavailable.

For a list of error codes, visit the API Error Center.