The Management API of OpenSearch Retrieval Engine Edition returns responses in two formats: a success response and an error response.
Success response
Example:
{
"requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
"result": (Array|Object)
}Parameters:
| Parameter | Type | Description |
|---|---|---|
| requestId | String | The request ID. |
| result | Array | Object | The returned data. For GET requests, this field contains the corresponding value. For POST or DELETE requests, this field returns an empty object ({}) or empty array ([]). |
Error response
Example:
{
"requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",
"code": "instance.NotFound",
"message": "Instance not found"
}Parameters:
| Parameter | Type | Description |
|---|---|---|
| requestId | String | The request ID. |
| code | String | The error code. Use this value to look up the cause and resolution in the error code reference. |
| message | String | The error message. |