icon-oneapi.svg
OneAPI

レスポンス コードとエラー メッセージについて

次のHTTPステータス コードは、Zscaler OneAPIによって返されます。

コード説明
401認証トークンが無効であるか、期限切れであるか、見つかりません。
403APIクライアントは、要求されたリソースにアクセスできません。
404リクエストされたAPIリソースが見つかりませんでした。
408クライアントが完全な要求を送信するのに時間がかかりすぎました。
413HTTPリクエストが最大許容可能サイズを超えています。
429レート制限またはクォータを超えました。短期間に送られたリクエストが多すぎます。
500リクエストの処理中に内部サーバー エラーが発生しました。
503リクエストされたリソースは一時的に利用不可です。
504サーバーがリクエストに応答するのに時間がかかりすぎました。
閉じる

さらに、特定のZscalerサービスのAPIでは、そのサービス専用のステータス コードのセットが使用される場合があります。次のセクションでは、特定のサービス専用のステータス コードについて説明します。

ZIA API

Zscaler Internet Access (ZIA) APIは、ZIAのユース ケースとシナリオに特有の次の追加レスポンス コードとエラー メッセージを使用します。

コード説明
200成功したリクエスト。
204成功しました。コンテンツは返されません。
400無効または不正な要求です。
403

このコードは、次のいずれかの理由で返されます。

  • ユーザーのロールには、アクセス許可も機能スコープもありません。
  • 必要なSKUサブスクリプションが不足しています。
  • スケジュール済みアップグレード中にZIA管理ポータルがメンテナンス モードになっている場合、POST、PUTまたはDELETEメソッドを使用するAPI操作が実行されます。

Zscalerサポートまたはお客様のZscalerアカウント チームに連絡してサポートを受けてください。

404リソースが存在しません。
405メソッドは許可されていません。このエラーは、リクエスト メソッドがターゲット リソースでサポートされていない場合に返されます。
409編集の競合が発生した可能性があるため、リクエストを処理できませんでした。別の管理者が同時に構成変更を保存している可能性があります。このシナリオでは、クライアントは短時間後に再試行することが期待されます。
415サポートされていないメディア タイプです。このエラーは、リクエスト ヘッダーのContent-Typeとしてapplication/jsonを含めなかった場合に返されます(例:Content-Type: application/json)。
500予期しないエラーです。
503サービスは一時的に利用できません。
閉じる

ZPA API

Zscaler Private Access (ZPA) APIは、ZPAのユース ケースとシナリオに特有の次の追加レスポンス コードとエラー メッセージを使用します。

コード説明
200成功
201作成済み
204コンテンツなし
400

不正な要求

例えば、以下の通りです。

{
 "id": "resource.not.found", 
 "reason": "No resource exists with the given id/name :0", 
 "params": [
   "0" 
 ] 
}
401

承認解除

例えば、以下の通りです。

{
 id: "access.denied",
 reason: "Access denied"
}
403禁止
404見つかりません
409

競合

例えば、以下の通りです。

{
   "params":[
      "com.zscaler.zpn.model.PolicySet"
   ],
   "id":"api.concurrent.access.error",
   "reason":"Unable to modify the resource due to concurrent change requests. Try again"
}

ポリシー・セット・コントローラーに対してPOST、PUT、およびDELETEメソッドを使用した並行API呼び出しは、エラー409ー競合を返すことがあります。ポリシー ルールごとに一度に1つのPUTリクエストのみが送信されるようにします。

429

レート制限またはクォータを超えました。

次の例は、APIコールがレート制限されているときのレスポンス本文です。

{
  "exception": "invalid.toomanyrequests",
  "id": "invalid.toomanyrequests",
  "reason": "Exceeded the number of requests allowed"
}

次の例は、APIコールがレート制限されているときのレスポンス ヘッダーです。

{
  "content-type": "application/json",
  "date": "Wed, 6 Mar 2024 11:38 GMT",
  "retry-after": "13s"
} 

詳細は、「レート制限について」を参照してください。

503

サービスを利用できません

次の例は、エラー コード503のレスポンス本文です。

{
 "id": "retryable.server.error",
 "reason": "An error occurred. Refer to the Retry-After header, and then try again."
}

レスポンス ヘッダーの例を次に示します:{Retry-After: 10s}

Zscalerは、再試行する前に、指数関数的なバックオフ戦略を推奨します。Retry-Afterヘッダーがレスポンス ヘッダーの一部として使用可能な場合は、Retry-Afterヘッダーに記載されている規定の時間まで待ってから再試行してください。

閉じる

Zscaler Client Connector API

Zscaler Client Connector APIでは、Zscaler Client Connectorのユース ケースとシナリオに特有の次の追加レスポンス コードとエラーメッセージを使用します。

コード説明
200成功
400不正な要求
401承認解除
403禁止
404見つかりません
閉じる

関連記事s
レート制限についてレスポンス コードとエラー メッセージについて