ListTables - OpenSearch - Alibaba Cloud Documentation Center

Queries a list of index tables.

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

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-0ju2rewdi02
newMode	boolean	No	Specifies whether the OpenSearch Vector Search Edition instance is of the new version.	true

Sample requests

GET /openapi/ha3/instances/{instanceId}/tables

Response parameters

Parameter	Type	Description	Example
	object
requestId	string	requestId	10D5E615-69F7-5F49-B850-00169ADE513C
result	array<object>	The result.
item	object
name	string	The index name.	es_test_1b
indexStatus	string	The state of the index table. Valid values: NEW, PUBLISH, IN_USE, NOT_USE, STOP_USE, RESTORE_USE, and FAIL. After an index is created in an OpenSearch Retrieval Engine Edition instance, the index enters the IN_USE state. If the first full index fails to be created in an OpenSearch Vector Search Edition instance of the new version, the index is in the FAIL state.	IN_USE
status	string	The state of the index table. Valid values: NEW, PUBLISH, IN_USE, NOT_USE, STOP_USE, RESTORE_USE, and FAIL. After an index is created in an OpenSearch Retrieval Engine Edition instance, the index enters the IN_USE state. If the first full index fails to be created in an OpenSearch Vector Search Edition instance of the new version, the index is in the FAIL state.	IN_USE

Examples

Sample success responses

JSONformat

{
  "requestId": "10D5E615-69F7-5F49-B850-00169ADE513C",
  "result": [
    {
      "name": "es_test_1b",
      "indexStatus": "IN_USE",
      "status": "IN_USE"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-09	The response structure of the API has changed	View Change Details