v1

latestOpenAPI 3.0.22026-07-173834119.9 KB
Vectorization

Get Opensearch Index Status

Endpoint to Get Index Status

This endpoint returns the status of the specified index.


Request Body

FieldTypeDescription
index_idstrThe ID of the index.

Example Request Body

```json

{
    "index_id": "b1c2b4c5-6d7e-8f9g-0h1i-2j3k4l5m6n7"
}

```

Response Body

FieldTypeDescription
index_idstrThe ID of the index.
statusstrThe status of the index. Returns "ACTIVE" or "NOT_FOUND_OR_READY".

Errors

  • 400 Bad Request: If the index is not found.
  • 500 Internal Server Error: If there is an unexpected error during the retrieval of the index status.
post/vector/store/index/status

Request body

index_idstring required

Response

Successful Response

object required