RemoteGymp · API v1

Limites et erreurs

Lire chaque page, respecter les limites de débit et gérer les erreurs en toute sécurité.

  1. Limites de débit

    Les limites sont configurables. GET et /v1/operations/capabilities signalent requestsPerMinute et authenticationRequestsPerMinutePerIp. Après une erreur 429, respecter l’option « Réessayer après » et patienter plus longtemps si la limitation persiste. Les lectures par lots acceptent jusqu’à 100 identifiants ; les points de terminaison individuels peuvent avoir des limites de page ou de charge utile inférieures. (Retry-After)

  2. Lisez chaque page

    Utiliser la règle de continuation du point de terminaison appelé, en conservant les mêmes filtres. Les listes peuvent changer pendant leur lecture ; utiliser des instantanés pour obtenir une copie cohérente.

    PaginationContinuer avecArrêter lorsque
    CurseurTransmettre next comme after.Le suivant est null.
    Décaler avec nextOffsetTransmettre nextOffset comme offset.nextOffset est null.
    Décalage avec hasMoreIncrémenter le décalage du nombre d'éléments retournés.hasMore est faux.
    LogicielTransmettre la valeur numérique de next comme after ; redémarrer si updatedAtUtc change.Le suivant est null.
    Flux d'événementsTransmettre next comme after.hasMore est faux.
  3. Gérer les erreurs

    Lire le code d'erreur ainsi que le statut HTTP. Si la réponse contient requestId, indiquez-le lors de votre prise de contact avec le support.

    Statut HTTPQue faire ?
    400Corriger la requête.
    401Vérifier les informations d’identification ou obtenir un nouveau jeton d’accès.
    403Vérifier la portée, les autorisations et si l’accès est activé.
    404La ressource est peut-être manquante ou hors de votre périmètre.
    409Veuillez lire le code d'erreur et l'état actuel avant de prendre une décision.
    410Le curseur d'instantané ou d'événement a expiré. Créez une nouvelle ligne de base.
  4. En cas de délai d'attente d'écriture :

    Un délai d'attente ou une erreur 503 n'indique pas nécessairement un échec. Pour les écritures renvoyant des accusés de réception, consultez GET ou /v1/operations/by-key?idempotencyKey={key} avant de réessayer. Pour la création d'une entrée de maintenance, réutilisez l'entrée Idempotency-Key et le corps de l'entrée d'origine.

Référence API →

Révision du contenu 3f225a253 · OpenAPI SHA-256: b12c42306a89