調用GetRequestDiagnosisResult介面,查詢SQL診斷的結果。
介面說明
使用該介面需滿足以下前提條件:
-
在使用 SDK 調用 DAS 服務時,需要將地區指定為 cn-shanghai。
-
該介面不支援查詢自動 SQL 最佳化的診斷結果
-
本介面適用的資料庫引擎為:
RDS MySQL
RDS PostgreSQL
RDS SQL Server
PolarDB MySQL 版
PolarDB PostgreSQL 版(相容 Oracle)
ApsaraDB for MongoDB
RDS PostgreSQL 執行個體核心小版本為 20220130 及以上。查看和升級核心小版本,請參見升級核心小版本。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
hdm:GetRequestDiagnosisResult |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| InstanceId |
string |
是 |
執行個體 ID。 |
rm-0iwhhl8gx0ld6**** |
| NodeId |
string |
否 |
節點 ID。 說明
對於 PolarDB MySQL 版、PolarDB PostgreSQL 版(相容 Oracle)和ApsaraDB for 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 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| Message |
string |
請求返回訊息。 說明
請求成功時該參數返回 Successful,請求失敗時會返回請求異常資訊(如錯誤碼等)。 |
Successful |
| RequestId |
string |
請求 ID。 |
800FBAF5-A539-5B97-A09E-C63AB2F7**** |
| Data |
object |
返回資料 |
|
| messageId |
string |
診斷 ID,唯一標識。 |
61820b594664275c4429**** |
| uuid |
string |
診斷執行個體唯一標識。 |
hdm_51fe9bc19ec413f4d530431af87a**** |
| accountId |
string |
使用者識別碼。 |
2093**** |
| sqlId |
string |
SQL 模板 ID。 |
0c95dae3afef77be06572612df9b**** |
| engine |
string |
資料庫引擎,取值:
|
MySQL |
| dbSchema |
string |
資料庫名。 |
das |
| param |
string |
額外資訊。 |
{"":""} |
| state |
integer |
診斷狀態:
|
2 |
| result |
string |
SQL 診斷結果。
|
{ "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 |
string |
SQL 診斷建立時間,格式為 Unix 時間戳記,單位為毫秒。 |
1633071840000 |
| gmtModified |
string |
SQL 診斷修改時間,格式為 Unix 時間戳記,單位為毫秒。 |
1633071850000 |
| Code |
string |
返回的狀態代碼。 |
200 |
| Success |
string |
請求是否執行成功:
|
true |
樣本
正常返回樣本
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. | 沒有許可權執行該操作 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。