すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeIndex

    ドキュメントセンター

    AnalyticDB:DescribeIndex

    最終更新日:Mar 21, 2026

    インデックスに関する情報を取得します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    gpdb:DescribeIndex

    get

    *Collection

    acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    クラスターのリージョン ID です。

    説明

    最新のリージョン一覧を照会するには、DescribeRegions 操作を呼び出してください。

    cn-hangzhou
    DBInstanceId

    string

    任意

    クラスター ID です。

    説明

    リージョン内のすべての AnalyticDB for PostgreSQL インスタンス（インスタンス ID を含む）の情報を照会するには、DescribeDBInstances 操作を呼び出してください。

    gp-xxxxxxxxx
    WorkspaceId

    string

    任意

    複数の AnalyticDB for PostgreSQL インスタンスで構成されるワークスペースの ID です。このパラメーターと DBInstanceId の両方が空であることはできません。両方のパラメーターが指定されている場合、本パラメーターの値が優先されます。

    有効な値：

    • ip

    • l2

    • cosine

    gp-ws-*****
    Namespace

    string

    必須

    名前空間の名称です。

    説明

    名前空間の一覧を照会するには、ListNamespaces 操作を呼び出してください。

    mynamespace
    NamespacePassword

    string

    必須

    名前空間のパスワードです。

    説明

    このパラメーターの値は、CreateNamespace 操作を呼び出す際に指定します。

    testpassword
    Collection

    string

    必須

    コレクションの名称です。

    説明

    コレクションの一覧を照会するには、ListCollections 操作を呼び出してください。

    testcollection
    IndexName

    string

    必須

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

    testindex

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストの固有 ID です。

    ABB39CC3-4488-4857-905D-2E4A051D0521
    Message

    string

    返されたメッセージです。

    success
    Status

    string

    リクエストが成功したかどうかを示します。有効な値：

    • false：操作に失敗しました。

    • true：操作が成功しました。

    success
    Namespace

    string

    名前空間です。

    mynamespace
    Collection

    string

    コレクションの名称です。

    testcollection
    IndexName

    string

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

    testindex
    IndexDef

    string

    インデックスの定義です。

    CREATE INDEX testindex ON mynamespace. testcollection

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "Namespace": "mynamespace",
  "Collection": "testcollection",
  "IndexName": "testindex",
  "IndexDef": "CREATE INDEX testindex ON mynamespace. testcollection"
}

    エラーコード

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

    変更履歴

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