すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeDBResourceGroup

    ドキュメントセンター

    AnalyticDB:DescribeDBResourceGroup

    最終更新日:Jun 30, 2026

    クラスターのリソースグループ情報を照会します。

    操作説明

    現在のサービスのサービス登録については、エンドポイントをご参照ください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    adb:DescribeDBResourceGroup

    list

    *DBClusterLakeVersion

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    データレイクハウスエディションクラスターのクラスター ID。

    amv-bp11q28kvl688****
    GroupName

    string

    任意

    リソースグループ名。

    説明

    このパラメーターを指定しない場合、指定されたクラスター内のすべてのリソースグループの情報がデフォルトで返されます。

    test_group
    GroupType

    string

    任意

    リソースグループのタイプ。有効な値:

    • Interactive

    • Job

    説明

    データレイクハウスエディションのリソースグループの詳細については、リソースグループの概要をご参照ください。

    Job
    RegionId

    string

    任意

    リージョン ID。

    説明

    DescribeRegions 操作を呼び出して、クラスターのリージョン ID をクエリできます。

    cn-hangzhou

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエスト ID。

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

    array<object>

    リソースグループ情報のリスト。

    array<object>

    リソースグループ情報のリスト。

    GroupType

    string

    リソースグループのタイプ。有効な値:

    • Interactive

    • Job

    説明

    データレイクハウスエディションのリソースグループの詳細については、リソースグループの概要 (データレイクハウスエディション)をご参照ください。

    Job
    GroupName

    string

    リソースグループ名。

    test1
    MinComputeResource

    string

    予約コンピューティングリソースの最小値。単位: ACU。

    0ACU
    MaxComputeResource

    string

    予約コンピューティングリソースの最大値。単位: ACU。

    512ACU
    ClusterSizeResource

    string

    予約済みパラメーター。該当なし。

    Reserved parameter
    MinClusterCount

    integer

    予約済みパラメーター。該当なし。

    Reserved parameter
    MaxClusterCount

    integer

    予約済みパラメーター。該当なし。

    Reserved parameter
    RunningClusterCount

    integer

    予約済みパラメーター。該当なし。

    Reserved parameter
    ClusterMode

    string

    予約済みパラメーター。該当なし。

    Reserved parameter
    ElasticMinComputeResource

    string

    エラスティックコンピューティングリソースの最小値。単位: ACU。

    16ACU
    EnableSpot

    string

    リソースグループでスポットインスタンス特徴が有効かどうかを示します。スポットインスタンス特徴が有効な場合、リソースの単位価格は下がりますが、リソースが解放される可能性があります。有効な値:

    • True: スポットインスタンス特徴が有効です。

    • False: スポットインスタンス特徴が無効です。

    Job タイプのリソースグループのみ True に設定できます。

    True
    GroupUsers

    string

    リソースグループにアタッチされた Resource Access Management (RAM) ユーザー。

    testb,testc
    CreateTime

    string

    リソースグループが作成された時間。時間は協定世界時 (UTC) で、yyyy-MM-ddTHH:mm:ssZ のフォーマットです。

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

    string

    リソースグループが最後に更新された時間。時間は協定世界時 (UTC) で、yyyy-MM-ddTHH:mm:ssZ のフォーマットです。

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

    string

    リソースグループのステータス。有効な値:

    • creating: 作成中

    • ok: 作成済み

    • pendingdelete: 削除保留中

    ok
    Rules

    array<object>

    タスクルーティングルール。

    object

    ルール情報のリスト。

    GroupName

    string

    リソースグループの名前。

    user_default
    QueryTime

    string

    クエリ実行時間のしきい値 (単位：ms)。

    180000
    TargetGroupName

    string

    ターゲットリソースグループの名前。

    job
    Engine

    string

    エンジンタイプ。

    AnalyticDB
    Message

    string

    タスクルーティングルールのメッセージ。

    SUCCESS
    AutoStopInterval

    string

    自動停止間隔。数値の後に m (分) を付けたフォーマットです。値の範囲は 0m または 5m から 10080m です。0m の値は自動停止が無効であることを示します。

    0m
    SpecName

    string

    スペック名。

    ADB.MLLarge.2
    TargetResourceGroupName

    string

    ターゲットリソースグループの名前。

    test
    MinGpuQuantity

    integer

    GPU の最小値。

    1
    MaxGpuQuantity

    integer

    GPU の最大値。

    2
    RayConfig

    object

    Ray 構成情報。

    EnableUserEni

    boolean

    ENI が有効かどうかを示します。

    HeadSpecType

    string

    ヘッドノードのリソースタイプ。

    cpu
    HeadSpec

    string

    ヘッドノードの仕様。

    ADB.MLLarge.2
    HeadAllocateUnit

    string

    ヘッドノードの割り当て単位。

    1
    HeadDiskCapacity

    string

    ヘッドノードのディスクサイズ。

    100Gi
    Category

    string

    Ray クラスターのタイプ。有効な値：

    • BASIC：高可用性を持たない基本クラスター。

    • HIGH_AVAILABILITY：高可用性クラスター。

    BASIC
    WorkerGroups

    array<object>

    Ray ワーカーグループのリスト。

    object

    Ray ワーカーグループ。

    GroupName

    string

    Ray ワーカーグループの名前。

    g01
    AllocateUnit

    string

    割り当て単位。

    1
    MaxWorkerQuantity

    integer

    ワーカーの最大数。

    1
    MinWorkerQuantity

    integer

    ワーカーの最小数。

    1
    WorkerDiskCapacity

    string

    各ワーカーのディスクサイズ。

    100G
    WorkerSpecName

    string

    ワーカーのリソース仕様。

    large
    WorkerSpecType

    string

    Ray ワーカーのリソースタイプ。

    CPU
    RayClusterAddress

    string

    Ray クラスターのアドレス。

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

    string

    Ray Dashboard のアドレス。

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

    string

    Ray Grafana のアドレス。

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

    string

    1.2.3.4:8100
    AppConfig

    object

    Ray アプリケーション設定。

    AppName

    string

    Ray アプリケーションの名前。

    app01
    AppType

    string

    Ray アプリケーションのタイプ。

    IsaacLab
    ImageSelector

    object

    イメージ設定。

    Image

    string

    イメージ。

    lab2.10.0-ray2.43.0
    InferenceEngine

    string

    推論エンジン。

    vLLM
    LlmModel

    string

    LLM モデル。

    Deepseek-R1
    StorageMounts

    array<object>

    マウントされたストレージのリスト。

    object

    マウントされたストレージ設定。

    StorageId

    integer

    ストレージ ID。

    1
    MountPath

    string

    マウントパス。

    /mnt/data01
    UserDefinedRequirements

    string

    GpuElasticPlan

    object

    GPU 時間共有エラスティックプラン。

    Enabled

    boolean

    プランが有効かどうかを示します。

    false
    Rules

    array<object>

    ルールのリスト。

    object

    ルール。

    StartCronExpression

    string

    スケーリングアクティビティの開始時刻 (Cron 式で指定)。

    0 0 2 * * ?
    EndCronExpression

    string

    スケーリングアクティビティの終了時刻 (Cron 式で指定)。開始時刻と終了時刻の間隔は、1 時間以上である必要があります。

    0 0 3 * * ?
    ScalePolicy

    string

    リソースグループのスケールアウトポリシー。有効な値:

    • AutoScaling: AutoScaling 自動スケーリングポリシーを有効にします。

    • Disable: 自動スケーリングを無効にします。

    • MultiCluster: MultiCluster 自動スケーリングポリシーを有効にします。

    AutoScaling
    Classification

    string

    リソースグループの分類。有効な値:

    • SQL

    • SparkSQL

    • MultiCluster

    • AI

    SQL
    EngineParams

    object

    エンジンパラメーター。

    any

    エンジンパラメーター。

    {\"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

    例

    成功レスポンス

    JSONJSON

    {
  "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",
        "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"
          }
        ],
        "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"
      }
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidPoolName.Malformed The specified parameter PoolName is not valid. PoolName パラメーターが無効です。パラメーター値が要件を満たしていることを確認してください。
    400 InvalidPoolUser.Malformed The specified parameter PoolUser is not valid. PoolUser パラメーターが無効です。パラメーター値が要件を満たしていることを確認してください。
    400 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. 指定された DBClusterId が存在しません。DBClusterId の値が正しいことを確認してください。
    400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. DBClusterId パラメーターが無効です。パラメーター値が要件を満たしていることを確認してください。
    400 InvalidPoolType.Malformed The specified parameter PoolType is not valid. PoolType パラメーターが無効です。パラメーター値が要件を満たしていることを確認してください。
    400 InvalidMinComputeResource.Malformed The specified parameter MinComputeResource is not valid. MinComputeResource パラメーターが無効です。パラメーター値が要件を満たしていることを確認してください。
    400 InvalidMaxComputeResource.Malformed The specified parameter MaxComputeResource is not valid. MaxComputeResource パラメーターが無効です。パラメーター値が要件を満たしていることを確認してください。
    408 AcsServerTimeOut The request has failed due to Adb Cloud Service time out. バックエンドサービスが時間切れになりました。しばらくしてからもう一度お試しください。

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。