本文へスキップ
Sursa Developers

オブジェクト

ErrorInfo

エラーの構造化された説明。

フィールド

  • codestring必須

    エラーカタログのコード(<domain>.<reason>、またはdetailオブジェクトのコード)。

  • messagestring必須

    英語のメッセージ(detailのテキストと同じ)。

  • detailsobject

    構造化された詳細(choices、limit、used、retry_after、バリデーションのフィールド)。paramsには、エラーカタログのコードのテキストに代入される値({name} → 値)が入るため、クライアントは自分の言語でメッセージを表示できます。レスポンスに翻訳は含まれず、APIは英語だけで応答します(1.62.0以降)。

  • request_idstring

    全体を通して使われるリクエストID(X-Request-IDヘッダーとログの記録と同じ)。

  • doc_urlstring (uri-reference)

    開発者ポータルのエラーコードのページ(…/errors/<code>)。

参照元

Error