全部產品
Search

搜尋本產品

    OpenSearch：ListIndexes - 擷取索引列表

    文件中心

    OpenSearch：ListIndexes - 擷取索引列表

    更新時間：Sep 29, 2025

    擷取索引列表。

    介面說明

    方法

    GET

    URI

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

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    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

    否

    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 (edit 版本為 null)

    1
    dataSource

    string

    資料來源

    ha-cn-pl32rf0****_test_api
    domain

    string

    資料來源的部署名

    vpc_hz_domain_1
    indexStatus

    string

    NEW, PUBLISH

    PUBLISH
    content

    string

    schema 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, swift, saro, oss, unKnow)

    odps
    domain

    string

    離線部署

    vpc_hz_domain_2
    config

    object

    odps 資料來源配置

    endpoint

    string

    odps 相關

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

    string

    odps 資料來源 ak

    L***p
    accessSecret

    string

    odps 資料來源 ak secret

    5**9a6
    project

    string

    odps 資料來源專案名稱

    tisplus_dev
    partition

    string

    資料分區

    ds=20231220
    table

    string

    saro、odps 相關

    dump_odps_demo
    namespace

    string

    saro 相關

    TEST_dump_demo_sj_na61hunbu2_share_holo
    path

    string

    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 資料來源-tag

    test_tag
    saroConfig

    object

    saro 資料來源配置

    namespace

    string

    saro 資料來源的 namespace

    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",

    }

  ]

}

    樣本

    正常返回樣本

    JSON格式

    {
  "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"
    }
  ]
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。