DescribeSlowLogRecords でスローログを取得 - DAS - Alibaba Cloud - Database Autonomy Service

複数の条件によるフィルターおよびソートをサポートする、データベースインスタンスのスロークエリログレコードを照会します。

操作説明

InstanceId はインスタンス ID を指定します。このパラメーターは必須です。
StartTime および EndTime はクエリの有効値を指定します。これらのパラメーターは必須です。
PageNumber および PageSize を設定して、ページングにより結果を取得します。
OrderBy パラメーターを使用して結果をソートします。ソート可能なフィールドについては、リファレンスを参照してください。
Filters パラメーターを使用して、ホストアドレスや SQL ID によるフィルターなど、クエリ条件をさらに絞り込みます。
重要特定のデータベースタイプ（PostgreSQL や PolarDB for PostgreSQL など）では、特定のソート方法がサポートされていません。必要に応じて適切な設定項目を設定してください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

hdm:DescribeSlowLogRecords

get

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンスの ID。	rm-8vbk4xz99su8****
NodeId	string	任意	ノードの ID。	pi-d9j9fe7wq7t9i****
StartTime	integer	必須	開始時刻。	1596177993000
EndTime	integer	必須	終了時刻。	1634972640000
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。	1
PageSize	integer	任意	ページサイズ。	10
Filters	array<object>	任意	フィルター条件のリスト。
	object	任意	フィルター条件のリスト。
Key	string	任意	フィルターパラメーター。説明詳細については、補足説明を参照してください。	None
Value	string	任意	フィルターパラメーターの値。	None
OrderBy	string	任意	MySQL QueryTimeSeconds: クエリの持続時間（秒）。 LockTimeSeconds: ロック待ち時間（秒）。 RowsSent: 送信行数。 RowsExamined: スキャン行数。 Redis QueryTime: クエリの持続時間。 Timestamp: 実行終了時刻。 MongoDB QueryTime: クエリの持続時間。 Timestamp: 実行終了時刻。 KeysExamined: スキャンされたキーの数。 DocExamined: スキャンされたドキュメントの数。 ReturnNum: 返された行数。重要 RDS PostgreSQL、PolarDB for PostgreSQL、および SQL Server ではソートはサポートされていません。	QueryTimeSeconds
Asc	boolean	任意	結果を昇順にソートするかどうかを指定します。デフォルト値: true。 true: 昇順。 false: 降順。	true

Key でサポートされるパラメーターと値:

RDS MySQL、PolarDB for MySQL、RDS PostgreSQL、PolarDB for PostgreSQL
- hostAddress: ソースホストアドレス。複数の値はコンマで区切ります。
- sqlId: SQL ID。複数の値はコンマで区切ります。
- user: ユーザー名。複数の値はコンマで区切ります。
- dbName: データベース名。複数の値はコンマで区切ります。
- tags: タグ。複数の値はコンマで区切ります。
MongoDB
- hostInsId: ロール ID。複数の値はコンマで区切ります。
- insRole: インスタンスロール。複数の値はコンマで区切ります。
- opType: 操作タイプ。複数の値はコンマで区切ります。
- namespace: 名前空間。複数の値はコンマで区切ります。
- nodeType: コンポーネントタイプ。複数の値はコンマで区切ります。
- queryId: クエリ ID。複数の値はコンマで区切ります。
ApsaraDB for Tair (Redis® OSS-Compatible)
- hostAddress: ソースホストアドレス。
- user: ユーザー名。
- dbName: データベース名。
- nodeType: ノードタイプ。
RDS SQL Server
- hostAddress: ソースホストアドレス。複数の値はコンマで区切ります。
- sqlId: SQL ID。複数の値はコンマで区切ります。
- user: ユーザー名。複数の値はコンマで区切ります。
- dbName: データベース名。複数の値はコンマで区切ります。
- tags: タグ。複数の値はコンマで区切ります。
PolarDB-X
- traceId: インスタンスのトレース ID。
- role: ノードロール。有効な値: CN (コンピューティングノード) または DN (ストレージノード)。このパラメーターは必須です。
- hostAddress: ソースホストアドレス。複数の値はコンマで区切ります。
- 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: 成功。 false: 失敗した。	true
Data	object	DBLogRecords
DbInstanceName	string	インスタンスの ID。	rm-bp157g54vy772****
NodeId	string	ノードの ID。	ノード123
ItemsNumbers	integer	現在のページのクエリログリスト内の項目数。	10
StartTime	string	開始時刻。	1672531200000
EndTime	string	終了時刻。	1672617600000
DbInstanceId	integer	インスタンスの数値 ID。	100
TotalRecords	integer	レコードの総数。	100
PageNumbers	integer	ページングクエリのページ番号。ページは 1 から始まります。デフォルト値: 1。	1
MaxRecordsPerPage	integer	ページングクエリの 1 ページあたりの最大値。有効値: 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	ソースホストアドレス。	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	MongoDB 操作中にスキャンされたドキュメントの数。	100
KeysExamined	string	MongoDB でスキャンされたインデックス行の数。	値A
TableName	string	テーブル名。	tableNameExample
LockTime	number	ロック待ち時間。	100
RowsExamined	integer	スキャンされた行数。	100
RowsSent	integer	返された行数。	10
ThreadId	string	スレッドの ID。	57472578
Timestamp	integer	時間。	1747118812
SqlTag	object	タグ。
SqlId	string	sqlid。	8ad7069f236bcdaaa9b3ae4b6299****
Tags	string	カンマで区切られた複数のタグ。	DAS_IMPORTANT,DAS_IN_PLAN
Comments	string	備考。	test
LockTimeSeconds	number	ロック待ち時間（秒）。	100
QueryTimeSeconds	number	クエリの持続時間（秒）。	100
SqlType	string	SQL ステートメントのタイプ。有効な値: SELECT UPDATE DELETE	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	スロークエリ検索文。説明 ApsaraDB for Tair (Redis® OSS-Compatible) データベースインスタンスのみサポートされています。	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	ApsaraDB PolarDB-X 2.0 データベースインスタンスの計算ノードによって更新または返された合計行数。説明 ApsaraDB PolarDB-X 2.0 インスタンスのみサポートされています。	20
Frows	integer	ApsaraDB PolarDB-X 2.0 データベースインスタンスの計算ノード（CN）によってフェッチされた行数。説明 ApsaraDB PolarDB-X 2.0 インスタンスのみサポートされています。	10
Scnt	integer	ApsaraDB PolarDB-X 2.0 データベースインスタンスの計算ノード（CN）からの DN リクエスト数。説明 ApsaraDB PolarDB-X 2.0 インスタンスのみサポートされています。	10
TraceId	string	PolarDB-X 2.0 のトレース ID。これは ApsaraDB PolarDB-X 2.0 データベースノード上の SQL ステートメントを実行する ID です。説明 ApsaraDB PolarDB-X 2.0 インスタンスのみサポートされています。	074ce334-5247-40b9-b0c1-158aea5d****
TemplateId	string	ApsaraDB PolarDB-X 2.0 データベースインスタンスのテンプレート ID。説明 ApsaraDB PolarDB-X 2.0 インスタンスのみサポートされています。	6a63b6ac4572abfaef7d1163f684****
NodeId	string
Cmd	string
Rt	integer
RequestSize	integer
ResponseSize	integer
ClientIp	string
DbId	string
OriginTime	string
OpType	string
Fail	string
Params	string
Reason	string
ReqId	string
ExtText	string

例

成功レスポンス

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": "",
        "ExtText": ""
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParams	The request parameters are invalid.	リクエストパラメーターが無効です。
403	NoPermission	You are not authorized to do this action.	この操作を実行する権限がありません。

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。