Управление вебхуками

Как администратор, вы можете обновлять вебхуки организации и управлять ими, обновляя их конфигурацию (например, обновляя триггеры событий, на которые подписан webhook), а также отключая и удаляя настроенные ранее вебхуки.

Примечание:

В этой версии вебхуки сервисов являются бета-функцией. Во время бета-тестирования эти функции могут быть не полными, иметь известные проблемы с производительностью или качеством и не будут поддерживаться технической поддержкой Esri. Документация бета-API для вебхуков сервиса доступна в Руководство по API администратора вебхуков сервиса PDF. Дополнительную информацию о функциях ArcGIS Enterprise в стадии бета-тестирования см. в разделе Бета-функции.

Обновление вебхуков

Настроенные параметры вебхуков можно обновить после создания. В следующих разделах описывается, как обновить свойства вебхуков для организации, сервиса геообработки и сервиса объектов.

Обновление вебхуков организации

Для обновления свойств вебхуков организации выполните следующие шаги.

Примечание:

Пример запроса POST, обновляющего конфигурацию вебхука см. в документации REST API Обновить вебхук.

1. Перейдите к ArcGIS Portal Directory и войдите как участник с ролью администратора.

   Вебхуки могут создаваться и управляться только администраторами или участниками, которым назначена роль администратора по умолчанию.

   https://machine.domain.com/webadaptor/sharing/rest

   После выполнения входа появится точка доступа ресурса Пользователь для вашей учетной записи.

2. Нажмите на гиперссылку Org ID или выполните запрос в следующей форме для доступа к странице ресурса Portal Self:
   https://machine.domain.com/webadaptor/sharing/rest/portals/self

3. Прокрутите вниз точки доступа ресурса Self и щелкните Вебхук > [Webhook] > Обновить вебхук, где [Webhook] представляет ID или имя определенного вебхука, чтобы получить доступ к операции Обновить вебхук.
4. В точке доступа Обновить вебхук измените следующую информацию:
   1. Для обновления имени вебхука предоставьте уникальное имя для вебхука в текстовом поле Имя.
   2. Если вы используете новый получатель вебхука или вам необходимо обновить целевой URL-адрес для существующего получателя, предоставьте новый URL-адрес в текстовом поле Целевой URL.

      Целевой URL-адрес будет запрашиваться во время обновления вебхука, чтобы гарантировать, что между получателем и порталом ArcGIS Enterprise может быть установлено успешное соединение. Пример цели показывается ниже:

      https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow

   3. При необходимости добавьте буквенно-цифровую строку, которая действует как секретный ключ для вебхука, или обновите ранее существовавший секретный ключ, который можно использовать для аутентификации сообщений вебхука с получателем. Предоставьте новый секретный ключ в текстовом окне Секретный ключ (дополнительно).
   4. Дополнительно обновите информацию о деактивации для вебхука в тестовом поле Свойства конфигурации.

      По умолчанию вебхук деактивируется, если произошло пять сбоев в течение пяти дней.

   5. Чтобы обновить триггеры событий для вебхука или выбрать получение вебхуков для всех триггеров событий, выберите одно из следующего:
      • Щелкните Позволить мне задать вручную, чтобы изменить список событий-триггеров, которые будут использоваться для этого вебхука в текстовом окне Присылать мне изменения для этих событий, разделенных запятыми. Например, чтобы подписаться на все события, относящиеся к определенной группе в вашей организации, укажите триггер события, аналогичный показанному ниже, где [groupID] представляет уникальный ID, связанный с определенной группой.
        /groups/[groupID]/update

      • Щелкните Присылать мне все, чтобы подписаться на все поддерживаемые триггеры событий и получать уведомления для каждого события по мере того, как они происходят.
5. После того как все указанные выше параметры будут настроены, щелкните Обновить вебхук, чтобы отправить запрос и применить изменения.

Обновление вебхуков сервиса геообработки

Для обновления свойств вебхуков сервиса геообработки выполните следующие шаги.

Примечание:

Пример запроса POST, обновляющего конфигурацию вебхука сервиса геообработки, см. в документации бета REST API вебхука в Руководство по API администратора вебхуков сервиса PDF.

1. Перейдите к Директории администратора ArcGIS Server и выполните вход как участник с соответствующими назначенными ему правами администратора.

   Вебхуки могут создаваться и управляться только администраторами, имеющими права Update, Delete, Security и Infrastructure или права администратора сервера, назначенные им, или с назначенной ролью администратора по умолчанию.

   https://machine.domain.com/webadaptor/admin

2. После выполнения входа перейдите к операции Редактировать для сервиса геообработки, нажав Сервисы > [ServiceName] > Вебхуки > [Webhook] > Редактировать, где [ServiceName] представляет затрагиваемый сервис геообработки, и [Webhook] представляет вебхук, который будет обновлен. Для сервисов, размещенных в определенных папках, щелкните Сервисы > [FolderName] > [ServiceName] > Вебхуки > [Webhook] > Редактировать, где [FolderName] представляет папку, в которой находится сервис.
3. В точке доступа Редактировать измените следующую информацию:
   1. Если имя вебхука обновляется, предоставьте уникальное имя для вебхука в текстовом поле Имя. Предоставленное имя может содержать только буквенно-цифровые значения, так как использование специальных символов приведет к ответу с ошибкой.
   2. При необходимости добавьте буквенно-цифровую строку, которая действует как секретный ключ для вебхука, или обновите ранее существовавший секретный ключ, который можно использовать для аутентификации сообщений вебхука с получателем. Введите новый или обновите секретный ключ в текстовом окне Ключ подписи.
   3. Если вы используете нового получателя или вам необходимо обновить целевой URL-адрес, предоставьте новый URL в текстовом окне Hook URL, который будет запрашиваться во время обновления вебхука, чтобы гарантировать, что может быть установлено успешное соединение между получателем и ArcGIS Server развертывания.

      Пример целевого URL-адреса показывается ниже:

      https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow

   4. Чтобы установить новое значение типа медиа для вебхука, выберите одно из следующего в ниспадающем окне Тип содержания:
      • application/json (default)
      • application/x-www-form-urlencoded
   5. Чтобы обновить формат цели, выберите одно из следующего в ниспадающем окне Целевой формат:
      • JSON (по умолчанию)
      • PJSON
   6. Выберите, включить или отключить обратные вызовы для вебхука, изменив значение, выбранное для параметра Активировать. Для включения выберите true. Для отключения выберите false.
4. После того как все указанные выше параметры будут настроены, щелкните Редактировать, чтобы отправить запрос и применить изменения.

Примечание:

В отличие от вебхуков сервисов объектов и организаций, вебхуки сервисов геообработки не имеют триггеров событий, заданных пользователем. Вебхуки сервисов геообработки доставляют полезные данные по завершении задания геообработки. Более подробную информацию о полезных данных, передаваемых для сервисов геообработки, см. в разделе Полезные данные.

Обновление вебхуков сервиса объектов

Для обновления свойств вебхуков сервиса объектов выполните следующие шаги.

Примечание:

Пример запроса POST, обновляющего свойства вебхука сервиса объектов, см. в документации бета REST API вебхука в Руководство по API администратора вебхуков сервиса PDF.

1. Перейдите к Директории администратора ArcGIS Server и выполните вход как участник с соответствующими назначенными ему правами администратора.

   Вебхуки могут создаваться и управляться только администраторами, имеющими права Update, Delete, Security и Infrastructure или права администратора сервера, назначенные им, или с назначенной ролью администратора по умолчанию.

   https://machine.domain.com/webadaptor/admin

2. После выполнения входа перейдите к ресурсу Вебхуки для сервиса объектов, нажав Сервисы > [ServiceName] > Вебхуки > Создать, где [ServiceName] представляет сервис, для которого создается вебхук. Для сервисов, размещенных в определенных папках, щелкните Сервисы > [FolderName] > [ServiceName] > Вебхуки > Создать, где [FolderName] представляет папку, в которой находится сервис.
3. В точке доступа Создать вебхук измените следующую информацию:
   1. Если имя вебхука обновляется, предоставьте уникальное имя для вебхука в текстовом поле Имя. Предоставленное имя может содержать только буквенно-цифровые значения, так как использование специальных символов приведет к ответу с ошибкой.
   2. Для обновления триггеров событий для вебхука, перечислите триггеры событий, который будут использоваться для этого вебхука, в текстовом окне Изменить тип. Например, если вы хотите обновить вебхук, который будет вызываться при создании любого сервиса объектов, используйте следующий триггер события:

      FeaturesCreated

      Список все триггеров событий, поддерживаемых для вебхуков сервиса объектов, см. в статье Триггеры событий.
   3. При необходимости добавьте буквенно-цифровую строку, которая действует как секретный ключ для вебхука, или обновите ранее существовавший секретный ключ, который можно использовать для аутентификации сообщений вебхука с получателем. Введите новый или обновите секретный ключ в текстовом окне Ключ подписи.
   4. Если вы используете нового получателя или вам необходимо обновить целевой URL-адрес, предоставьте новый URL в текстовом окне Hook URL, который будет запрашиваться во время обновления вебхука, чтобы гарантировать, что может быть установлено успешное соединение между получателем и ArcGIS Server развертывания.

      Пример целевого URL-адреса показывается ниже:

      https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow

   5. Чтобы установить новое значение типа медиа для вебхука, выберите одно из следующего в ниспадающем окне Тип содержания:
      • application/json (default)
      • application/x-www-form-urlencoded
   6. Чтобы обновить формат цели, выберите одно из следующего в ниспадающем окне Целевой формат:
      • JSON (по умолчанию)
      • PJSON
   7. Выберите, включить или отключить обратные вызовы для вебхука, изменив значение, выбранное для параметра Активировать. Для включения выберите true. Для отключения выберите false.
   8. Настройте расписание вебхуков, изменив информацию Секунды, в текстовом окне Расписание. Для сервисов объектов, которые часто редактируются, уменьшите значение Секунд, чтобы получать более частые вебхуки с меньшим количеством информации о событиях в полезных данных. Для сервисов объектов, которые редактируются редко, увеличьте значение Секунд, чтобы получать менее частые вебхуки с большим количеством информации о событиях в полезных данных.

      Минимальное значение и по умолчанию для расписания составляет 20 секунд.

4. После того как все указанные выше параметры будут настроены, щелкните Редактировать, чтобы отправить запрос и применить изменения.

Деактивация вебхуков

Вебхуки можно деактивировать вручную или, для вебхуков организации, при выполнении условия деакцивации, которое задается при создании вебхука. Когда вебхук деактивирован, он приостанавливается и не может доставлять полезные данные при их запуске. В следующих разделах описывается, как деактивировать вебхуки организации, сервиса геообработки и сервиса объектов.

Деактивация вебхуков организации

Для деактивации вебхука организации выполните следующие шаги.

Примечание:

Пример запроса POST, деактивирующего вебхук, см. в документации REST API Деактивация вебхука.

1. Перейдите к ArcGIS Portal Directory и войдите как участник с ролью администратора.

   Вебхуки могут создаваться и управляться только администраторами или участниками, которым назначена роль администратора по умолчанию.

   https://machine.domain.com/webadaptor/sharing/rest

   После выполнения входа появится точка доступа ресурса Пользователь для вашей учетной записи.

2. Нажмите на гиперссылку Org ID или выполните запрос в следующей форме для доступа к странице ресурса Portal Self:
   https://machine.domain.com/webadaptor/sharing/rest/portals/self

3. Прокрутите вниз точки доступа ресурса Self и щелкните Вебхук > [Webhook] > Деактивировать, где [Webhook] отражает ID или имя определенного вебхука для доступа операции Деактивировать.
4. Оказавшись на точке доступа Деактивации, нажмите кнопку Деактивировать, чтобы приостановить вебхук.

Деактивация вебхуков сервиса геообработки

Для деактивации всех вебхуков, настроенных для сервиса геообработки, выполните следующие шаги.

Примечание:

Пример запроса POST, деактивирующего все настроенные вебхуки для сервиса геообработки, см. в документации бета REST API вебхука в Руководство по API администратора вебхуков сервиса PDF.

1. Перейдите к Директории администратора ArcGIS Server и выполните вход как участник с соответствующими назначенными ему правами администратора.

   Вебхуки могут создаваться и управляться только администраторами, имеющими права Update, Delete, Security и Infrastructure или права администратора сервера, назначенные им, или с назначенной ролью администратора по умолчанию.

   https://machine.domain.com/webadaptor/admin

2. После выполнения входа перейдите к операции deactivateAll для сервиса геообработки, нажав Сервисы > [ServiceName] > Вебхуки > deactivateAll, где [ServiceName] представляет определенный сервис геообработки. Для сервисов, размещенных в определенных папках, щелкните Сервисы > [FolderName] > [ServiceName] > Вебхуки > deactivateAll, где [FolderName] представляет папку, в которой находится сервис.
3. Оказавшись на точке доступа deactivateAll, щелкните Деактивировать все, чтобы приостановить все настроенные вебхуки.

Деактивация вебхуков сервиса объектов

Для деактивации всех вебхуков, настроенных для сервиса объектов, выполните следующие шаги.

Примечание:

Пример запроса POST, деактивирующего все настроенные вебхуки для сервиса объектов, см. в документации бета REST API вебхука в Руководство по API администратора вебхуков сервиса PDF.

1. Перейдите к Директории администратора ArcGIS Server и выполните вход как участник с соответствующими назначенными ему правами администратора.

   Вебхуки могут создаваться и управляться только администраторами, имеющими права Update, Delete, Security и Infrastructure или права администратора сервера, назначенные им, или с назначенной ролью администратора по умолчанию.

   https://machine.domain.com/webadaptor/admin

2. После выполнения входа перейдите к операции deactivateAll для сервиса объектов, нажав Сервисы > [ServiceName] > Вебхуки > deactivateAll, где [ServiceName] представляет определенный сервис объектов. Для сервисов, размещенных в определенных папках, щелкните Сервисы > [FolderName] > [ServiceName] > Вебхуки > deactivateAll, где [FolderName] представляет папку, в которой находится сервис.
3. Оказавшись на точке доступа deactivateAll, щелкните Деактивировать все, чтобы приостановить все настроенные вебхуки.

Активация вебхуков

Пока вебхук деактивирован, он не будет иметь возможность доставлять полезные данные. Повторная активация вебхука перезапускает вебхук и включает его возможность доставлять полезные данные при следующем вызове вебхукаю В следующих разделах описывается, как активировать деактивированные ранее вебхуки организации, сервиса геообработки и сервиса объектов.

Активация вебхуков организации

Для активации вебхука организации выполните следующие шаги.

Примечание:

Пример запроса POST, активирующего вебхук, см. в документации REST API Активация вебхука.

1. Перейдите к ArcGIS Portal Directory и войдите как участник с ролью администратора.

   Вебхуки могут создаваться и управляться только администраторами или участниками, которым назначена роль администратора по умолчанию.

   https://machine.domain.com/webadaptor/sharing/rest

   После выполнения входа появится точка доступа ресурса Пользователь для вашей учетной записи.

2. Нажмите на гиперссылку Org ID или выполните запрос в следующей форме для доступа к странице ресурса Portal Self:
   https://machine.domain.com/webadaptor/sharing/rest/portals/self

3. Прокрутите вниз точки доступа ресурса Self и щелкните Вебхук > [Webhook] > Активировать, где [Webhook] представляет ID или имя определенного вебхука для доступа операции Активировать.
4. В точке доступа Активировать щелкните Активировать для перезапуска вебхука.

Активация вебхуков сервиса геообработки

Для активации всех вебхуков, настроенных для сервиса геообработки, выполните следующие шаги.

Примечание:

Пример запроса POST, активирующего все настроенные вебхуки для сервиса геообработки, см. в документации бета REST API вебхука в Руководство по API администратора вебхуков сервиса PDF.

1. Перейдите к Директории администратора ArcGIS Server и выполните вход как участник с соответствующими назначенными ему правами администратора. .

   Вебхуки могут создаваться и управляться только администраторами, имеющими права Update, Delete, Security и Infrastructure или права администратора сервера, назначенные им, или с назначенной ролью администратора по умолчанию.

   https://machine.domain.com/webadaptor/admin

2. После выполнения входа перейдите к операции activateAll для сервиса геообработки, нажав Сервисы > [ServiceName] > Вебхуки > activateAll, где [ServiceName] представляет определенный сервис геообработки. Для сервисов, размещенных в определенных папках, щелкните Сервисы > [FolderName] > [ServiceName] > Вебхуки > activateAll, где [FolderName] представляет папку, в которой находится сервис.
3. Оказавшись на точке доступа activateAll, щелкните Активировать все, чтобы возобновить все приостановленные вебхуки.

Активация вебхуков сервиса объектов

Для активации всех вебхуков, настроенных для сервиса объектов, выполните следующие шаги.

Примечание:

Пример запроса POST, активирующего все настроенные вебхуки для сервиса объектов, см. в документации бета REST API вебхука в Руководство по API администратора вебхуков сервиса PDF.

1. Перейдите к Директории администратора ArcGIS Server и выполните вход как участник с соответствующими назначенными ему правами администратора.

   Вебхуки могут создаваться и управляться только администраторами, имеющими права Update, Delete, Security и Infrastructure или права администратора сервера, назначенные им, или с назначенной ролью администратора по умолчанию.

   https://machine.domain.com/webadaptor/admin

2. После выполнения входа перейдите к операции activateAll для сервиса объектов, нажав Сервисы > [ServiceName] > Вебхуки > activateAll, где [ServiceName] представляет определенный сервис объектов. Для сервисов, размещенных в определенных папках, щелкните Сервисы > [FolderName] > [ServiceName] > Вебхуки > activateAll, где [FolderName] представляет папку, в которой находится сервис.
3. Оказавшись на точке доступа activateAll, щелкните Активировать все, чтобы возобновить все приостановленные вебхуки.

Удаление вебхуков

Если созданный ранее вебхук больше не нужен, его можно навсегда убрать из организации, удалив его. В следующих разделах описывается, как удалить вебхуки организации, сервиса геообработки и сервиса объектов.

Удаление вебхуков организации

Для удаления вебхука организации выполните следующие шаги.

Примечание:

Пример запроса POST, удаляющего вебхук, см. в документации REST API Удаление вебхука.

1. Перейдите к ArcGIS Portal Directory и войдите как участник с ролью администратора.

   Вебхуки могут создаваться и управляться только администраторами или участниками, которым назначена роль администратора по умолчанию.

   https://machine.domain.com/webadaptor/sharing/rest

   После выполнения входа появится точка доступа ресурса Пользователь для вашей учетной записи.

2. Нажмите на гиперссылку Org ID или выполните запрос в следующей форме для доступа к ресурсу Portal Self:
   https://machine.domain.com/webadaptor/sharing/rest/portals/self

3. Прокрутите вниз точки доступа ресурса Self и щелкните Вебхук > [Webhook] > Удалить, where [Webhook] где представляет ID или имя определенного вебхука для доступа операции Удалить.
4. Оказавшись на точке доступа Delete, щелкните Удалить, чтобы окончательно удалить вебхук.

Удаление вебхуков сервиса геообработки

Вебхуки сервиса геообработки можно удалить двумя способами Можно удалить все вебхуки, настроенные для сервиса геообработки, или удалить отдельный вебхук. Для удаления вебхуков сервиса геообработки выполните следующие шаги.

Примечание:

Пример запроса POST, активирующего все настроенные вебхуки для сервиса геообработки, см. в документации бета REST API вебхука в Руководство по API администратора вебхуков сервиса PDF.

1. Перейдите к Директории администратора ArcGIS Server и выполните вход как участник с соответствующими назначенными ему правами администратора.

   Вебхуки могут создаваться и управляться только администраторами, имеющими права Update, Delete, Security и Infrastructure или права администратора сервера, назначенные им, или с назначенной ролью администратора по умолчанию.

   https://machine.domain.com/webadaptor/admin

2. После выполнения входа перейдите к ресурсу Вебхуки, нажав Сервисы > [ServiceName] > Вебхуки, где [ServiceName] представляет определенный сервис геообработки. Для сервисов, размещенных в определенных папках, щелкните Сервисы > [FolderName] > [ServiceName] > Вебхуки, где [FolderName] представляет папку, в которой находится сервис.
3. Оказавшись на точке доступа Webhooks, выберите удаление всех вебхуков или определенного вебхука.
   • Для удаления всех вебхуков, настроенных для сервиса геообработки, щелкните deleteAll для доступа к конечной точке операции. Оказавшись на точке доступа, щелкните Удалить все.
   • Для удаления определенного вебхука нажмите [Webhook] > Удалить, где [Webhook] представляет ID вебхука. Оказавшись на точке доступа операции Delete, щелкните Удалить.

Удаление вебхуков сервиса объектов

Вебхуки сервиса объектов можно удалить двумя способами Можно удалить все вебхуки, настроенные для сервиса объектов, или удалить отдельный вебхук. Для удаления вебхуков сервиса объектов выполните следующие шаги.

Примечание:

Пример запроса POST, активирующего все настроенные вебхуки для сервиса объектов, см. в документации бета REST API вебхука в Руководство по API администратора вебхуков сервиса PDF.

1. Перейдите к Директории администратора ArcGIS Server и выполните вход как участник с соответствующими назначенными ему правами администратора.

   Вебхуки могут создаваться и управляться только администраторами, имеющими права Update, Delete, Security и Infrastructure или права администратора сервера, назначенные им, или с назначенной ролью администратора по умолчанию.

   https://machine.domain.com/webadaptor/admin

2. После выполнения входа перейдите к ресурсу Вебхуки, нажав Сервисы > [ServiceName] > Вебхуки, где [ServiceName] представляет определенный сервис объектов. Для сервисов, размещенных в определенных папках, щелкните Сервисы > [FolderName] > [ServiceName] > Вебхуки, где [FolderName] представляет папку, в которой находится сервис.
3. Оказавшись на точке доступа Webhooks, выберите удаление всех вебхуков или определенного вебхука.
   • Для удаления всех вебхуков, настроенных для сервиса объектов, щелкните deleteAll для доступа к конечной точке операции. Оказавшись на точке доступа, щелкните Удалить все.
   • Для удаления определенного вебхука нажмите [Webhook] > Удалить, где [Webhook] представляет ID вебхука. Оказавшись на точке доступа операции Delete, щелкните Удалить.