この API は、データベースインスタンスからスローログレコードを取得します。さまざまな条件によるフィルターとソートをサポートしています。
操作説明
InstanceIdはインスタンス ID です。このパラメーターは必須です。StartTimeとEndTimeは、クエリの時間範囲を指定します。これらのパラメーターは必須です。PageNumberとPageSizeパラメーターを使用して、結果をページ分割します。OrderByパラメーターを使用して、結果をソートします。ソート可能なフィールドの詳細については、ドキュメントをご参照ください。Filtersパラメーターを使用して、ホストアドレスや SQL ID などの条件でクエリを絞り込みます。重要 RDS for PostgreSQL や PolarDB for PostgreSQL など、一部のデータベースタイプでは特定のソート方法をサポートしていません。ご利用のデータベースタイプに適したパラメーターを選択してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
hdm:DescribeSlowLogRecords |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceId |
string |
必須 |
インスタンス ID。 |
rm-8vbk4xz99su8**** |
| NodeId |
string |
任意 |
ノード ID。 |
pi-d9j9fe7wq7t9i**** |
| StartTime |
integer |
必須 |
クエリ範囲の開始時刻。この値は、1970 年 1 月 1 日 00:00:00 協定世界時 (UTC) から経過したミリ秒数を表す UNIX タイムスタンプです。 |
1596177993000 |
| EndTime |
integer |
必須 |
クエリ範囲の終了時刻。この値は、1970 年 1 月 1 日 00:00:00 協定世界時 (UTC) から経過したミリ秒数を表す UNIX タイムスタンプです。 |
1634972640000 |
| PageNumber |
integer |
任意 |
返されるページのページ番号。ページは 1 から始まります。 |
1 |
| PageSize |
integer |
任意 |
各ページで返されるエントリ数。 |
10 |
| Filters |
array<object> |
任意 |
フィルター条件。 |
|
|
object |
任意 |
フィルター条件。 |
||
| Key |
string |
任意 |
フィルターパラメーターの名前。 説明
詳細については、「リクエストパラメーターの補足情報」セクションをご参照ください。 |
None |
| Value |
string |
任意 |
フィルターパラメーターの値。 |
None |
| OrderBy |
string |
任意 |
重要 ApsaraDB RDS for PostgreSQL、PolarDB for PostgreSQL (Compatible with Oracle)、および ApsaraDB for SQL Server インスタンスでは、ソートはサポートされていません。 |
QueryTimeSeconds |
| Asc |
boolean |
任意 |
結果を昇順でソートするかどうかを指定します。デフォルト値: true。
|
true |
Key パラメーターは次の値をサポートしています。
- RDS for MySQL、PolarDB for MySQL、RDS for PostgreSQL、および PolarDB for PostgreSQL
hostAddress: 送信元 IP アドレス。複数の値はコンマで区切ります。
sqlId: SQL ID。複数の値はコンマで区切ります。
user: ユーザー。複数の値はコンマで区切ります。
dbName: データベース名。複数の値はコンマで区切ります。
tags: タグ。複数の値はコンマで区切ります。
- MongoDB
hostInsId: ロール ID。複数の値はコンマで区切ります。
insRole: インスタンスロール。複数の値はコンマで区切ります。
opType: 操作タイプ。複数の値はコンマで区切ります。
namespace: 名前空間。複数の値はコンマで区切ります。
nodeType: コンポーネントタイプ。複数の値はコンマで区切ります。
queryId: クエリ ID。複数の値はコンマで区切ります。
- Tair
hostAddress: 送信元 IP アドレス。
user: ユーザー。
dbName: データベース名。
nodeType: ノードタイプ。
- RDS for SQL Server
hostAddress: 送信元 IP アドレス。複数の値はコンマで区切ります。
sqlId: SQL ID。複数の値はコンマで区切ります。
user: ユーザー。複数の値はコンマで区切ります。
dbName: データベース名。複数の値はコンマで区切ります。
tags: タグ。複数の値はコンマで区切ります。
- PolarDB-X
traceId: トレース ID。
role: ノードロール。このパラメーターは必須です。有効な値:
CN(コンピュートノード) とDN(データノード)。hostAddress: 送信元 IP アドレス。複数の値はコンマで区切ります。
sqlId: SQL ID。複数の値はコンマで区切ります。
user: ユーザー。複数の値はコンマで区切ります。
dbName: データベース名。複数の値はコンマで区切ります。
tags: タグ。複数の値はコンマで区切ります。
SQL エンジンでは、sqlId でデータをクエリできます。
sqlIdパラメーターは最大 20 個のコンマ区切り値を受け入れます。MongoDB では、queryId でデータをクエリできます。
queryIdパラメーターは最大 20 個のコンマ区切り値を受け入れます。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| Code |
string |
応答状態コード。 |
200 |
| Message |
string |
応答メッセージ。 説明
リクエストが成功した場合、Successful が返されます。リクエストが失敗した場合、エラーメッセージが返されます。 |
Successful |
| RequestId |
string |
リクエスト ID。 |
A1C79EE2-D04D-571B-8C60-961FAF8E**** |
| Success |
string |
リクエストが成功したかどうかを示します。有効な値:
|
true |
| Data |
object |
スロークエリログの詳細。 |
|
| DbInstanceName |
string |
インスタンス ID。 |
rm-bp157g54vy772**** |
| NodeId |
string |
ノード ID。 |
node123 |
| ItemsNumbers |
integer |
現在のページのスローログレコード数。 |
10 |
| StartTime |
string |
開始時刻。 |
1672531200000 |
| EndTime |
string |
終了時刻。 |
1672617600000 |
| DbInstanceId |
integer |
インスタンスの数値 ID。 |
100 |
| TotalRecords |
integer |
合計エントリ数。 |
100 |
| PageNumbers |
integer |
ページ番号。ページは 1 から始まります。デフォルト値は 1 です。 |
1 |
| MaxRecordsPerPage |
integer |
各ページで返される最大エントリ数。有効な値: 5 ~ 100。 |
20 |
| Logs |
array<object> |
スロークエリログレコードの配列。 |
|
|
array<object> |
スロークエリログレコード。 |
||
| SqlId |
string |
SQL テンプレート ID。 |
sqlId |
| Scheme |
string |
データスキーマ。 |
HTTPS |
| SubInstanceId |
string |
サブインスタンス ID。 |
r-8vb219d10038**** |
| DbInstanceName |
string |
インスタンス ID。 |
rm-2zebg30mk056g**** |
| InsName |
string |
インスタンス名。 |
test |
| AccountName |
string |
アカウント名。 |
user1 |
| HostAddress |
string |
送信元 IP アドレス。 |
192.168.1.1 |
| QueryStartTime |
string |
クエリが開始された時刻。時刻は yyyy-MM-dd hh:mm:ss 形式で、協定世界時 (UTC) で表示されます。 |
2024-04-01 11:00:00 |
| SQLText |
string |
SQL ステートメント。 |
SELECT * FROM my_table WHERE ROWNUM <= 10 |
| Psql |
string |
SQL テンプレート。 |
SELECT * FROM my_table WHERE ROWNUM <= 10 |
| DBName |
string |
データベース名。 |
test |
| QueryTime |
integer |
クエリ実行時間 (ミリ秒単位)。 |
121 |
| ReturnItemNumbers |
string |
返されたアイテムの数。 |
test |
| DocsExamined |
string |
スキャンされたドキュメントの数。 説明 このパラメーターは、ApsaraDB for MongoDB インスタンスにのみ返されます。 |
100 |
| KeysExamined |
string |
スキャンされたインデックスエントリの数。 説明 このパラメーターは、ApsaraDB for MongoDB インスタンスにのみ返されます。 |
valueA |
| TableName |
string |
テーブル名。 |
tableNameExample |
| LockTime |
number |
ロック待ち時間 (ミリ秒単位)。 |
100 |
| RowsExamined |
integer |
スキャンされた行数。 |
100 |
| RowsSent |
integer |
返された行数。 |
10 |
| ThreadId |
string |
スレッド ID。 |
57472578 |
| Timestamp |
integer |
Unix タイムスタンプ。単位: 秒。 |
1747118812 |
| SqlTag |
object |
SQL タグの詳細。 |
|
| SqlId |
string |
SQL テンプレート ID。 |
8ad7069f236bcdaaa9b3ae4b6299**** |
| Tags |
string |
タグ。複数のタグはコンマ ( |
DAS_IMPORTANT,DAS_IN_PLAN |
| Comments |
string |
備考。 |
test |
| LockTimeSeconds |
number |
ロック待ち時間 (秒単位)。 |
100 |
| QueryTimeSeconds |
number |
クエリ実行時間 (秒単位)。 |
100 |
| SqlType |
string |
SQL ステートメントのタイプ。有効な値:
|
SELECT |
| CPUTime |
number |
クエリによって消費された CPU 時間。 説明
このパラメーターは ApsaraDB RDS for SQL Server インスタンスにのみ返されます。 |
50 |
| IOWrites |
integer |
I/O 書き込み数。 説明
このパラメーターは ApsaraDB RDS for SQL Server インスタンスにのみ返されます。 |
1 |
| LastRowsCountAffected |
integer |
最後のステートメントによって影響を受けた行数。 説明
このパラメーターは ApsaraDB RDS for SQL Server インスタンスにのみ返されます。 |
10 |
| LogicalIOReads |
integer |
論理読み込み数。 説明
このパラメーターは ApsaraDB RDS for SQL Server インスタンスにのみ返されます。 |
1 |
| PhysicalIOReads |
integer |
物理読み込み数。 説明
このパラメーターは ApsaraDB RDS for SQL Server インスタンスにのみ返されます。 |
1 |
| RowsCountAffected |
integer |
影響を受けた行数。 説明
このパラメーターは ApsaraDB RDS for SQL Server インスタンスにのみ返されます。 |
10 |
| Command |
string |
スロークエリステートメント。 説明 このパラメーターは、Tair インスタンスの場合にのみ返されます。 |
SELECT |
| Namespace |
string |
名前空間。 説明 このパラメーターは、ApsaraDB for MongoDB インスタンスの場合にのみ返されます。 |
pro-test |
| QueryId |
string |
クエリ ID。 説明 このパラメーターは ApsaraDB for MongoDB インスタンスに対してのみ返されます。 |
sq-1pzcdMwRb |
| ReturnNum |
string |
文字列としての返された行数。 説明 このパラメーターは、ApsaraDB for MongoDB インスタンスの場合にのみ返されます。 |
20 |
| ApplicationName |
string |
アプリケーション名。 説明 このパラメーターは、ApsaraDB RDS for SQL Server インスタンスの場合にのみ返されます。 |
MyApp |
| CPUTimeSeconds |
number |
クエリによって消費された CPU 時間 (秒単位)。 説明 このパラメーターは、ApsaraDB RDS for SQL Server インスタンスでのみ返されます。 |
100 |
| Rows |
integer |
PolarDB-X 2.0 インスタンスのコンピュートノードによって更新または返された行の合計数。 説明
このパラメーターは PolarDB-X 2.0 インスタンスにのみ返されます。 |
20 |
| Frows |
integer |
PolarDB-X 2.0 インスタンスのコンピュートノード (CN) によってフェッチされた行数。 説明
このパラメーターは PolarDB-X 2.0 インスタンスにのみ返されます。 |
10 |
| Scnt |
integer |
PolarDB-X 2.0 インスタンスのコンピュートノード (CN) からデータノード (DN) に送信されたリクエスト数。 説明
このパラメーターは PolarDB-X 2.0 インスタンスにのみ返されます。 |
10 |
| TraceId |
string |
PolarDB-X 2.0 インスタンスのトレース ID。データノード上の SQL ステートメントの実行 ID を表します。 説明
このパラメーターは PolarDB-X 2.0 インスタンスにのみ返されます。 |
074ce334-5247-40b9-b0c1-158aea5d**** |
| TemplateId |
string |
PolarDB-X 2.0 インスタンスのテンプレート ID。 説明
このパラメーターは PolarDB-X 2.0 インスタンスにのみ返されます。 |
6a63b6ac4572abfaef7d1163f684**** |
| NodeId |
string |
ノード ID。 |
|
| Cmd |
string |
データをクエリする際に使用されるコマンドです。 説明 このパラメーターは、Tair インスタンスでのみ返されます。 |
|
| Rt |
integer |
実行時間。単位:マイクロ秒。 説明 Tair インスタンスの場合のみ、このパラメーターが応答に含まれます。 |
|
| RequestSize |
integer |
リクエストのサイズをバイト単位で示します。 説明 このパラメーターは、Tair インスタンスの場合にのみ返されます。 |
|
| ResponseSize |
integer |
応答のサイズです。単位: バイト。 説明 注記: このパラメーターは、Tair インスタンスにのみ返されます。 |
|
| ClientIp |
string |
クライアントの IP アドレスです。 説明 このパラメーターは Tair インスタンスの場合にのみ返されます。 |
|
| DbId |
string |
データベースの ID です。 説明 このパラメーターは、Tair インスタンスの場合にのみ返されます。 |
|
| OriginTime |
string |
コマンドが実行された時刻です。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。 説明 このパラメーターは、ApsaraDB for MongoDB インスタンスでのみ応答に含まれます。 |
|
| OpType |
string |
操作タイプ。 説明 このパラメーターは、ApsaraDB for MongoDB インスタンスの場合にのみ返されます。 |
|
| Fail |
string |
コマンドの実行が失敗したかどうかを示します。 説明 このパラメーターは、ApsaraDB for MongoDB インスタンスの場合にのみ返されます。 |
|
| Params |
string |
コマンドのパラメーターです。 説明 このパラメーターは、ApsaraDB for MongoDB インスタンスの場合にのみ返されます。 |
|
| Reason |
string |
コマンドの実行に失敗した理由です。 説明 このパラメーターは、ApsaraDB for MongoDB インスタンスでのみ返されます。 |
|
| ReqId |
string |
リクエスト ID です。 説明 このパラメーターは、ApsaraDB for MongoDB インスタンスの場合にのみ返されます。 |
例
成功レスポンス
JSONJSON
{
"Code": "200",
"Message": "Successful",
"RequestId": "A1C79EE2-D04D-571B-8C60-961FAF8E****",
"Success": "true",
"Data": {
"DbInstanceName": "rm-bp157g54vy772****",
"NodeId": "node123",
"ItemsNumbers": 10,
"StartTime": "1672531200000",
"EndTime": "1672617600000",
"DbInstanceId": 100,
"TotalRecords": 100,
"PageNumbers": 1,
"MaxRecordsPerPage": 20,
"Logs": [
{
"SqlId": "sqlId",
"Scheme": "HTTPS",
"SubInstanceId": "r-8vb219d10038****",
"DbInstanceName": "rm-2zebg30mk056g****",
"InsName": "test",
"AccountName": "user1",
"HostAddress": "192.168.1.1",
"QueryStartTime": "2024-04-01 11:00:00",
"SQLText": "SELECT * FROM my_table WHERE ROWNUM <= 10",
"Psql": "SELECT * FROM my_table WHERE ROWNUM <= 10\n",
"DBName": "test",
"QueryTime": 121,
"ReturnItemNumbers": "test",
"DocsExamined": "100",
"KeysExamined": "valueA",
"TableName": "tableNameExample",
"LockTime": 100,
"RowsExamined": 100,
"RowsSent": 10,
"ThreadId": "57472578",
"Timestamp": 1747118812,
"SqlTag": {
"SqlId": "8ad7069f236bcdaaa9b3ae4b6299****",
"Tags": "DAS_IMPORTANT,DAS_IN_PLAN",
"Comments": "test"
},
"LockTimeSeconds": 100,
"QueryTimeSeconds": 100,
"SqlType": "SELECT",
"CPUTime": 50,
"IOWrites": 1,
"LastRowsCountAffected": 10,
"LogicalIOReads": 1,
"PhysicalIOReads": 1,
"RowsCountAffected": 10,
"Command": "SELECT",
"Namespace": "pro-test",
"QueryId": "sq-1pzcdMwRb",
"ReturnNum": "20",
"ApplicationName": "MyApp",
"CPUTimeSeconds": 100,
"Rows": 20,
"Frows": 10,
"Scnt": 10,
"TraceId": "074ce334-5247-40b9-b0c1-158aea5d****",
"TemplateId": "6a63b6ac4572abfaef7d1163f684****",
"NodeId": "",
"Cmd": "",
"Rt": 0,
"RequestSize": 0,
"ResponseSize": 0,
"ClientIp": "",
"DbId": "",
"OriginTime": "",
"OpType": "",
"Fail": "",
"Params": "",
"Reason": "",
"ReqId": ""
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. | |
| 403 | NoPermission | You are not authorized to do this action. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。