Build a Serverless Resource Group via API - DataWorks - Alibaba Cloud - DataWorks

Creates a resource group.

Operation description

You must purchase DataWorks Basic Edition or higher to use this operation.
Before you call this operation, make sure that you understand how general-purpose resource groups in DataWorks are billed and review the pricing.
Before you call this operation, make sure that you have created the AliyunServiceRoleForDataWorks service-linked role.

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

create

*DwResourceGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the general-purpose resource group. It must be up to 128 characters long, start with a letter, and contain only letters, digits, and underscores (_).	common_resource_group
Remark	string	No	The remark for the general-purpose resource group. It can be up to 128 characters long and can contain letters, Chinese characters, digits, and underscores (_).	Create a serverless resource group for common tasks
PaymentType	string	Yes	The billing method of the resource group. `PrePaid` indicates subscription, and `PostPaid` indicates pay-as-you-go.	PrePaid
PaymentDurationUnit	string	No	The unit of the subscription duration. Valid values: `Month` and `Year`.	Month
PaymentDuration	integer	No	The subscription duration.	1
AutoRenewEnabled	boolean	No	Specifies whether to enable auto-renewal for the subscription.
Spec	integer	No	The specification of the resource group, in CUs. This parameter is required when `PaymentType` is set to `PrePaid`.	2
VpcId	string	Yes	The ID of the VPC to be bound by default.	vpc-m2et4f3oc8m****
VswitchId	string	Yes	The ID of the vSwitch to be bound by default.	vsw-uf8usrhs7hjd9****
ClientToken	string	Yes	A client token to ensure the idempotence of the request.	eb870033-74c8-4b1b-9664-04c4e7cc3465
AliyunResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-aek2kqofrgXXXXX
AliyunResourceTags	array<object>	No	The list of Alibaba Cloud tags.
	object	No	An Alibaba Cloud tag.
Key	string	No	The tag key.	key
Value	string	No	The tag value.	value

Response elements

Element	Type	Description	Example
	object	The returned data.
Success	boolean	Indicates whether the request was successful.	true
ResourceGroupOrder	object	Information about the resource group creation order.
OrderId	integer	The ID of the resource group creation order.	2391982058XXXXX
OrderInstanceId	string	The instance ID of the resource group creation order.	c442b330-3b10-4584-959e-736e4edXXXXX
Id	string	The unique identifier of the general-purpose resource group.	Serverless_res_group_524257424564736_6831777003XXXXX
RequestId	string	The request ID. You can use this ID to locate logs and troubleshoot issues.	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Examples

Success response

JSON format

{
  "Success": true,
  "ResourceGroupOrder": {
    "OrderId": 0,
    "OrderInstanceId": "c442b330-3b10-4584-959e-736e4edXXXXX",
    "Id": "Serverless_res_group_524257424564736_6831777003XXXXX"
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.