GetSqlOptimizeAdvice_数据库自治服务_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

SQL 诊断功能提供实例诊断建议,您可通过诊断建议优化实例的索引,详情请参见自动 SQL 优化

说明 调用本接口只能查询由 DAS 自动 SQL 优化功能产生的诊断建议。

使用该接口需满足以下前提条件:

  • 数据库引擎为 RDS MySQL 和 PolarDB MySQL 版。
  • 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。

流控信息

请求速率为60/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
hdm:GetSqlOptimizeAdvice
Get
全部资源
*

请求参数

字段名称字段详情
ConsoleContextstring

备用参数。

示例值:None
Enginestring

数据库引擎,取值:展开详情

示例值:MySQL
InstanceIdsstring

实例 ID。展开详情

示例值:rm-2ze1jdv45i7l6****参考取值来源:
    AddHDMInstance
    GetInstanceInspections
StartDtstring

查询开始日期,格式:yyyyMMdd(UTC 时间)。展开详情

示例值:20210916
EndDtstring

查询结束日期,格式:yyyyMMdd(UTC 时间)。展开详情

示例值:20210917
Regionstring

实例所属地域,取值:展开详情

示例值:cn-china

返回参数

字段名称字段详情
Codestring

返回的状态码。

示例值:200
Messagestring

请求返回消息。展开详情

示例值:Successful
Dataobject

详细信息列表,包括信息总数、错误码等。

RequestIdstring

请求 ID。

示例值:B6D17591-B48B-4D31-9CD6-9B9796B2****
Successstring

请求是否执行成功:展开详情

示例值:true

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidParams
The request parameters are invalid.诊断
403
NoPermission
You are not authorized to do this action.诊断

变更历史

变更时间变更内容概要操作
2023-03-29
新增请求参数Region
2021-09-09
新增OpenAPI,查询自动SQL优化产生的诊断建议

相关示例