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

ApsaraDB for OceanBase (Deprecated):DescribeSampleSqlRawTexts

最終更新日:May 26, 2026

この API を呼び出すと、サンプリングされた 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:DescribeSampleSqlRawTexts

none

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

InstanceId

string

任意

OceanBase クラスターの ID。

ob317v4uif****

TenantId

string

任意

テナントの ID。

ob2mr3oae0****

StartTime

string

必須

開始時刻。

値は YYYY-MM-DDThh:mm:ssZ フォーマットの UTC 時刻である必要があります。

2023-04-12T04:38:38Z

EndTime

string

必須

終了時刻。

値は YYYY-MM-DDThh:mm:ssZ フォーマットの UTC 時刻である必要があります。

2023-04-12T05:38:38Z

DbName

string

必須

データベース名。

test_db

SqlId

string

必須

SQL ステートメントの ID。

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

TraceId

string

任意

実行されたクエリのトレース ID です。DescribeSQLSamples API が返す TraceId の値です。

説明

注: すべての低速 SQL ステートメントのトレース ID を使用して原文を照会できるわけではありません。

YB420A700EFB-00060D53E42D0C61-0-0

Limit

string

任意

返される SQL テキストの最大数。

20

DynamicSql

boolean

任意

SQL ステートメントが集約ステートメントであるかどうかを指定します。

true

レスポンスフィールド

フィールド

説明

object

リクエストの戻り値。

RequestId

string

リクエスト ID。

EE205C00-30E4-****-****-87E3A8A2AA0C

Data

object

データリスト。

SqlText

array

SQL ステートメント。

string

SQL ステートメント。

{ "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C", "Data": { "SqlText": [ "\"INSERT INTO test (id, k, c, pad) VALUES (36, 87, 11,62582 )\"" ] } }

成功レスポンス

JSONJSON

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": {
    "SqlText": [
      "{\n  \"RequestId\": \"EE205C00-30E4-****-****-87E3A8A2AA0C\",\n  \"Data\": {\n    \"SqlText\": [\n      \"\\\"INSERT INTO test (id, k, c, pad) VALUES (36, 87, 11,62582 )\\\"\"\n    ]\n  }\n}"
    ]
  }
}

エラーコード

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

変更履歴

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