ListUsersAsync - Elastic High Performance Computing - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the E-HPC cluster. You can call the ListClusters operation to query the cluster ID.	ehpc-hz-vu7c2WkVGx
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries returned per page. Valid values: 1 to 50. Default value: 10.	10
AsyncId	string	No	The ID of the asynchronous task.	t-hz02xltxaex1q80

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The request ID.	9A05F620-ED46-4A57-95F1-C67D6D3C5DD2
PageNumber	integer	The number of the page returned. Pages start from page 1.	1
TotalCount	integer	The total number of users.	1
Users	object []	The list of users.
Name	string	The username of the account.	testuser
AddTime	string	The time when the user was created.	2022-09-28T09:05:26.000Z
Group	string	The user groups.	wheel
UserId	string	The user ID.	1000
GroupId	string	The user group ID.	10
AsyncId	string	The ID of the asynchronous task.	t-sh03egi3mls****
AsyncStatus	string	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 code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
403	InvalidClusterStatus	The operation failed due to invalid cluster status.	The cluster status does not support the operation.
404	ManagerNotFound	The manager nodes do not exist or their status is abnormal.	The manager nodes do not exist or their status is abnormal.
404	ClusterNotFound	The specified cluster does not exist.	The specified instance does not exist.
406	AgentError	The agent service request failed.	-
406	AgentError.Account.DomainNotExist	The specified domain does not exist: %s.	The domain service does not exist: %s
406	AgentError.Account.GetentPasswdFailure	Failed to get the user list: %s.	Failed to obtain the domain user list: %s
406	AgentError.Account.GetUserListFailure	Get user list fail: %s	Failed to query the list of users: %s
406	EcsError	An error occurred while calling the ECS API operation.	An error occurred while calling the ECS API operation.
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	The request has failed due to a temporary failure of the server.

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