すべてのプロダクト
Search

このプロダクト

    :ListIndexes

    ドキュメントセンター

    :ListIndexes

    最終更新日:Sep 29, 2025

    インデックスのリストを取得します。

    操作説明

    メソッド

    GET

    URI

    /openapi/ha3/instances/{instanceId}/indexes

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    searchengine:ListIndexes

    list

    *Instance

    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 なし なし

    リクエスト構文

    GET /openapi/ha3/instances/{instanceId}/indexes HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンス ID。

    ha-cn-2r42ost****
    newMode

    boolean

    任意

    コンソールページの新しいバージョンを使用するかどうかを指定します。

    true
    catalog

    string

    任意

    Data Lake Formation (DLF) データソースのデータカタログの ID。

    clg-paimon-765e9e2d43ab4fccbf095853a661eafc
    database

    string

    任意

    DLF データソースのデータベース。

    dlf_test
    table

    string

    任意

    DLF データソースのデータテーブル。

    rag

    リクエストの例

    

    GET /openapi/ha3/instances/ose-test1/indexes

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返された結果。

    requestId

    string

    リクエスト ID。

    4FB0325E-8C37-5525-96AC-0333523170A3
    result

    array<object>

    インデックス詳細のリスト。

    object

    インデックス詳細のリスト。

    name

    string

    インデックス名。

    general
    versions

    array<object>

    バージョンのリスト。

    object

    インデックスバージョンに関する情報。

    desc

    string

    説明。

    Index Note
    files

    array<object>

    ファイル名のリスト。

    object

    バージョン情報。

    fullPathName

    string

    フルテキストインデックスの作成後のフォルダ名。

    /qrs.json

    isDir

    boolean

    フォルダが存在するかどうかを示します。

    true
    isTemplate

    boolean

    ファイルがテンプレートであるかどうかを示します。

    true
    name

    string

    ファイル名。

    qrs.json

    name

    string

    バージョン名。

    test
    status

    string

    ステータス。

    • NEW: インデックスは作成中です。

    • PUBLISH: インデックスは通常の状態です。

    • IN_USE: インデックスは使用中です。

    • NOT_USE: インデックスは使用されていません。

    • STOP_USE: インデックスは停止中です。

    • RESTORE_USE: インデックスは再開中です。

    • FAIL: インデックスは失敗しました。

    PUBLISH
    updateTime

    integer

    更新時間。

    2024-06-20 08:52:54
    versionId

    integer

    バージョン ID。このパラメーターは編集バージョンの場合は null です。

    1
    dataSource

    string

    データソース。

    ha-cn-pl32rf0****_test_api
    domain

    string

    データソースのデプロイメント名。

    vpc_hz_domain_1
    indexStatus

    string

    NEW、PUBLISH

    PUBLISH
    content

    string

    JSON 形式のスキーマ。

    {"summarys":{"parameter":{"file_compressor":"zstd"},"summary_fields":["id"]},"file_compress":[{"name":"file_compressor","type":"zstd"},{"name":"no_compressor","type":""}],"indexs":[{"index_fields":"name","index_name":"ids","index_type":"STRING"},{"has_primary_key_attribute":true,"index_fields":"id","is_primary_key_sorted":false,"index_name":"id","index_type":"PRIMARYKEY64"}],"attributes":[{"file_compress":"no_compressor","field_name":"id"}],"fields":[{"user_defined_param":{},"compress_type":"uniq","field_type":"STRING","field_name":"id"},{"compress_type":"uniq","field_type":"STRING","field_name":"name"}],"table_name":"api"}
    partition

    integer

    データシャードの数。

    2
    fullVersion

    integer

    フルバージョン、つまりインデックスバージョン。

    1688523414
    fullUpdateTime

    string

    フルインデックスが切り替えられた時間。

    2023-07-05 10:40:38
    incUpdateTime

    string

    増分更新の時間。

    2023-07-05 10:58:33
    indexSize

    integer

    インデックスサイズ。

    4689
    description

    string

    説明。

    note
    dataSourceInfo

    object

    データソースに関する情報。

    processPartitionCount

    integer

    データ更新用のリソース数。

    2
    name

    string

    データソース名。

    ha-cn-pl32rf0****_test_api
    type

    string

    データソースのタイプ。有効な値: odps (MaxCompute)、swift、saro、oss (Object Storage Service)、および unKnow。

    odps
    domain

    string

    オフラインデプロイメント。

    vpc_hz_domain_2
    config

    object

    MaxCompute データソースの構成。

    endpoint

    string

    MaxCompute データソースに関する情報。

    http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
    accessKey

    string

    MaxCompute データソースの AccessKey ID。

    L***p
    accessSecret

    string

    MaxCompute データソースの AccessKey シークレット。

    5**9a6
    project

    string

    MaxCompute プロジェクトの名前。

    tisplus_dev
    partition

    string

    データパーティション。

    ds=20231220
    table

    string

    saro または MaxCompute データソースに関する情報。

    dump_odps_demo
    namespace

    string

    saro データソースに関する情報。

    TEST_dump_demo_sj_na61hunbu2_share_holo
    path

    string

    Hadoop 分散ファイルシステム (HDFS) データソースに関する情報。

    http://test_opensearch/sift_oss_test.data
    ossPath

    string

    OSS データソースに関する情報。

    /test_opensearch/sift_oss_test.data
    bucket

    string

    OSS バケット。

    ha3test-oss
    format

    string

    OSS のファイル形式。

    • ha3

    • json

    ha3
    catalog

    string

    DLF データソースのデータカタログの ID。

    clg-paimon-21cc136237a6457f8618f5f82d116d7e
    database

    string

    DLF データソースのデータベース名。

    dlf_test
    tag

    string

    DLF データソースのタグ。

    test_tag
    saroConfig

    object

    saro データソースの構成。

    namespace

    string

    saro データソースの名前空間。

    TEST_dump_demo_sj_na61hunbu2_share_holo
    tableName

    string

    saro データテーブルの名前。

    dump_odps_demo
    autoBuildIndex

    boolean

    フルインデックスを自動的にビルドするかどうかを示します。

    true
    createTime

    string

    作成時間。

    2024-05-21 16:05:26
    updateTime

    string

    更新時間。

    2024-05-21 16:05:26

    レスポンスの例

    正常なレスポンスの例 

    {

  "requestId": "38b079f1-7846-4226-8c90-3e2644b5c52b",

  "result": [

    {

      "name": "index1",

      "dataSource": "test_yyds_data1",

    },

    {

      "name": "index1",

      "dataSource": "test_yyds_data1",

    }

  ]

}

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "4FB0325E-8C37-5525-96AC-0333523170A3",
  "result": [
    {
      "name": "general",
      "versions": [
        {
          "desc": "Index Note",
          "files": [
            {
              "fullPathName": "/qrs.json\n",
              "isDir": true,
              "isTemplate": true,
              "name": "qrs.json\n"
            }
          ],
          "name": "test",
          "status": "PUBLISH",
          "updateTime": 0,
          "versionId": 1
        }
      ],
      "dataSource": "ha-cn-pl32rf0****_test_api",
      "domain": "vpc_hz_domain_1",
      "indexStatus": "PUBLISH",
      "content": "{\"summarys\":{\"parameter\":{\"file_compressor\":\"zstd\"},\"summary_fields\":[\"id\"]},\"file_compress\":[{\"name\":\"file_compressor\",\"type\":\"zstd\"},{\"name\":\"no_compressor\",\"type\":\"\"}],\"indexs\":[{\"index_fields\":\"name\",\"index_name\":\"ids\",\"index_type\":\"STRING\"},{\"has_primary_key_attribute\":true,\"index_fields\":\"id\",\"is_primary_key_sorted\":false,\"index_name\":\"id\",\"index_type\":\"PRIMARYKEY64\"}],\"attributes\":[{\"file_compress\":\"no_compressor\",\"field_name\":\"id\"}],\"fields\":[{\"user_defined_param\":{},\"compress_type\":\"uniq\",\"field_type\":\"STRING\",\"field_name\":\"id\"},{\"compress_type\":\"uniq\",\"field_type\":\"STRING\",\"field_name\":\"name\"}],\"table_name\":\"api\"}",
      "partition": 2,
      "fullVersion": 1688523414,
      "fullUpdateTime": "2023-07-05 10:40:38",
      "incUpdateTime": "2023-07-05 10:58:33",
      "indexSize": 4689,
      "description": "note",
      "dataSourceInfo": {
        "processPartitionCount": 2,
        "name": "ha-cn-pl32rf0****_test_api",
        "type": "odps",
        "domain": "vpc_hz_domain_2",
        "config": {
          "endpoint": "http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api",
          "accessKey": "L***p",
          "accessSecret": "5**9a6",
          "project": "tisplus_dev",
          "partition": "ds=20231220",
          "table": "dump_odps_demo",
          "namespace": "TEST_dump_demo_sj_na61hunbu2_share_holo",
          "path": "http://test_opensearch/sift_oss_test.data",
          "ossPath": "/test_opensearch/sift_oss_test.data",
          "bucket": "ha3test-oss",
          "format": "ha3",
          "catalog": "clg-paimon-21cc136237a6457f8618f5f82d116d7e",
          "database": "dlf_test",
          "tag": "test_tag"
        },
        "saroConfig": {
          "namespace": "TEST_dump_demo_sj_na61hunbu2_share_holo",
          "tableName": "dump_odps_demo"
        },
        "autoBuildIndex": true
      },
      "createTime": "2024-05-21 16:05:26",
      "updateTime": "2024-05-21 16:05:26"
    }
  ]
}

    エラーコード

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

    変更履歴

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