AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 智能开放搜索 OpenSearch 开发参考 管控API合集 向量检索版&召回引擎版 API目录 配置中心 索引结构 ListIndexes - 获取索引列表

ListIndexes - 获取索引列表

更新时间：
产品详情
我的收藏

获取索引列表。

接口说明

方法

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：GetFile - 查看索引表版本详情下一篇：RecoverIndex - 从索引中恢复数据