REST API エラーの処理
HTTP エラー応答は、次の 2 つのカテゴリに分類されます。
- クライアント エラー (400 コード レベル) – クライアントが無効な要求を送信したか、要求が定義に従っていません。
- サーバー エラー (500 レベル) – サーバーが一時的に要求を満たさなかったか、サーバー エラーが発生しました。 HTTP 要求をもう一度送信してみてください。
次の表に示すエラー コードは、Microsoft Defender for Endpoint API のいずれかの操作によって返される場合があります。
- エラー コードに加えて、すべてのエラー応答にエラー メッセージが含まれており、問題の解決に役立ちます。
- メッセージは、変更可能なフリー テキストです。
- ページの下部には、応答の例があります。
適用対象:
Defender for Endpoint を試す場合は、 無料試用版にサインアップしてください。
エラー コード | HTTP ステータス コード | メッセージ |
---|---|---|
BadRequest | BadRequest (400) | 一般的な不適切な要求エラー メッセージ。 |
ODataError | BadRequest (400) | OData URI クエリが無効です (特定のエラーが指定されています)。 |
InvalidInput | BadRequest (400) | 無効な入力 {無効な入力}。 |
InvalidRequestBody | BadRequest (400) | 要求本文が無効です。 |
InvalidHashValue | BadRequest (400) | ハッシュ値 {無効なハッシュ} が無効です。 |
InvalidDomainName | BadRequest (400) | ドメイン名 {無効なドメイン} が無効です。 |
InvalidIpAddress | BadRequest (400) | IP アドレス {無効な IP} が無効です。 |
InvalidUrl | BadRequest (400) | URL {無効な URL} が無効です。 |
MaximumBatchSizeExceeded | BadRequest (400) | 最大バッチ サイズを超えました。 受信済み: {batch size received},allowed: {batch size allowed}. |
MissingRequiredParameter | BadRequest (400) | パラメーター {不足しているパラメーター} がありません。 |
OsPlatformNotSupported | BadRequest (400) | OS プラットフォーム {クライアント OS プラットフォーム} は、このアクションではサポートされていません。 |
ClientVersionNotSupported | BadRequest (400) | {要求されたアクション} は、クライアント バージョン {サポートされているクライアント バージョン} 以降でサポートされています。 |
権限がありません (Unauthorized) | 未承認 (401) | 未承認 (無効または期限切れの承認ヘッダー)。 |
禁止されています | 禁止 (403) | 禁止 (有効なトークンが、アクションのアクセス許可が不十分)。 |
DisabledFeature | 禁止 (403) | テナント機能が有効になっていません。 |
DisallowedOperation | 禁止 (403) | {許可されていない操作と理由}。 |
NotFound | 見つかりません (404) | 一般的な見つからないエラー メッセージ。 |
ResourceNotFound | 見つかりません (404) | リソース {要求されたリソース} が見つかりませんでした。 |
TooManyRequests | 要求が多すぎます (429) | 応答は、要求の数または CPU によってクォータ制限に達することを表します。 |
InternalServerError | 内部サーバー エラー (500) | (エラー メッセージは表示されません。操作を再試行してください)。 |
調整
HTTP クライアントは、特定の時間枠内の HTTP 要求の数が API ごとの呼び出しの許可数を超えると、"要求が多すぎるエラー (429)" を受け取る可能性があります。
HTTP クライアントは、さらに HTTPS 要求の再送信を遅らせ、レート制限に準拠した方法で送信する必要があります。 新しい要求を行う前に待機する時間 (秒単位) を示す応答ヘッダーの Retry-After
429 応答を無視するか、短い時間枠で HTTP 要求を再送信しようとすると、429 エラー コードが返されます。
本文パラメーターでは大文字と小文字が区別されます
送信された本文パラメーターでは、現在、大文字と小文字が区別されます。
InvalidRequestBody または MissingRequiredParameter エラーが発生した場合は、パラメーターの大文字または小文字が間違っている可能性があります。
API ドキュメント ページを確認し、送信されたパラメーターが関連する例と一致することをチェックします。
関連付け要求 ID
各エラー応答には、追跡用の一意の ID パラメーターが含まれています。
このパラメーターのプロパティ名は "target" です。
エラーについてお問い合わせの際は、この ID を添付すると、問題の根本原因を特定できます。
例
{
"error": {
"code": "ResourceNotFound",
"message": "Machine 123123123 was not found",
"target": "43f4cb08-8fac-4b65-9db1-745c2ae65f3a"
}
}
{
"error": {
"code": "InvalidRequestBody",
"message": "Request body is incorrect",
"target": "1fa66c0f-18bd-4133-b378-36d76f3a2ba0"
}
}
ヒント
さらに多くの情報を得るには、 Tech Community 内の Microsoft Security コミュニティ (Microsoft Defender for Endpoint Tech Community) にご参加ください。
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示