首页 数据库自治服务 开发参考 API参考 API目录 索引诊断 GetInstanceMissingIndexList - 查询RDS SQL Server实例索引缺失情况

GetInstanceMissingIndexList - 查询RDS SQL Server实例索引缺失情况

更新时间: 2024-03-22 18:22:12

调用GetInstanceMissingIndexList接口,查询RDS SQL Server实例所有缺失索引的详细信息。

接口说明

  • 本接口仅适用于 RDS SQL Server 版实例。
  • 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。

调试

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

授权信息

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

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

请求参数

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

数据库实例 ID。

rm-t4nfalp2ap421****
PageNostring

分页查询的页码,从 1 开始,默认为 1。

1
PageSizestring

每页最大记录数,默认值为 10。

10
ObjectNamestring

对象名。

bas_customer
ReservedSizestring

表总空间筛选条件。单位为 MB。输入格式为运算符+分割服“|”+表总空间大小,例如筛选条件设置为查询总空间大于等于 100M 的表时,输入:>=|100

>=|100
RowCountstring

表记录数筛选条件。输入格式为运算符+分割服“|”+表记录数,例如>=|100

>=|100000
ReservedPagesstring

总页数筛选条件。输入格式为运算符+分割服“|”+总页数,例如>=|100

>=|100
IndexCountstring

索引个数(索引缺失表目前所拥有的索引个数)筛选条件。输入格式为运算符+分割服“|”+索引个数,例如>=|100

>=|8
UniqueCompilesstring

编译次数筛选条件。输入格式为运算符+分割服“|”+编译次数,例如>=|100

>=|10000
UserSeeksstring

查找次数筛选条件。输入格式为运算符+分割服“|”+查找次数,例如>=|100

>=|1000
UserScansstring

扫描次数筛选条件。输入格式为运算符+分割服“|”+扫描次数,例如>=|100

>=|10000
AvgTotalUserCoststring

平均开销节约百分比(预测建立了缺失索引后,用户的平均 CPU 开销节约百分比。)筛选条件。输入格式为运算符+分割服“|”+平均开销节约百分比,例如筛选条件设置为查询平均开销节约百分比小于等于 10%时,输入:<=|10

<=|8
AvgUserImpactstring

性能提升百分比(预测建立了缺失索引后,用户的平均查询性能提升百分比。)筛选条件。输入格式为运算符+分割服“|”+性能提升百分比,例如筛选条件设置为查询性能提升百分比大于等于 100%时,输入:>=|100

>|10000
StartTimestring

索引最后查找时间的开始时间。格式为 Unix 时间戳,单位为毫秒。

1679414400000
EndTimestring

索引最后查找时间的结束时间。格式为 Unix 时间戳,单位为毫秒。

1681869544000

返回参数

名称类型描述示例值
object
Codestring

返回的状态码。

200
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
Dataobject

详细信息列表。

Listobject []

返回信息列表。

AvgTotalUserCostdouble

预测建立了缺失索引后,用户的平均 CPU 开销节约百分比。

4.67
AvgUserImpactdouble

预测建立了缺失索引后,用户的平均查询性能提升百分比。

98.3
DatabaseNamestring

数据库名称。

testdb
EqualityColumnsstring

相等列。缺失索引被使用来做等于查询的列。

col1,col2,col3
IncludedColumnsstring

包含列。缺失索引包含列。

col3,col4
IndexCountlong

索引个数。索引缺失表目前所拥有的索引个数。

1
LastUserSeeklong

用户最后查找时间。缺失索引用户最后的查找时间点。

1702023327000
ObjectNamestring

对象名。

stu
ReservedPageslong

总页数。

5025
ReservedSizedouble

总空间大小。

39.26
RowCountlong

记录数。

226945
SchemaNamestring

架构名。

dbo
SystemScanslong

扫描次数。

0
SystemSeekslong

查找次数。

0
UniqueCompileslong

编译次数。

2392
UserScanslong

用户扫描次数。索引缺失表被扫描的次数。

0
UserSeekslong

用户查找次数。索引缺失被查找的次数。

1081
InequalityColumnsstring

不等列。缺失索引被使用来做不等于查询的列。

2392
CreateIndexstring

索引创建语句。您可以使用这个语句来创建缺失索引。

CREATE INDEX [IX_CLOUDDBA_school_dbo_stu@col1_@col2] ON [school].[dbo].[stu]([col1],[col2],[col3]) INCLUDE ([col4],[col5]) WITH (FILLFACTOR = 90, ONLINE = OFF);
PageNolong

页码。

1
PageSizelong

每页数量。

10
Totallong

总记录数。

16
RequestIdstring

请求 ID。

0A74B755-98B7-59DB-8724-1321B394****
Successstring

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "List": [
      {
        "AvgTotalUserCost": 4.67,
        "AvgUserImpact": 98.3,
        "DatabaseName": "testdb",
        "EqualityColumns": "col1,col2,col3",
        "IncludedColumns": "col3,col4",
        "IndexCount": 1,
        "LastUserSeek": 1702023327000,
        "ObjectName": "stu",
        "ReservedPages": 5025,
        "ReservedSize": 39.26,
        "RowCount": 226945,
        "SchemaName": "dbo",
        "SystemScans": 0,
        "SystemSeeks": 0,
        "UniqueCompiles": 2392,
        "UserScans": 0,
        "UserSeeks": 1081,
        "InequalityColumns": "2392",
        "CreateIndex": "CREATE INDEX [IX_CLOUDDBA_school_dbo_stu@col1_@col2] ON [school].[dbo].[stu]([col1],[col2],[col3]) INCLUDE ([col4],[col5]) WITH (FILLFACTOR = 90, ONLINE = OFF);"
      }
    ],
    "PageNo": 1,
    "PageSize": 10,
    "Total": 16
  },
  "RequestId": "0A74B755-98B7-59DB-8724-1321B394****",
  "Success": "true"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

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

阿里云首页 数据库自治服务 相关技术圈