Control de errores de LA API REST

  • Artículo

Las respuestas de error HTTP se dividen en dos categorías:

  • Error de cliente (nivel de código 400): el cliente envió una solicitud no válida o la solicitud no está de acuerdo con las definiciones.
  • Error del servidor (nivel 500): el servidor no pudo cumplir temporalmente la solicitud o se produjo un error de servidor. Intente volver a enviar la solicitud HTTP.

Los códigos de error enumerados en la tabla siguiente pueden devolverse mediante una operación en cualquiera de Microsoft Defender para punto de conexión API.

  • Además del código de error, cada respuesta de error contiene un mensaje de error, que puede ayudar a resolver el problema.
  • El mensaje es un texto libre que se puede cambiar.
  • En la parte inferior de la página, puede encontrar ejemplos de respuesta.

Se aplica a:

¿Quiere experimentar Defender para punto de conexión? Regístrese para obtener una prueba gratuita.

Código de error Código de estado HTTP Mensaje
BadRequest BadRequest (400) Mensaje de error de solicitud incorrecta general.
ODataError BadRequest (400) Consulta URI de OData no válida (se especifica el error específico).
InvalidInput BadRequest (400) Entrada no válida {la entrada no válida}.
InvalidRequestBody BadRequest (400) Cuerpo de la solicitud no válido.
InvalidHashValue BadRequest (400) El valor hash {el hash no válido} no es válido.
InvalidDomainName BadRequest (400) El nombre de dominio {el dominio no válido} no es válido.
InvalidIpAddress BadRequest (400) La dirección IP {la dirección IP no válida} no es válida.
InvalidUrl BadRequest (400) La dirección URL {la dirección URL no válida} no es válida.
MaximumBatchSizeExceeded BadRequest (400) Se ha superado el tamaño máximo del lote. Recibido: {tamaño de lote recibido}, permitido: {tamaño de lote permitido}.
MissingRequiredParameter BadRequest (400) Falta el parámetro {el parámetro que falta}.
OsPlatformNotSupported BadRequest (400) La plataforma del sistema operativo {la plataforma del sistema operativo cliente} no es compatible con esta acción.
ClientVersionNotSupported BadRequest (400) {La acción solicitada} se admite en la versión de cliente {versión de cliente compatible} y versiones posteriores.
No autorizado (Unauthorized) No autorizado (401) No autorizado (encabezado de autorización no válido o expirado).
Prohibido (Forbidden) Prohibido (403) Prohibido (token válido pero permiso insuficiente para la acción).
DisabledFeature Prohibido (403) La característica de inquilino no está habilitada.
No permitidaOperation Prohibido (403) {la operación no permitida y el motivo}.
NotFound No encontrado (404) Mensaje de error General no encontrado.
ResourceNotFound No encontrado (404) No se encontró el recurso {el recurso solicitado}.
TooManyRequests Demasiadas solicitudes (429) La respuesta representa alcanzar el límite de cuota por número de solicitudes o por CPU.
InternalServerError Error interno del servidor (500) (Sin mensaje de error, vuelva a intentar la operación).

Limitación

El cliente HTTP puede recibir un "Error de demasiadas solicitudes (429)" cuando el número de solicitudes HTTP en un período de tiempo determinado supera el número permitido de llamadas por API.

El cliente HTTP debe retrasar la reenviación de más solicitudes HTTPS y, a continuación, enviarlas de forma que cumpla con las limitaciones de velocidad. Un Retry-After en el encabezado de respuesta que indica cuánto tiempo esperar (en segundos) antes de realizar una nueva solicitud

Si se omite la respuesta 429 o se intenta volver a enviar solicitudes HTTP en un período de tiempo más corto, se devuelve el código de error 429.

Los parámetros del cuerpo distinguen mayúsculas de minúsculas

Los parámetros del cuerpo enviados distinguen entre mayúsculas y minúsculas actualmente.

Si experimenta errores InvalidRequestBody o MissingRequiredParameter , podría deberse a un mayúscula de parámetro incorrecto o a una letra minúscula.

Revise la página de documentación de la API y compruebe que los parámetros enviados coinciden con el ejemplo pertinente.

Identificador de solicitud de correlación

Cada respuesta de error contiene un parámetro de identificador único para el seguimiento.

El nombre de propiedad de este parámetro es "target".

Al ponerse en contacto con nosotros sobre un error, adjuntar este identificador ayuda a encontrar la causa principal del problema.

Ejemplos

{
    "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"
    }
}

Sugerencia

¿Desea obtener más información? Engage con la comunidad de seguridad de Microsoft en nuestra comunidad tecnológica: Microsoft Defender para punto de conexión Tech Community.