GetResourceGroup API Overview & Resource Group Attributes - DataWorks - Alibaba Cloud - DataWorks

Queries the information about a resource group based on its ID.

Operation description

DataWorks Basic Edition or a more advanced edition is required to use this feature.

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

get

*DwResourceGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
Id	string	Yes	The ID of the resource group.	Serverless_res_group_524257424564736_6831777003XXXXX

Response elements

Element	Type	Description	Example
	object	Schema of Response
Success	boolean	Indicates whether the request was successful.	true
ResourceGroup	object	The details about the resource group.
Id	string	The ID of the 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	The specifications of the resource group.
Standard	string	The number of compute units (CUs) in the resource group.	2CU
Amount	integer	The number of resources in the resource group.	1
ResourceGroupType	string	The type of the resource group. Valid values: 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 instance ID of the order that is used to create the resource group.	c442b330-3b10-4584-959e-736e4edXXXXX
CreateUser	string	The ID of the account that is used to create the resource group.	11075500042XXXXX
CreateTime	integer	The time when the resource group was created. The value is a 64-bit timestamp.	1727055811000
DefaultVpcId	string	The ID of the virtual private cloud (VPC) with which the resource group is associated by default.	vpc-m2et4f3oc8msfbccXXXXX
DefaultVswitchId	string	The ID of the vSwitch with which the resource group is associated by default.	vsw-uf8usrhs7hjd9amsXXXXX
AliyunResourceGroupId	string	The ID of the Alibaba Cloud resource group.	rg-aek2kqofrgXXXXX
AliyunResourceTags	array<object>	The tags.
	object	The tag.
Key	string	The tag key.	key
Value	string	The tag value.	value
RequestId	string	The request ID.	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Examples

Success response

JSON format

{
  "Success": true,
  "ResourceGroup": {
    "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",
    "DefaultVswitchId": "vsw-uf8usrhs7hjd9amsXXXXX",
    "AliyunResourceGroupId": "rg-aek2kqofrgXXXXX",
    "AliyunResourceTags": [
      {
        "Key": "key",
        "Value": "value"
      }
    ]
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.