Queries the information about an index version.
Operation description
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| searchengine:GetIndex | get |
|
| none |
Request syntax
GET /openapi/ha3/instances/{instanceId}/indexes/{indexName} HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| instanceId | string | Yes | The instance ID. | ha-cn-8ed2j834u03 |
| indexName | string | Yes | The index name. | index_jiayi_text |
Response parameters
Sample responses
Sample success response
{
"requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
"result": {
"name": "index-name",
"dataSource": "ha-cn-xxx-index-name",
"domain": "test", // The name of the data source.
"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\":\"Note 2\"}",
"{\"feild3\":\"Note 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": "Description"
},
"OFFLINE_TABLE": {
"name": "ha-cn-finxmo71065_table_ha-cn-finxmo71065_test_saro_v2",
"updateTime": 1709261682000,
"desc": "Description"
},
"OFFLINE_COMMON": {
"name": "ha-cn-finxmo71065_offline_adv_v2",
"updateTime": 1709259817000,
"desc": "Description"
},
"OFFLINE_PLUGIN": {
"name": "ha-cn-finxmo71065_offline_plugin_v2",
"updateTime": 1709259817000,
"desc": "Description"
},
"OFFLINE_INDEX": {
"name": "ha-cn-finxmo71065@ha-cn-finxmo71065_test_saro@test_saro@index_config_v2",
"updateTime": 1709259817000,
"desc": "Description"
}
},
"configWhenBuild": {
"OFFLINE_DICT": {
"name": "ha-cn-finxmo71065_offline_dict_v2",
"updateTime": 1709259817000,
"desc": "Description"
},
"OFFLINE_TABLE": {
"name": "ha-cn-finxmo71065_table_ha-cn-finxmo71065_test_saro_v2",
"updateTime": 1709261682000,
"desc": "Description"
},
"OFFLINE_COMMON": {
"name": "ha-cn-finxmo71065_offline_adv_v2",
"updateTime": 1709259817000,
"desc": "Description"
},
"OFFLINE_PLUGIN": {
"name": "ha-cn-finxmo71065_offline_plugin_v2",
"updateTime": 1709259817000,
"desc": "Description"
},
"OFFLINE_INDEX": {
"name": "ha-cn-finxmo71065@ha-cn-finxmo71065_test_saro@test_saro@index_config_v2",
"updateTime": 1709259817000,
"desc": "Description"
}
}
}
Examples
Sample success responses
JSONformat
{
"requestId": "4FB0325E-8C37-5525-96AC-0333523170A3",
"result": {
"name": "general",
"versions": [
{
"desc": "close alarm, by 3.9.2 hotfix workflow",
"files": [
{
"fullPathName": "\" \"",
"isDir": true,
"isTemplate": true,
"name": "qrs.json"
}
],
"name": "ha-cn-7pp2ngv4s02_qrs",
"status": "2",
"updateTime": 0,
"versionId": 1
}
],
"dataSource": "ha-cn-tl32nd2nq01_00",
"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": "test index",
"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": "Description\n"
}
}
},
"configWhenBuild": {
"key": {
"key": {
"name": "\nha-cn-pl32rf0****_offline_adv_v1",
"updateTime": "1716258634000",
"desc": "Description\n"
}
}
},
"extend": {
"key": [
"Extended information\n"
]
}
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-07-31 | The response structure of the API has changed | View Change Details |
| 2024-05-16 | The response structure of the API has changed | View Change Details |
| 2023-07-20 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2022-01-12 | Add Operation | View Change Details |