すべてのプロダクト
Search
ドキュメントセンター

OpenSearch:レスポンス構造体

最終更新日:Dec 28, 2024

このトピックでは、Retrieval Engine Edition の Management API から返されるレスポンス構造体について説明します。

成功レスポンス

:

{
	"requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
	"result": (Array|Object) // 返されたデータ。
}

説明

GET リクエストの場合、result パラメーターの対応する値がレスポンスで返されます。POST または DELETE リクエストの場合、レスポンスの result パラメーターの値は {} または [] です。

構造体のパラメーター:

パラメーター

タイプ

説明

requestId

String

リクエストの ID。

result

Array | Object

返されたデータ。

エラーレスポンス

:

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

構造体のパラメーター:

パラメーター

タイプ

説明

requestId

String

リクエストの ID。

code

String

エラーコード。

message

String

エラーメッセージ。

詳細については、エラーコード を参照してください。