DsgUserGroupQueryUserList-DataWorks(DataWorks)-阿里云帮助中心

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

dataworks:DsgUserGroupQueryUserList

list

*All Resource

*

None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	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 list of users or roles.
	object
AccountName	string	The username.	user1
YunAccount	string	The Alibaba Cloud account name or RAM role name. Use this value when the user group is created by an Alibaba Cloud account or a RAM role.	user:user1
AccountType	integer	The user type. 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 account ID. Required when a RAM user is used.	123
RequestId	string	The request ID.	102400001

Examples

Success response

JSON format

{
  "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.
500	UNKNOWN.ERROR	unknown error.	Unknown error.
403	PERMISSION.DENIED.ERROR	Permission denied	Insufficient permissions.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.