SLA

Все методы · Ключи и права · Ошибки

Примеры ответов сокращены. Пустой массив означает допустимый результат без доступных записей, а не обязательное отсутствие данных.

Для методов с ключом действуют общие проверки: 401 — ключ не принят, 403 — не хватает scope или прав владельца, 429 — превышен лимит. Неверные параметры могут дать 400, недоступный адресный ресурс — 404. Особенности команды указаны рядом с методом. Точную причину смотрите в error.code и details: как обработать ошибку и безопасно повторить запрос.

Получить SLA записи

GET /api/v1/objects/{objectId}/sla

Действие ключа: sla:read. Оно не заменяет права владельца на объекты и поля.

Сервер рассчитывает SLA по действующим политикам и календарям.

Параметры пути: objectId. Тело: не требуется.

Пример запроса

GET /api/v1/objects/OBJECT_ID/sla HTTP/1.1
Host: service.example.invalid
Authorization: Bearer YOUR_API_KEY

Ответ и ошибки

Успех: 200. Массив экземпляров SLA.

{
  "data": [],
  "meta": {
    "correlationId": "CORRELATION_ID",
    "apiVersion": "v1"
  }
}

Получить историю SLA

GET /api/v1/sla/{instanceId}/history

Действие ключа: sla:read. Оно не заменяет права владельца на объекты и поля.

instanceId — идентификатор экземпляра SLA, не политики.

Параметры пути: instanceId. Тело: не требуется.

Пример запроса

GET /api/v1/sla/INSTANCE_ID/history HTTP/1.1
Host: service.example.invalid
Authorization: Bearer YOUR_API_KEY

Ответ и ошибки

Успех: 200. Массив событий.

{
  "data": [],
  "meta": {
    "correlationId": "CORRELATION_ID",
    "apiVersion": "v1"
  }
}

Выполнить команду SLA

POST /api/v1/sla/{instanceId}/{command}

Действие ключа: sla:write. Оно не заменяет права владельца на объекты и поля.

command: pause, resume, stop или recalculate. expectedRevision необязателен, но рекомендуется. recalculate дополнительно принимает calendarId/calendarVersion. Переходы зависят от текущего статуса: например pause только ACTIVE, resume только PAUSED.

Параметры пути: instanceId, command. Тело: JSON; пример ниже показывает основные поля.

Пример запроса

POST /api/v1/sla/INSTANCE_ID/pause HTTP/1.1
Host: service.example.invalid
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "expectedRevision": 1
}

Ответ и ошибки

Успех: 200. Обновлённый экземпляр.

{
  "data": {
    "id": "INSTANCE_ID",
    "revision": 2,
    "status": "PAUSED"
  },
  "meta": {
    "correlationId": "CORRELATION_ID",
    "apiVersion": "v1"
  }
}

JSON-тело свыше 10 MiB отклоняется с 413.

Связанные статьи

• Обзор API
• Права доступа
• Интеграции