調用GetRequestDiagnosisResult接口,查詢SQL診斷的結果。
接口說明
使用該接口需滿足以下前提條件:
-
在使用 SDK 調用 DAS 服務時,需要將地域指定為 cn-shanghai。
-
該接口不支持查詢自動 SQL 優化的診斷結果
-
本接口適用的數據庫引擎為:
- RDS MySQL
- RDS PostgreSQL
- RDS SQL Server
- PolarDB MySQL 版
- PolarDB PostgreSQL 版(兼容 Oracle)
- 云數據庫 MongoDB 版
說明
RDS PostgreSQL 實例內核小版本為 20220130 及以上。查看和升級內核小版本,請參見升級內核小版本。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
hdm:GetRequestDiagnosisResult | get | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 實例 ID。 | rm-0iwhhl8gx0ld6**** |
NodeId | string | 否 | 節點 ID。 說明
對于 PolarDB MySQL 版、PolarDB PostgreSQL 版(兼容 Oracle)和云數據庫 MongoDB 等集群實例,需要提供節點 ID。
| 202**** |
MessageId | string | 是 | 診斷 ID, CreateRequestDiagnosis 接口返回的診斷唯一標識。 說明
當 MessageId 為自動 SQL 優化的診斷 ID 時,該接口無法返回診斷結果
| 61820b594664275c4429**** |
SqlId | string | 否 | SQL 模板 ID。 說明
此參數是 DAS 控制臺調用 API 時使用,用戶使用此 API 時無需傳入。
| None |
Source | string | 否 | 任務來源。 說明
此參數是 DAS 控制臺調用 API 時使用,用戶使用此 API 時無需傳入。
| None |
返回參數
示例
正常返回示例
JSON
格式
{
"Message": "Successful",
"RequestId": "800FBAF5-A539-5B97-A09E-C63AB2F7****",
"Data": {
"messageId": "61820b594664275c4429****",
"uuid": "hdm_51fe9bc19ec413f4d530431af87a****",
"accountId": "2093****",
"sqlId": "0c95dae3afef77be06572612df9b****",
"engine": "MySQL",
"dbSchema": "das",
"param": "{\"\":\"\"}",
"state": 2,
"result": "{ \"endTime\":1636354256000, \"errorCode\":\"0001\", \"errorMessage\":\"TFX成功\", \"estimateCost\":{ \"cpu\":1.7878745150389268, \"io\":9.948402604746128, \"rows\":8.889372575194633 }, \"improvement\":12933.97, \"indexAdvices\":[ { \"columns\":[ \"work_no\" ], \"ddlAddIndex\":\"ALTER TABLE `test`.`work_order` ADD INDEX `idx_workno` (`work_no`)\", \"indexName\":\"idx_workno\", \"schemaName\":\"test\", \"tableName\":\"work_order\", \"unique\":false } ], \"ip\":\"****.mysql.rds.aliyuncs.com\", \"messageId\":\"6188c8cb2f1365b16aee****\", \"port\":3306, \"sqlTag\":\"{\\\"PRED_EQUAL\\\":\\\"Y\\\",\\\"CNT_QB\\\":\\\"1\\\",\\\"CNT_TB\\\":\\\"1\\\"}\", \"startTime\":1636354252000, \"success\":true, \"support\":true, \"tuningAdvices\":[ ] }",
"gmtCreate": "1633071840000",
"gmtModified": "1633071850000"
},
"Code": "200",
"Success": "true"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 請求參數錯誤 |
403 | NoPermission | You are not authorized to do this action. | 沒有權限執行該操作 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|
暫無變更歷史