DsgUserGroupQueryUserList - DataWorks - Alibaba Cloud Documentation Center

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:DsgUserGroupQueryUserList	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example

The current API does not require request parameters

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
ErrorCode	string	The error code.	1029030003
ErrorMessage	string	The error message.	param error
HttpStatusCode	integer	The HTTP status code.	400
Data	array<object>	The returned result.
Datas	object
AccountName	string	The name of the user.	user1
YunAccount	string	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
AccountType	integer	The type of the user. Valid values: 1 to 5: Alibaba Cloud account 6: RAM role	2
BaseId	string	The user ID or role ID.	234
ParentAccountId	string	The parent user ID. This parameter is required if a RAM user is used.	123
RequestId	string	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 code	Error code	Error message	Description
400	USERGROUP.ACCOUNTLISTSIZE.ERROR	The number of account exceeds the limit.	The number of users exceeds the limit
400	USERGROUP.ID.ERROR	The 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.
400	USERGROUP.LISTSIZE.ERROR	The number of user groups exceeds the limit.	The number of user groups exceeds the limit
400	USERGROUP.PAGESIZE.ERROR	Page size is too large, maximum of 100.	Page size limit, up to 100
400	USERACCOUNT.OWNER.ERROR	User list or owner user does not exist.	User list or responsible user does not exist
400	PARAMS.ERROR	param error.	-
403	PERMISSION.DENIED.ERROR	Permission denied	Insufficient permissions.
500	UNKNOWN.ERROR	unknown error.	Unknown error.

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