DescribeDBResourceGroup - 查詢資源群組 -

查詢叢集的資源群組資訊。

介面說明

當前服務的接入地址請參見服務存取點。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

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	Schema of Response
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	預留參數，不涉及	預留參數，不涉及
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	查詢執行時間閾值，單位為毫秒（ms）。	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 Cluster 地址	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
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
EngineParams	object	引擎參數
	any	引擎參數

樣本

正常返回樣本

JSON格式

{
  "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": true,
        "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": true,
        "Rules": [
          {
            "StartCronExpression": "",
            "EndCronExpression": ""
          }
        ]
      },
      "EngineParams": {
        "key": ""
      }
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
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.	後端服務逾時,請稍後嘗試。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。