DescribeDBResourceGroup API を使用したリソースグループ情報のクエリ - AnalyticDB

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

操作説明

このサービスのアクセスエンドポイントについては、「サービスエンドポイント」をご参照ください。

今すぐお試しください

この 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。説明クラスターのリージョン ID をクエリするには、DescribeRegions 操作を呼び出します。	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	予約済みパラメーター。該当なし。	预留参数，不涉及
MinClusterCount	integer	予約済みパラメーター。該当なし。	预留参数，不涉及
MaxClusterCount	integer	予約済みパラメーター。該当なし。	预留参数，不涉及
RunningClusterCount	integer	予約済みパラメーター。該当なし。	预留参数，不涉及
ClusterMode	string	予約済みパラメーター。該当なし。	预留参数，不涉及
ElasticMinComputeResource	string	最小エラスティックコンピューティングリソース (ACU 単位)。	16ACU
EnableSpot	string	リソースグループに対してスポットインスタンス機能が有効になっているかどうかを示します。スポットインスタンス機能を有効にすると、リソースの単価は下がりますが、リソースがリリースされる可能性があります。有効な値： True：スポットインスタンス機能を有効にします。 False：スポットインスタンス機能を無効にします。 Job タイプの`リソースグループ`のみ True に設定できます。	True
GroupUsers	string	リソースグループにバインドされている 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	クエリ実行時間のしきい値 (ミリ秒単位)。	180000
TargetGroupName	string	ターゲットリソースグループ名。	job
Engine	string
Message	string
AutoStopInterval	string
SpecName	string
TargetResourceGroupName	string
MinGpuQuantity	integer
MaxGpuQuantity	integer
RayConfig	object
EnableUserEni	boolean
HeadSpecType	string
HeadSpec	string
HeadAllocateUnit	string
HeadDiskCapacity	string
Category	string
WorkerGroups	array<object>	Ray Worker グループのリスト。
	object
GroupName	string	Ray Worker グループ名。	g01
AllocateUnit	string	割り当て単位。	1
MaxWorkerQuantity	integer	Worker の最大数。	1
MinWorkerQuantity	integer	Worker の最小数。	1
WorkerDiskCapacity	string	各 Worker のディスクサイズ。	100G
WorkerSpecName	string	Worker のリソースタイプ。	large
WorkerSpecType	string	Ray Worker のリソースタイプ。	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
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
GpuElasticPlan	object
Enabled	boolean
Rules	array<object>
	object
StartCronExpression	string
EndCronExpression	string
ScalePolicy	string
Classification	string
EngineParams	object	エンジンパラメーター。
	any	エンジンパラメーター。

例

成功レスポンス

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": "ok",
      "Rules": [
        {
          "GroupName": "user_default",
          "QueryTime": "180000",
          "TargetGroupName": "job"
        }
      ],
      "Engine": "",
      "Message": "",
      "AutoStopInterval": "",
      "SpecName": "",
      "TargetResourceGroupName": "",
      "MinGpuQuantity": 0,
      "MaxGpuQuantity": 0,
      "RayConfig": {
        "EnableUserEni": false,
        "HeadSpecType": "",
        "HeadSpec": "",
        "HeadAllocateUnit": "",
        "HeadDiskCapacity": "",
        "Category": "",
        "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"
          }
        ]
      },
      "GpuElasticPlan": {
        "Enabled": false,
        "Rules": [
          {
            "StartCronExpression": "",
            "EndCronExpression": ""
          }
        ]
      },
      "ScalePolicy": "",
      "Classification": "",
      "EngineParams": {
        "key": ""
      }
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidPoolName.Malformed	The specified parameter PoolName is not valid.
400	InvalidPoolUser.Malformed	The specified parameter PoolUser is not valid.
400	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
400	InvalidPoolType.Malformed	The specified parameter PoolType is not valid.
400	InvalidMinComputeResource.Malformed	The specified parameter MinComputeResource is not valid.
400	InvalidMaxComputeResource.Malformed	The specified parameter MaxComputeResource is not valid.
408	AcsServerTimeOut	The request has failed due to Adb Cloud Service time out.

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

変更履歴

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