Получить статус анонимизации: различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) (Новая страница: «Данный запрос проверяет статус задания анонимизации . Ответ содержит процент выполнени...») |
ENetrebin (обсуждение | вклад) (→Curl) |
||
| (не показана 1 промежуточная версия этого же участника) | |||
| Строка 3: | Строка 3: | ||
Запрос создает <code>application/json</code>полезную нагрузку. | Запрос создает <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan=" | | rowspan="2" |GET | ||
|Managed | |Managed | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs/{requestId}</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs/{requestId}</nowiki></code> | ||
|- | |- | ||
| | |Среда АктивногоШлюза | ||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs/{requestId}</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs/{requestId}</nowiki></code> | ||
|} | |} | ||
| Строка 51: | Строка 48: | ||
=== Объекты тела ответа === | === Объекты тела ответа === | ||
==== Объект | ==== Объект <code>AnonymizationProgressResult</code> ==== | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
| Строка 74: | Строка 71: | ||
В этом примере запрос проверяет статус задания анонимизации с идентификатором 7810238295331327902 . | В этом примере запрос проверяет статус задания анонимизации с идентификатором 7810238295331327902 . | ||
Маркер API передается в заголовке авторизации . | Маркер API передается в заголовке авторизации. | ||
Ответ показывает, что задание выполнено. | Ответ показывает, что задание выполнено. | ||
| Строка 80: | Строка 77: | ||
==== Curl ==== | ==== Curl ==== | ||
<code>curl -X GET \ | <code>curl -X GET \ | ||
<nowiki>https://mySampleEnv.live. | <nowiki>https://mySampleEnv.live.astromkey.com/api/v1/anonymize/anonymizationJobs/7810238295331327902</nowiki> \ | ||
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code> | -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code> | ||
==== URL-адрес запроса ==== | ==== URL-адрес запроса ==== | ||
<code><nowiki>https://mySampleEnv.live. | <code><nowiki>https://mySampleEnv.live.astromkey.com/api/v1/anonymize/anonymizationJobs/7810238295331327902</nowiki></code> | ||
==== Содержание ответа ==== | ==== Содержание ответа ==== | ||
Текущая версия на 04:27, 4 июня 2024
Данный запрос проверяет статус задания анонимизации . Ответ содержит процент выполнения задания.
Запрос создает 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, если задание ожидает выполнения. Может быть |
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
