DocsICP FilingConsole
官方文档
首页

DescribeDBResourceGroup

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

Queries the resource group information of a cluster.

Operation description

For the service endpoint, see Service 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: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 omit this parameter, the operation returns all resource groups in the specified cluster.

test_group
GroupType

string

No

The resource group type. Valid values:

  • Interactive

  • Job

Note

See Resource group overview for more information about Data Lakehouse Edition resource groups.

Job
RegionId

string

No

The region ID.

Note

You can call DescribeRegions to query the most recent region list.

cn-hangzhou

Response elements

Element

Type

Description

Example

object

The response schema.

RequestId

string

The request ID.

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

array<object>

A list of resource groups.

array<object>

A list of resource groups.

GroupType

string

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 (Data Lakehouse Edition).

Job
GroupName

string

The name of the resource group.

test1
MinComputeResource

string

The minimum amount of reserved computing resources, in ACUs.

0ACU
MaxComputeResource

string

The maximum amount of reserved computing resources, in ACUs.

512ACU
ClusterSizeResource

string

A reserved parameter.

Reserved parameter
MinClusterCount

integer

A reserved parameter.

Reserved parameter
MaxClusterCount

integer

A reserved parameter.

Reserved parameter
RunningClusterCount

integer

A reserved parameter.

Reserved parameter
ClusterMode

string

A reserved parameter.

Reserved parameter
ElasticMinComputeResource

string

The minimum amount of elastic computing resources, in ACUs.

16ACU
EnableSpot

string

Indicates whether to enable the spot instance feature for the resource group. If you enable this feature, the resource unit price is reduced, but the resources can be reclaimed at any time. Valid values:

  • True: The spot instance feature is enabled.

  • False: The spot instance feature is disabled.

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

True
GroupUsers

string

The RAM users that are bound to the resource group.

testb,testc
CreateTime

string

The creation time of the resource group. The time is in UTC and formatted as yyyy-MM-ddTHH:mm:ssZ.

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

string

The last update time of the resource group. The time is in UTC and formatted as yyyy-MM-ddTHH:mm:ssZ.

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

string

The status of the resource group. Valid values:

  • creating: The resource group is being created.

  • ok: The resource group is active.

  • pendingdelete: The resource group is pending deletion.

ok
Rules

array<object>

A list of job delivery rules.

object

The details of a job delivery rule.

GroupName

string

The name of the resource group.

user_default
QueryTime

string

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

180000
TargetGroupName

string

The name of the target resource group.

job
Engine

string

The engine type.

AnalyticDB
Message

string

A message about the status of the job delivery rule.

SUCCESS
AutoStopInterval

string

The duration after which the resource group is automatically stopped. Specify the duration in minutes, ending with m. Valid values: 0m or a value from 5m to 10080m. A value of 0m disables automatic stopping.

0m
SpecName

string

The specification name.

ADB.MLLarge.2
TargetResourceGroupName

string

The name of the target resource group.

test
MinGpuQuantity

integer

The minimum number of GPUs.

1
MaxGpuQuantity

integer

The maximum number of GPUs.

2
RayConfig

object

The Ray configuration.

EnableUserEni

boolean

Indicates whether ENIs are enabled.

HeadSpecType

string

The resource type of the head node.

cpu
HeadSpec

string

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

  • BASIC: A basic cluster without high availability.

  • HIGH_AVAILABILITY: a high-availability cluster.

BASIC
WorkerGroups

array<object>

A list of Ray worker groups.

object

A Ray worker group.

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 resource specifications 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
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 LLM model.

Deepseek-R1
StorageMounts

array<object>

A list of mounted storage.

object

A mounted storage configuration.

StorageId

integer

The storage ID.

1
MountPath

string

The mount path.

/mnt/data01
UserDefinedRequirements

string

GpuElasticPlan

object

The GPU elastic plan.

Enabled

boolean

Indicates whether the plan is enabled.

false
Rules

array<object>

A list of rules.

object

A rule.

StartCronExpression

string

The start time of the scaling activity, specified as a Cron expression.

0 0 2 * * ?
EndCronExpression

string

The end time of the scaling activity, specified as a Cron expression. The time interval between the start time and end time must be at least one hour.

0 0 3 * * ?
ScalePolicy

string

The scaling policy of the resource group. Valid values:

  • AutoScaling: Enables the auto-scaling policy.

  • Disable: Disables the auto-scaling policy.

  • MultiCluster: Enables the multi-cluster scaling 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

InsertNodeSpec

string

8ACU
InsertNodeNum

string

1
SelectNodeSpec

string

8ACU
SelectNodeNum

string

1
SelectNodeCacheSize

string

10
StorageNodeSpec

string

8ACU
StorageNodeNum

string

2
StorageNodeDiskSize

string

100
StorageNodeDiskType

string

essd_pl1
AuthNodeSpec

string

8ACU
AuthNodeNum

string

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": "ok",
      "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",
        "AppConfig": {
          "AppName": "app01",
          "AppType": "IsaacLab",
          "ImageSelector": {
            "Image": "lab2.10.0-ray2.43.0",
            "InferenceEngine": "vLLM",
            "LlmModel": "Deepseek-R1"
          }
        },
        "StorageMounts": [
          {
            "StorageId": 1,
            "MountPath": "/mnt/data01"
          }
        ],
        "UserDefinedRequirements": ""
      },
      "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.