すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeDBResourceGroup

    ドキュメントセンター

    AnalyticDB:DescribeDBResourceGroup

    最終更新日:Oct 21, 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

    必須

    Data Lakehouse Edition クラスターの ID。

    amv-bp11q28kvl688****
    GroupName

    string

    任意

    リソースグループ名。

    説明

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

    test_group
    GroupType

    string

    任意

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

    • Interactive

    • Job

    説明

    Data Lakehouse Edition のリソースグループの詳細については、「リソースグループの概要」を参照してください。

    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

    説明

    Data Lakehouse Edition のリソースグループの詳細については、「リソースグループの概要 (Data Lakehouse Edition)」を参照してください。

    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

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

    • Pending: リソースグループの作成中です。

    • Running: リソースグループは実行中です。

    • Scaling: リソースグループのスケーリング中です。

    • Deleting: リソースグループの削除中です。

    • Deleted: リソースグループは削除されています。

    Running
    Rules

    array<object>

    タスク配信ルール。

    object

    ルールのリスト。

    GroupName

    string

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

    user_default
    QueryTime

    string

    クエリ実行時間のしきい値。単位: ミリ秒。

    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 ダッシュボードのアドレス。

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

    string

    Ray Grafana のアドレス。

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

    string

    Ray Serve のパブリックエンドポイント。

    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

    large 言語モデル (LLM)。

    Deepseek-R1
    StorageMounts

    array<object>

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

    object

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

    StorageId

    integer

    ストレージの ID。

    1
    MountPath

    string

    マウントパス。

    /mnt/data01
    StorageName

    string

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

    training-data
    UserDefinedRequirements

    string

    RayCluster 用のカスタム Python 依存関係。requirements.txt フォーマットで内容を指定し、1 回線に 1 つの pip 依存関係を記述します。最大値 200 回線まで指定でき、各回線は 512 文字以内に収める必要があります。バージョン制約、extras、PEP 440 ダイレクト URL、# コメントがサポートされていますが、シェルのメタ文字はサポートされていません。このパラメーターは、RayCluster タイプの AI リソースグループにのみ適用されます。

    numpy==1.24.0
    GpuElasticPlan

    object

    GPU の時間ベースのエラスティックプラン。

    Enabled

    boolean

    GPU の時間ベースのエラスティックプランが有効かどうかを示します。

    false
    Rules

    array<object>

    ルールのリスト。

    object

    ルール。

    StartCronExpression

    string

    cron 式フォーマットの開始時刻。間隔は 1 時間以上である必要があります。

    0 0 2 * * ?
    EndCronExpression

    string

    cron 式フォーマットの終了時刻。間隔は 1 時間以上である必要があります。

    0 0 3 * * ?
    ScalePolicy

    string

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

    • AutoScaling: AutoScaling ポリシーを有効にします。

    • Disable: auto scaling を無効にします。

    • MultiCluster: MultiCluster ポリシーを有効にします。

    AutoScaling
    Classification

    string

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

    • SQL

    • SparkSQL

    • MultiCluster

    • AI

    SQL
    EngineParams

    object

    エンジンパラメーター。

    any

    エンジンパラメーター。

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

    object

    PromQL リソースグループの構成。

    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": "予約済みパラメーター",
      "MinClusterCount": 0,
      "MaxClusterCount": 0,
      "RunningClusterCount": 0,
      "ClusterMode": "予約済みパラメーター",
      "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-クラスターアドレス.example.com",
        "RayDashboardAddress": "http://ray-ダッシュボードアドレス.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"
      }
    }
  ]
}

    エラーコード

    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. バックエンドサービスが時間切れになりました。しばらくしてからもう一度お試しください。

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

    変更履歴

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