获取索引列表。
接口说明
调试
您可以在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 |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "4FB0325E-8C37-5525-96AC-0333523170A3",
"result": [
{
"name": "general",
"versions": [
{
"desc": "索引备注\n",
"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": "备注",
"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"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-12-05 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-07-20 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2022-01-12 | 新增 OpenAPI | 查看变更详情 |