All Products
Search
Document Center

Elastic High Performance Computing:ListUsers

Last Updated:Apr 11, 2024

Queries all users of a cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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:ListUsersREAD
  • 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-FYUr32****
PageNumberintegerNo

The page number of the page to return.

Pages start from page 1.

Default value: 1.

1
PageSizeintegerNo

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

Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page.

1
RequestIdstring

The request ID.

04F0F334-1335-436C-A1D7-6C044FE7****
PageNumberinteger

The page number returned.

1
TotalCountinteger

The total number of returned entries.

1
Usersobject []

The list of users.

Namestring

The username of the account.

user1
AddTimestring

The time when the user was created.

2018-07-18T17:46:47
Groupstring

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.
wheel

Examples

Sample success responses

JSONformat

{
  "PageSize": 1,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
  "PageNumber": 1,
  "TotalCount": 1,
  "Users": {
    "UserInfo": [
      {
        "Name": "user1",
        "AddTime": "2018-07-18T17:46:47",
        "Group": "wheel"
      }
    ]
  }
}

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