DocsICP FilingConsole
Documentation

DescribeDBResourceGroup

Updated at:
Copy as MD
My Favorites

Queries the resource group information of a cluster.

Operation description

For the endpoint of this service, see service registration 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:DescribeDBResourceGroup

list

*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

No

The name of the resource group.

Note

If you do not specify this parameter, information about all resource groups in the specified cluster is returned by default.

test_group
GroupType

string

No

The type of the resource group. Valid values:

  • Interactive

  • Job

Note

For more information about resource groups in Data Lakehouse Edition, see Resource group overview.

Job
RegionId

string

No

The region ID.

Note

You can call the DescribeRegions operation to query the region ID of the cluster.

cn-hangzhou

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

A94B6C02-7BD4-5D67-9776-3AC8317E8DD3
GroupsInfo

array<object>

The list of resource group information.

array<object>

The list of resource group information.

GroupType

string

The resource group type. Valid values:

  • Interactive

  • Job

Note

For more information about Data Lakehouse Edition resource groups, see Resource group overview (Data Lakehouse Edition).

Job
GroupName

string

The name of the resource group.

test1
MinComputeResource

string

The minimum reserved compute resources. Unit: ACU.

0ACU
MaxComputeResource

string

The maximum reserved compute resources. Unit: ACU.

512ACU
ClusterSizeResource

string

The reserved parameter. This parameter is not applicable.

Reserved parameter
MinClusterCount

integer

The reserved parameter. This parameter is not applicable.

Reserved parameter
MaxClusterCount

integer

The reserved parameter. This parameter is not applicable.

Reserved parameter
RunningClusterCount

integer

The reserved parameter. This parameter is not applicable.

Reserved parameter
ClusterMode

string

The reserved parameter. This parameter is not applicable.

Reserved parameter
ElasticMinComputeResource

string

The minimum elastic compute resources. Unit: ACU.

16ACU
EnableSpot

string

Specifies whether to enable the spot instance feature for the resource group. After you enable this feature, the unit price of resources decreases, but the instances may be released. Valid values:

  • True: enables the spot instance feature.

  • False: disables the spot instance feature.

This parameter can be set to True only for Job resource groups.

True
GroupUsers

string

The Resource Access Management (RAM) users attached to the resource group.

testb,testc
CreateTime

string

The time when the resource group was created. The time is displayed in UTC in the yyyy-MM-ddTHH:mm:ssZ format.

2022-08-29T03:34:30Z
UpdateTime

string

The time when the resource group was updated. The time is displayed in UTC in the yyyy-MM-ddTHH:mm:ssZ format.

2022-08-31T03:34:30Z
Status

string

The status of the resource group. Valid values:

  • Pending: The resource group is being created.

  • Running: The resource group is running.

  • Scaling: The resource group is being scaled.

  • Deleting: The resource group is being deleted.

  • Deleted: The resource group is deleted.

Running
Rules

array<object>

The job delivery rules.

object

The list of rules.

GroupName

string

The name of the resource group.

user_default
QueryTime

string

The threshold for query execution time. Unit: milliseconds.

180000
TargetGroupName

string

The name of the destination resource group.

job
Engine

string

The engine type.

AnalyticDB
Message

string

The message of the job delivery rule.

SUCCESS
AutoStopInterval

string

The auto-stop interval. The value is in the format of a number followed by "m", which indicates minutes. Valid values range from 0m or 5m to 10080m. A value of 0m indicates that the resource group does not automatically stop.

0m
SpecName

string

The specification name.

ADB.MLLarge.2
TargetResourceGroupName

string

The name of the destination resource group.

test
MinGpuQuantity

integer

The minimum number of GPUs.

1
MaxGpuQuantity

integer

The maximum number of GPUs.

2
RayConfig

object

The Ray configuration information.

EnableUserEni

boolean

Specifies whether to enable the elastic network interface (ENI).

HeadSpecType

string

The resource type of the head node.

cpu
HeadSpec

string

The node specifications of the head node.

ADB.MLLarge.2
HeadAllocateUnit

string

The allocation unit of the head node.

1
HeadDiskCapacity

string

The disk size of the head node.

100Gi
Category

string

The Ray cluster type. Valid values:

  • BASIC: the basic type, which is not highly available.

  • HIGH_AVAILABILITY: the high-availability type.

BASIC
WorkerGroups

array<object>

The list of Ray worker groups.

object

The list of Ray worker groups.

GroupName

string

The name of the Ray worker group.

g01
AllocateUnit

string

The allocation unit.

1
MaxWorkerQuantity

integer

The maximum number of workers.

1
MinWorkerQuantity

integer

The minimum number of workers.

1
WorkerDiskCapacity

string

The disk size of each worker.

100G
WorkerSpecName

string

The specification of the worker.

large
WorkerSpecType

string

The resource type of the Ray worker.

CPU
RayClusterAddress

string

The address of the Ray cluster.

http://ray-cluster-address.example.com
RayDashboardAddress

string

The address of the Ray dashboard.

http://ray-dashboard-address.example.com
RayGrafanaAddress

string

The address of Ray Grafana.

http://ray-grafana-address.example.com
RayServePublicAddress

string

The public endpoint of Ray Serve.

1.2.3.4:8100
AppConfig

object

The Ray application configuration.

AppName

string

The name of the Ray application.

app01
AppType

string

The type of the Ray application.

IsaacLab
ImageSelector

object

The image configuration.

Image

string

The image.

lab2.10.0-ray2.43.0
InferenceEngine

string

The inference engine.

vLLM
LlmModel

string

The large language model (LLM).

Deepseek-R1
StorageMounts

array<object>

The list of mounted storage.

object

The mounted storage.

StorageId

integer

The storage ID.

1
MountPath

string

The mount path.

/mnt/data01
StorageName

string

The name of the mounted storage.

training-data
UserDefinedRequirements

string

The custom Python dependencies for RayCluster. Specify the content in the requirements.txt format, with one pip dependency per line. A maximum of 200 lines are allowed, and each line cannot exceed 512 characters. Version constraints, extras, PEP 440 direct URLs, and # comments are supported, but shell metacharacters are not supported. This parameter applies only to AI resource groups of the RayCluster type.

numpy==1.24.0
GpuElasticPlan

object

The GPU time-based elastic plan.

Enabled

boolean

Indicates whether the GPU time-based elastic plan is enabled.

false
Rules

array<object>

The list of rules.

object

The rule.

StartCronExpression

string

The start time in cron expression format. The interval must be no less than 1 hour.

0 0 2 * * ?
EndCronExpression

string

The end time in cron expression format. The interval must be no less than 1 hour.

0 0 3 * * ?
ScalePolicy

string

The scale-out policy of the resource group. Valid values:

  • AutoScaling: enables the AutoScaling policy.

  • Disable: disables auto scaling.

  • MultiCluster: enables the MultiCluster policy.

AutoScaling
Classification

string

The classification of the resource group. Valid values:

  • SQL

  • SparkSQL

  • MultiCluster

  • AI

SQL
EngineParams

object

The engine parameters.

any

The engine parameters.

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

object

The PromQL resource group configuration.

InsertNodeSpec

string

The insert node specifications.

8ACU
InsertNodeNum

string

The number of insert nodes.

1
SelectNodeSpec

string

The query node specifications.

8ACU
SelectNodeNum

string

The number of query nodes.

1
SelectNodeCacheSize

string

The cache size of the query node.

10
StorageNodeSpec

string

The storage node specifications.

8ACU
StorageNodeNum

string

The number of storage nodes.

2
StorageNodeDiskSize

string

The disk size of the storage node.

100
StorageNodeDiskType

string

The disk type of the storage node.

essd_pl1
AuthNodeSpec

string

The authentication node specifications.

8ACU
AuthNodeNum

string

The number of authentication nodes.

2

Examples

Success response

JSON format

{
  "RequestId": "A94B6C02-7BD4-5D67-9776-3AC8317E8DD3",
  "GroupsInfo": [
    {
      "GroupType": "Job",
      "GroupName": "test1",
      "MinComputeResource": "0ACU",
      "MaxComputeResource": "512ACU",
      "ClusterSizeResource": "Reserved parameter",
      "MinClusterCount": 0,
      "MaxClusterCount": 0,
      "RunningClusterCount": 0,
      "ClusterMode": "Reserved parameter",
      "ElasticMinComputeResource": "16ACU",
      "EnableSpot": "True",
      "GroupUsers": "testb,testc",
      "CreateTime": "2022-08-29T03:34:30Z",
      "UpdateTime": "2022-08-31T03:34:30Z",
      "Status": "Running",
      "Rules": [
        {
          "GroupName": "user_default",
          "QueryTime": "180000",
          "TargetGroupName": "job"
        }
      ],
      "Engine": "AnalyticDB",
      "Message": "SUCCESS",
      "AutoStopInterval": "0m",
      "SpecName": "ADB.MLLarge.2",
      "TargetResourceGroupName": "test",
      "MinGpuQuantity": 1,
      "MaxGpuQuantity": 2,
      "RayConfig": {
        "EnableUserEni": false,
        "HeadSpecType": "cpu",
        "HeadSpec": "ADB.MLLarge.2",
        "HeadAllocateUnit": "1",
        "HeadDiskCapacity": "100Gi",
        "Category": "BASIC",
        "WorkerGroups": [
          {
            "GroupName": "g01",
            "AllocateUnit": "1",
            "MaxWorkerQuantity": 1,
            "MinWorkerQuantity": 1,
            "WorkerDiskCapacity": "100G",
            "WorkerSpecName": "large",
            "WorkerSpecType": "CPU"
          }
        ],
        "RayClusterAddress": "http://ray-cluster-address.example.com",
        "RayDashboardAddress": "http://ray-dashboard-address.example.com",
        "RayGrafanaAddress": "http://ray-grafana-address.example.com",
        "RayServePublicAddress": "1.2.3.4:8100",
        "AppConfig": {
          "AppName": "app01",
          "AppType": "IsaacLab",
          "ImageSelector": {
            "Image": "lab2.10.0-ray2.43.0",
            "InferenceEngine": "vLLM",
            "LlmModel": "Deepseek-R1"
          }
        },
        "StorageMounts": [
          {
            "StorageId": 1,
            "MountPath": "/mnt/data01",
            "StorageName": "training-data"
          }
        ],
        "UserDefinedRequirements": "numpy==1.24.0"
      },
      "GpuElasticPlan": {
        "Enabled": false,
        "Rules": [
          {
            "StartCronExpression": "0 0 2 * * ?",
            "EndCronExpression": "0 0 3 * * ?"
          }
        ]
      },
      "ScalePolicy": "AutoScaling",
      "Classification": "SQL",
      "EngineParams": {
        "key": "{\\\"spark.adb.version\\\":\\\"3.5\\\"}"
      },
      "AtmConfig": {
        "InsertNodeSpec": "8ACU",
        "InsertNodeNum": "1",
        "SelectNodeSpec": "8ACU",
        "SelectNodeNum": "1",
        "SelectNodeCacheSize": "10",
        "StorageNodeSpec": "8ACU",
        "StorageNodeNum": "2",
        "StorageNodeDiskSize": "100",
        "StorageNodeDiskType": "essd_pl1",
        "AuthNodeSpec": "8ACU",
        "AuthNodeNum": "2"
      }
    }
  ]
}

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.
408 AcsServerTimeOut The request has failed due to Adb Cloud Service time out. The backend service timed out. Please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.