OceanBase Cloud

PDF をダウンロード

DescribeSqlAudits - SQL監査データの照会

最終更新:2026-09-30 10:37:22

機能の概要

SQL監査データを照会するために使用されます。

呼び出しの説明

インターフェース制約

呼び出し元はマルチクラウドAPIにアクセスするためのキーを持っている必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。

リクエストパス

GET /api/v2/instances/{instanceId}/tenants/{tenantId}/sqlaudit/data

リクエストパラメータ

Path

パラメータ	型	必須	説明	サンプル値
instanceId	String	はい	クラスタID	ob317v4uif****
tenantId	String	はい	テナントID	t4louaeei****

Query

パラメータ	型	必須	説明	サンプル値
startTime	String	はい	区間開始時間	2025-01-01T00:00:00Z
endTime	String	はい	区間終了時間	2025-01-02T00:00:00Z
clientIp	String	いいえ	JSON文字列配列、クライアントIPリスト、例：["xx.xxx.xx.xxx"]	`["xx.xxx.xx.xxx"]`
dbName	String	いいえ	JSON文字列配列、データベースリスト、例：["default_database"]	`["default_database"]`
executeTimeMin	Integer	いいえ	最小実行時間、ミリ秒単位	10
executeTimeMax	Integer	いいえ	最大実行時間、ミリ秒単位	1000
nodeIp	String	いいえ	JSON文字列配列、実行ノードリスト、例：["i-bp18l4****str4uk03"]	`["i-bp18l4****str4uk03"]`
operatorType	String	いいえ	JSON文字列配列、SQLタイプリスト、例：["SELECT", "CREATE"]	`["SELECT", "CREATE"]`
scanRowsMin	Integer	いいえ	スキャン最小行数	0
scanRowsMax	Integer	いいえ	スキャン最大行数	10000
userName	String	いいえ	JSON文字列配列、ユーザー名リスト、例：["doc_test"]	`["doc_test"]`
searchKeyWord	String	いいえ	JSON文字列配列、検索キーワード、例：["キーワード1","キーワード2"]。searchKeyWordMethodと同時に設定する必要があります	`["keyword1", "keyword2"]`
searchKeyWordMethod	String	いいえ	キーワード検索の論理演算子。and、orを指定できます。searchKeyWordと同時に設定する必要があります。	and
sortField	String	いいえ	ソートフィールド	elapsedTime
sortType	String	いいえ	ソートタイプ	desc
pageNumber	Integer	いいえ	ページ番号。デフォルトは1	1
pageSize	Integer	いいえ	1ページあたりのレコード数。デフォルトは10	10
openRequest	unknown	はい	Open requestパラメータ	-

戻り値

項目	型	説明	例
success	Boolean	操作の成功・失敗を示すフラグ	true
errorCode	String	エラーコード	INVALID_PARAMETER
errorMessage	String	エラーメッセージ	Invalid parameter
data	Object	業務データ(object)	N/A
cost	Number	所要時間	1.0
server	String	サーバーのアドレス。通常はOBServerノードのIPアドレスです。	10.0.0.10
requestId	String	リクエストID	d04eabba****
totalCount	Number	総レコード数。	100.0
extra	Object	拡張情報。	{}

dataオブジェクトの項目

項目	型	説明	例
sqlAuditDTOList	Array	SQL監査レコードのリスト。	[{'id': 'resource-123456'}]
totalCount	Integer	総レコード数。	100

data.sqlAuditDTOList[]要素の項目

項目	型	説明	例
key	Integer	キー名。	1
querySQL	String	クエリSQL	SELECT * FROM users WHERE id = 1
sqlID	String	SQLステートメントの一意の識別子	sql_1234****
databaseName	String	データベース名	test_db
userName	String	ユーザー名	root
clientIp	String	クライアントIPパラメータ	successful
userClientIp	String	ユーザークライアントIP	admin
operatorType	String	操作タイプ。	NORMAL
elapsedTime	Number	SQL実行時間。	12.5
scanRows	Integer	SQLスキャン行数。	1
affectedRows	Integer	SQL影響行数。	1
requestTime	String	リクエスト時間	2026-02-25 15:40:43+00:00
requestTimestamp	Integer	リクエストタイムスタンプ	1
isSuccess	Integer	操作の成功・失敗を示すフラグ	1
retCode	Integer	戻りコード。	0

例

リクエスト例

curl --digest -u '<Your AccessKey ID:AccessKey Secret>' \
  -X GET \
  'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/sqlaudit/data?openRequest={openRequest}' \
  -G \
  --data-urlencode 'searchKeyWord=["keyword1","keyword2"]' \
  -d 'searchKeyWordMethod=and' \
  -d 'startTime={startTime}' \
  -d 'endTime={endTime}' \
  -d 'pageNumber={pageNumber}' \
  -d 'pageSize={pageSize}'

レスポンス例

JSON 形式

{
    "success": true,
    "errorCode": "INVALID_PARAMETER",
    "errorMessage": "Invalid parameter",
    "data": {
        "sqlAuditDTOList": [
            {
                "key": 1,
                "querySQL": "SELECT * FROM users WHERE id = 1",
                "sqlID": "sql_1234****",
                "databaseName": "test_db",
                "userName": "root",
                "clientIp": "successful",
                "userClientIp": "admin",
                "operatorType": "NORMAL",
                "elapsedTime": 12.5,
                "scanRows": 1,
                "affectedRows": 1,
                "requestTime": "2026-02-25 15:40:43+00:00",
                "requestTimestamp": 1,
                "isSuccess": 1,
                "retCode": 0
            }
        ],
        "totalCount": 100
    },
    "cost": 1.0,
    "server": "xxx.xxx.x.xxx:xxx",
    "requestId": "d04eabba****",
    "totalCount": 100.0,
    "extra": "{}"
}

前のトピック

DescribeOasSQLText - SQLテキストのクエリ

次のトピック

DescribeOutlineBinding - SQLアウトラインのバインディング情報を照会する

DescribeSqlAudits - SQL監査データの照会|OceanBase Cloud|ドキュメント|OceanBaseマニュアル