All Products
Search
Document Center

DataWorks:DsgUserGroupQueryUserList

Last Updated:Oct 17, 2024

Queries a list of users or roles of the current tenant.

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

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
ErrorCodestring

The error code.

1029030003
ErrorMessagestring

The error message.

param error
HttpStatusCodeinteger

The HTTP status code.

400
Dataarray<object>

The returned result.

Datasobject
AccountNamestring

The name of the user.

user1
YunAccountstring

The name of the Alibaba Cloud account or RAM role. The return value of this parameter must be used if the user group is created by using an Alibaba Cloud account or a RAM role.

user:user1
AccountTypeinteger

The type of the user. Valid values:

  • 1 to 5: Alibaba Cloud account
  • 6: RAM role
2
BaseIdstring

The user ID or role ID.

234
ParentAccountIdstring

The parent user ID. This parameter is required if a RAM user is used.

123
RequestIdstring

The request ID.

102400001

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "Data": [
    {
      "AccountName": "user1",
      "YunAccount": "user:user1",
      "AccountType": 2,
      "BaseId": "234",
      "ParentAccountId": "123"
    }
  ],
  "RequestId": "102400001"
}

Error codes

HTTP status codeError codeError messageDescription
400USERGROUP.ACCOUNTLISTSIZE.ERRORThe number of account exceeds the limit.The number of users exceeds the limit
400USERGROUP.ID.ERRORThe user group ID does not match the tenant or does not exist.The user group ID does not exist or does not belong to the tenant.
400USERGROUP.LISTSIZE.ERRORThe number of user groups exceeds the limit.The number of user groups exceeds the limit
400USERGROUP.PAGESIZE.ERRORPage size is too large, maximum of 100.Page size limit, up to 100
400USERACCOUNT.OWNER.ERRORUser list or owner user does not exist.User list or responsible user does not exist
400PARAMS.ERRORparam error.-
403PERMISSION.DENIED.ERRORPermission deniedInsufficient permissions.
500UNKNOWN.ERRORunknown error.Unknown error.

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