OpenAPI response structure

更新时间:
复制 MD 格式

All OpenSearch API responses use one of two JSON structures: a success response or an error response.

Success responses

Example

{
    "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
    "result": (Array|Object) // The result that was returned.
}

Fields

FieldTypeDescription
requestIdStringThe request ID.
resultArray/ObjectThe result that was returned.

Error responses

Example

{
    "requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",
    "httpCode": 404,
    "code": "App.NotFound",
    "message": "App not found"
}

Fields

FieldTypeDescription
requestIdStringThe request ID.
httpCodeIntegerThe HTTP status code.
codeStringThe error code.
messageStringThe error message.

For a full list of error codes, see Error codes.