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

Текущая версия от 14:11, 24 декабря 2024

API АппОптима / Эндпойнты среды / Анонимизация / GET статус анонимизации

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

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

GET	АппОптима	`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.AppOptima.com/api/v1/anonymize/anonymizationJobs/7810238295331327902 \
    -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

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

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

<{
  "progress": 100
}

Код ответа

200

@@ Строка 1: / Строка 1: @@
+'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D1%81%20%D0%B0%D0%B2%D1%82%D0%BE%D0%BE%D0%B1%D0%BD%D0%BE%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5%D0%BC%20%D0%B7%D0%B0%D0%B4%D0%B0%D0%BD%D0%B8%D0%B9-,%D0%90%D0%BD%D0%BE%D0%BD%D0%B8%D0%BC%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Анонимизация] / GET статус анонимизации'''''
 Данный запрос проверяет статус задания анонимизации . Ответ содержит процент выполнения задания.
@@ Строка 4: / Строка 6: @@
 {| class="wikitable"
 | rowspan="2" |GET
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs/{requestId}</nowiki></code>
 |-
@@ Строка 10: / Строка 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"
@@ Строка 56: / Строка 57: @@
 |}
 ===JSON-модель тела ответа===
-  <code>{
+  <{
     "progress": 50
-  }</code>
+  }
 ==Пример==
 В этом примере запрос проверяет статус задания анонимизации с идентификатором 7810238295331327902 .
@@ Строка 66: / Строка 67: @@
 Ответ показывает, что задание выполнено.
 ====Curl====
-  <code>curl -X GET \
+  <curl -X GET \
-      <nowiki>https://mySampleEnv.live.astromkey.com/api/v1/anonymize/anonymizationJobs/7810238295331327902</nowiki> \
+      <nowiki>https://mySampleEnv.live.AppOptima.com/api/v1/anonymize/anonymizationJobs/7810238295331327902</nowiki> \
-      -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
+      -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
 ====URL-адрес запроса====
-  <code><nowiki>https://mySampleEnv.live.astromkey.com/api/v1/anonymize/anonymizationJobs/7810238295331327902</nowiki></code>
+  <code><nowiki>https://mySampleEnv.live.AppOptima.com/api/v1/anonymize/anonymizationJobs/7810238295331327902</nowiki></code>
 ====Содержание ответа====
-  <code>{
+  <{
     "progress": 100
-  }</code>
+  }
 ====Код ответа====