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

ApsaraDB for OceanBase (Deprecated):DescribeRecommendIndex

最終更新日:Sep 01, 2026

APIを迅速に取得およびデバッグできるオンラインCLIツールです。実行可能なSDKコードサンプルを動的に生成できます。

今すぐお試しください

この 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:DescribeRecommendIndex

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

TenantId

string

必須

診断システムによる計算後にSQL 文に対して推奨されるインデックス。

  • 推奨インデックスがプライマリキーの場合、PRIMARYが返されます。

  • ユーザーが作成したインデックスが推奨される場合、インデックス名が返されます。
    システムはSQL 文に対して1つのインデックスのみを推奨します。テーブルのインデックスを確認するには、DescribeIndexes 操作を呼び出すことができます。

t2mr3oae0****

InstanceId

string

必須

リクエストの戻り結果。

ob317v4uif****

SQLId

string

必須

OceanBaseクラスターのID。

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

レスポンスフィールド

フィールド

型

説明

例

object

SQL IDは、DescribeSlowSQLListまたはDescribeTopSQLList 操作の戻り値から取得できます。

RequestId

string

テナントモード。 有効な値:
Oracle
MySQL




EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

RecommendIndex

object

推奨インデックスに関する情報。

SuggestIndex

string

例 1

PRIMARY

TenantMode

string

テナントモードを返します。サポートされるモードは次のとおりです:

  • Oracle:Oracleモード。

  • MySQL:MySQLモード。

mysql

TableList

string

テーブル情報。
SQLIDに対応するSQL 文に関連するデータテーブルを返します。単一テーブルクエリの場合、アクセスされた単一のデータテーブルを返します。結合クエリの場合、SQL 文によってアクセスされたすべてのデータテーブルを返し、VERTICAL LINEで区切ります。例:「Table1|Table2」。

testtable

例

成功レスポンス

JSONJSON

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "RecommendIndex": {
    "SuggestIndex": "PRIMARY",
    "TenantMode": "mysql",
    "TableList": "testtable"
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

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

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

変更履歴

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