GetRequestDiagnosisResult を呼び出して、SQL 診断結果を取得します。
操作説明
この API には、次の前提条件があります。
-
SDK を使用して DAS サービスを呼び出す場合、リージョンを中国 (上海) に設定する必要があります。
-
この API は、自動 SQL 最適化の診断結果のクエリをサポートしていません。
-
この API は、次のデータベースエンジンをサポートしています。
RDS MySQL
RDS PostgreSQL
RDS SQL Server
PolarDB for MySQL
PolarDB for PostgreSQL (Oracle 互換)
ApsaraDB for MongoDB
RDS PostgreSQL インスタンスには、マイナーカーネルバージョン 20220130 以降が必要です。マイナーカーネルバージョンを表示およびアップグレードする方法については、「マイナーカーネルバージョンのアップグレード」をご参照ください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
hdm:GetRequestDiagnosisResult |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceId |
string |
必須 |
インスタンス ID。 |
rm-0iwhhl8gx0ld6**** |
| NodeId |
string |
任意 |
ノード ID。 説明
このパラメーターは、PolarDB for MySQL、PolarDB for PostgreSQL (Oracle 互換)、ApsaraDB for MongoDB などのクラスターインスタンスに必要です。 |
202**** |
| MessageId |
string |
必須 |
CreateRequestDiagnosis 操作によって返される一意の診断 ID。 説明
|
61820b594664275c4429**** |
| SqlId |
string |
任意 |
SQL テンプレート ID。 説明
このパラメーターは DAS コンソールが内部で使用します。このパラメーターを指定する必要はありません。 |
None |
| Source |
string |
任意 |
タスクのソース。 説明
このパラメーターは DAS コンソールが内部で使用します。このパラメーターを指定する必要はありません。 |
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 |
ユーザー ID。 |
2093**** |
| sqlId |
string |
SQL テンプレート ID。 |
0c95dae3afef77be06572612df9b**** |
| engine |
string |
データベースエンジン。有効な値：
|
MySQL |
| dbSchema |
string |
データベース名。 |
das |
| param |
string |
追加情報。 |
{"":""} |
| state |
integer |
診断ステータス。有効な値：
|
2 |
| result |
string |
SQL 診断結果の詳細。JSON 形式の文字列で返されます。
|
{ "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 |
例
成功レスポンス
JSONJSON
{
"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 ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. | |
| 403 | NoPermission | You are not authorized to do this action. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。