Havenask コントロール API は、成功したリクエストと失敗したリクエストの両方に、統一されたレスポンスボディを返します。
成功レスポンス
例：
{
"requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
"result": (Array|Object) // 返されるデータ
}説明
成功した GET リクエストは、result フィールドにレスポンスデータを返します。成功した POST リクエストまたは DELETE リクエストは、result フィールドに {} または [] を返します。
構造：
|
フィールド |
タイプ |
説明 |
|
requestId |
文字列 |
リクエスト ID |
|
result |
配列 | オブジェクト |
返されるデータ |
エラーレスポンス
例：
{
"requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",
"code": "instance.NotFound",
"message": "Instance not found"
}構造：
|
フィールド |
タイプ |
説明 |
|
requestId |
文字列 |
リクエスト ID |
|
code |
文字列 |
エラーコード |
|
message |
文字列 |
エラーメッセージ |
詳細については、「エラーコード」をご参照ください。