Sparse spatial map APIs エラーコード説明

レスポンス形式

すべての API レスポンスは統一された JSON 形式を使用します。以下は例です:

{

  "statusCode": 119,

  "msg": "Parameter has errors",

  "date": "2022-06-15T09:56:30.000Z",

  "result":  //result は statusCode が 0 の場合のみ存在します。エラーが発生した場合、結果フィールドは空です

}

フィールド	型	説明
statusCode	integer	ビジネス status code。0 は成功を示し、0 以外はエラーを示します
msg	string	メッセージ
result	object	返される内容。status code が 0 のときは target image object structure を返し、それ以外は空です
date	string	サーバー時刻

重要

statusCode == 0 の場合のみ result にレスポンス内容が含まれます。他の状態では result は空です
statusCode != 0 の場合は、エラーメッセージ msg に注意してください

エラーコード分類

HTTP status code 説明

HTTP status code	説明
200	リクエスト成功（business error を含む場合があります）
400	リクエストパラメータエラー
401	APIKey 認証失敗
403	権限不足または resource へのアクセス禁止
404	リクエスト URL の API Path が存在しません
500	サーバー内部エラー
502	アプリケーション例外をキャッチ、データエラーの可能性があります

注意: business error は通常 HTTP 200 レスポンスで返され、具体的なエラータイプは statusCode フィールドで識別されます。

Business status code 一覧

Status Code	Message
0	Success
101	Uploaded file is empty
102	File size is too large
106	Missing parameter or parameter is empty
110	Call server API errors
111	Resource not found
401	Authentication token expired
401	Authentication parameter is missing
401	Unknown appId or appKey
401	Account is locked
401	Authentication failed, invalid signature or token

よくあるエラーシナリオ

タイムアウトして応答がない

Request Timeout: ネットワークが遅い可能性があります。client のネットワーク環境を確認することを推奨します

認証関連エラー

Http 401 Unauthorized: APIKey 認証失敗。appId/appKey が正しいか確認してください
Status code 401: アプリケーションキーが無効、またはアプリケーションが存在しません。アプリケーション設定を確認してください

パラメータエラー

400 Bad Request: リクエストパラメータ形式エラー

Resource 操作エラー

Status code 10x: 照会した target resource が存在しない、またはパラメータが誤っています

システムエラー

Http 50x Internal Server Error: サーバー内部例外またはアプリケーション例外をキャッチしました。Web サイトまたは sample でテストすることを推奨します

ベストプラクティス推奨

client 処理: HTTP status code のみに依存せず、statusCode フィールドに基づいてビジネスが成功したか判断することを推奨します
エラー retry: 5xx エラーは適宜 retry できます。4xx エラーはリクエストパラメータを確認する必要があります
ログ記録: トラブルシューティングしやすくするため、完全なエラーレスポンスを記録することを推奨します
タイムアウト処理: 長時間待機を避けるため、合理的なリクエスト timeout を設定します

Table of Contents