すべてのプロダクト
Search
ドキュメントセンター

ApsaraDB for OceanBase (Deprecated):DescribeSqlAuditStat

最終更新日:May 26, 2026

このオペレーションを呼び出して、クライアント IP アドレス、ユーザー、SQL ステートメント ID 別に SQL ステートメントの実行統計を収集できます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

oceanbase:DescribeSqlAuditStat

none

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

InstanceId

string

任意

OceanBase クラスターの ID です。

ob317v4uif****

TenantId

string

任意

テナントの ID です。

t33h8y08k****

StartTime

string

任意

開始時刻です。フォーマットは yyyy-MM-dd'T'HH:mm:ss'Z' です。

2025-01-14T02:34:49Z

EndTime

string

任意

終了時刻です。フォーマットは yyyy-MM-dd'T'HH:mm:ss'Z' です。時間範囲は 6 時間を超えることはできません。

2025-01-14T03:34:49Z

PageSize

integer

任意

ページサイズです。

  • 最大値:100。

  • デフォルト値:10。

1

PageNumber

integer

任意

取得するページ番号です。

  • ページ番号は 1 から始まります。

  • デフォルト値:1。

1

レスポンスフィールド

フィールド

説明

object

応答のスキーマです。

RequestId

string

リクエスト ID です。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

Data

array<object>

返されるデータです。

object

返されるデータです。

InstanceId

string

クラスターインスタンスの ID です。

ob317v4uif****

TenantId

string

テナントの ID です。

t33h8y08k****

UserClientIp

string

クライアントの IP アドレスです。

xx.xx.xx.xx

UserName

string

ユーザー名です。

test_mysql

DatabaseName

string

データベースの名前です。

test_database_1

SqlId

string

SQL ステートメントの ID です。

8D6E84****0B8FB1823D199E2CA1****

TotalSucceed

integer

成功した実行の総数です。

1

TotalFailed

integer

失敗した実行の総数です。

0

TotalAffectRows

integer

影響を受ける行の総数です。

1

TotalScanRows

integer

スキャンされた行の総数です。

10

TotalReturnRows

integer

返された行の総数です。

1

AffectRows

number

影響を受けた行の平均数です。影響を受けた行数が 0 の SQL 実行は計算から除外されます。値は四捨五入されます。

1

ScanRows

number

スキャンされた行の平均数です。スキャンされた行数が 0 の SQL 実行は計算から除外されます。値は四捨五入されます。

1

ReturnRows

number

返された行の平均数です。返された行数が 0 の SQL 実行は計算から除外されます。値は四捨五入されます。

1

ExecuteTime

number

平均実行時間 (ms) です。

142

SqlStatement

string

SQL テンプレートです。

UPDATE `oceanbase_test_table` SET `name` = ? WHERE `key` = ?

OperatorType

string

操作の種類です。

UPDATE

TotalCount

integer

総数です。

9

成功レスポンス

JSONJSON

{
  "RequestId": "\t\nEE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C\n",
  "Data": [
    {
      "InstanceId": "ob317v4uif****",
      "TenantId": "t33h8y08k****",
      "UserClientIp": "xx.xx.xx.xx\n",
      "UserName": "test_mysql ",
      "DatabaseName": "test_database_1",
      "SqlId": "8D6E84****0B8FB1823D199E2CA1****",
      "TotalSucceed": 1,
      "TotalFailed": 0,
      "TotalAffectRows": 1,
      "TotalScanRows": 10,
      "TotalReturnRows": 1,
      "AffectRows": 1,
      "ScanRows": 1,
      "ReturnRows": 1,
      "ExecuteTime": 142,
      "SqlStatement": "UPDATE `oceanbase_test_table` SET `name` = ? WHERE `key` = ?",
      "OperatorType": "UPDATE"
    }
  ],
  "TotalCount": 9
}

エラーコード

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

変更履歴

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