GetResourceGroup - DataWorks - Alibaba Cloud Documentation Center

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

Operation description

You can use this API operation only in DataWorks Basic Edition or an advanced edition.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example

The current API does not require request parameters

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
ResourceGroup	object	The details about the resource group.
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 started. CreateFailed: The resource group fails to be started. 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.	Normal
Spec	object	The specifications of the resource group.
Amount	integer	The number of resources in the resource group.	1
ResourceGroupType	string	The type 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

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "ResourceGroup": {
    "Id": "Serverless_res_group_524257424564736_6831777003XXXXX",
    "Name": "common_resource_group",
    "Remark": "",
    "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"
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

Error codes

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