RemoteGymp · API v1

Ограничения и ошибки

Чтение каждой страницы, соблюдение ограничений скорости и безопасное восстановление после ошибок.

  1. Ограничения скорости

    Ограничения настраиваются. GET /v1/operations/capabilities сообщает о requestsPerMinute и authenticationRequestsPerMinutePerIp. После ошибки 429 соблюдайте правило «Повторить попытку» и подождите дольше, если ограничение скорости продолжается. Пакетное чтение принимает до 100 идентификаторов; Для отдельных конечных точек могут быть установлены меньшие ограничения на количество страниц или объем полезной нагрузки. (Retry-After)

  2. Читайте каждую страницу

    Используйте правило продолжения для вызываемой конечной точки, сохраняя те же фильтры. Списки могут изменяться во время чтения; используйте снимки, когда вам нужна согласованная копия.

    ПагинацияПродолжить сОстановить, когда
    КурсорПередать next как after.следующий — null.
    Смещение с nextOffsetПередать nextOffset как offset.nextOffset равно null.
    Смещение с hasMoreУвеличить смещение на количество возвращаемых элементов.hasMore равно false.
    Программное обеспечениеПередать числовое значение next как after; перезапустить, если updatedAtUtc изменится.следующий — null.
    Лента событийПередать next как after.hasMore равно false.
  3. Обработка ошибок

    Прочтите код ошибки, а также HTTP-статус. Если ответ содержит requestId, укажите его при обращении в службу поддержки.

    HTTP-статусЧто делать
    400Исправьте запрос.
    401Проверьте учетные данные или получите новый токен доступа.
    403Проверьте область действия, разрешения и включен ли доступ.
    404Ресурс может отсутствовать или выходить за пределы вашей области действия.
    409Перед принятием решения ознакомьтесь с кодом ошибки и текущим состоянием.
    410Срок действия снимка или курсора событий истек. Начните новую базовую линию.
  4. Если запись завершилась по таймауту

    Таймаут или ошибка 503 не доказывают сбой действия. Для записей, возвращающих квитанции об операции, перед повторной попыткой найдите GET /v1/operations/by-key?idempotencyKey={key}. Для создания записей обслуживания используйте исходный Idempotency-Key и тело записи.

Справочник API →

Редактирование контента 3f225a253 · OpenAPI SHA-256: b12c42306a89