エラーの原因を明確にする USER_COMMAND_ERROR の導入
API が、既存の INTERNAL_COMMAND_ERROR に加えて、新しいエラーコード USER_COMMAND_ERROR を返せるようになりました。これにより、ユーザーの入力の誤りによるエラーと、Transloadit 内部の不具合によるエラーを、より明確に区別できます。指定した処理設定に起因する問題をすばやく特定して解決できるため、全体としてよりスムーズに利用できます。
最善を尽くしていても、すべてのトランスコード処理が正常に完了するとは限りません。その場合、Assemblyはエラーで終了し、失敗として記録されます。通常、失敗の原因は次の 3 つのいずれかです。
- 入力ファイルの形式が不正、またはファイルが破損している場合。たとえば、画像ファイルの末尾の数バイトが欠落しているケースです。
- 指定した処理設定に誤りがある場合。たとえば、暗号化された PDF ドキュメントのパスワードが指定されていないケースです。
- 入力ファイルと処理設定は正しいものの、内部の不具合で処理に失敗した場合。
これまでは、いずれの場合もAssemblyはエラーステータス
INTERNAL_COMMAND_ERROR で終了していました。しかし、このステータスだけでは、ユーザーにとっても、サービスを運用する私たちにとっても、ファイルや処理設定の不備によるエラーと、内部エラーによるものを区別しにくい状況でした。この区別は、ユーザーが自分で対処できるエラーを判断するうえで重要です。また、私たちも内部の問題をできるだけ早く修正することに集中できます。
何が変わるのか?
今後、ファイルの不備や処理設定の誤りによるエラーが発生すると、Assemblyは新しいステータス
USER_COMMAND_ERROR で失敗します。これは、たとえば
Assembly Instructionsを修正するなど、ユーザー自身で解決できる問題が発生したことを示します。
Transloadit 内部の不具合で失敗したAssemblyには、引き続き INTERNAL_COMMAND_ERROR ステータスが設定されます。これにより、私たちはできるだけ早く問題を調査し、解決できます。
ユーザーへの影響は?
ほとんどのユーザーは、連携について何も対応する必要はありません。対応が必要なのは、ログの記録や再試行の開始などのために、Transloadit との連携コードで
INTERNAL_COMMAND_ERROR ステータスを判定している場合だけです。その場合は、新しい USER_COMMAND_ERROR ステータスも考慮することをお勧めします。
ご質問やご不明な点があれば、これまでどおりサポートチームがお手伝いします。お気軽にお問い合わせください。今回の変更についてご案内します。
