DocsICP FilingConsole
官方文档
首页

CreateDBResourceGroup

更新时间：
复制 MD 格式
我的收藏

Create a resource group for an Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.

Operation description

For the service endpoint, see endpoint.

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

adb:CreateDBResourceGroup

create

*DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

 None None

Request parameters

Parameter

Type

Required

Description

Example
DBClusterId

string

Yes

The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.

amv-bp11q28kvl688****
GroupName

string

Yes

The name of the resource group. The name must meet the following requirements:

  • The name can be up to 255 characters in length.

  • It must start with a digit, an uppercase letter, or a lowercase letter.

  • It can contain digits, uppercase letters, lowercase letters, hyphens (-), and underscores (_).

test_group
GroupType

string

Yes

The type of the resource group. Valid values:

  • Interactive

  • Job

Note

For more information about resource groups for the Data Lakehouse Edition, see Introduction to resource groups (Data Lakehouse Edition).

Job
MinComputeResource

string

No

The minimum amount of reserved computing resources, in ACUs.

  • If GroupType is set to Interactive, the minimum value is 16 ACUs.

  • If GroupType is set to Job, the minimum value is 0 ACUs.

0ACU
MaxComputeResource

string

No

The maximum amount of reserved computing resources, in ACUs. The value cannot exceed the unallocated resources of the cluster.

  • If GroupType is set to Interactive, the value must be a multiple of 16 ACUs.

  • If GroupType is set to Job, the value must be a multiple of 8 ACUs.

48ACU
ClusterSizeResource

string

No

This parameter is reserved.

-
MinClusterCount

integer

No

This parameter is reserved.

-

MaxClusterCount

integer

No

This parameter is reserved.

-
ClusterMode

string

No

This parameter is reserved.

-
EnableSpot

boolean

No

Specifies whether to enable the spot instance feature for the resource group. When this feature is enabled, resources are provided at a lower price but may be reclaimed. Only Job resource groups support this feature. Valid values:

  • True: enables the spot instance feature.

  • False: disables the spot instance feature.

True
RegionId

string

No

The region ID.

Note

You can call the DescribeRegions operation to query the region ID of an AnalyticDB for MySQL Data Lakehouse Edition (3.0) cluster.

cn-hangzhou
Rules

array<object>

No

The job submission rules.

object

No

A list of rules.

GroupName

string

No

The name of the source resource group.

  • The name can be up to 255 characters in length.

  • It must start with a digit, an uppercase letter, or a lowercase letter.

  • It can contain digits, uppercase letters, lowercase letters, hyphens (-), and underscores (_).

test_group
QueryTime

string

No

The query execution time threshold, in milliseconds (ms).

180000

TargetGroupName

string

No

The name of the target resource group.

job

Engine

string

No

The database engine. Valid values:

  • AnalyticDB (default): the AnalyticDB for MySQL engine.

  • SparkWarehouse: the SparkWarehouse engine.

SparkWarehouse
EngineParams

object

No

The engine configuration.

{\"spark.adb.version\":\"3.5\"}
AutoStopInterval

string

No

The auto-stop interval, in minutes (m).

5m
SpecName

string

No

The specification name.

ADB.MLLarge.2
MinGpuQuantity

integer

No

The minimum number of GPUs.

1
MaxGpuQuantity

integer

No

The maximum number of GPUs.

2
TargetResourceGroupName

string

No

The name of the target resource group.

test
RayConfig

object

No

The Ray configuration.

Note

This parameter is required if the resource group is an AI resource group and the engine is RayCluster.

EnableUserEni

boolean

No

Specifies whether to enable user-defined elastic network interfaces (ENIs).

HeadSpecType

string

No

The resource type of the head node.

CPU
HeadSpec

string

No

The specifications of the head node.

xlarge
HeadAllocateUnit

string

No

The allocation unit of the head node.

1
HeadDiskCapacity

string

No

The disk size of the head node.

100G
Category

string

No

The type of the Ray cluster. Valid values:

  • BASIC: a basic, non-high-availability cluster.

  • HIGH_AVAILABILITY: a high-availability cluster.

BASIC
WorkerGroups

array<object>

No

A list of Ray worker group configurations.

object

No

A Ray worker group configuration.

GroupName

string

No

The name of the worker group.

test
AllocateUnit

string

No

The allocation unit.

1
MaxWorkerQuantity

integer

No

The maximum number of worker nodes.

2
MinWorkerQuantity

integer

No

The minimum number of worker nodes.

1
WorkerDiskCapacity

string

No

The disk size of each worker node.

100G
WorkerSpecName

string

No

The specifications of the worker node.

xlarge
WorkerSpecType

string

No

The resource type of the worker node.

GPU
UserDefinedRequirements

string

No

GpuElasticPlan

object

No

The time-based scaling plan for GPUs.

Enabled

boolean

No

Specifies whether to enable the scaling plan immediately after it is created. Valid values:

  • true: Enables the plan immediately.

  • false: Does not enable the plan.

true
Rules

array<object>

No

A list of scaling rules.

object

No

A scaling rule.

StartCronExpression

string

No

The start time of the rule, specified as a Cron expression. The duration between the start and end times must be at least one hour.

0 0 2 * * ?
EndCronExpression

string

No

The end time of the rule, specified as a Cron expression. The duration between the start and end times must be at least one hour.

0 0 3 * * ?
ScalePolicy

string

No

The auto-scaling policy for the resource group. Valid values:

  • AutoScaling: Enables the AutoScaling policy.

  • Disable: Disables auto-scaling.

  • MultiCluster: Enables the MultiCluster policy.

AutoScaling
Classification

string

No

The classification of the resource group. Valid values:

  • SQL

  • SparkSQL

  • MultiCluster

  • AI

SQL

Response elements

Element

Type

Description

Example

object

The response schema.

RequestId

string

The request ID.

A94B6C02-7BD4-5D67-9776-3AC8317E8DD5

Examples

Success response

JSON format

{
  "RequestId": "A94B6C02-7BD4-5D67-9776-3AC8317E8DD5"
}

Error codes

HTTP status code

Error code

Error message

Description
400 InvalidPoolName.Malformed The specified parameter PoolName is not valid. The PoolName parameter is invalid. Check the parameter.
400 InvalidPoolUser.Malformed The specified parameter PoolUser is not valid. The PoolUser parameter is invalid. Check the parameter.
400 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.
400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. The DBClusterId parameter is invalid. Check the parameter.
400 InvalidPoolType.Malformed The specified parameter PoolType is not valid. The PoolType parameter is invalid. Check the parameter.
400 InvalidMinComputeResource.Malformed The specified parameter MinComputeResource is not valid. The MinComputeResource parameter is invalid. Check the parameter.
400 InvalidMaxComputeResource.Malformed The specified parameter MaxComputeResource is not valid. The MaxComputeResource parameter is invalid. Check the parameter.
400 ACS.ResourceGroup.InvalidResourceGroupState The state of this resource group does not support this operation. This operation is not supported due to the current state of the resource group.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.