Выполнение задания анонимизации: различия между версиями

Материал из Dynatrace
(Новая страница: «Пользователю гарантировано право на удаление личных данных. Этот эндпойнт предоставляе...»)
 
Строка 9: Строка 9:
Запрос создает <code>application/json</code>полезную нагрузку. Тело ответа содержит идентификатор задания анонимизации, который можно использовать для проверки статуса задания .
Запрос создает <code>application/json</code>полезную нагрузку. Тело ответа содержит идентификатор задания анонимизации, который можно использовать для проверки статуса задания .
{| class="wikitable"
{| class="wikitable"
| rowspan="3" |ПОМЕЩАТЬ
| rowspan="3" |PUT
|Удалось
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs</nowiki></code>
|-
|-
Строка 16: Строка 16:
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v1/anonymize/anonymizationJobs</nowiki></code>
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v1/anonymize/anonymizationJobs</nowiki></code>
|-
|-
|Окружающая среда ActiveGate
|Environment АктивныйШлюз
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs</nowiki></code>
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs</nowiki></code>
|}
|}


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


== Параметры ==
== Параметры ==
Строка 28: Строка 28:
!Тип
!Тип
!Описание
!Описание
!В
!In
!Необходимый
!Необходимость
|-
|-
|startTimestamp
|startTimestamp
|целое число
|integer
|Отметка времени начала сеанса пользователя для анонимизации в миллисекундах UTC.
|Отметка времени начала сеанса пользователя для анонимизации в миллисекундах UTC.


Если не установлено, используется самое раннее доступное время.
Если не установлено, используется самое раннее доступное время.
|запрос
|запрос
|необязательный
|необязательно
|-
|-
|endTimestamp
|endTimestamp
|целое число
|integer
|Отметка времени окончания сеанса пользователя для анонимизации в миллисекундах UTC.
|Отметка времени окончания сеанса пользователя для анонимизации в миллисекундах UTC.


Если не установлено, используется текущее время.
Если не установлено, используется текущее время.
|запрос
|запрос
|необязательный
|необязательно
|-
|-
|идентификаторы пользователей
|userIds
|строка []
|string[]
|UserID пользователя для анонимизации.
|UserID пользователя для анонимизации.


Вы можете указать несколько идентификаторов в следующем формате: <code>userIds=user1&userIds=user2</code>.
Вы можете указать несколько идентификаторов в следующем формате: <code>userIds=user1&userIds=user2</code>.
|запрос
|запрос
|необязательный
|необязательно
|-
|-
|ips
|ips
|строка []
|string[]
|IP-адрес пользователя для анонимизации. Все сеансы пользователей с этого IP будут анонимными.
|IP-адрес пользователя для анонимизации. Все сеансы пользователей с этого IP будут анонимными.


Вы можете указать несколько IP-адресов в следующем формате: <code>ips=ip1&ips=ip2</code>.
Вы можете указать несколько IP-адресов в следующем формате: <code>ips=ip1&ips=ip2</code>.
|запрос
|запрос
|необязательный
|необязательно
|-
|-
|дополнительное поле
|additionalField
|строка []
|string[]
|Список полей для анонимизации.
|Список полей для анонимизации.


Строка 71: Строка 71:
Элемент может содержать эти значения
Элемент может содержать эти значения
|запрос
|запрос
|необязательный
|необязательно
|}
|}



Версия 09:18, 9 марта 2022

Пользователю гарантировано право на удаление личных данных. Этот эндпойнт предоставляет вам средства для выполнения таких запросов.

Далее рассмотрено создание задания анонимизации сеанса пользователя. Задание анонимизирует все сеансы пользователей в указанный период времени, маскируя идентификатор пользователя ( userIds ) и IP-адрес ( ips ).

Чтобы определить сеансы пользователей, которые должны быть анонимизированы, вы можете указать идентификатор пользователя, IP-адрес или и то, и другое. Если вы укажете и то, и другое, применяется логика ИЛИ — каждый сеанс с указанными идентификаторами пользователей становится анонимным, независимо от того, с какого IP-адреса он пришел; каждый сеанс с указанного IP-адреса становится анонимным, даже если он принадлежит идентификатору пользователя, который не был указан. Вы можете указать несколько идентификаторов пользователей и IP-адресов.

Независимо от того, как вы идентифицируете пользовательские сеансы, и идентификатор пользователя, и IP-адрес маскируются. Вы не можете отменить анонимизацию.

Запрос создает application/jsonполезную нагрузку. Тело ответа содержит идентификатор задания анонимизации, который можно использовать для проверки статуса задания .

PUT Managed https://{your-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs
SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/anonymize/anonymizationJobs
Environment АктивныйШлюз https://{your-activegate-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs

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

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

Параметры

Параметр Тип Описание In Необходимость
startTimestamp integer Отметка времени начала сеанса пользователя для анонимизации в миллисекундах UTC.

Если не установлено, используется самое раннее доступное время.

запрос необязательно
endTimestamp integer Отметка времени окончания сеанса пользователя для анонимизации в миллисекундах UTC.

Если не установлено, используется текущее время.

запрос необязательно
userIds string[] UserID пользователя для анонимизации.

Вы можете указать несколько идентификаторов в следующем формате: userIds=user1&userIds=user2.

запрос необязательно
ips string[] IP-адрес пользователя для анонимизации. Все сеансы пользователей с этого IP будут анонимными.

Вы можете указать несколько IP-адресов в следующем формате: ips=ip1&ips=ip2.

запрос необязательно
additionalField string[] Список полей для анонимизации.

Вы можете указать несколько полей в следующем формате: additionalField=field1&additionalField=field2.

Элемент может содержать эти значения

запрос необязательно

Ответ

Коды ответов

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

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

Объект _ AnonymizationIdResult

Элемент Тип Описание
кластеррекуестидс Идентификатор запроса кластера анонимизации [ ] Список кортежей ID запроса и имени кластера

Может быть null.

идентификатор запроса нить Идентификатор вновь созданного задания анонимизации. Если задействовано несколько центров обработки данных, список должен быть разделен символом «|». будет возвращен

Может быть null.

Объект _ AnonymizationClusterRequestID

Список кортежей ID запроса и имени кластера

Элемент Тип Описание
я бы целое число -

Может быть null.

dcName нить -

Может быть null.

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

{
  "clusterRequestIds": [
    {
      "id": 1,
      "dcName": "string"
    }
  ],
  "requestId": "-4013759873546847071|7354684707140137598"
}

Пример

В этом примере запрос запускает задание по анонимизации всех сеансов пользователей john.smith и mary.smith в период между 00:00 1 сентября 2018 г. и 23:59 10 сентября 2018 г. (соответствует временным меткам 1535752800000 и 1536616799000). , соответственно).

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

Ответ содержит идентификатор задания анонимизации, который можно использовать для проверки его состояния.

Завиток

curl -X PUT \
  'https://mySampleEnv.live.dynatrace.com/api/v1/anonymize/anonymizationJobs?startTimestamp=1535752800000&endTimestamp=1536616799000&userIds=john.smith&userIds=mary.smith' \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

https://mySampleEnv.live.dynatrace.com/api/v1/anonymize/anonymizationJobs?startTimestamp=1535752800000&endTimestamp=1536616799000&userIds=john.smith&userIds=mary.smith

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

{
  "requestId": "7810238295331327902"
}

Код ответа

200