Удаление информации об асинхронных операциях

Содержание раздела
  1. Удаление информации об асинхронных операциях
    1. URL
    2. Заголовки запроса
    3. Тело запроса
    4. Примеры запросов
      1. Удаление информации об указанной операции
      2. Удаление информации об операциях логической БД
      3. Удаление информации об операциях окружения

Доступны POST-методы со следующими возможностями:

Удаление информации об операциях не останавливает их выполнение.

URL

  • {baseUrl}/api/v1/datamarts[/{datamart}]/query/{requestId} — позволяет удалить информацию об асинхронной операции, исполняющей запрос с идентификатором requestId;
  • {baseUrl}/api/v1/datamarts[/{datamart}]/queries — позволяет удалить информацию об асинхронных операциях следующих логических баз данных:
    • указанной логической БД — если URL содержит имя логической БД datamart;
    • всех логических БД окружения — если URL не содержит имя логической БД.

Параметры:

  • baseUrl — путь для подключения к серверу ноды Prostore, состоящий из IP-адреса или доменного имени и номера порта;
  • datamart (опциональный) — имя логической базы данных, для которой удаляется информация об асинхронных операциях;
  • requestId — уникальный идентификатор асинхронного запроса, полученный в ответе query.

Заголовки запроса

Поддерживаются следующие опциональные заголовки:

  • x-request-id — задает уникальный идентификатор HTTP-запроса. Если не указан, система генерирует UUID-значение и возвращает его в качестве идентификатора в ответе;
  • Authorization — задает тип аутентификации и авторизационный токен (JWT). Возможное значение типа аутентификации — Bearer.

Подробнее об аутентификации запросов см. в разделе Аутентификация.

Тело запроса

Тело запроса может быть пустым (содержать {}) или содержать опциональный параметр running, задающий фильтр асинхронных операций.

Возможные значения параметра running:

  • false (по умолчанию) — информация удаляется по неуспешным операциям, то есть по операциям со статусом 2;
  • true — информация удаляется по всем операциям независимо от их статуса.

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

Удаление информации об указанной операции

Запрос без авторизационного токена:

curl -X 'POST' \
  'http://localhost:9090/api/v1/datamarts/marketing/query/234567' \
  -H 'x-request-id: 5385cbbd-ecb8-40ed-a792-54af304de6dc' \
  -d '{}'

Запрос с авторизационным токеном:

curl -X 'POST' \
  'http://localhost:9090/api/v1/datamarts/marketing/query/234567' \
  -H 'x-request-id: 65443cdd-7cd1-430e-9dd6-a87444b279c7' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c' \
  -d '{}'

Удаление информации об операциях логической БД

Удаление информации обо всех асинхронных операциях логической БД marketing:

curl -X 'POST' \
  'http://localhost:9090/api/v1/datamarts/marketing/queries' \
  -H 'x-request-id: 245dc5e7-733e-443d-94e5-0a50ed4febc6' \
  -d '{
  "running": true
  }'

Удаление информации о неуспешных асинхронных операциях логической БД marketing:

curl -X 'POST' \
  'http://localhost:9090/api/v1/datamarts/marketing/queries' \
  -H 'x-request-id: f10cbc37-6fa4-429d-af5b-d461138837c1' \
  -d '{
  "running": false
  }'

--- или

curl -X 'POST' \
  'http://localhost:9090/api/v1/datamarts/marketing/queries' \
  -H 'x-request-id: 7ac75831-0ebc-4c92-b603-abad972db253' \
  -d '{}'

Удаление информации об операциях окружения

Удаление информации обо всех асинхронных операциях окружения:

curl -X 'POST' \
  'http://localhost:9090/api/v1/datamarts/queries' \
  -H 'x-request-id: a3c32dea-e96a-43ef-8077-78f8ef697dd0' \
  -d '{
  "running": true
}'

Удаление информации о неуспешных асинхронных операциях окружения:

curl -X 'POST' \
  'http://localhost:9090/api/v1/datamarts/queries' \
  -H 'x-request-id: 52cfa75f-4ffe-4170-87d3-a4557a65f961' \
  -d '{
  "running": false
}'

--- или

curl -X 'POST' \
  'http://localhost:9090/api/v1/datamarts/queries' \
  -H 'x-request-id: 946d7548-ba09-4273-9564-9911f8f8c7db' \
  -d '{}'