ListClusterNames - OpenSearch - Alibaba Cloud Documentation Center

Queries cluster names.

Operation description

Method

GET

URI

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

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