查询集群的资源组信息。
接口说明
当前服务的接入地址请参见服务接入点。
调试
您可以在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": ""
}
]
}
错误码
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-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 错误码发生变更 | 查看变更详情 |