ListResourceGroups - DataWorks - Alibaba Cloud Documentation Center

Queries a list of resource groups of a specific type.

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:ListResourceGroups	get	TenantResourceGroup `acs:dataworks:{#regionId}:{#accountId}:exclusive_resource_group/`	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupType	integer	Yes	The type of the resource group that you want to query. Valid values: 0: DataWorks 1: scheduling 2: MaxCompute 3: Platform for AI (PAI) 4: Data Integration 7: exclusive resource group for scheduling (An ID is generated for the purchased resource when you purchase an exclusive resource group for scheduling.) 9: DataService Studio Default value: 1 If the value indicates a compute engine, the resource groups to query are the ones that were created when you purchased the compute engine.	3
Keyword	string	No	The keyword that is used for fuzzy match by resource group name and identifier.	abc
BizExtKey	string	No	The category of the resource group. Valid values: default (default): shared resource group single: exclusive resource group	default
ResourceManagerResourceGroupId	string	No	The resource group ID.	rg-acfmzbn7pti3zfa
Tags	array<object>	No	The tags.
	object	No
Key	string	No	The tag key.	Env
Value	string	No	The tag value.	Test

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	0bc1411515937635973****
Success	boolean	Indicates whether the request was successful.	true
Data	array<object>	The resource groups.
Data	object
Status	integer	The status of the resource group. Valid values: 0: NORMAL, which indicates that the resource group is running or in service. 1: STOP, which indicates that the resource group has expired and is frozen. 2: DELETED, which indicates that the resource group is released or destroyed. 3: CREATING, which indicates that the resource group is being created or started. 4: CREATE_FAILED, which indicates that the resource group fails to be created or started. 5: UPDATING, which indicates that the resource group is being scaled out or upgraded. 6: UPDATE_FAILED, which indicates that the resource group fails to be scaled out or upgraded. 7: DELETING, which indicates that the resource group is being released or destroyed. 8: DELETE_FAILED, which indicates that the resource group fails to be released or destroyed. 9: TIMEOUT, which indicates that the operation performed on the resource group times out. All operations may time out. This value is temporarily available only for DataService Studio.	0
UpdateTime	string	The time when the resource group was last updated.	Jul 9, 2018 2:43:37 PM
IsDefault	boolean	Indicates whether the resource group is the default resource group. Valid values: true: The resource group is the default resource group. false: The resource group is not the default resource group.	true
Cluster	string	The name of the cluster. This parameter is returned only if the type of the resource group is MaxCompute or PAI.	AY18G
EnableKp	boolean	Indicates whether the UID of an Alibaba Cloud account is used for access. Valid values: true: The MaxCompute compute engine uses the UID of the Alibaba Cloud account as the display name of the account for access. false: The MaxCompute compute engine uses the name of the Alibaba Cloud account as the display name of the account for access. The remaining values are useless. This parameter is returned only if the type of the resource group is MaxCompute.	false
ResourceGroupType	string	The type of the resource group. Valid values: 0: DataWorks 2: MaxCompute 3: PAI 4: Data Integration 7: scheduling 9: DataService Studio	3
CreateTime	string	The time when the cluster was created. Example: Jul 9, 2018 2:43:37 PM.	Jul 9, 2018 2:43:37 PM
Identifier	string	The identifier of the resource group.	e1815577-2f4e-4c5e-b29****
Mode	string	The mode of the resource group. Valid values: ISOLATE: exclusive resource group that adopts the subscription billing method SHARE: shared resource group that adopts the pay-as-you-go billing method DEVELOP: resource group for developers	SHARE
BizExtKey	string	The category of the resource group. Valid values: default: shared resource group single: exclusive resource group	default
Sequence	integer	The sequence number of the resource group. Created resource groups are sorted in ascending order by sequence number.	300
Specs	object	The details of the resource group. The content enclosed in braces {} is the details of the resource group.	{}
Name	string	The name of the resource group.	abc
Id	long	The resource group ID.	1234567
TenantId	long	The tenant ID.	1234567
ResourceManagerResourceGroupId	string	The ID of your Alibaba Cloud resource group.	rg-acfmzbn7pti3zfa
Tags	array<object>	The tags.
Tag	object
Key	string	The tag key.	Env
Value	string	The tag value.	Test

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "0bc1411515937635973****",
  "Success": true,
  "Data": [
    {
      "Status": 0,
      "UpdateTime": "Jul 9, 2018 2:43:37 PM",
      "IsDefault": true,
      "Cluster": "AY18G",
      "EnableKp": false,
      "ResourceGroupType": "3",
      "CreateTime": "Jul 9, 2018 2:43:37 PM",
      "Identifier": "e1815577-2f4e-4c5e-b29****",
      "Mode": "SHARE",
      "BizExtKey": "default",
      "Sequence": 300,
      "Specs": {},
      "Name": "abc",
      "Id": 1234567,
      "TenantId": 1234567,
      "ResourceManagerResourceGroupId": "rg-acfmzbn7pti3zfa",
      "Tags": [
        {
          "Key": "Env",
          "Value": "Test"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	The connection does not exist.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	The project does not exist.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	The user is not in the project.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	The user is not a project administrator or owner.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	The user is not in tenant.

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

Change history

Change time	Summary of changes	Operation
2022-12-13	The Error code has changed. The request parameters of the API has changed	View Change Details
2022-10-31	API Description Update. The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details