All Products
Search

This Product

    AnalyticDB:CreateDBResourceGroup

    Document Center

    AnalyticDB:CreateDBResourceGroup

    Last Updated:Mar 03, 2026

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

    Operation description

    For the endpoint of this service, see Endpoints.

    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 length cannot exceed 255 characters.

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

    • 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, see Resource group management.

    Job

    MinComputeResource

    string

    No

    The minimum reserved computing resources, in ACU.

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

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

    0ACU

    MaxComputeResource

    string

    No

    The maximum reserved computing resources, in ACU.

    • If the resource group type is Interactive, the maximum reserved computing resources are the currently unallocated resources in the cluster, with a step size of 16 ACU.

    • If the resource group type is Job, the maximum reserved computing resources are the currently unallocated resources in the cluster, with a step size of 8 ACU.

    48ACU

    ClusterSizeResource

    string

    No

    Reserved parameter (not applicable).

    无

    MinClusterCount

    integer

    No

    Reserved parameter (not applicable).

    无

    MaxClusterCount

    integer

    No

    Reserved parameter (not applicable).

    无

    ClusterMode

    string

    No

    Reserved parameter (not applicable).

    无

    EnableSpot

    boolean

    No

    Specifies whether to enable the spot instance feature for the resource group. Enable Spot Instances for the resource group to reduce unit costs. But resouces may be reclaimed. Only Job resource groups can enable this feature. Valid values:

    • True: Enable.

    • False: Disable.

    True

    RegionId

    string

    No

    The region ID.

    Note

    Call the DescribeRegions API to query the region ID of an AnalyticDB for MySQL cluster.

    cn-hangzhou

    Rules

    array<object>

    No

    Job delivery rules.

    object

    No

    The list of rule information.

    GroupName

    string

    No

    The name of the resource group.

    • The length cannot exceed 255 characters.

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

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

    test_group

    QueryTime

    string

    No

    The query running 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): AnalyticDB for MySQL engine.

    • SparkWarehouse: SparkWarehouse engine.

    SparkWarehouse

    EngineParams

    object

    No

    Engine configuration.

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

    AutoStopInterval

    string

    No

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

    5m

    SpecName

    string

    No

    Reserved parameter, not applicable.

    预留参数，不涉及。

    MinGpuQuantity

    integer

    No

    Reserved parameter, not applicable.

    预留参数，不涉及。

    MaxGpuQuantity

    integer

    No

    Reserved parameter, not applicable.

    预留参数，不涉及。

    TargetResourceGroupName

    string

    No

    Reserved parameter, not applicable.

    预留参数，不涉及。

    RayConfig

    object

    No

    Ray configuration information (required if the resource group is an AI resource group and the deployment mode is RayCluster).

    EnableUserEni

    boolean

    No

    HeadSpecType

    string

    No

    HeadSpec

    string

    No

    Head node specifications.

    xlarge

    HeadAllocateUnit

    string

    No

    HeadDiskCapacity

    string

    No

    Category

    string

    No

    The type of the Ray cluster. Valid values:

    • BASIC: Basic type, not high availability.

    • HIGH_AVAILABILITY: High availability type.

    BASIC

    WorkerGroups

    array<object>

    No

    The list of Ray Worker group configuration information.

    object

    No

    Ray Worker group configuration information.

    GroupName

    string

    No

    The name of the Ray 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 each Worker.

    100G

    WorkerSpecName

    string

    No

    The resource specifications of the Ray Worker.

    xlarge

    WorkerSpecType

    string

    No

    The resource type of the Ray Worker.

    GPU

    GpuElasticPlan

    object

    No

    Enabled

    boolean

    No

    Rules

    array<object>

    No

    object

    No

    StartCronExpression

    string

    No

    EndCronExpression

    string

    No

    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.