調用GetSqlOptimizeAdvice接口,查詢DAS自動SQL優化產生的診斷建議。
接口說明
SQL 診斷功能提供實例診斷建議,您可通過診斷建議優化實例的索引,詳情請參見自動 SQL 優化。
說明
調用本接口只能查詢由 DAS 自動 SQL 優化功能產生的診斷建議。
使用該接口需滿足以下前提條件:
- 數據庫引擎為 RDS MySQL 和 PolarDB MySQL 版。
- 使用阿里云或 DAS 的 SDK 時,建議使用最新版本。
- 在使用 SDK 調用 DAS 服務時,需要將地域指定為 cn-shanghai。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ConsoleContext | string | 否 | 備用參數。 | None |
Engine | string | 否 | 數據庫引擎,取值:
| MySQL |
InstanceIds | string | 否 | 實例 ID。 說明
僅支持 RDS MySQL、PolarDB MySQL 版實例。
| rm-2ze1jdv45i7l6**** |
StartDt | string | 否 | 查詢開始日期,格式:yyyyMMdd(UTC 時間)。
| 20210916 |
EndDt | string | 否 | 查詢結束日期,格式:yyyyMMdd(UTC 時間)。
| 20210917 |
Region | string | 否 | 實例所屬地域,取值:
此參數只有在請求參數 InstanceIds 為空時有效。如果請求參數 InstanceIds 為空時,按照 Region 參數設置的地域獲取數據,系統默認實例所屬地域為cn-china;如果請求參數 InstanceIds 不為空時,即使設置了 Region 參數,也以 InstanceIds 所傳入的第一個實例所在地域為準獲取數據。 說明
在中國內地各地域創建的實例,傳入此參數時,都為cn-china。
| cn-china |
返回參數
示例
正常返回示例
JSON
格式
{
"Code": "200",
"Data": {
"CreateTime": "1632303861000",
"DownloadUrl": "https://das-sql-optimize.oss-cn-shanghai.aliyuncs.com/adb/oss_sql_optimize_advice/1083*******",
"ExpireTime": "1632563061000",
"Status": "FINISH",
"StatusCode": "SUCCESS",
"TaskId": "2021091710461519216****"
},
"Message": "Successful",
"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. | 沒有權限執行該操作 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-03-29 | OpenAPI 描述信息更新、OpenAPI 入參發生變更 | 查看變更詳情 |