Server & Workload Protection に送信する要求にエラーが含まれている場合、対応には問題の特定に使用できる次の情報が含まれます。
- PostmanやcURLなどのソフトウェアでAPIを直接使用する場合は、対応のステータスコードと対応本文のエラーメッセージでエラーを認識できます。
- SDKを使用する場合、対応は例外 (PythonおよびJava) またはエラー (JavaScript) として提供されます。例外またはエラーには、対応本文からのエラーメッセージが含まれます。
エラー応答のトラブルシューティングを改善するには、発生する可能性のあるエラーの種類と一般的な原因を理解する必要があります。
エラー情報の取得
SDKを使用すると、キャッチした例外 (PythonおよびJava) またはエラー (JavaScript) にエラーメッセージが表示されます。の例 GETリクエストの実行: ポリシーの一覧表示例外をキャッチしてエラーメッセージを出力する方法を示します。次の例は、そのセクションの例の一部です。
# Create a PoliciesApi object policies_api = api.PoliciesApi(api.ApiClient(configuration)) # List policies using version v1 of the API policies_list = policies_api.list_policies(api_version) # View the list of policies return policies_list
PostmanまたはcURLの場合、対応を受信するとエラーメッセージが表示されます。
認証エラー
認証エラーが発生すると、次の対応メッセージが返されます。
Invalid API Key
。 PostmanおよびcURLユーザの場合、このエラーは401
ステータスコード。このエラーは、一般的に次の状況で発生します。- 要求の認証に使用する秘密鍵が正しく入力されていません
- リクエストの認証に使用されたAPIキーが削除されました
認証エラー
API キーにアクションの実行またはリソースへのアクセスが許可されていない場合、認可エラーが発生します。これらのエラーにより、次の形式の対応メッセージが生成されます。
Not authorized to <action> <resource type>
、 例えば、Not authorized to delete computers
。 Postman および cURL ユーザーの場合、このエラーは次のエラーに関連付けられます。403
ステータスコード。このエラーは通常、次の状況で発生します。- APIキーに割り当てられている役割に、リソース、操作、またはその両方に対するアクセス権がありません。
- APIキーがロックアウトされています。
- APIキーの有効期限が切れています。
リソースが見つからないというエラー
「リソースが見つかりません」エラーは、特定のリソースに対してアクションを実行するリクエストが行われ、そのリソースが見つからない場合に発生します。これらのエラーにより、次の形式の対応メッセージが生成されます。
The <resource> does not exist
、 例えば、The policy does not exist
。 Postman および cURL ユーザーの場合、このエラーは次のエラーに関連付けられます。404
ステータスコード。このエラーは通常、次の状況で発生します。- リソースの識別に使用されたIDが正しくありません。
- リソースが削除されました。
不正なリクエストエラー
不正要求エラーは、要求が Server & Workload Protection で想定される形式または構文に準拠していない場合、または Server & Workload Protection で許可されていないタスクを実行しようとした場合に発生します。このメッセージは、エラーの原因となった状況に固有のものであり、次のようにさまざまです。
- パラメータとして使用されているオブジェクトが無効です。たとえば、役割を作成し、提供された
Role
を持たないオブジェクトname
プロパティを設定するとエラーメッセージが表示されるRole Name cannot be blank
。 - (PostmanまたはcURL) 必要なヘッダがないか、ヘッダ名の入力に誤りがあります。たとえば、
api-version
エラーメッセージが表示されるMissing 'api-version' request header. Please set this header with the a value of a supported API version
。 - APIバージョンの値が正しくありません。たとえば、
1
APIバージョンによってエラーメッセージが表示されるためInvalid 'api-version' request header. Please make sure this header starts with 'v' followed by a number. E.g. v1
。 - Server & Workload Protectionで許可されていない依存ルールを持つルールの割り当てを解除しようとしました。たとえば、HTTPプロトコルデコードという侵入防御ルールの割り当てをポリシーから解除しようとすると、次のエラーメッセージが表示されます。
Intrusion Prevention Rule 5341 could not be removed because Rule 8401 depends on Rule 5341
。
PostmanおよびcURLユーザの場合、このエラーは
400
ステータスコード。SDKの互換性を確認する
使用しているSDKに Server & Workload Protectionとの互換性がない場合、または古いバージョンのSDKで開発されたスクリプトを新しいバージョンのSDKを使用して実行すると、エラーが発生することがあります。詳細については、 SDKバージョンの互換性ガイドします。