全部产品
Search

搜索本产品

    数据库自治服务 DAS：GetSqlOptimizeAdvice - 查询自动SQL优化产生的诊断建议

    文档中心

    数据库自治服务 DAS：GetSqlOptimizeAdvice - 查询自动SQL优化产生的诊断建议

    更新时间：Nov 14, 2024

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

    接口说明

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

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

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

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

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    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
    Regionstring否

    实例所属地域，取值：

    • cn-china：中国内地。
    • cn-hongkong：中国香港。
    • ap-southeast-1：新加坡。

    此参数只有在请求参数 InstanceIds 为空时有效。如果请求参数 InstanceIds 为空时，按照 Region 参数设置的地域获取数据，系统默认实例所属地域为cn-china；如果请求参数 InstanceIds 不为空时，即使设置了 Region 参数，也以 InstanceIds 所传入的第一个实例所在地域为准获取数据。

    说明 在中国内地各地域创建的实例，传入此参数时，都为cn-china。
    		cn-china

    返回参数

    名称类型描述示例值
    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.请求参数错误
    403NoPermissionYou are not authorized to do this action.没有权限执行该操作

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

    变更历史

    变更时间变更内容概要操作
    2023-03-29OpenAPI 描述信息更新、OpenAPI 入参发生变更查看变更详情