Give Feedback

pydo.databases.list_opeasearch_indexes()

Generated on 8 May 2026 from pydo version v0.34.0

Copy page as Markdown View page as Markdown

Usage

client.databases.list_opeasearch_indexes(
    database_cluster_uuid="9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
)

Returns JSONRaises HttpResponseError

Description

To list all of a OpenSearch cluster’s indexes, send a GET request to /v2/databases/{database_cluster_uuid}/indexes.

The result will be a JSON object with a indexes key.

Parameters

database_cluster_uuid string required: A unique identifier for a database cluster.

Response Example

Show Response Example

{
  "indexes": [
    {
      "index_name": "sample-data",
      "number_of_shards": 2,
      "number_of_replicas": 3,
      "size": 208,
      "created_time": "2021-01-01T00:00:00Z",
      "status": "open",
      "health": "green"
    },
    {
      "index_name": "logs-*",
      "number_of_shards": 2,
      "number_of_replicas": 3,
      "size": 208,
      "created_time": "2021-01-01T00:00:00Z",
      "status": "open",
      "health": "green"
    }
  ]
}

More Information

See /v2/databases/{database_cluster_uuid}/indexes in the API reference for additional detail on responses, headers, parameters, and more.