查看索引表版本详情。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| searchengine:GetIndex | get |
|
| 无 |
请求语法
GET /openapi/ha3/instances/{instanceId}/indexes/{indexName} HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceId | string | 是 | 实例 ID | ha-cn-pl32rf0**** |
| indexName | string | 是 | 索引名称 | test_api |
返回参数
返回示例
正确返回
{
"requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
"result": {
"name": "index-name",
"dataSource": "ha-cn-xxx-index-name",
"domain": "test", // 数据源的部署名称
"partition": 2,
"indexStatus": "IN_USE",
"content": "{\n\t\"summarys\":{\n\t\t\"parameter\":{\n\t\t\t\"file_compressor\":\"zstd\"\n\t\t},\n\t\t\"summary_fields\":[\n\t\t\t\"id\"\n\t\t]\n\t},\n\t\"file_compress\":[\n\t\t{\n\t\t\t\"name\":\"file_compressor\",\n\t\t\t\"type\":\"zstd\"\n\t\t},\n\t\t{\n\t\t\t\"name\":\"no_compressor\",\n\t\t\t\"type\":\"\"\n\t\t}\n\t],\n\t\"indexs\":[\n\t\t{\n\t\t\t\"index_fields\":\"name\",\n\t\t\t\"index_name\":\"ids\",\n\t\t\t\"index_type\":\"STRING\"\n\t\t},\n\t\t{\n\t\t\t\"has_primary_key_attribute\":true,\n\t\t\t\"index_fields\":\"id\",\n\t\t\t\"is_primary_key_sorted\":false,\n\t\t\t\"index_name\":\"id\",\n\t\t\t\"index_type\":\"PRIMARYKEY64\"\n\t\t}\n\t],\n\t\"attributes\":[\n\t\t{\n\t\t\t\"file_compress\":\"no_compressor\",\n\t\t\t\"field_name\":\"id\"\n\t\t}\n\t],\n\t\"fields\":[\n\t\t{\n\t\t\t\"user_defined_param\":{},\n\t\t\t\"compress_type\":\"uniq\",\n\t\t\t\"field_type\":\"STRING\",\n\t\t\t\"field_name\":\"id\"\n\t\t},\n\t\t{\n\t\t\t\"compress_type\":\"uniq\",\n\t\t\t\"field_type\":\"STRING\",\n\t\t\t\"field_name\":\"name\"\n\t\t}\n\t],\n\t\"table_name\":\"api\"\n}",
"extend": {
"vector": [
"vector"
],
"embeding": [
"id"
],
"description": [
"{\"feild2\":\"备注 2\"}",
"{\"feild3\":\"备注 3\"}"
]
},
"cluster": {
"build_parallel_num": "2",
"merge_parallel_num": "2"
},
"dataSourceInfo": {
"type": "odps",
"dataSource": "ha-cn-xxx-index-name",
"processPartitionCount": 2,
"domain": "test",
"autoBuildIndex": true,
"config": {
"project": "tisplus_dev",
"table": "tisplus_one_key_build_station_template_table_test",
"partition": "ds=12345",
"accesskeyId": "root",
"accesskeySecret": "root123",
"endpoint": "http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api"
},
"saroConfig": {
"namespace": "TEST_dump_demo_sj_na61hunbu2_share_holo",
"tableName": "dump_odps_demo"
},
"processParallelNum": 2,
"swiftConfig":{
"topic":"ha-cn-xxx-index-name"
}
},
"config": {
"OFFLINE_DICT": {
"name": "ha-cn-finxmo71065_offline_dict_v2",
"updateTime": 1709259817000,
"desc": "描述"
},
"OFFLINE_TABLE": {
"name": "ha-cn-finxmo71065_table_ha-cn-finxmo71065_test_saro_v2",
"updateTime": 1709261682000,
"desc": "描述"
},
"OFFLINE_COMMON": {
"name": "ha-cn-finxmo71065_offline_adv_v2",
"updateTime": 1709259817000,
"desc": "描述"
},
"OFFLINE_PLUGIN": {
"name": "ha-cn-finxmo71065_offline_plugin_v2",
"updateTime": 1709259817000,
"desc": "描述"
},
"OFFLINE_INDEX": {
"name": "ha-cn-finxmo71065@ha-cn-finxmo71065_test_saro@test_saro@index_config_v2",
"updateTime": 1709259817000,
"desc": "描述"
}
},
"configWhenBuild": {
"OFFLINE_DICT": {
"name": "ha-cn-finxmo71065_offline_dict_v2",
"updateTime": 1709259817000,
"desc": "描述"
},
"OFFLINE_TABLE": {
"name": "ha-cn-finxmo71065_table_ha-cn-finxmo71065_test_saro_v2",
"updateTime": 1709261682000,
"desc": "描述"
},
"OFFLINE_COMMON": {
"name": "ha-cn-finxmo71065_offline_adv_v2",
"updateTime": 1709259817000,
"desc": "描述"
},
"OFFLINE_PLUGIN": {
"name": "ha-cn-finxmo71065_offline_plugin_v2",
"updateTime": 1709259817000,
"desc": "描述"
},
"OFFLINE_INDEX": {
"name": "ha-cn-finxmo71065@ha-cn-finxmo71065_test_saro@test_saro@index_config_v2",
"updateTime": 1709259817000,
"desc": "描述"
}
}
}
示例
正常返回示例
JSON格式
{
"requestId": "4FB0325E-8C37-5525-96AC-0333523170A3",
"result": {
"name": "test_api",
"versions": [
{
"desc": "索引备注",
"files": [
{
"fullPathName": "/qrs.json\n",
"isDir": true,
"isTemplate": true,
"name": "qrs.json"
}
],
"name": "test",
"status": "PUBLISH",
"updateTime": 1718846192,
"versionId": 1
}
],
"dataSource": "ha-cn-pl32rf0****_test_api\n",
"domain": "sz_vpc_domain_1",
"indexStatus": "IN_USE",
"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": "2024-06-20 08:52:54",
"incUpdateTime": "2024-06-20 08:52:54",
"indexSize": 4689,
"description": "备注",
"dataSourceInfo": {
"processPartitionCount": 2,
"name": "ha-cn-pl32rf0****_test_api\n",
"type": "odps",
"domain": "vpc_hz_domain_1",
"config": {
"endpoint": "http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api",
"accessKey": "L***p",
"accessSecret": "5**9a6",
"project": "tisplus_dev",
"partition": "ds=20220713",
"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",
"catalog": "",
"database": "",
"tag": ""
},
"saroConfig": {
"namespace": "TEST_dump_demo_sj_na61hunbu2_share_holo",
"tableName": "llm"
},
"autoBuildIndex": true,
"processParallelNum": 2
},
"cluster": {
"key": {
"buildParallelNum": 2,
"mergeParallelNum": 2
}
},
"config": {
"key": {
"key": {
"name": "\nha-cn-pl32rf0****_offline_adv_v1",
"updateTime": "1716258634000",
"desc": "备注信息"
}
}
},
"configWhenBuild": {
"key": {
"key": {
"name": "\nha-cn-pl32rf0****_offline_adv_v1",
"updateTime": "1716258634000",
"desc": "备注信息"
}
}
},
"extend": {
"key": [
"扩展信息"
]
}
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-07-31 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-05-16 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-07-20 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2022-01-12 | 新增 OpenAPI | 查看变更详情 |