DocsICP FilingConsole
Documentation

GetResourceGroup

Updated at:
Copy as MD
Product
My Favorites

Retrieves the information of a specified resource group by ID.

Operation description

You must purchase DataWorks Basic Edition or a higher edition 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 None

Request parameters

Parameter

Type

Required

Description

Example
Id

string

Yes

The unique identifier 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 detailed information of the resource group.

Id

string

The unique identifier of the resource group.

Serverless_res_group_524257424564736_6831777003XXXXX
Name

string

The name of the resource group.

common_resource_group
Remark

string

The remarks of the resource group.

Create a common resource group for common tasks
PaymentType

string

The billing method of the resource group. Valid values:

  • PrePaid: subscription.

  • PostPaid: pay-as-you-go.

PrePaid
Status

string

The status of the resource group. Valid values:

  • Normal: normal (running/in service).

  • Stop: frozen (expired).

  • Deleted: deleted (released/destroyed).

  • Creating: being created.

  • CreateFailed: creation failed.

  • Updating: being updated (scaling out/scaling in/specification change in progress).

  • UpdateFailed: update failed (scale-out failed/upgrade failed).

  • Deleting: being deleted (being released/being destroyed).

  • DeleteFailed: deletion failed (release failed/destruction failed).

  • Timeout: operation timed out.

  • Freezed: frozen.

  • Starting: starting.

Valid values:

  • Creating :

    Being created.

  • Stop :

    Frozen (expired)

  • Timeout :

    Operation timed out.

  • DeleteFailed :

    Deletion failed (release failed/destruction failed)

  • UpdateFailed :

    Update failed (scale-out failed/upgrade failed)

  • Updating :

    Being updated (scaling out/scaling in/specification change in progress)

  • Deleted :

    Deleted (released/destroyed)

  • Normal :

    Normal (running/in service)

  • Deleting :

    Being deleted (being released/being destroyed)

  • CreateFailed :

    Creation failed.

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: new-version resource group.

  • ExclusiveDataIntegration: exclusive data integration resource group.

  • ExclusiveScheduler: exclusive scheduling resource group.

  • ExclusiveDataService: exclusive data service resource group.

Valid values:

  • CommonV2 :

    New-version resource group.

  • ExclusiveDataIntegration :

    Exclusive data integration resource group.

  • ExclusiveScheduler :

    Exclusive scheduling resource group.

  • ExclusiveDataService :

    Exclusive data service resource group.

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, represented as a 64-bit timestamp.

1727055811000
DefaultVpcId

string

The ID of the default VPC bound to the resource group.

vpc-m2et4f3oc8msfbccXXXXX
DefaultVswitchId

string

The ID of the default vSwitch bound to the resource group.

vsw-uf8usrhs7hjd9amsXXXXX
AliyunResourceGroupId

string

The ID of the Alibaba Cloud resource group to which the resource group belongs.

rg-aek2kqofrgXXXXX
AliyunResourceTags

array<object>

The list of Alibaba Cloud tags.

object

The Alibaba Cloud tag.

Key

string

The tag key.

key
Value

string

The tag value.

value
RequestId

string

The ID of the request, which is used to locate logs and troubleshoot issues.

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 common 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.