DescribeDBInstanceIndexUsage - 查看索引的使用情况

获取AnalyticDB PostgreSQL版实例中索引的使用情况。

接口说明

合理的使用索引可以提升数据库的查询速度,本接口用于查看 AnalyticDB PostgreSQL 版实例的索引使用情况。

目前该功能仅支持存储弹性模式实例,且内核版本为 V6.3.10.1 及以上版本。如何查看和升级内核小版本,请参见查看内核小版本版本升级

调试

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

授权信息

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

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

请求参数

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

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-bp12ga6v69h86****
PageSizeinteger

每页记录数,取值说明:

  • 30
  • 50
  • 100

默认值:30

30
PageNumberinteger

页码,大于 0 且不超过 Integer 的最大值,默认值:1

1
Databasestring

数据库名称

test
OrderBystring

排序条件

{Field: SchemaName, Type: Desc}

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
TotalCountinteger

总记录数。

1
PageNumberinteger

当前页码。

1
Itemsarray<object>

索引使用详情列表。

Itemsobject
DatabaseNamestring

数据库名称。

adbtest
SchemaNamestring

Schema 名称。

schema1
TableNamestring

表名称。

tab1_ptr_2010
IsPartitionTableboolean

是否是分区表,取值如下:

  • true:是分区表。
  • false:不是分区表。
true
ParentTableNamestring

父表名。

tab1
IndexNamestring

索引名称。

idx1
IndexSizestring

索引大小,单位为 Byte。

10000
IndexScanTimeslong

索引被扫描次数。

50000
IndexDefstring

索引的定义。

CREATE INDEX idx1 ON schema1.tab1_ptr_2010
TimeLastUpdatedstring

上次更新(DELETE、INSERT 或 UPDATE 操作)表的时间。

2022-08-08T20:00:00Z

示例

正常返回示例

JSON格式

{
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "TotalCount": 1,
  "PageNumber": 1,
  "Items": [
    {
      "DatabaseName": "adbtest",
      "SchemaName": "schema1",
      "TableName": "tab1_ptr_2010",
      "IsPartitionTable": true,
      "ParentTableName": "tab1",
      "IndexName": "idx1",
      "IndexSize": "10000",
      "IndexScanTimes": 50000,
      "IndexDef": "CREATE INDEX idx1 ON schema1.tab1_ptr_2010",
      "TimeLastUpdated": "2022-08-08T20:00:00Z"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-08-06OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情