Query DSG User Groups with DsgUserGroupQueryList - DataWorks - Alibaba Cloud - DataWorks

Queries the list of user groups in Data Security Guard.

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:DsgUserGroupQueryList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of entries to return on each page. Maximum value: 100.	10
Name	string	No	The keyword of the user group name. The platform performs a fuzzy match based on the keyword to query related user group information.	yun_group
Owner	string	No	The owner of the user group.	user1
ProjectName	string	No	The name of the engine. You can configure this parameter to query MaxCompute user group information.	dev_project
userGroupType	integer	No	The type of the user group. Valid values: 1: Alibaba Cloud user. 2: RAM role. 3: MaxCompute role.

Response elements

Element	Type	Description	Example
	object	OpenApiResultModel<PagingResultModel>
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call fails.	true
ErrorCode	string	The error code.	1029030003
ErrorMessage	string	The error message.	param error
HttpStatusCode	integer	The HTTP status code.	400
PageData	object	The paginated query results.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries to return on each page. Maximum value: 100.	10
TotalCount	integer	The total number of returned user groups.	100
Data	array<object>	The list of user groups.	{ "accounts": [ "role_project_scheduler" ], "gmtCreate": "2024-05-10 15:22:18", "gmtModified": "2024-05-10 15:22:18", "id": 1955, "name": "dsg_fin_test-复制", "owner": "UAT" }
	object	The user group information.
Accounts	array	The collection of usernames in the user group.
	string	The username.	user1
Id	integer	The ID of the user group.	123
GmtCreate	string	The creation time of the user group.	2024-05-10 17:14:44
GmtModified	string	The update time of the user group.	2024-05-10 17:14:44
Name	string	The name of the user group.	test_group
Owner	string	The owner of the user group.	user1
mcAggregationInfo	string	The MaxCompute aggregation information.
RequestId	string	The ID of the request. You can use the ID to locate logs and troubleshoot issues.	102400001

Examples

Success response

JSON format

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "PageData": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Data": [
      {
        "Accounts": [
          "user1"
        ],
        "Id": 123,
        "GmtCreate": "2024-05-10 17:14:44",
        "GmtModified": "2024-05-10 17:14:44",
        "Name": "test_group",
        "Owner": "user1",
        "mcAggregationInfo": ""
      }
    ]
  },
  "RequestId": "102400001"
}

Error codes

HTTP status code	Error code	Error message	Description
400	PARAMS.ERROR	param error.	The parameter is invalid.
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
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.