ListClusterNames - OpenSearch - Alibaba Cloud Documentation Center

Queries cluster names.

Operation description

Method

GET

URI

/openapi/ha3/instances/{instanceId}/cluster-names

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

Request syntax

GET /openapi/ha3/instances/{instanceId}/cluster-names HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example

The current API does not require request parameters

Sample requests

GET /openapi/ha3/instances/ha3_instance_name/cluster-names

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	id of request	F6E3D968-529C-5C40-AFDD-133A8B8FD930
result	object	The result set.
name	string	The cluster name.	my_index
description	string	The description of the cluster.	ha3_test
id	long	The cluster ID.	25030

Sample responses

Success responses

{
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": [
    {
      "name":"pre",
      "description":"pre",
      "id": 1,
    }
  ]
}

Examples

Sample success responses

JSONformat

{
  "requestId": "F6E3D968-529C-5C40-AFDD-133A8B8FD930",
  "result": {
    "name": "my_index",
    "description": "ha3_test",
    "id": 25030
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-12-12	The request parameters of the API has changed	View Change Details
2022-01-12	Add Operation	View Change Details