ListResourceGroups API Overview - DataWorks - Alibaba Cloud - DataWorks

Queries a list of resource groups.

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

list

*DwResourceGroup

acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of a resource group, which is used for fuzzy match.	Resource
ProjectId	integer	No	The ID of the DataWorks workspace.	1000
Statuses	array	No	The statuses of resource groups.
	string	No	The status of resource groups. Valid values: Normal: The resource group is running or in use. Stop: The resource group has expired. Deleted: The resource group is released or destroyed. Creating: The resource group is being created. CreateFailed: The resource group fails to be created. Updating: The resource group is being scaled in or out, or its configurations are being changed. UpdateFailed: The resource group fails to be scaled out or upgraded. Deleting: The resource group is being released or destroyed. DeleteFailed: The resource group fails to be released or destroyed. Timeout: The operations that are performed on the resource group time out. Freezed: The resource group is frozen. Starting	Normal
ResourceGroupTypes	array	No	The types of resource groups to query. If you do not configure this parameter, only serverless resource groups are returned by default.
	string	No	Resource group types: CommonV2: serverless resource group ExclusiveDataIntegration: exclusive resource group for Data Integration ExclusiveScheduler: exclusive resource group for scheduling ExclusiveDataService: exclusive resource group for DataService Studio	CommonV2
PaymentType	string	No	The billing method of resource groups. Valid values: PrePaid PostPaid	PrePaid
AliyunResourceGroupId	string	No	Alibaba Cloud Resource Group ID	rg-aek2kqofrgXXXXX
AliyunResourceTags	array<object>	No	Alibaba Cloud tag list
	object	No	Alibaba Cloud label
Key	string	No	Tag Key	key
Value	string	No	Tag Value	value
PageSize	integer	No	The number of entries per page.	100
PageNumber	integer	No	The page number.	1
SortBy	string	No	The list of fields used for sorting. Fields such as TriggerTime and StartedTime are supported. You must configure this parameter in the Sorting field + Sort by (Desc/Asc). By default, results are sorted in ascending order. Valid values: Id (Desc/Asc): the resource group ID Name (Desc/Asc): the name of the resource group Remark (Desc/Asc): the remarks of the resource group Type (Desc/Asc): the type of the resource group Status (Desc/Asc): the status of the resource group Spec (Desc/Asc): the specifications of the resource group CreateUser (Desc/Asc): the creator of the resource group CreateTime (Desc/Asc): the time when the resource group is created Default value: CreateTime Asc	CreateTime Asc

Response elements

Element	Type	Description	Example
	object	Schema of Response
Success	boolean	Indicates whether the request was successful. Valid values: true and false.	true
PagingInfo	object	The pagination information.
ResourceGroupList	array<object>	The resource groups returned.
	array<object>	The details about a resource group.
Id	string	Unique identifier of a resource group	Serverless_res_group_524257424564736_6831777003XXXXX
Name	string	The name of the resource group.	common_resource_group
Remark	string	The description of the resource group.	Create a general-purpose resource group for common tasks
PaymentType	string	The billing method of the resource group. Valid values: PrePaid and PostPaid. The value PrePaid indicates the subscription billing method, and the value PostPaid indicates the pay-as-you-go billing method.	PrePaid
Status	string	The status of the resource group. Valid values: Normal: The resource group is running or in use. Stop: The resource group is expired. Deleted: The resource group is released or destroyed. Creating: The resource group is being created. CreateFailed: The resource group fails to be created. Updating: The resource group is being scaled in or out, or the configurations of the resource group are being changed. UpdateFailed: The resource group fails to be scaled out or upgraded. Deleting: The resource group is being released or destroyed. DeleteFailed: The resource group fails to be released or destroyed. Timeout: The operations that are performed on the resource group time out. Freezed: The resource group is frozen. Starting: The resource group is being started.	Normal
Spec	object	Resource Group specifications
Standard	string	Specification details	2CU
Amount	integer	Quantity	1
ResourceGroupType	string	Resource group types: CommonV2: Serverless resource group ExclusiveDataIntegration: Exclusive resource group for Data Integration ExclusiveScheduler: Exclusive resource group for scheduling ExclusiveDataService: Exclusive resource group for DataService Studio	CommonV2
OrderInstanceId	string	The order instance ID of the resource group.	c442b330-3b10-4584-959e-736e4edXXXXX
CreateUser	string	The ID of the user who created the resource group.	11075500042XXXXX
CreateTime	integer	The creation time, which is a 64-bit timestamp.	1727055811000
DefaultVpcId	string	Default VPC ID bound to a common resource group	vpc-m2et4f3oc8msfbccXXXXX
DefaultVswicthId	string	The default switch ID bound to the common resource group.	vsw-uf8usrhs7hjd9amsXXXXX
AliyunResourceGroupId	string	Alibaba Cloud Resource Group ID	rg-aek2kqofrgXXXXX
AliyunResourceTags	array<object>	Alibaba Cloud tag list
	object
Key	string	Tag Key	Key
Value	string	Tag Value	Value
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	100
TotalCount	integer	All data entries	100
RequestId	string	The request ID. You can use the ID to query logs and troubleshoot issues.	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Examples

Success response

JSON format

{
  "Success": true,
  "PagingInfo": {
    "ResourceGroupList": [
      {
        "Id": "Serverless_res_group_524257424564736_6831777003XXXXX",
        "Name": "common_resource_group",
        "Remark": "Create a general-purpose resource group for common tasks",
        "PaymentType": "PrePaid",
        "Status": "Normal",
        "Spec": {
          "Standard": "2CU",
          "Amount": 1
        },
        "ResourceGroupType": "CommonV2",
        "OrderInstanceId": "c442b330-3b10-4584-959e-736e4edXXXXX",
        "CreateUser": "11075500042XXXXX",
        "CreateTime": 1727055811000,
        "DefaultVpcId": "vpc-m2et4f3oc8msfbccXXXXX",
        "DefaultVswicthId": "vsw-uf8usrhs7hjd9amsXXXXX",
        "AliyunResourceGroupId": "rg-aek2kqofrgXXXXX",
        "AliyunResourceTags": [
          {
            "Key": "Key",
            "Value": "Value"
          }
        ]
      }
    ],
    "PageNumber": 1,
    "PageSize": 100,
    "TotalCount": 100
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.