規約
ID、タイムスタンプ、エラーの形、バージョン管理、再試行。
| 慣例 | ルール |
|---|---|
| ID | UUID。中身は不透明です。丸ごと保存し、解析したり短くしたりしないでください |
| タイムスタンプ | UTCでのRFC 3339、例: 2026-09-22T04:10:00Z |
| 不明なフィールド | 無視してください。新しいレスポンスフィールドや新しいステータス値は、バージョン変更なしで追加されることがあります |
| バージョニング | プレフィックスがメジャーバージョンを表します。破壊的変更には新しいプレフィックスと事前通知があります |
| エラー | {"description": "…", "error": {"error_code": "…", "error_attributes": {…}}} — に基づいて分岐し error.error_code、ログに記録し 説明、そのテキストでは一致判定しません。参照 エラーと制限 |
| 再試行 | 従ってください Retry-After 429では。5xxでは、指数バックオフとジッターを使って再試行します |
冪等性
送信してください idempotency_key 開始するすべての実行ごとに。これはあなた自身の文字列です。エピソード番号、ジョブID、ワーク単位で安定したものであれば何でも構いません。
- 同じキーで 同じ本文を使うと 2回目を開始する代わりに、すでに存在する実行が返されます。
- 同じキーで 異なる本文を使うと は
idempotency_conflict。
そのため、タイムアウト後の再試行は安全になります。これは、1回の実行と、課金対象になる重複実行との違いです。
トレース
すべてのレスポンスには x-morphic-trace-idが含まれます。ログに記録してください。問題を報告するとき、このIDがあることで、時間帯を聞かれる代わりに数秒で実行を見つけられます。