Códigos de erro e processamento de erros | Conceitos da Graph API

Aplica-se a: Graph API | Azure Active Directory (AD)

Aplicações de cliente que utilizam a Graph API do Azure Active Directory (AD) devem implementar a lógica para reagir como transições quanto possível para condições diferentes e fornecer a melhor experiência possível aos seus clientes de processamento de erros. O tópico aborda os tipos de erros que o Azure AD Graph API devolve e fornece orientações gerais sobre como lidar com os mesmos.

Processamento de erros da Graph API

Tipos de erros

Graph API erros ocorrerem nas seguintes categorias.

• Erros de cliente. Erros de cliente são representados por códigos de estado HTTP 400-série. Incluem os objetos com valores inválidos, objetos que estão em falta necessário propriedades ou valores de propriedade, tentar aceder a um recurso de inexistente, tentar atualizar uma propriedade só de leitura e omitindo o token de autorização necessário. Para resolver estes erros, corrija o problema subjacente antes de repetir o pedido.
• Erros de servidor. Erros de servidor são representados por códigos de estado HTTP 500-série, tais como uma falha transitória diretório. A maioria destes erros é transitória e pode ser resolvida por repetir o pedido.
• Erros de rede/protocolo. Uma variedade de erros relacionados com a rede pode ocorrer ao enviar um pedido ou receber uma resposta, como erros de resolução do nome de anfitrião, ligações fechadas prematuramente e erros de negociação de SSL. Não é possível resolver a maioria destes erros repetindo; o problema subjacente tem de ser corrigidos. No entanto, alguns erros, tais como falhas de resolução de nome de anfitrião ou tempos limite, poderão ser resolvidos pelo repetir o pedido.

Estrutura de mensagem de erro

Erros de API do gráfico tem um corpo formatado, que é composta por um código de estado HTTP, uma mensagem e valores. Utilize as propriedades do corpo de erro da sua lógica de processamento de erros.

Tenha em atenção: respostas de HTTP algumas não podem incluir o corpo da resposta de mensagem/código/valores porque o pedido é encaminhado através dos serviços de proxy e de gateway. Não se esqueça de incluir lógica predefinida que pode processar erros com base no código de estado HTTP individualmente.

Segue-se um exemplo de um erro de HTTP 400 Request_BadRequest.

 HTTP/1.1 400 Bad Request
 Content-Type: application/json;odata=minimalmetadata;charset=utf-8
 request-id: ddca4a7e-02b1-4899-ace1-19860901f2fc
 Date: Tue, 02 Jul 2013 01:48:19 GMT
 …
 
 {
     "odata.error" : {
         "code" : "Request_BadRequest",
         "message" : {
             "lang" : "en",
             "value" : "A value is required for property 'mailNickname' of resource 'Group'."
         },
     "values" : null
    }
 }

Cada corpo da mensagem tem código, mensagem e propriedades de valores.

• Código: a lógica de processamento de erros para a qual ramificar com base no código de Design.

  "code" : "Request_BadRequest"
  

• Mensagem: uma cadeia de identificação de idioma/valor que representa uma mensagem de erro legível por humanos. O conteúdo estiver no campo valor. No exemplo seguinte, o pedido falha porque o valor da mailNickname propriedade está em falta.

  "message" : {
       "lang" : "en",
       "value" : "A value is required for property 'mailNickname' of resource 'Group'."
  }
  

• Valores: uma coleção de pares nome/valor que fornecem mais informações sobre a natureza da falha. No exemplo seguinte sem valores estão incluídos.

  "values" : null
  

Referência de código de erro

Códigos de erro HTTP

A tabela seguinte lista Graph API códigos de erro, mensagens de erro e ações a considerar ao corrigir os erros.

Em geral, os erros de HTTP 500-série respondem a tentativas, preferencialmente, distribuídas através de cada vez mais longos intervalos de tempo ("repetição com um intervalo de término") e com um fator de distribuição aleatório. erros de série de 400 indicarem um problema que têm de ser corrigido antes de tentar novamente.

Recursos adicionais

• Referência de AD Graph API do Azure