次の方法で共有

要求サービス API エラー コード

  • [アーティクル]

Note

Microsoft Entra Verified ID は、Microsoft Entra Verified ID という名称になり、Microsoft Entra 製品ファミリの一部となりました。 ID ソリューションの Microsoft Entra ファミリの詳細を確認し、統合 Microsoft Entra 管理センターで作業を開始してください。

Microsoft Entra 確認済み ID には、資格情報を発行して確認できる要求サービス REST API が含まれています。 この記事では、要求サービス API のエラー コードを指定します。

エラー オブジェクト

パブリック プレビュー中に、要求サービス API は次の形式のエラーを返しました。

{
  "requestId": "4bb6726f77af7623ab52962323016442",
  "date": "Thu, 28 Apr 2022 14:30:54 GMT",
  "mscv": "17ppwf3uxR10MfRR.1",
  "error": {
    "code": "client_request.invalid_include_qr_code",
    "message": "The request contains `includeQRCode`, but it is not boolean."
  }
}

この形式は、より簡単なエラー処理を可能にし、トラブルシューティングのサポートを向上させるために、次のように変更されました。 新しい形式では、innererror オブジェクトはエラーの原因に関する詳細を提供しますが、外部のエラー コードとメッセージ フィールドには標準化された値が使用されます。

{
  "requestId": "782628eb-503a-4978-84f2-d7c634f25b15",
  "date": "Fri, 29 Apr 2022 11:20:19 GMT",
  "mscv": "QbBLwF7XAp0dt4Lw.1",
  "error": {
    "code": "badRequest",
    "message": "The request is invalid.",
    "innererror": {
      "code": "badOrMissingField",
      "message": "The request contains `includeQRCode`, but it is not boolean.",
      "target": "includeQRCode"
    }
  }
}
プロパティ タイプ Description
requestId string 自動生成された要求 ID。
date date エラーの時刻。
mscv string Microsoft の内部コード。
error Error 外部のエラー オブジェクト

エラーの種類

error オブジェクトは API 呼び出しから返される HTTP 状態コードと一致するようになり、開発者はより簡単にエラー処理を行えるようになりました。

プロパティ タイプ Description
code string HTTP 状態コードと一致する戻りエラー コード。
message string 返される HTTP 状態コードにも依存する標準化されたエラー メッセージ。
innererror Innererror エラーの原因に関する詳細を提供します。

エラー コードとメッセージ

返されるさまざまな HTTP 状態コードにマップされる最上位レベルの code 値を次に示します。

HTTP 状態コード code message
400 badRequest 要求が無効です。
401 無許可 要求されたリソースには、認証が必要です。
403 許可されていません この要求を実行するためのアクセス許可がありません。
404 notFound 要求されたリソースは存在しません。
405 methodNotAllowed 要求されたメソッドは、要求されたリソースでは許可されません。
406 notAcceptable 要求された応答形式はサポートされていません。
408 requestTimeout 要求がタイムアウトしました。
409 競合 サーバーの競合により、サーバーが要求を実行することはできません。
410 なくなりました 要求されたリソースは使用できなくなりました。
411 contentLengthRequired Content-length ヘッダーが見つかりません。
412 preconditionFailed この要求の前提条件が失敗しました。
413 payloadTooLarge ペイロードが大きすぎます。
414 uriTooLong URI が長すぎます。
415 unsupportedMediaType 指定されたメディアの種類がサポートされていません。
416 rangeNotSatisfiable 要求されたデータの範囲を満たすことはできません。
417 expectationFailed Expect ヘッダーを満たすことができませんでした。
421 misdirectedRequest この要求に対する応答を生成できません。
422 unprocessableEntity 要求にセマンティック エラーが含まれています。
423 locked ソースまたは宛先のリソースがロックされています。
429 tooManyRequests 要求が多すぎます。後でもう一度お試しください。
431 requestHeaderFieldsTooLarge 要求ヘッダー フィールドが大きすぎます。
500 internalServerError サーバーで汎用エラーが発生しました。
501 notImplemented サーバーは、要求された関数をサポートしていません。
502 badGateway 別のゲートウェイから不適切な応答を受信しました。
503 serviceUnavailable このサーバーは一時的にご利用になれません。後でもう一度お試しください。
504 gatewayTimeout 別のゲートウェイからタイムアウトを受信しました。
507 insufficientStorage 要求のデータを保存できません。

内部エラーの種類

内部エラー オブジェクトには、開発者が現在のエラーを調査する際に役立つエラーの具体的な詳細が含まれています。

{
  "requestId": "782628eb-503a-4978-84f2-d7c634f25b15",
  "date": "Fri, 29 Apr 2022 11:20:19 GMT",
  "mscv": "QbBLwF7XAp0dt4Lw.1",
  "error": {
    "code": "badRequest",
    "message": "The request is invalid.",
    "innererror": {
      "code": "badOrMissingField",
      "message": "The request contains `includeQRCode`, but it is not boolean.",
      "target": "includeQRCode"
    }
  }
}
プロパティ タイプ Description
code string 内部エラー コード。 エラーの種類に基づいて標準化されたコードが含まれています
message string 内部エラー メッセージ。 エラーの詳細なメッセージが含まれています。 この例では、includeQRCode フィールドの型が間違っています。
target string 省略可能。 ターゲットには、このエラーの原因となっている要求のフィールドが含まれています。 このフィールドは省略可能であり、エラーの種類によっては存在しない場合があります。

内部エラー コード

コード 説明
badOrMissingField 要求に関する検証の問題が発生したときに返されます。 target フィールドには、このエラーの原因となっている要求のフィールドが含まれています。
notFound クライアントが要求しているリソースが見つからない場合に返されます。 target フィールドには、見つからないリソース名/ID が含まれています。
tokenError JWT などのトークンに関する検証の問題に対して返されます。 target フィールドには、問題の原因となっているトークン名 (該当する場合) が含まれます。
transientError クライアントが後の段階で要求を再試行した場合に成功応答を取得できる可能性があるすべてのケースに対して返されます。 このコードが返される一般的な例に、HTTP 429 コードが返される場合があります

次のステップ