ListIndexes - OpenSearch - Alibaba Cloud Documentation Center

Retrieves a list of indexes.

Operation description

Method

GET

URI

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

searchengine:ListIndexes

list

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

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-2r42ost****
newMode	boolean	No	Specifies whether to use the new version of the console page.	true
catalog	string	No	The ID of the data catalog for the Data Lake Formation (DLF) data source.	clg-paimon-765e9e2d43ab4fccbf095853a661eafc
database	string	No	The database of the DLF data source.	dlf_test
table	string	No	The data table of the DLF data source.	rag

Sample request

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

Response elements

Element	Type	Description	Example
	object	The returned result.
requestId	string	The request ID.	4FB0325E-8C37-5525-96AC-0333523170A3
result	array<object>	The list of index details.
	object	The list of index details.
name	string	The index name.	general
versions	array<object>	The list of versions.
	object	The information about the index version.
desc	string	The description.	Index Note
files	array<object>	The list of file names.
	object	The version information.
fullPathName	string	The name of the folder after a full-text index is created.	/qrs.json
isDir	boolean	Indicates whether a folder exists.	true
isTemplate	boolean	Indicates whether the file is a template.	true
name	string	The file name.	qrs.json
name	string	The version name.	test
status	string	The status. NEW: The index is being created. PUBLISH: The index is in the Normal state. IN_USE: The index is in use. NOT_USE: The index is not in use. STOP_USE: The index is being stopped. RESTORE_USE: The index is being resumed. FAIL: The index failed.	PUBLISH
updateTime	integer	The update time.	2024-06-20 08:52:54
versionId	integer	The version ID. This parameter is null for an edit version.	1
dataSource	string	The data source.	ha-cn-pl32rf0****_test_api
domain	string	The deployment name of the data source.	vpc_hz_domain_1
indexStatus	string	NEW, PUBLISH	PUBLISH
content	string	The schema in the JSON format.	{"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 data shards.	2
fullVersion	integer	The full version, which is the index version.	1688523414
fullUpdateTime	string	The time when the full index was switched.	2023-07-05 10:40:38
incUpdateTime	string	The time of the incremental update.	2023-07-05 10:58:33
indexSize	integer	The index size.	4689
description	string	The description.	note
dataSourceInfo	object	The information about the data source.
processPartitionCount	integer	The number of resources for data updates.	2
name	string	The data source name.	ha-cn-pl32rf0****_test_api
type	string	The type of the data source. Valid values: odps (MaxCompute), swift, saro, oss (Object Storage Service), and unKnow.	odps
domain	string	The offline deployment.	vpc_hz_domain_2
config	object	The configurations of the MaxCompute data source.
endpoint	string	Information about the MaxCompute data source.	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	The AccessKey ID of the MaxCompute data source.	L***p
accessSecret	string	The AccessKey secret of the MaxCompute data source.	5**9a6
project	string	The name of the MaxCompute project.	tisplus_dev
partition	string	The data partition.	ds=20231220
table	string	Information about the saro or MaxCompute data source.	dump_odps_demo
namespace	string	Information about the saro data source.	TEST_dump_demo_sj_na61hunbu2_share_holo
path	string	Information about the Hadoop Distributed File System (HDFS) data source.	http://test_opensearch/sift_oss_test.data
ossPath	string	Information about the OSS data source.	/test_opensearch/sift_oss_test.data
bucket	string	The OSS bucket.	ha3test-oss
format	string	The file format for OSS. ha3 json	ha3
catalog	string	The ID of the data catalog for the DLF data source.	clg-paimon-21cc136237a6457f8618f5f82d116d7e
database	string	The database name of the DLF data source.	dlf_test
tag	string	The tag of the DLF data source.	test_tag
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 data table.	dump_odps_demo
autoBuildIndex	boolean	Indicates whether to automatically build a full index.	true
createTime	string	The creation time.	2024-05-21 16:05:26
updateTime	string	The update time.	2024-05-21 16:05:26

Sample responses

Sample success response

{

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

  "result": [

    {

      "name": "index1",

      "dataSource": "test_yyds_data1",

    },

    {

      "name": "index1",

      "dataSource": "test_yyds_data1",

    }

  ]

}

Examples

Success response

JSON format

{
  "requestId": "4FB0325E-8C37-5525-96AC-0333523170A3",
  "result": [
    {
      "name": "general",
      "versions": [
        {
          "desc": "Index Note",
          "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": "note",
      "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"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.