DescribeAuditRecords - Tair (Redis® OSS-Compatible) - Alibaba Cloud ドキュメントセンター

Tair (Redis OSS-compatible) インスタンスの監査ログを照会します。

操作説明

この操作を呼び出す前に、対象インスタンスで監査ログ機能を有効化する必要があります。詳細については、「ModifyAuditLogConfig」をご参照ください。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

kvstore:DescribeAuditRecords

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンスの ID です。	r-bp1zxszhcgatnx****
NodeId	string	任意	インスタンス内のノードの ID です。このパラメーターを指定することで、特定のノードのモニタリングデータを照会できます。説明このパラメーターは、読み書き分離およびクラスターインスタンスでのみ使用可能です。 DescribeLogicInstanceTopology 操作を呼び出して、ノード ID を照会できます。	r-bp1zxszhcgatnx****-db-0
AccountName	string	任意	アカウントのユーザー名です。このパラメーターを指定しない場合、インスタンスのすべてのアカウントが照会されます。	demo
DatabaseName	string	任意	インスタンス内のデータベース名です。このパラメーターを指定しない場合、すべてのデータベースが照会されます。有効な値は 0 ～ 255 です。0 はデータベース 0 を指定します。	0
QueryKeywords	string	任意	監査ログを照会するためのキーワードです。コマンドをキーワードとして指定してログを照会できます。デフォルトでは、すべてのコマンドが照会されます。説明 1 回の呼び出しでは、1 つのキーワードのみを指定できます。	maxclients
HostAddress	string	任意	クライアントの IP アドレスです。このパラメーターを指定しない場合、この呼び出しはすべてのクライアントに適用されます。	127.0.0.1
PageSize	integer	任意	1 ページあたりに返されるエントリ数です。	30
PageNumber	integer	任意	返されるページのページ番号です。	1
StartTime	string	必須	照会範囲の開始時刻です。yyyy-MM-ddTHH:mm:ssZ の形式で指定してください。時刻は協定世界時 (UTC) で指定する必要があります。	2019-03-24T12:10:00Z
EndTime	string	必須	照会範囲の終了時刻です。終了時刻は開始時刻より後である必要があります。yyyy-MM-ddTHH:mm:ssZ の形式で指定してください。時刻は協定世界時 (UTC) で指定する必要があります。説明監査ログには多数のエントリが含まれるため、照会範囲は 10 分以内とすることを推奨します。また、1 日を超える範囲を指定しないでください。	2019-03-25T12:10:00Z

レスポンスフィールド

フィールド	型	説明	例
	object
EndTime	string	照会の終了時刻です。	2019-03-25T12:10:00Z
StartTime	string	照会の開始時刻です。	2019-03-24T12:10:00Z
RequestId	string	リクエストの ID です。	9F5EB478-824E-4AC4-8D2B-58F31A02****
InstanceName	string	インスタンスの名前です。	r-bp1zxszhcgatnx****
TotalRecordCount	integer	返されたエントリの合計数です。	22222
PageNumber	integer	返されたページのページ番号です。	1
PageSize	integer	1 ページあたりに返される最大エントリ数です。	30
Items	object
SQL	array<object>	返された監査ログエントリのコレクションです。
	object
HostAddress	string	クライアントの IP アドレスです。	127.0.0.1
SQLText	string	実行されたコマンドです。	CONFIG GET maxmemory
DatabaseName	string	データベース名です。	demo
SQLType	string	コマンドの種類です。	non_read_write
ExecuteTime	string	コマンドが実行された時刻です。	2019-03-25T03:22:08Z
TotalExecutionTimes	string	コマンドの実行に要した時間です。	0
NodeId	string	ノードの ID です。説明クラスターまたは読み書き分離アーキテクチャを使用するインスタンスの場合にのみ、特定のノード ID が返されます。	r-bp1zxszhcgatnx****-db-0
AccountName	string	アカウントのユーザー名です。	demo
IPAddress	string	インスタンスの IP アドレスです。	192.16.100.***

例

成功レスポンス

JSONJSON

{
  "EndTime": "2019-03-25T12:10:00Z",
  "StartTime": "2019-03-24T12:10:00Z",
  "RequestId": "9F5EB478-824E-4AC4-8D2B-58F31A02****",
  "InstanceName": "r-bp1zxszhcgatnx****",
  "TotalRecordCount": 22222,
  "PageNumber": 1,
  "PageSize": 30,
  "Items": {
    "SQL": [
      {
        "HostAddress": "127.0.0.1",
        "SQLText": "CONFIG GET maxmemory",
        "DatabaseName": "demo",
        "SQLType": "non_read_write",
        "ExecuteTime": "2019-03-25T03:22:08Z",
        "TotalExecutionTimes": "0",
        "NodeId": "r-bp1zxszhcgatnx****-db-0",
        "AccountName": "demo",
        "IPAddress": "192.16.100.***"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IncorrectDBInstance.NotSupported	This instance do not support log audit.
400	InvalidEndTime.Invalid	pecified end time is before this service active time.
400	InvalidStartTime.Malformed	The Specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The Specified parameter EndTime is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.
400	InvalidPageNumbers.Malformed	Specified page number is not valid.
400	InvalidQueryTime.Format	Specified query time is not valid.

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

変更履歴

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