Codes d'état et erreurs
État | Code d'erreur | Description |
---|---|---|
200 | SUCCESS |
La réponse normale est envoyée. |
400 | BAD_REQUEST |
Requête mal formatée, c'est-à-dire les paramètres de requête en double fournis |
401 | INVALID_POLICY_KEY |
Doit fournir un en-tête BCOV-Policy avec une clé de stratégie légale. |
403 | ACCESS_DENIED , VIDEO_NOT_PLAYABLE , PLAYLIST_NOT_PLAYABLE , JWT_AUTH |
La clé de stratégie fournie n'autorise pas ce compte ou cette vidéo, ou la ressource demandée est inactive. VIDEO_NOT_PLAYABLE peut être retourné à partir de Roebuck par des requêtes vidéo uniques. Il indique que la vidéo ne passe pas le contrôle jouable (ingéré, actif, dans le calendrier). |
404 | VIDEO_NOT_FOUND , PLAYLIST_NOT_FOUND , RESOURCE_NOT_FOUND , ACCOUNT_NOT_FOUND |
La ressource désignée n'a pas été trouvée. |
405 | METHOD_NOT_ALLOWED |
Seuls GET, HEAD et OPTIONS sont autorisés pour cette API. |
500 | SERVER_ERROR |
Erreur interne du serveur Wedge, aura généralement plus d'informations dans les journaux. |
502 | SERVER_ERROR , ACCOUNT_RETRIEVE_FAILURE , VIDEO_RETRIEVE_FAILURE , VIDEO_URLS_RETRIEVE_FAILURE , PLAYLIST_RETRIEVE_FAILURE , PLAYLIST_VIDEOS_RETRIEVE_FAILURE |
J'ai reçu une mauvaise réponse d'un serveur backend, généralement Roebuck ou Nomic a renvoyé une erreur 5xx. |
503 | SERVICE_UNAVAILABLE |
Non retourné par Wedge. Cela peut se produire s'il n'y avait pas de serveur actif dans l'équilibreur de charge. Ce serait mauvais. (L'API Playerback ne limite pas les taux, pas plus que les services qu'elle appelle.) |
504 | SERVER_TIMEOUT |
Un appel à un serveur principal ou à l'un des serveurs sur lesquels ils dépendent a expiré. |
Réponses d'erreur
Conformément aux normes de conception de l'API, les réponses d'erreur (4xx
et 5xx
) consistent en une liste de réponses d'erreur d'une error_code
ou de plusieurs cartes qui incluent un error_subcode
, et éventuellement un non-localisé message
avec plus de détails.
[ {"error_code » : « ERROR_CODE1"},
{"error_code » : « ERROR_CODE2", « message » : « les détails peuvent aller ici"}
{"error_code » : « ERROR_CODE3", « error_subcode » : « MORE_SPECIFIC_CODE », « message » : « détails lisibles par l'homme sur ce qui s'est passé"}]
Codes d'erreur
error_code
Ce qui est censé être à la fois compréhensible et utilisé par le code client pour choisir différentes actions et messages utilisateur traduisibles. Les codes d'erreur sont UPPER_SNAKE_CASE.
État | Code d'erreur | Source d'erreur |
---|---|---|
403 | ACCESS_DENIED |
Politique nomique |
403 | VIDEO_NOT_PLAYABLE |
Roebuck |
404 | VIDEO_NOT_FOUND |
Roebuck |
Autre | VIDEO_RETRIEVE_FAILURE si impossible de récupérer la vidéo |
Roebuck |
Autre | VIDEO_URLS_RETRIEVE_FAILURE si impossible de récupérer les sources ou les images |
Roebuck |
Sous-codes d'erreur
Voici quelques-uns mais pas tous les sous-codes d'erreur (recherche :error_subcode
dans la source)
Code d'erreur | Sous-codes d'erreur |
---|---|
BAD_REQUEST |
DUPLICATE_PARAMETERS |
ACCESS_DENIED |
POLICY_ERROR |
ACCESS_DENIED |
ACCOUNT_ID , VIDEO_ID , CLIENT_GEO , CLIENT_IP , DOMAIN , POLICY_ERROR [ 1] |
SOURCES_RESTRICTED |
TVE_AUTH |
SERVER_ERROR |
LOOKUP_GEO |
SERVER_TIMEOUT |
LOOKUP_GEO |
Remarques
[1] ACCESS_DENIED
/POLICY_ERROR
signifie toute erreur inattendue lors de l'évaluation de la politique (y compris l'obtention des informations vidéo pour les comptes géo-restreints). Il peut être utile de vérifier les exceptions dans le journal avec cette erreur.