全部产品
Search
文档中心

云原生数据仓库AnalyticDB:DescribeDBResourceGroup - 获取资源组详情

更新时间:Nov 14, 2024

获取资源组详情。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的实例 ID。
gp-xxxxxxxxx
ResourceGroupNamestring

资源组名称。

说明 当该值为空时,返回所有资源组详情;当该值不为空,则返回指定资源组详情
testgroup

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

ABB39CC3-4488-4857-905D-2E4A051D0521
ResourceGroupItemsarray<object>

资源组详情。

ResourceGroupItemobject
ResourceGroupNamestring

资源组名称。

testgroup
ResourceGroupConfigstring

资源组配置。

说明
  • CpuRateLimit:资源组可使用 cpu 资源百分比,单位:%
  • MemoryLimit:资源组可使用内存资源百分比,单位:%
  • MemorySharedQuota:提交到该资源组的事务之间共享的内存资源百分比,单位:%,默认值:80
  • MemorySpillRatio:内存密集型事务的内存使用阈值。当事务达到此阈值时,将溢出磁盘,单位:%,默认值:0
  • Concurrency:资源组允许的最大并发数,默认值:20
  • {"CpuRateLimit":10,"MemoryLimit":12,"MemorySharedQuota":20,"MemorySpillRatio":75,"Concurrency":3}
    RoleListarray

    角色列表。

    Rolestring

    角色名称。

    testrole

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
      "ResourceGroupItems": {
        "ResourceGroupItem": [
          {
            "ResourceGroupName": "testgroup",
            "ResourceGroupConfig": "{\"CpuRateLimit\":10,\"MemoryLimit\":12,\"MemorySharedQuota\":20,\"MemorySpillRatio\":75,\"Concurrency\":3}",
            "RoleList": {
              "Role": [
                "testrole"
              ]
            }
          }
        ]
      }
    }

    错误码

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