All Products
Search
Document Center

OpenSearch:Response structure

Last Updated:Aug 27, 2024

This topic describes the content of the response to the call of an OpenSearch Retrieval Engine Edition API operation for management and control.

Success response

Example:

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

Note

For a successful GET request, the request result is returned in the request parameter. For a successful POST or DELETE request, the result parameter in the response is {} or [].

Structure:

Field

Type

Description

requestId

String

The ID of the request.

result

Array | Object

The returned data.

Error response

Example:

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

Structure:

Field

Type

Description

requestId

String

The ID of the request.

code

String

The error code.

message

String

The error message.

For more information, see Error codes.