All Products
Search
Document Center

MaxCompute:ListUsers

Last Updated:Dec 16, 2024

Obtains users in a MaxCompute project.

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:
    • 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
odps:ListUserslist
*All Resources
*
    none
none

Request syntax

GET /api/v1/users HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
pageNumberintegerNo

The number of the page to return.

1
pageSizeintegerNo

The number of entries to return on each page.

10

Response parameters

ParameterTypeDescriptionExample
object

PopResult<ListResultDTO<UserAccount, DefaultPageInfo>>

requestIdstring

The ID of the request.

0a06dd4816687424611405643e3730
dataobject

The returned data.

usersarray<object>

The users.

usersobject

The users.

accountIdstring

The ID of the Alibaba Cloud account.

167835629082
accountNamestring

The username of the account.

Bob@
displayNamestring

The display name.

Bob
accountTypestring

The type of the account.

ALIYUN
tenantIdstring

The ID of the tenant.

1567253789
totalCountinteger

The total number of returned entries.

64
pageNumberinteger

The page number of the returned page.

2
pageSizeinteger

The number of entries returned per page.

10

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2024-08-26The internal configuration of the API is changed, but the call is not affectedView Change Details