すべてのプロダクト
Search

このプロダクト

    ApsaraDB for OceanBase (Deprecated):DescribeOutlineBinding

    ドキュメントセンター

    ApsaraDB for OceanBase (Deprecated):DescribeOutlineBinding

    最終更新日:May 26, 2026

    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:DescribeOutlineBinding

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    TenantId

    string

    必須

    テナント ID です。

    t2mr3oae0****
    TableName

    string

    必須

    テナント名です。注： このパラメーター名は TableName ですが、テナント名を指定します。名前は 2～20 文字で、英字、数字、アンダースコア (_) で構成され、大文字と小文字が区別されます。先頭は英字またはアンダースコアである必要があり、予約語「sys」は使用できません。

    pay_online
    DatabaseName

    string

    必須

    データベース名です。

    testdb
    SQLId

    string

    必須

    SQL ID です。

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

    boolean

    任意

    • スロットリング情報を照会する場合は true に設定します。

    • バインドされたインデックスまたはバインドされた実行計画を照会する場合は false に設定します。

    false
    InstanceId

    string

    任意

    OceanBase インスタンス ID です。

    ob317v4uif****
    DynamicSql

    boolean

    任意

    SQL がテンプレート SQL であるかどうかを示します。

    FormatSqlId

    string

    任意

    整形済み SQL ステートメントの ID です。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されるデータです。

    OutlineBinding

    object

    アウトラインバインディングの詳細です。

    BindPlan

    string

    バインドされた実行計画です。

    PHY_TABLE_SCAN | bmsql_order_line | 40 ******
    OutlineId

    integer

    アウトライン ID です。

    -1
    BindIndex

    string

    バインドされたインデックスです。

    PRIMARY
    MaxConcurrent

    integer

    最大同時実行数です。

    2
    TableName

    string

    テーブル名です。

    cluster_info
    SqlText

    string

    スロットリングに使用される SQL テキストです。

    SqlTextConcurrentNum

    integer

    SQL テキストの同時実行数制限です。

    ByFormatSqlId

    boolean

    バインディングがファジーバインディングであるかどうかを示します。

    RequestId

    string

    リクエスト ID です。

    EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

    例

    成功レスポンス

    JSONJSON

    {
  "OutlineBinding": {
    "BindPlan": "PHY_TABLE_SCAN | bmsql_order_line | 40 ******",
    "OutlineId": -1,
    "BindIndex": "PRIMARY",
    "MaxConcurrent": 2,
    "TableName": "cluster_info",
    "SqlText": "",
    "SqlTextConcurrentNum": 0,
    "ByFormatSqlId": false
  },
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    2014 InternalError The request processing has failed due to some unknown error.

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

    変更履歴

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