SQL 診断レコードをページ単位で照会します。
操作説明
この API オペレーションを呼び出す前に、次の点にご注意ください。
-
SDK を使用して Database Autonomy Service (DAS) の API オペレーションを呼び出す場合、リージョン ID を cn-shanghai に設定する必要があります。
-
この API オペレーションは、次のデータベースエンジンをサポートしています。
ApsaraDB RDS for MySQL
ApsaraDB RDS for PostgreSQL
ApsaraDB RDS for SQL Server
PolarDB for MySQL
PolarDB for PostgreSQL (Compatible with Oracle)
ApsaraDB for MongoDB
Apsara RDS for PostgreSQL インスタンスのマイナーエンジンバージョンは 20220130 以降である必要があります。ApsaraDB RDS for PostgreSQL インスタンスのマイナーエンジンバージョンの確認方法と更新方法の詳細については、「ApsaraDB RDS for PostgreSQL インスタンスのマイナーエンジンバージョンの更新」をご参照ください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
hdm:GetRequestDiagnosisPage |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceId |
string |
必須 |
インスタンス ID。 |
rm-0iwhhl8gx0ld6**** |
| NodeId |
string |
任意 |
ノード ID。 説明
データベースインスタンスが PolarDB for MySQL、PolarDB for PostgreSQL (Compatible with Oracle)、または ApsaraDB for MongoDB インスタンスの場合は、ノード ID を指定する必要があります。 |
202**** |
| PageNo |
integer |
必須 |
ページ番号。正の整数である必要があります。デフォルト値：1。 |
1 |
| PageSize |
integer |
必須 |
1 ページあたりのエントリ数。正の整数である必要があります。デフォルト値：10。 |
10 |
| StartTime |
integer |
必須 |
照会する時間範囲の開始時刻。1970 年 1 月 1 日 00:00:00 (UTC) から経過したミリ秒数を表す UNIX タイムスタンプに設定します。 |
1633071840000 |
| EndTime |
integer |
必須 |
照会する時間範囲の終了時刻。1970 年 1 月 1 日 00:00:00 (UTC) から経過したミリ秒数を表す UNIX タイムスタンプに設定します。 |
1634972640000 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| Message |
string |
返されたメッセージ。 説明
リクエストが成功した場合、`Successful` が返されます。リクエストが失敗した場合、エラーコードなどの情報を含むエラーメッセージが返されます。 |
Successful |
| RequestId |
string |
リクエスト ID。 |
800FBAF5-A539-5B97-A09E-C63AB2F7**** |
| Data |
object |
返されたデータ。 |
|
| list |
array<object> |
返された SQL 診断レコード。 |
|
|
object |
|||
| messageId |
string |
診断タスクの一意の ID。 |
61820b594664275c4429**** |
| uuid |
string |
診断インスタンスの一意の ID。 |
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 診断タスクの結果。結果には次の情報が含まれます。
|
{ "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 診断タスクが作成された時刻。1970 年 1 月 1 日 00:00:00 (UTC) から経過したミリ秒数を表す UNIX タイムスタンプです。 |
1633071840000 |
| gmtModified |
string |
SQL 診断タスクが変更された時刻。1970 年 1 月 1 日 00:00:00 (UTC) から経過したミリ秒数を表す UNIX タイムスタンプです。 |
1633071850000 |
| pageNo |
integer |
ページ番号。正の整数である必要があります。デフォルト値：1。 |
1 |
| pageSize |
integer |
1 ページあたりのエントリ数。正の整数である必要があります。デフォルト値：10。 |
10 |
| total |
integer |
返されたエントリの総数。 |
100 |
| extra |
string |
追加情報。 |
{"":""} |
| Code |
string |
返された HTTP ステータスコード。 |
200 |
| Success |
string |
リクエストが成功したかどうかを示します。有効な値：
|
true |
例
成功レスポンス
JSONJSON
{
"Message": "Successful",
"RequestId": "800FBAF5-A539-5B97-A09E-C63AB2F7****",
"Data": {
"list": [
{
"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"
}
],
"pageNo": 1,
"pageSize": 10,
"total": 100,
"extra": "{\"\":\"\"}"
},
"Code": "200",
"Success": "true"
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. | |
| 403 | NoPermission | You are not authorized to do this action. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。