GetInstanceMissingIndexList - 查询RDS SQL Server实例索引缺失情况-阿里云帮助中心

调用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:GetInstanceMissingIndexList

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	数据库实例 ID。	rm-t4nfalp2ap421****
PageNo	string	否	分页查询的页码，从 1 开始，默认为 1。	1
PageSize	string	否	每页最大记录数，默认值为 10。	10
ObjectName	string	否	对象名。	bas_customer
ReservedSize	string	否	表总空间筛选条件。单位为 MB。输入格式为`运算符+分割服“\|”+表总空间大小`，例如筛选条件设置为查询总空间大于等于 100M 的表时，输入：`>=\|100`。	>=\|100
RowCount	string	否	表记录数筛选条件。输入格式为`运算符+分割服“\|”+表记录数`，例如`>=\|100`。	>=\|100000
ReservedPages	string	否	总页数筛选条件。输入格式为`运算符+分割服“\|”+总页数`，例如`>=\|100`。	>=\|100
IndexCount	string	否	索引个数（索引缺失表目前所拥有的索引个数）筛选条件。输入格式为`运算符+分割服“\|”+索引个数`，例如`>=\|100`。	>=\|8
UniqueCompiles	string	否	编译次数筛选条件。输入格式为`运算符+分割服“\|”+编译次数`，例如`>=\|100`。	>=\|10000
UserSeeks	string	否	查找次数筛选条件。输入格式为`运算符+分割服“\|”+查找次数`，例如`>=\|100`。	>=\|1000
UserScans	string	否	扫描次数筛选条件。输入格式为`运算符+分割服“\|”+扫描次数`，例如`>=\|100`。	>=\|10000
AvgTotalUserCost	string	否	平均开销节约百分比（预测建立了缺失索引后，用户的平均 CPU 开销节约百分比。）筛选条件。输入格式为`运算符+分割服“\|”+平均开销节约百分比`，例如筛选条件设置为查询平均开销节约百分比小于等于 10%时，输入：`<=\|10`。	<=\|8
AvgUserImpact	string	否	性能提升百分比（预测建立了缺失索引后，用户的平均查询性能提升百分比。）筛选条件。输入格式为`运算符+分割服“\|”+性能提升百分比`，例如筛选条件设置为查询性能提升百分比大于等于 100%时，输入：`>=\|100`。	>\|10000
StartTime	string	否	索引最后查找时间的开始时间。格式为 Unix 时间戳，单位为毫秒。	1679414400000
EndTime	string	否	索引最后查找时间的结束时间。格式为 Unix 时间戳，单位为毫秒。	1681869544000

返回参数

名称	类型	描述	示例值
	object
Code	string	返回的状态码。	200
Message	string	请求返回消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
Data	object	详细信息列表。
List	array<object>	返回信息列表。
	object	记录详情。
AvgTotalUserCost	number	预测建立了缺失索引后，用户的平均 CPU 开销节约百分比。	4.67
AvgUserImpact	number	预测建立了缺失索引后，用户的平均查询性能提升百分比。	98.3
DatabaseName	string	数据库名称。	testdb
EqualityColumns	string	相等列。缺失索引被使用来做等于查询的列。	col1,col2,col3
IncludedColumns	string	包含列。缺失索引包含列。	col3,col4
IndexCount	integer	索引个数。索引缺失表目前所拥有的索引个数。	1
LastUserSeek	integer	用户最后查找时间。缺失索引用户最后的查找时间点。	1702023327000
ObjectName	string	对象名。	stu
ReservedPages	integer	总页数。	5025
ReservedSize	number	总空间大小。	39.26
RowCount	integer	记录数。	226945
SchemaName	string	架构名。	dbo
SystemScans	integer	扫描次数。	0
SystemSeeks	integer	查找次数。	0
UniqueCompiles	integer	编译次数。	2392
UserScans	integer	用户扫描次数。索引缺失表被扫描的次数。	0
UserSeeks	integer	用户查找次数。索引缺失被查找的次数。	1081
InequalityColumns	string	不等列。缺失索引被使用来做不等于查询的列。	2392
CreateIndex	string	索引创建语句。您可以使用这个语句来创建缺失索引。	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	integer	页码。	1
PageSize	integer	每页数量。	10
Total	integer	总记录数。	16
RequestId	string	请求 ID。	0A74B755-98B7-59DB-8724-1321B394****
Success	string	请求是否执行成功： 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	错误码	错误信息	描述
400	InvalidParams	The request parameters are invalid.	请求参数错误
403	NoPermission	You are not authorized to do this action.	没有权限执行该操作

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

变更历史

更多信息，参考变更详情。