Получить статус анонимизации

Материал из Документация Ключ-АСТРОМ
Версия от 04:27, 4 июня 2024; ENetrebin (обсуждение | вклад) (→‎Curl)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Данный запрос проверяет статус задания анонимизации . Ответ содержит процент выполнения задания.

Запрос создает application/jsonполезную нагрузку.

GET Managed https://{your-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs/{requestId}
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs/{requestId}

Аутентификация

Чтобы выполнить этот запрос, вам необходимо разрешение Анонимизировать данные сеанса пользователя по соображениям конфиденциальности данных ( UserSessionAnonymization) , назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр Тип Описание In Необходимость
requestId string Идентификатор требуемого задания анонимизации. path требуется

Ответ

Коды ответов

Код Тип Описание
200 AnonymizationProgressResult Успех. Тело ответа содержит статус задания анонимизации.
400 - Не удалось. Ввод недействителен. Подробности смотрите в теле ответа.

Объекты тела ответа

Объект AnonymizationProgressResult

Элемент Тип Описание
progress integer Прогресс задания анонимизации, %.

-1, если задание ожидает выполнения.

Может быть null.

JSON-модель тела ответа

{
  "progress": 50
}

Пример

В этом примере запрос проверяет статус задания анонимизации с идентификатором 7810238295331327902 .

Маркер API передается в заголовке авторизации.

Ответ показывает, что задание выполнено.

Curl

curl -X GET \
    https://mySampleEnv.live.astromkey.com/api/v1/anonymize/anonymizationJobs/7810238295331327902 \
    -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL-адрес запроса

https://mySampleEnv.live.astromkey.com/api/v1/anonymize/anonymizationJobs/7810238295331327902

Содержание ответа

{
  "progress": 100
}

Код ответа

200