文档首页/ 数据管理服务 DAS/ API参考/ API/ 云DBA/ 查询索引使用明细列表 - GetIndexUsageDetailList
更新时间:2026-09-20 GMT+08:00
分享

查询索引使用明细列表 - GetIndexUsageDetailList

功能介绍

查询索引使用明细列表。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    das::showCloudDBAInfo

    read

    -

    -

    -

    -

URI

POST /v3/{project_id}/instances/{instance_id}/index-usage/get-index-usage-detail-list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值:

不涉及。

instance_id

是

String

参数解释:

实例ID,实例的唯一标识。可通过查看实例列表或者实例详情获取实例ID信息。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为36个字符。

默认取值:

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

conditions

是

Arrays of 表3 Objects

参数解释:

过滤条件。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

object_name

否

String

参数解释:

表名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

sort_field

否

String

参数解释:

排序字段。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

sort_asc

否

Boolean

参数解释:

排序是否升序。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

cur_page

否

Integer

参数解释:

当前页。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

per_page

否

Integer

参数解释:

页大小。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 Condition

参数

是否必选

参数类型

描述

field

否

String

参数解释:

过滤字段。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

min_value

否

Double

参数解释:

最小值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

max_value

否

Double

参数解释:

最大值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

detail_list

Arrays of 表5 IndexUsageDetail Objects

参数解释:

索引缺失明细列表。

取值范围:

不涉及。

total

Long

参数解释:

总数。

取值范围:

不涉及。

collect_time

Long

参数解释:

采集时间。

取值范围:

不涉及。

表5 IndexUsageDetail

参数

参数类型

描述

table_name

String

参数解释:

表名称。

取值范围:

不涉及。

index_name

String

参数解释:

索引名称。

取值范围:

不涉及。

ix_type_desc

String

参数解释:

索引类型描述。

取值范围:

不涉及。

fragmentation_percentage

Double

参数解释:

碎片率。

取值范围:

不涉及。

index_size_mb

Double

参数解释:

索引占用的空间大小(MB)。

取值范围:

不涉及。

maintenance_operation

String

参数解释:

维护操作。建议的维护操作。

取值范围:

不涉及。

page_count

Long

参数解释:

页数。索引占用的空间页数。

取值范围:

不涉及。

ix_seek_count

Long

参数解释:

查找-次数。通过用户查询执行的搜索次数。

取值范围:

不涉及。

ix_scan_count

Long

参数解释:

扫描-次数。未使用索引的用户查询的扫描数。

取值范围:

不涉及。

ix_key_lookup_count

Long

参数解释:

书签查找-次数。由用户查询执行的书签查找次数。

取值范围:

不涉及。

ix_update_count

Long

参数解释:

更新-次数。通过用户查询执行的更新次数。

取值范围:

不涉及。

seek_percentage

Double

参数解释:

查找-百分比。使用索引做查找的次数及百分比。

取值范围:

不涉及。

scan_percentage

Double

参数解释:

扫描-百分比。使用索引做扫描的次数及百分比。

取值范围:

不涉及。

key_lookup_percentage

Double

参数解释:

书签查找-百分比。使用索引做Key Lookup的次数及百分比。

取值范围:

不涉及。

update_percentage

Double

参数解释:

更新-百分比。索引被更新的次数及百分比。

取值范围:

不涉及。

is_primary_key

Boolean

参数解释:

主键。索引是否是主键。

取值范围:

不涉及。

is_disabled

Boolean

参数解释:

禁用。索引是否被禁用。

取值范围:

不涉及。

column_list

String

参数解释:

列。索引包含的列。

取值范围:

不涉及。

fill_factor

String

参数解释:

填充因子。索引的填充因子。

取值范围:

不涉及。

create_date

Long

参数解释:

创建时间。索引的创建时间。

取值范围:

不涉及。

stats_last_updated

Long

参数解释:

统计信息更新时间。索引对应的统计信息最后更新时间。

取值范围:

不涉及。

请求示例

POST https://das.cn-north-1.myhuaweicloud.com/v3/2cfb7eecd30f344f8e21f03106c7a607/instances/5eb0301017874d4b8d8e697ab8e7676ain04/index-usage/get-index-usage-detail-list 
 
{
    "conditions": [],
    "cur_page": 1,
    "per_page": 10,
    "sort_field": "",
    "sort_asc": false
}

响应示例

状态码: 200

Success.

{
    "detail_list": [
        {
            "table_name": "[test].[dbo].[test]",
            "index_name": "TEST@ContactID_@TEST",
            "ix_type_desc": "NONCLUSTERED",
            "fragmentation_percentage": 99.75,
            "index_size_mb": 3.12,
            "maintenance_operation": "Rebuild",
            "page_count": 399,
            "ix_seek_count": 0,
            "ix_scan_count": 0,
            "ix_key_lookup_count": 0,
            "ix_update_count": 0,
            "seek_percentage": 0,
            "scan_percentage": 0,
            "key_lookup_percentage": 0,
            "update_percentage": 0,
            "is_primary_key": false,
            "is_disabled": false,
            "column_list": "ServiceSpaceID,[*inc*]ID,[*inc*]CustomerID",
            "fill_factor": "0",
            "create_date": 1709535480000,
            "stats_last_updated": 1716865020000
        }
    ],
    "total": 1,
    "collect_time": 1764204246000
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

相关文档