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

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

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

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetSqlOptimizeAdvice

系统规定参数。取值:GetSqlOptimizeAdvice

ConsoleContext String None

备用参数。

Engine String MySQL

数据库引擎,取值:

  • MySQL:RDS MySQL。
  • PolarDBMySQL:PolarDB MySQL。
InstanceIds String rm-2ze1jdv45i7l6****

实例ID,您可通过调用GetInstanceInspections接口获取。

说明 仅支持RDS MySQL、PolarDB MySQL实例。
StartDt String 20210916

SQL建议生成的开始日期,格式:yyyyMMdd(UTC时间)。

说明 若为空,默认为当前日期前一天。
EndDt String 20210917

SQL建议生成的结束日期,格式:yyyyMMdd(UTC时间)。

说明 若为空,默认为当前日期前一天,开始日期和结束日期不能超过30天。

返回数据

名称 类型 示例值 描述
Code String 200

返回的状态码。

Message String Successful

请求返回消息。

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

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

Status String FINISH

任务运行状态:

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

任务状态码说明:

  • NO_DATA:没有数据。
  • INTERNAL_ERROR:内部错误。
  • SUCCESS:成功。
DownloadUrl String https://das-sql-optimize.oss-cn-shanghai.aliyuncs.com/adb/oss_sql_optimize_advice/1083*******

文件下载的链接。

CreateTime String 1632303861000

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

ExpireTime String 1632563061000

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

说明 文件过期时间为任务创建时间的3天后。
TaskId String 2021091710461519216****

任务ID。

RequestId String B6D17591-B48B-4D31-9CD6-9B9796B2****

请求ID。

Success String true

请求是否执行成功:

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

示例

请求示例

http(s)://das.cn-shanghai.aliyuncs.com/?Action=GetSqlOptimizeAdvice
&ConsoleContext=None
&Engine=MySQL
&InstanceIds=rm-2ze1jdv45i7l6****
&StartDt=20210916
&EndDt=20210917
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParams The request parameters are invalid. 请求参数错误

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