This topic describes the response struct returned for the Management API of Retrieval Engine Edition.
Success response
Example:
{
"requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
"result": (Array|Object) // The returned data.
}Note
For a GET request, the corresponding value of the result parameter is returned in the response. For a POST or DELETE request, the value of the result parameter in the response is {} or [].
Parameters in the struct:
Parameter | 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"
}Parameters in the struct:
Parameter | 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.