首页 数据库自治服务 DAS API参考指南 API目录 自动SQL优化 GetSqlOptimizeAdvice - 查询自动SQL优化产生的诊断建议

GetSqlOptimizeAdvice - 查询自动SQL优化产生的诊断建议

调用GetSqlOptimizeAdvice接口,查询DAS自动SQL优化产生的诊断建议。

接口说明

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

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

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

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

调试

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

调试

授权信息

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

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

请求参数

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

备用参数。

None
Enginestring

数据库引擎,取值:

  • MySQL:RDS MySQL。
  • PolarDBMySQL:PolarDB MySQL版。
MySQL
InstanceIdsstring

实例ID。

说明仅支持RDS MySQL、PolarDB MySQL版实例。
rm-2ze1jdv45i7l6****
StartDtstring

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

说明
  • 为空时,默认为当前日期的前一天。
  • 只能查询当前日期前一天及之前的数据。
  • 20210916
    EndDtstring

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

    说明
  • 为空时,默认为当前日期的前一天。
  • 只能查询当前日期前一天及之前的数据,查询开始日期和查询结束日期的间隔不能超过30天。
  • 20210917

    返回参数

    名称类型描述示例值
    object
    Codestring

    返回的状态码。

    200
    Messagestring

    请求返回消息。

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

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

    Statusstring

    任务运行状态:

    • INIT:初始化。
    • RUNNING:运行中。
    • FINISH:完成。
    • FAILED:失败。
    FINISH
    StatusCodestring

    任务状态码说明:

    • NO_DATA:没有数据。
    • INTERNAL_ERROR:内部错误。
    • SUCCESS:成功。
    SUCCESS
    DownloadUrlstring

    文件下载的链接。

    https://das-sql-optimize.oss-cn-shanghai.aliyuncs.com/adb/oss_sql_optimize_advice/1083*******
    CreateTimestring

    任务创建时间,格式为Unix时间戳,单位为毫秒。

    1632303861000
    ExpireTimestring

    文件过期时间,格式为Unix时间戳,单位为毫秒。

    说明任务创建3天后,文件过期。
    1632563061000
    TaskIdstring

    任务ID。

    2021091710461519216****
    RequestIdstring

    请求ID。

    B6D17591-B48B-4D31-9CD6-9B9796B2****
    Successstring

    请求是否执行成功:

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

    示例

    正常返回示例

    JSON格式

    {
      "Code": "200",
      "Message": "Successful",
      "Data": {
        "Status": "FINISH",
        "StatusCode": "SUCCESS",
        "DownloadUrl": "https://das-sql-optimize.oss-cn-shanghai.aliyuncs.com/adb/oss_sql_optimize_advice/1083*******",
        "CreateTime": "1632303861000",
        "ExpireTime": "1632563061000",
        "TaskId": "2021091710461519216****"
      },
      "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
      "Success": "true"
    }

    错误码

    HTTP status code错误码错误信息描述
    400InvalidParamsThe request parameters are invalid.请求参数错误

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

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