MaxCompute:ListUsers - MaxCompute - Alibaba Cloud - MaxCompute

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

odps:ListUsers

list

*全部资源

*

None

Request syntax

GET /api/v1/users HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
pageNumber	integer	No	页码	1
pageSize	integer	No	每页返回数目	10

Response elements

Element	Type	Description	Example
	object	PopResult<ListResultDTO<UserAccount, DefaultPageInfo>>
requestId	string	请求 id	0a06dd4816687424611405643e3730
data	object	返回数据
users	array<object>	用户列表
	object	用户列表
accountId	string	账号 ID	16783562****
accountName	string	账号名称	Bob@
displayName	string	显示名称	Bob
accountType	string	账号类型	ALIYUN
tenantId	string	租户 ID	1567253789
totalCount	integer	返回结果的总数量。	64
pageNumber	integer	当前页码。	2
pageSize	integer	每页显示条数。	10

Examples

Success response

JSON format

{
  "requestId": "0a06dd4816687424611405643e3730",
  "data": {
    "users": [
      {
        "accountId": "16783562****",
        "accountName": "Bob@",
        "displayName": "Bob",
        "accountType": "ALIYUN",
        "tenantId": "1567253789"
      }
    ],
    "totalCount": 64,
    "pageNumber": 2,
    "pageSize": 10
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.