文档

DescribeApsResourceGroups - 查询资源组信息

更新时间:

调用DescribeApsResourceGroups接口获取数据同步时所用资源组的详细信息。

接口说明

  • 地域的公网接入地址:adb.<region-id>.aliyuncs.com。示例:adb.cn-hangzhou.aliyuncs.com
  • 地域的 VPC 接入地址:adb-vpc.<region-id>.aliyuncs.com。示例:adb-vpc.cn-hangzhou.aliyuncs.com

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
adb:DescribeApsResourceGroupsnone
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

说明 您可以调用 DescribeRegions 接口查看指定 AnalyticDB MySQL 湖仓版(3.0)集群的地域 ID。
cn-hangzhou
DBClusterIdstring

企业版、基础版或湖仓版集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看集群的集群 ID。
amv-bp1t6rym21****
WorkloadIdstring

数据同步任务 ID。

aps-hz1686v37sx****

返回参数

名称类型描述示例值
object

响应模式。

RequestIdstring

请求 ID。

6FC370D7-1D4C-5A8E-805E-F73366382C66
Messagestring

调用结果的附加信息。取值说明:

  • 请求正常,返回 Success。
  • 请求异常,返回具体异常错误码。
Success
HttpStatusCodelong

HTTP 状态码。

200
Dataobject

资源组信息列表。

Steplong

资源组的步长,单位 ACU。

  • 当 GroupType 为 Interactive 时,步长为 16 ACU。
  • 当 GroupType 为 Job 时,步长为 8 ACU。
8
ResourceGroupsarray<object>

资源组列表。

object

资源组列表。

CuOptionsarray

资源梯度值列表。

long

资源梯度值。

MaxComputeResourceinteger

最大计算预留资源,单位 ACU。

  • 当 GroupType 为 Interactive 时,计算预留资源最大为集群当前未分配资源,步长为 16 ACU。
  • 当 GroupType 为 Job 时,计算预留资源最大为集群当前未分配资源,步长为 8 ACU。
512
LeftComputeResourceinteger

剩余计算资源,单位 ACU。

512
MinComputeResourceinteger

最小计算预留资源,单位 ACU。

  • 当 GroupType 为 Interactive 时,计算预留资源最小为 16 ACU。
  • 当 GroupType 为 Job 时,计算预留资源最小为 0 ACU。
0
GroupNamestring

资源组名称。

test
GroupTypestring

资源组类型,取值:

  • Interactive
  • Job
说明 关于湖仓版资源组的详细信息,请参见资源组介绍
Job
Availableboolean

资源组是否可用。取值说明:

  • True:可用。
  • False:不可用。
True
Successboolean

请求是否成功。取值说明:

  • True:成功。
  • False:失败。
True

示例

正常返回示例

JSON格式

{
  "RequestId": "6FC370D7-1D4C-5A8E-805E-F73366382C66",
  "Message": "Success",
  "HttpStatusCode": 200,
  "Data": {
    "Step": 8,
    "ResourceGroups": [
      {
        "CuOptions": [
          0
        ],
        "MaxComputeResource": 512,
        "LeftComputeResource": 512,
        "MinComputeResource": 0,
        "GroupName": "test",
        "GroupType": "Job",
        "Available": true
      }
    ]
  },
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-04-10OpenAPI 入参发生变更查看变更详情
2023-05-09OpenAPI 返回结构发生变更查看变更详情