DescribeAuditLogRecords API を使用した SQL 監査ログの取得 - AnalyticDB

クラスターの SQL 監査ログを照会します。

操作説明

SQL 監査が有効になっている場合にのみ、SQL 監査ログを照会できます。過去 30 日間に生成された SQL 監査ログのみ取得可能です。SQL 監査を無効化した後に再び有効化した場合、再び有効化された以降に生成されたログのみ取得できます。SQL 監査ログには、INSERT INTO VALUES、REPLACE INTO VALUES、および UPSERT INTO VALUES 操作は記録されません。
このサービスのエンドポイントについては、「エンドポイント」をご参照ください。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

adb:DescribeAuditLogRecords

list

*DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	Enterprise Edition、Basic Edition、または Data Lakehouse Edition のクラスター ID。説明 DescribeDBClusters 操作を呼び出して、ターゲットリージョン内のすべてのクラスター ID を一覧表示できます。	amv-t4nj8619bz2w3****
RegionId	string	必須	リージョン ID。説明 DescribeRegions 操作を呼び出して、クラスターのリージョン ID を照会できます。	cn-hangzhou
StartTime	string	任意	照会対象の時間範囲の開始時刻。`yyyy-MM-ddTHH:mmZ` 形式で指定してください。時刻は協定世界時 (UTC) で指定する必要があります。説明 SQL 監査が有効になっている場合にのみ、SQL 監査ログを照会できます。過去 30 日間に生成された SQL 監査ログのみ照会可能です。SQL 監査を無効化した後に再び有効化した場合、再び有効化された以降に生成されたログのみ照会できます。	2022-08-12T04:17Z
EndTime	string	任意	照会対象の時間範囲の終了時刻。`yyyy-MM-ddTHH:mmZ` 形式で指定してください。時刻は協定世界時 (UTC) で指定する必要があります。説明終了時刻は開始時刻より後である必要があります。開始時刻と終了時刻の間の時間範囲は、24 時間を超えてはなりません。	2022-08-12T17:08Z
DBName	string	任意	SQL ステートメントが実行されたデータベースの名前。	adb_demo
QueryKeyword	string	任意	検索結果内でキーワードとして使用する文字列。	adb
SqlType	string	任意	SQL ステートメントの種類。有効な値は以下のとおりです。 DELETE SELECT UPDATE INSERT INTO SELECT ALTER DROP CREATE 説明 1 回の照会で照会できるのは、1 種類の SQL ステートメントのみです。このパラメーターを設定しない場合、すべての種類の SQL ステートメントのログが照会されます。	SELECT
Succeed	string	任意	SQL ステートメントが正常に実行されたかどうかを示します。有効な値は以下のとおりです。 true：ステートメントが正常に実行されました。 false：ステートメントの実行に失敗しました。	true
HostAddress	string	任意	SQL ステートメントを実行するために使用されたクライアントの IP アドレスおよびポート番号。	100.104.XX.XX:43908
OrderType	string	任意	SQL ステートメントの実行時刻に基づいて取得されたエントリを並べ替える順序。有効な値は以下のとおりです。 asc：昇順 desc：降順	asc
User	string	任意	SQL ステートメントを実行するために使用されたユーザー名。	test
Order	string	任意	取得されたエントリをフィールドごとに並べ替える順序。JSON 配列形式のキーと値のペアで指定します。配列内のキーと値のペアの順序に従って、エントリが並べ替えられます。各キーと値のペアは、`Field` および `Type` で構成されます。例：`[{"Field":"ExecutionStartTime","Type":"Desc"},{"Field":"ScanRows","Type":"Asc"}]`。 `Field`：取得されたエントリを並べ替えるために使用されるフィールド。有効な値は以下のとおりです。 HostAddress：データベースに接続するクライアントの IP アドレス。 UserName：ユーザー名。 ExecutionStartTime：SQL ステートメントの実行開始時刻。 QueryTime：SQL ステートメントの実行時間。 PeakMemoryUsage：SQL ステートメントの実行時のピークメモリ使用量。 ScanRows：データソースを持つタスクによってスキャンされた行数。 ScanSize：スキャンされたデータ量。 ScanTime：データをスキャンするのに要した合計時間。 PlanningTime：実行計画を生成するのに要した時間。 WallTime：各ノードにおけるクエリのすべての演算子の合計 CPU 時間。 ProcessID：プロセス ID。 `Type`：並べ替えの種類。有効な値は以下のとおりです。 Desc：降順 Asc：昇順	[{"Field":"ExecuteTime","Type":"Desc"},{"Field":"HostAddress","Type":"Asc"}]
PageSize	integer	任意	1 ページあたりに返すエントリ数。有効な値は以下のとおりです。 10（デフォルト） 30 50 100	10
PageNumber	integer	任意	ページ番号。値は 0 より大きい整数である必要があります。デフォルト値は 1 です。	1
ProxyUser	string	任意	予約済みパラメーター。	无

レスポンスフィールド

フィールド	型	説明	例
	object	リストの詳細情報。
TotalCount	string	エントリの合計数。	6974
PageSize	string	1 ページあたりのエントリ数。	10
RequestId	string	リクエスト ID。	8A564B7F-8C00-43C0-8EC5-919FBB70573
PageNumber	string	ページ番号。	1
DBClusterId	string	Data Lakehouse Edition のクラスター ID。	amv-t4nj8619bz2w3****
Items	array<object>	エントリのリスト。
	object	SQL レコードのリスト。
HostAddress	string	SQL ステートメントを実行するために使用されたクライアントの IP アドレスおよびポート番号。	100.104.XX.XX:43908
Succeed	string	SQL ステートメントが正常に実行されたかどうかを示します。有効な値は以下のとおりです。 true：ステートメントが正常に実行されました。 false：ステートメントの実行に失敗しました。	true
SQLText	string	SQL ステートメントの詳細情報。	SELECT * FROM adb_hdfs_import_source
TotalTime	string	SQL ステートメントの実行時間。単位：ミリ秒 (ms)。	216
ConnId	string	接続 ID。	14356****
DBName	string	SQL ステートメントが実行されたデータベースの名前。	adb_demo
SQLType	string	SQL ステートメントの種類。	SELECT
ExecuteTime	string	SQL ステートメントの実行開始時刻。`yyyy-MM-dd HH:mm:ss` 形式で、ご利用のローカルタイムゾーンの時刻となります。	2022-08-12 10:10:00
ExecuteTimestamp	integer
ProcessID	string	タスク ID。	202106081752021720161662490345362390
User	string	SQL ステートメントを実行するために使用されたユーザー名。	test
HasDiagnosticInfo	boolean

例

成功レスポンス

JSONJSON

{
  "TotalCount": "6974",
  "PageSize": "10",
  "RequestId": "8A564B7F-8C00-43C0-8EC5-919FBB70573",
  "PageNumber": "1",
  "DBClusterId": "amv-t4nj8619bz2w3****",
  "Items": [
    {
      "HostAddress": "100.104.XX.XX:43908",
      "Succeed": "true",
      "SQLText": "SELECT * FROM adb_hdfs_import_source",
      "TotalTime": "216",
      "ConnId": "14356****",
      "DBName": "adb_demo",
      "SQLType": "SELECT",
      "ExecuteTime": "2022-08-12 10:10:00",
      "ExecuteTimestamp": 0,
      "ProcessID": "202106081752021720161662490345362390",
      "User": "test",
      "HasDiagnosticInfo": false
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

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

変更履歴

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