すべてのプロダクト
Search

このプロダクト

    ApsaraDB for OceanBase (Deprecated):DescribeOasSQLDetails

    ドキュメントセンター

    ApsaraDB for OceanBase (Deprecated):DescribeOasSQLDetails

    最終更新日:May 26, 2026

    SQL テキストや関連するテーブル名など、詳細な 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:DescribeOasSQLDetails

    none

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    OceanBase クラスターの ID。

    ob317v4uif****
    TenantId

    string

    必須

    テナントの ID。

    t4louaeei****
    SqlId

    string

    必須

    SQL ID。

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

    string

    必須

    データベースの名前。

    test_db
    StartTime

    string

    必須

    SQL 実行計画を照会する開始時刻。
    値は YYYY-MM-DDThh:mm:ssZ フォーマットの UTC 時刻である必要があります。

    2023-04-12T04:38:38Z
    EndTime

    string

    必須

    SQL 実行計画を照会する終了時刻。
    値は YYYY-MM-DDThh:mm:ssZ フォーマットの UTC 時刻である必要があります。

    2023-04-12T05:38:38Z
    DynamicSql

    boolean

    任意

    SQL が動的 SQL であるかどうかを示します。

    false
    ParseTable

    boolean

    任意

    テーブルスキーマを解析するかどうかを示します。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返される応答。

    RequestId

    string

    リクエスト ID。

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

    object

    SQL の詳細データ。

    Fulltext

    string

    SQL テキスト。

    select * from test where id = ?
    Tables

    array

    SQL に関連するテーブル名のリスト。

    string

    テーブル名。

    [{"xxxx","xxxx","xxxx"},{...}...]
    UserName

    string

    ユーザー名。

    test_user
    Statement

    string

    パラメーター化されたテキスト。

    select * from test where id = ?
    DbName

    string

    データベースの名前。

    test_db

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": {
    "Fulltext": "select * from test where id = ?",
    "Tables": [
      "[{\"xxxx\",\"xxxx\",\"xxxx\"},{...}...]"
    ],
    "UserName": "test_user",
    "Statement": "select * from test where id = ?",
    "DbName": "test_db"
  }
}

    エラーコード

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

    変更履歴

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