GET статус анонимизации: различия между версиями

Версия от 14:03, 17 декабря 2024

API Ключ-АСТРОМ / Эндпойнты среды / Анонимизация / GET статус анонимизации

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

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

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

Параметры

Параметр	Тип	Описание	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

@@ Строка 12: / Строка 12: @@
 |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs/{requestId}</nowiki></code>
 |}
-==Аутентификация==
-Чтобы выполнить этот запрос, вам необходимо разрешение '''Анонимизировать данные сеанса пользователя по соображениям конфиденциальности данных''' ( <code>UserSessionAnonymization</code>) , назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
 ==Параметры==
 {| class="wikitable"
@@ Строка 58: / Строка 57: @@
 |}
 ===JSON-модель тела ответа===
-  <code>{
+  <{
     "progress": 50
   }</code>
@@ Строка 68: / Строка 67: @@
 Ответ показывает, что задание выполнено.
 ====Curl====
-  <code>curl -X GET \
+  <curl -X GET \
       <nowiki>https://mySampleEnv.live.astromkey.com/api/v1/anonymize/anonymizationJobs/7810238295331327902</nowiki> \
       -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
@@ Строка 74: / Строка 73: @@
   <code><nowiki>https://mySampleEnv.live.astromkey.com/api/v1/anonymize/anonymizationJobs/7810238295331327902</nowiki></code>
 ====Содержание ответа====
-  <code>{
+  <{
     "progress": 100
   }</code>
 ====Код ответа====