すべてのプロダクト
Search

このプロダクト

    Data Management:ListIndexes

    ドキュメントセンター

    Data Management:ListIndexes

    最終更新日:Mar 21, 2026

    テーブルのインデックスを照会します。

    操作説明

    セキュリティ協調モードで運用されるデータベースインスタンスのみが、この API を呼び出すことができます。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dms:ListIndexes

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Tid

    integer

    任意

    テナントの ID です。

    説明

    テナント ID を確認するには、Data Management (DMS) コンソールの右上隅にあるプロフィール画像にポインターを合わせます。詳細については、「DMS テナントの管理」をご参照ください。

    0
    TableId

    string

    必須

    テーブルの ID です。

    1
    Logic

    boolean

    任意

    テーブルが論理テーブルであるかどうかを指定します。

    false

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストの ID です。

    1F4DE2F1-5B47-462A-A973-E02EB7AF386B
    ErrorCode

    string

    エラーコードです。

    UnknownError
    ErrorMessage

    string

    エラーメッセージです。

    UnknownError
    IndexList

    object

    Index

    array<object>

    インデックスの詳細です。

    object

    IndexName

    string

    インデックスの名前です。

    idx_test
    IndexType

    string

    インデックスの種別です。有効な値は以下のとおりです。

    • Primary

    • Unique

    • Normal

    • FullText

    • Spatial

    Primary
    TableId

    string

    テーブルの ID です。

    1
    IndexId

    string

    インデックスの ID です。

    1
    IndexComment

    string

    インデックスの説明です。

    test
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "1F4DE2F1-5B47-462A-A973-E02EB7AF386B",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "IndexList": {
    "Index": [
      {
        "IndexName": "idx_test",
        "IndexType": "Primary",
        "TableId": "1",
        "IndexId": "1",
        "IndexComment": "test"
      }
    ]
  },
  "Success": true
}

    エラーコード

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

    変更履歴

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