ListIndexes - OpenSearch - Alibaba Cloud Documentation Center

Obtains the index list.

Operation description

Method

GET

URI

/openapi/ha3/instances/{instanceId}/indexes

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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:ListIndexes	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

Request syntax

GET /openapi/ha3/instances/{instanceId}/indexes HTTP/1.1

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

Sample requests

GET /openapi/ha3/instances/ose-test1/indexes

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	The request ID.	4FB0325E-8C37-5525-96AC-0333523170A3
result	array<object>	The details of indexes.
result	object	The list of index details.
name	string	The index name.	general
versions	array<object>	The index versions.
version	object	The version of the index.
desc	string	The description of the index version.	close alarm, by 3.9.2 hotfix workflow
files	array<object>	The files.
file	object	The version information.
fullPathName	string	The full path of the file.	" "
isDir	boolean	Indicates whether the file is a directory.	True
isTemplate	boolean	Indicates whether the file is a template.	True
name	string	The file name.	ha-cn-7mz2iv7sq01_qrs
name	string	The name of the index version.	ha-cn-7pp2ngv4s02_qrs
status	string	The status of the index version. Valid values: NEW: The index version is created. PUBLISH: The index version is normal. IN_USE: The index version is in use. NOT_USE: The index version is not used. STOP_USE: The index version is being stopped. RESTORE_USE: The index version is being restored. FAIL: The index version failed to be created.	2
updateTime	long	The time when the index version was updated.	" "
versionId	integer	The ID of the index version. If the index version is modified, the returned value is null.	1
dataSource	string	The name of the data source.	ha-cn-7mz2kvu2c01_table4
domain	string	The deployment name of the index.	test
indexStatus	string	The index ststus. Valid values: NEW and PUBLISH.	" "
content	string	The index schema, which is a JSON string.	{"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	The number of shards.	2
fullVersion	long	The full version of the index.	1688523414
fullUpdateTime	string	The time when full data in the index was last updated.	2023-07-05 10:40:38
incUpdateTime	string	The time when incremental data in the index was last updated.	2023-07-05 10:58:33
indexSize	long	The index size.	4689
description	string	The description.	Description
dataSourceInfo	object	The information about the data source.
processPartitionCount	integer	The number of resources used for data update.	2
name	string	The name of the data source.	index1
type	string	The type of the data source. Valid values: odps, swift, saro, oss, and unKnow.	odps
domain	string	The data center in which the data source is deployed.	test
config	object	The configuration of MaxCompute data sources.
endpoint	string	The endpoint of the MaxCompute data source.	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	The AccessKey ID of the MaxCompute data source.	root
accessSecret	string	The AccessKey secret of the MaxCompute data source.	root123
project	string	The name of the MaxCompute project that is used as the data source.	tisplus_dev
partition	string	The shard name.	ds=12345
table	string	The name of the MaxCompute table that is used as the data source.	dump_odps_demo
namespace	string	The namespace. This parameter is applicable to the SARO data source used in the intranet of Alibaba Group.	TEST_dump_demo_sj_na61hunbu2_share_holo
path	string	The file path in the Apsara File Storage for HDFS file system.	http://test_opensearch/sift_oss_test.data
ossPath	string	The Object Storage Service (OSS) path.	/test_opensearch/sift_oss_test.data
bucket	string	The OSS bucket.	ha3test-oss
saroConfig	object	The configurations of the SARO data source.
namespace	string	The namespace of the SARO data source.	TEST_dump_demo_sj_na61hunbu2_share_holo
tableName	string	The name of the SARO table.	dump_odps_demo
autoBuildIndex	boolean	Indicates whether the automatic full indexing feature is enabled.	true

Sample responses

Success responses

{

  "requestId": "38b079f1-7846-4226-8c90-3e2644b5c52b",

  "result": [

    {

      "name": "index1",

      "dataSource": "test_yyds_data1",

    },

    {

      "name": "index1",

      "dataSource": "test_yyds_data1",

    }

  ]

}

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": "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