Obtains the index list.
Operation description
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request syntax
GET /openapi/ha3/instances/{instanceId}/indexes
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
instanceId | string | Yes | The instance ID. | ha-cn-2r42ostoc01 |
newMode | boolean | No | Specifies whether the OpenSearch Vector Search Edition instance is of the new version. | true |
Response parameters
Examples
Sample success responses
JSON
format
{
"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": "ha-cn-7mz2iv7sq01_qrs"
}
],
"name": "ha-cn-7pp2ngv4s02_qrs",
"status": "2",
"updateTime": 0,
"versionId": 1
}
],
"dataSource": "ha-cn-7mz2kvu2c01_table4",
"domain": "test",
"indexStatus": "\" \"",
"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": "Description\n",
"dataSourceInfo": {
"processPartitionCount": 2,
"name": "index1",
"type": "odps",
"domain": "test",
"config": {
"endpoint": "http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api",
"accessKey": "root",
"accessSecret": "root123",
"project": "tisplus_dev",
"partition": "ds=12345",
"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"
},
"saroConfig": {
"namespace": "TEST_dump_demo_sj_na61hunbu2_share_holo",
"tableName": "dump_odps_demo"
},
"autoBuildIndex": true
}
}
]
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
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 |