全部產品
Search

搜尋本產品

    ：GetSqlOptimizeAdvice - 查詢自動SQL最佳化產生的診斷建議

    文件中心

    ：GetSqlOptimizeAdvice - 查詢自動SQL最佳化產生的診斷建議

    更新時間：Dec 19, 2025

    調用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:GetSqlOptimizeAdvice

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ConsoleContext

    string

    否

    備用參數。

    None
    Engine

    string

    否

    資料庫引擎，取值：

    • MySQL：RDS MySQL。

    • PolarDBMySQL：PolarDB MySQL 版。

    MySQL
    InstanceIds

    string

    否

    執行個體 ID。

    說明

    僅支援 RDS MySQL、PolarDB MySQL 版執行個體。

    rm-2ze1jdv45i7l6****
    StartDt

    string

    否

    查詢開始日期，格式：yyyyMMdd（UTC 時間）。

    • 為空白時，預設為當前日期的前一天。

    • 只能查詢當前日期前一天及之前的資料。

    20210916
    EndDt

    string

    否

    查詢結束日期，格式：yyyyMMdd（UTC 時間）。

    • 為空白時，預設為當前日期的前一天。

    • 只能查詢當前日期前一天及之前的資料，查詢開始日期和查詢結束日期的間隔不能超過 30 天。

    20210917
    Region

    string

    否

    執行個體所屬地區，取值：

    • cn-china：中國內地。

    • cn-hongkong：中國香港。

    • ap-southeast-1：新加坡。

    此參數只有在請求參數 InstanceIds 為空白時有效。如果請求參數 InstanceIds 為空白時，按照 Region 參數設定的地區擷取資料，系統預設執行個體所屬地區為cn-china；如果請求參數 InstanceIds 不為空白時，即使設定了 Region 參數，也以 InstanceIds 所傳入的第一個執行個體所在地區為準擷取資料。

    說明

    在中國內地各地區建立的執行個體，傳入此參數時，都為cn-china。

    cn-china

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Code

    string

    返回的狀態代碼。

    200
    Message

    string

    請求返回訊息。

    說明

    請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。

    Successful
    Data

    object

    詳細資料列表，包括資訊總數、錯誤碼等。

    Status

    string

    任務運行狀態：

    • INIT：初始化。

    • RUNNING：運行中。

    • FINISH：完成。

    • FAILED：失敗。

    FINISH
    StatusCode

    string

    任務狀態代碼說明：

    • NO_DATA：沒有資料。

    • INTERNAL_ERROR：內部錯誤。

    • SUCCESS：成功。

    SUCCESS
    DownloadUrl

    string

    檔案下載的連結。

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

    string

    任務建立時間，格式為 Unix 時間戳記，單位為毫秒。

    1632303861000
    ExpireTime

    string

    檔案到期時間，格式為 Unix 時間戳記，單位為毫秒。

    說明

    任務建立 3 天后，檔案到期。

    1632563061000
    TaskId

    string

    任務 ID。

    2021091710461519216****
    RequestId

    string

    請求 ID。

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

    string

    請求是否執行成功：

    • 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

    錯誤碼

    錯誤資訊

    描述
    400 InvalidParams The request parameters are invalid.
    403 NoPermission You are not authorized to do this action.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。