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

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

操作説明

SQL 監査ログは、SQL 監査が有効な場合にのみ照会できます。過去 30 日以内の SQL 監査ログのみを照会できます。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	必須	Lakehouse エディションクラスターのクラスター ID。説明 DescribeDBClusters 操作を呼び出して、指定されたリージョン内のすべてのクラスターの ID をクエリできます。	amv-t4nj8619bz2w3****
RegionId	string	必須	リージョン ID。説明 DescribeRegions 操作を呼び出して、クラスターのリージョン ID をクエリできます。	cn-hangzhou
StartTime	string	任意	クエリの開始時刻。時間は協定世界時 (UTC) で表示され、yyyy-MM-ddTHH:mmZ フォーマットです。説明 SQL 監査ログは、SQL 監査が有効な場合にのみ照会できます。過去 30 日以内の SQL 監査ログのみを照会できます。SQL 監査が無効化された後に再度有効化された場合、再度有効化された後に生成された SQL 監査ログのみを照会できます。	2022-08-12T04:17Z
EndTime	string	任意	クエリの終了時刻。時間は協定世界時 (UTC) で表示され、yyyy-MM-ddTHH:mmZ フォーマットです。説明終了時刻は開始時刻より後である必要があります。開始時刻と終了時刻の間隔は 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 つだけです。このパラメーターが空の場合、デフォルトですべてのタイプがクエリされます。	SELECT
Succeed	string	任意	対象の SQL ステートメントが正常に実行されたかどうかを示します。有効な値: true: SQL ステートメントが正常に実行されました。 false: SQL ステートメントの実行に失敗しました。	true
HostAddress	string	任意	対象の SQL ステートメントを実行するクライアントの IP アドレスおよびポート番号。	100.104.XX.XX:43908
OrderType	string	任意	実行時間による SQL ステートメントのソート順序。有効な値: asc: 昇順。 desc: 降順。	asc
User	string	任意	対象の SQL ステートメントを実行するユーザー名。	test
Order	string	任意	JSON フォーマットのソート構成。値は、入力配列の順序に基づいて複合ソートを指定する順序付き JSON 配列です。各要素には `Field` パラメーターと `Type` パラメーターが含まれます。例: `[{"Field":"ExecutionStartTime","Type":"Desc"},{"Field":"ScanRows","Type":"Asc"}]`。詳細: `Field` はソートのフィールド名を指定します。有効な値: HostAddress: データベースへの接続に使用されるクライアントアドレス。 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	任意	ページ番号。値は、INTEGER データの型の最大値を超えない正の整数である必要があります。デフォルト値: 1。	1
ProxyUser	string	任意	予約済みパラメーター。	None
ProcessId	string	任意	SQL クエリのプロセス ID。指定されたプロセスの監査ログをフィルター処理するために使用されます。	20210608175202172016166249034536****
EngineType	string	任意	エンジンタイプ。有効な値: XIHE: デフォルトのコンピュートエンジンの監査ログ。 AGENT_SERVERLESS: サーバーレス分析特徴の監査ログ。このパラメーターが指定されていない場合、デフォルト値は XIHE です。列挙値: XIHE : XIHE。 AGENT_SERVERLESS : AGENT_SERVERLESS。	XIHE

レスポンスフィールド

フィールド	型	説明	例
	object	リストの詳細。
TotalCount	string	Record の総数。	6974
PageSize	string	1 ページあたりのエントリ数。	10
RequestId	string	リクエスト ID。	8A564B7F-8C00-43C0-8EC5-919FBB70573
PageNumber	string	ページ番号。	1
DBClusterId	string	Lakehouse エディションクラスターのクラスター ID。	amv-t4nj8619bz2w3****
Items	array<object>	リスト。
	object	SQL Record リスト。
HostAddress	string	対象の SQL ステートメントを実行するクライアントの IP アドレスおよびポート番号。	100.104.XX.XX:43908
Succeed	string	対象の SQL ステートメントが正常に実行されたかどうかを示します。有効な値: true: SQL ステートメントが正常に実行されました。 false: SQL ステートメントの実行に失敗しました。	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	対象の SQL ステートメント実行の開始時刻。ミリ秒のタイムスタンプで表されます。	1774600396584
ProcessID	string	タスク ID。	202106081752021720161662490345362390
User	string	対象の SQL ステートメントを実行するユーザー名。	test
HasDiagnosticInfo	boolean	診断情報フォーマットが含まれているかどうかを示します。列挙値: true : true。 false : false。	true

例

成功レスポンス

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 WHERE port = 8080",
      "TotalTime": "216",
      "ConnId": "14356****",
      "DBName": "adb_demo",
      "SQLType": "SELECT",
      "ExecuteTime": "2022-08-12 10:10:00",
      "ExecuteTimestamp": 1774600396584,
      "ProcessID": "202106081752021720161662490345362390",
      "User": "test",
      "HasDiagnosticInfo": true
    }
  ]
}

エラーコード

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

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

変更履歴

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