このトピックでは、OpenSearch Retrieval Engine Edition の管理 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 | 文字列 | エラーメッセージ。 |
詳細については、「SearchEngine - Error Codes」をご参照ください。