All Products
Search
Document Center

Elastic High Performance Computing:ListUsersAsync

Last Updated:Jul 31, 2025

Queries the users in a cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ehpc:ListUsersAsync
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The ID of the E-HPC cluster. You can call the ListClusters operation to query the cluster ID.

ehpc-hz-vu7c2WkVGx
PageNumberintegerNo

The page number.
Pages start from page 1.
Default value: 1.

1
PageSizeintegerNo

The number of entries returned per page.
Valid values: 1 to 50.
Default value: 10.

10
AsyncIdstringNo

The ID of the asynchronous task.

t-hz02xltxaex1q80

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The request ID.

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

The number of the page returned. Pages start from page 1.

1
TotalCountinteger

The total number of users.

1
Usersarray<object>

The list of users.

UserInfoobject
Namestring

The username of the account.

testuser
AddTimestring

The time when the user was created.

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

The user groups.

wheel
UserIdstring

The user ID.

1000
GroupIdstring

The user group ID.

10
AsyncIdstring

The ID of the asynchronous task.

t-sh03egi3mls****
AsyncStatusstring

The status of the asynchronous task.

Success

Examples

Sample success responses

JSONformat

{
  "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"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParamsThe specified parameter %s is invalid.The specified parameter %s is invalid.
403InvalidClusterStatusThe operation failed due to invalid cluster status.The cluster status does not support the operation.
404ManagerNotFoundThe manager nodes do not exist or their status is abnormal.The manager nodes do not exist or their status is abnormal.
404ClusterNotFoundThe specified cluster does not exist.The specified instance does not exist.
406AgentErrorThe agent service request failed.The cluster-side command failed to run. %s
406AgentError.Account.DomainNotExistThe specified domain does not exist: %s.The domain service does not exist: %s
406AgentError.Account.GetentPasswdFailureFailed to get the user list: %s.Failed to obtain the domain user list: %s
406AgentError.Account.GetUserListFailureGet user list fail: %sFailed to query the list of users: %s
406EcsErrorAn error occurred while calling the ECS API operation.ECS API call error. %s
407NotAuthorizedYou are not authorized by RAM for this request.The request is not authorized by RAM.
500UnknownErrorAn unknown error occurred.An unknown error occurred.
503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history