エラーとリトライ
エラーエンベロープ、レスポンスの全一覧、それぞれの対処方法です。
エンベロープ
{ "message": "MISSING_CLIENT_ID", "details": [] }
message はエラーを識別し、details は通常空です。無効な画像など、フローがリクエストを拒否した場合も、このエンベロープのまま、理由が message と details に入って返されます。拒否を参照してください。
リファレンス
| ステータス | message | エンドポイント | リトライ可否 |
|---|---|---|---|
| 400 | INVALID_REQUEST | create | 不可。リクエストを修正してください |
| 400 | REQUEST_TOO_LARGE | create | 不可。ボディが 2 MiB を超えています |
| 400 | MISSING_<FIELD> / INVALID_<FIELD> | create | 不可。<FIELD> はフィールド名を大文字のスネークケースにしたものです(例: MISSING_CREDENTIAL_VALUE) |
| 401 | 空("") | create、selfie | 不可。Unico がアクセスキーを拒否しました。HUMAN_API_ACCESS_KEY を確認してください |
| 409 | CORRELATION_ID_ALREADY_USED | create | 不可。別のプロセスがその correlationId を使用しています。新しいものを使用してください |
| 422 | ATTRIBUTE_TYPE_NOT_SUPPORTED | create | 不可。カタログのコードを使用してください |
| 4xx | フローの message | create | 不可。プロセスは失敗として保存されます |
| 404 | PROCESS_NOT_FOUND | get、selfie | 不可 |
| 404 | SELFIE_NOT_FOUND | selfie | 不可。プロセスに利用可能な自撮りがありません |
| 4xx | 拒否の message | selfie | 不可 |
| 503 | DATABASE_UNAVAILABLE | すべて | create は下記を参照。get と selfie は可 |
| 502 | UPSTREAM_UNAVAILABLE | すべて | create は下記を参照。get と selfie は可 |
| 500 | INTERNAL | すべて | create は下記を参照 |
作成のリトライ
受理された作成リクエストはそれぞれ新しい id を持つ新しいプロセスを開始し、各 correlationId は 1 回しか使用できません。どの状態であっても、すでにプロセスが使用している correlationId は 409 CORRELATION_ID_ALREADY_USED で拒否されます。
- 400、409、422、その他の拒否: リクエストを修正してから再送信してください。
- 503
DATABASE_UNAVAILABLE: 何も保存・処理されていません。同じcorrelationIdでリトライしてください。 - 502 と 500: リクエストが確認できませんでした。自動的にリトライしないでください。再試行する場合は、新しい
correlationIdで新しい作成リクエストを送信してください。
バックエンドでの推奨手順:
- Human Plugin を呼び出す前に、各試行を
correlationIdをキーとして記録します。 502または500の場合は、業務ルールに従って新しい試行を開始するかどうかを判断します。- 関連する試行を記録上で紐付けて保持します。
読み取りのリトライ
プロセスまたはその自撮りに対する GET は、安全にリトライできます。バックオフを使用し、404 で停止してください。
レート制限
Human Plugin には組み込みのレートリミッターがありません。必要な場合は、ゲートウェイで制限を適用してください。