スパース空間マップ APIs エラーコード説明

レスポンス形式

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

{

  "statusCode": 119,

  "msg": "Parameter has errors",

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

  "result":  //statusCode が 0 の場合のみ result が存在。エラー時は結果フィールドは空

}

フィールド	タイプ	説明
statusCode	integer	業務ステータスコード。0 は成功、非 0 はエラーを示す
msg	string	メッセージ
result	object	返却内容。ステータスコードが 0 の場合にターゲットマップオブジェクト構造を返す。それ以外は空
date	string	サーバー時間

重要

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

エラーコード分類

HTTP ステータスコード説明

HTTP ステータスコード	説明
200	リクエスト成功（業務エラーを含む可能性あり）
400	リクエストパラメータエラー
401	APIKey 認証失敗
403	権限不足またはリソースアクセス禁止
404	リクエスト URL インターフェース Path が存在しない
500	サーバー内部エラー
502	アプリケーション例外キャッチ。データエラーの可能性あり

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

業務ステータスコード一覧表

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: ネットワークが遅い可能性があります。クライアントのネットワーク環境を確認することを推奨します

認証関連エラー

Http 401 Unauthorized: APIKey 認証失敗。appId/appKey が正しいか確認してください
ステータスコード 401: アプリケーションシークレットが無効、またはアプリケーションが存在しません。アプリケーション設定を確認してください

パラメータエラー

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

リソース操作エラー

ステータスコード 10x: クエリ対象リソースが存在しない、またはパラメータエラー

システムエラー

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

ベストプラクティス推奨事項

クライアント処理: HTTP ステータスコードだけでなく、statusCode フィールドで業務の成否を判断することを推奨します
エラー再試行: 5xx エラーは適切に再試行可能。4xx エラーはリクエストパラメータを確認してください
ログ記録: 問題調査のため、完全なエラーレスポンスを記録することを推奨します
タイムアウト処理: 長時間の待機を避けるため、適切なリクエストタイムアウト時間を設定してください

Table of Contents