获取AnalyticDB PostgreSQL版实例中索引的使用情况。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| gpdb:DescribeDBInstanceIndexUsage | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例 ID。 说明
您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。
| gp-bp12ga6v69h86**** |
| PageSize | integer | 否 | 每页记录数，取值说明：
默认值：30。 | 30 |
| PageNumber | integer | 否 | 页码，大于 0 且不超过 Integer 的最大值，默认值：1。 | 1 |
| Database | string | 否 | 数据库名称 | test |
| OrderBy | string | 否 | 排序条件 | {Field: SchemaName, Type: Desc} |
返回参数
示例
正常返回示例
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-06 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |