查詢集群的資源組信息。
接口說明
當前服務的接入地址請參見服務接入點。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
adb:DescribeDBResourceGroup | list |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 企業版、基礎版或湖倉版的集群 ID。 | amv-bp11q28kvl688**** |
GroupName | string | 否 | 資源組名稱。 說明
此參數不填寫時,默認返回指定集群的所有資源組信息。
| test_group |
GroupType | string | 否 | Job | |
RegionId | string | 否 | 地域 ID。 說明
您可以調用 DescribeRegions 接口查看集群的地域 ID。
| cn-hangzhou |
返回參數
示例
正常返回示例
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": "",
"EngineParams": {
"test": "test",
"test2": 1
},
"Message": "",
"AutoStopInterval": "",
"SpecName": "",
"TargetResourceGroupName": "",
"MinGpuQuantity": 0,
"MaxGpuQuantity": 0
}
]
}
錯誤碼
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. | 后端服務超時,請稍后嘗試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-09-29 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2024-08-14 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2024-03-25 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2024-03-01 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2024-01-26 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-09-25 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-03-31 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |