クラウド認識 APIs エラーコード説明
Response format
全てのAPIレスポンスは統一されたJSON形式で返されます。以下は例です:
{
"statusCode": 422,
"reuslt": "The image or meta exceeds its maximum permitted size",
"timestamp": 1514736000000,
"appKey": "test_app_key"
}
| フィールド | タイプ | 説明 |
|---|---|---|
| statusCode | integer | ビジネスステータスコード。0は成功、非0はエラーを示す |
| result | string | 返却内容。ステータスコードが0の場合はターゲット画像オブジェクト構造、それ以外はエラーメッセージ |
| timestamp | long | サーバーのUnix形式タイムスタンプ（ミリ秒単位） |
重要
statusCode == 0 の条件下でのみ、result にレスポンス内容が含まれます。それ以外の状態では result はエラーメッセージを返します。
エラーコード分類
HTTP ステータスコード説明
| HTTP ステータスコード | 説明 |
|---|---|
| 200 | リクエスト成功（ビジネスエラーが含まれる可能性あり） |
| 400 | リクエストパラメータエラー |
| 401 | APIKey 認証失敗 |
| 403 | 権限不足またはリソースアクセス禁止 |
| 404 | リクエストURLインターフェースPathが存在しない |
| 500 | サーバー内部エラー |
| 501 | アプリケーション例外キャッチ。データエラーの可能性あり |
| 502 | サーバー利用不可。カスタマーサポートへ連絡 |
注記
ビジネスエラーは通常 HTTP 200 レスポンスで返され、statusCode フィールドで具体的なエラータイプが識別されます。
ビジネスステータスコード一覧表
| Status Code | Message |
|---|---|
| 0 | ok |
| 1 | invalid appId (appKey) |
| 2 | invalid signature |
| 3 | invalid date |
| 4 | appId (appKey) not exist |
| 6 | invalid token |
| 6 | invalid appkey token |
| 7 | non-sdk client for dau databases |
| 8 | Dau databases are not compatible with sense-4.6+ any more. |
| 404 | Target not found |
| 414 | Parameter required not exists or not correct |
| 422 | The image or meta exceeds its maximum permitted size |
| 417 | fail to add image |
| 419 | Cannot update target in database because similar target exists. |
| 420 | Target delete failed |
| 424 | Target enable error |
| 403 | Target already exists |
| 426 | Judge exceeds maxium candidates |
| 427 | Image not correct |
一般的なエラーシナリオ
タイムアウト無応答
- Request Timeout： ネットワークが遅い可能性があります。クライアントのネットワーク環境を確認することを推奨します
認証関連エラー
- Http 401 Unauthorized： APIKey認証失敗。appId/appKeyが正しいか確認してください
- ステータスコード 401： アプリケーションシークレットが無効、またはアプリケーションが存在しません。アプリケーション設定を確認してください
パラメータエラー
- 400 Bad Request： リクエストパラメータ形式エラー
- ステータスコード 414： 必須パラメータが不足している、またはパラメータ値が要件を満たしていません
リソース操作エラー
- ステータスコード 404： クエリ対象のリソースが存在しません
- ステータスコード 403： ターゲットが既に存在するため、重複作成できません
- ステータスコード 417/420/424： 追加/削除/更新操作が失敗しました
ファイル関連エラー
- ステータスコード 422： アップロードファイルサイズが制限を超えています
- ステータスコード 427： 画像形式がサポートされていない、またはファイルが破損しています
システムエラー
- Http 500 Internal Server Error： サーバー内部例外。ウェブサイトまたはサンプルでテストすることを推奨します
- Http 501 Exception： アプリケーション例外キャッチ。データエラーの可能性あり。ウェブサイトまたはサンプルでテストすることを推奨します
- Http 502 Server： サービスレスポンスエラー。サーバーエラーの可能性があります。弊社までご連絡ください
ベストプラクティス推奨事項
- クライアント処理： ビジネスの成否判断はHTTPステータスコードのみに依存せず、
statusCodeフィールドで判断することを推奨します - エラー再試行： 5xxエラーは適切に再試行可能。4xxエラーはリクエストパラメータを確認してください
- ログ記録： 問題調査のため、完全なエラーレスポンスを記録することを推奨します
- タイムアウト処理： 長時間の待機を避けるため、適切なリクエストタイムアウト時間を設定してください