Use the ListUsers API to query users in a cluster - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ehpc:ListUsers

*All Resource

*

None

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-FYUr32****
PageNumber	integer	No	The page number to return. Pages start from 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	1
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE7****
PageNumber	integer	The page number returned.	1
TotalCount	integer	The total number of returned entries.	1
Users	object
UserInfo	array<object>	The list of users.
	object
Name	string	The username.	user1
AddTime	string	The time when the user was created.	2018-07-18T17:46:47
Group	string	The name of the permission group. Valid values: users: an ordinary permission group, applicable to users who only need to submit and debug jobs. wheel: a sudo permission group, applicable to administrators who manage the cluster. In addition to submitting and debugging jobs, users with sudo permissions can run sudo commands to install software and restart nodes.	wheel

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
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.
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.
406	AgentError	The agent service request failed.	The cluster-side command failed to run. %s
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
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.