Reference > PyDo > Library Reference > databases > list_opeasearch_indexes()

Was this page helpful?

Give Feedback

pydo.databases.list_opeasearch_indexes()

Generated on 25 November 2024 from pydo version v0.6.0

Description

To list all of a OpenSearch cluster’s indexes, send a GET request to /v2/databases/$DATABASE_ID/indexes.

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

Parameters

Name	Type	Required	Description	Default Value
`database_cluster_uuid`	string	True	A unique identifier for a database cluster.

Responses

See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.

200
401
404
429
500
default

A JSON object with a key of indexes.

Click to expand an example response.

{
  "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"
    }
  ]
}

Unauthorized

Click to expand an example response.

{
  "id": "unauthorized",
  "message": "Unable to authenticate you."
}

The resource was not found.

Click to expand an example response.

{
  "id": "not_found",
  "message": "The resource you requested could not be found."
}

API Rate limit exceeded

Click to expand an example response.

{
  "id": "too_many_requests",
  "message": "API Rate limit exceeded."
}

Server error.

Click to expand an example response.

{
  "id": "server_error",
  "message": "Unexpected server-side error"
}

Unexpected error

Click to expand an example response.

{
  "id": "example_error",
  "message": "some error message"
}