Response structure

更新时间:
复制 MD 格式

The Havenask control API returns a unified response body for both successful and failed requests.

Successful Response

Example:

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

Note

A successful GET request returns the response data in the result field. A successful POST or DELETE request returns {} or [] in the result field.

Structure:

Field

Type

Description

requestId

String

Request ID

result

Array | Object

Returned data

Error response

Example:

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

Structure:

Field

Type

Description

requestId

String

Request ID

code

String

Error code

message

String

Error message

For more information, see Error codes.