All Products
Search

This Product

    AnalyticDB:CreateDBResourceGroup

    Document Center

    AnalyticDB:CreateDBResourceGroup

    Last Updated:Jul 01, 2026

    Creates a resource group for a specified Dedicated Edition, Basic Edition, or Data Lakehouse Edition cluster.

    Operation description

    For information about the service registration of this service, 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 Dedicated Edition, Basic Edition, or Data Lakehouse Edition cluster.

    amv-bp11q28kvl688****
    GroupName

    string

    Yes

    The name of the resource group.

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

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

    • The name 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 Data Lakehouse Edition resource groups, see Resource group overview (Data Lakehouse Edition).

    Job
    MinComputeResource

    string

    No

    The minimum amount of reserved computing resources. Unit: ACUs.

    • If the resource group type is Interactive, the minimum reserved computing resources is 16 ACUs.

    • If the resource group type is Job, the minimum reserved computing resources is 0 ACUs.

    0ACU
    MaxComputeResource

    string

    No

    The maximum amount of reserved computing resources. Unit: ACUs.

    • If the resource group type is Interactive, the maximum reserved computing resources is the current unallocated resources of the cluster, in increments of 16 ACUs.

    • If the resource group type is Job, the maximum reserved computing resources is the current unallocated resources of the cluster, in increments of 8 ACUs.

    48ACU
    ClusterSizeResource

    string

    No

    A reserved parameter (not applicable).

    -
    MinClusterCount

    integer

    No

    A reserved parameter (not applicable).

    -

    MaxClusterCount

    integer

    No

    A reserved parameter (not applicable).

    -
    ClusterMode

    string

    No

    A reserved parameter (not applicable).

    -
    EnableSpot

    boolean

    No

    Specifies whether to enable the spot instance feature for the resource group. After the spot instance feature is enabled, the unit price of resources is reduced, but the resources may be released. 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 IDs of AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters.

    cn-hangzhou
    Rules

    array<object>

    No

    The job routing rules.

    object

    No

    The list of rules.

    GroupName

    string

    No

    The name of the resource group.

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

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

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

    test_group
    QueryTime

    string

    No

    The query execution time threshold. Unit: milliseconds (ms).

    180000

    TargetGroupName

    string

    No

    The name of the destination 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 automatic stop interval. Unit: 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 destination resource group.

    test
    RayConfig

    object

    No

    The Ray configuration.

    Note

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

    EnableUserEni

    boolean

    No

    Specifies whether to enable user ENI connectivity.

    HeadSpecType

    string

    No

    The resource type of the head node.

    CPU
    HeadSpec

    string

    No

    The node 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 Ray cluster type. Valid values:

    • BASIC: basic type, non-high-availability

    • HIGH_AVAILABILITY: high-availability type

    BASIC
    WorkerGroups

    array<object>

    No

    The list of Ray worker group configurations.

    object

    No

    The 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 workers.

    2
    MinWorkerQuantity

    integer

    No

    The minimum number of workers.

    1
    WorkerDiskCapacity

    string

    No

    The disk size of the worker node.

    100G
    WorkerSpecName

    string

    No

    The node specifications of the worker node.

    xlarge
    WorkerSpecType

    string

    No

    The resource type of the worker node.

    GPU
    UserDefinedRequirements

    string

    No

    GpuElasticPlan

    object

    No

    The GPU time-sharing elastic plan.

    Enabled

    boolean

    No

    Specifies whether to enable the elastic plan immediately after creation. Valid values:

    • true: enables the elastic plan immediately.

    • false: does not enable the elastic plan.

    true
    Rules

    array<object>

    No

    The list of rules.

    object

    No

    The rule.

    StartCronExpression

    string

    No

    The start time as a cron expression. The interval must be at least 1 hour.

    0 0 2 * * ?
    EndCronExpression

    string

    No

    The end time as a cron expression. The interval must be at least 1 hour.

    0 0 3 * * ?
    ScalePolicy

    string

    No

    The scaling policy of the resource group. Valid values:

    • AutoScaling: enables the AutoScaling automatic scaling policy.

    • Disable: disables automatic scaling.

    • MultiCluster: enables the MultiCluster automatic scaling policy.

    AutoScaling
    Classification

    string

    No

    The classification of the resource group. Valid values:

    • SQL

    • SparkSQL

    • MultiCluster

    • AI

    SQL
    AtmConfig

    object

    No

    SelectNodeSpec

    string

    No

    8ACU
    SelectNodeNum

    integer

    No

    1
    SelectNodeCacheSize

    integer

    No

    10
    StorageNodeSpec

    string

    No

    8ACU
    StorageNodeNum

    integer

    No

    2
    StorageNodeDiskSize

    integer

    No

    1
    StorageNodeDiskType

    string

    No

    essd_pl1
    InsertNodeSpec

    string

    No

    8ACU
    InsertNodeNum

    integer

    No

    2
    AuthNodeSpec

    string

    No

    8ACU
    AuthNodeNum

    integer

    No

    2

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    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.