API Контроллера Задач: различия между версиями
Материал из Документация Ключ-АСТРОМ
(Новая страница: «Чтобы пройти аутентификацию для использования API Контроллера Задач, вам необходим дейст...») |
|||
Строка 3: | Строка 3: | ||
# Зарегистрируйте клиента ([[Создание клиентского SSO]]). | # Зарегистрируйте клиента ([[Создание клиентского SSO]]). | ||
# Сгенерируйте токен ([[Создание SSO-токена]]). В настоящее время поддерживается только область <code>sso20-managed-cluster-offline-bundle</code>, которая позволяет создавать URL-адреса для скачивания пакетов обновлений. | # Сгенерируйте токен ([[Создание SSO-токена]]). В настоящее время поддерживается только область <code>sso20-managed-cluster-offline-bundle</code>, которая позволяет создавать URL-адреса для скачивания пакетов обновлений. | ||
# Выполняйте аутентификацию в вызовах API. Присоедините токен к заголовку HTTP авторизации, предшествующему области Bearer. | # Выполняйте аутентификацию в вызовах API. Присоедините токен к заголовку HTTP авторизации, предшествующему области <code>Bearer</code>. | ||
Пример аутентификации: | |||
<code>curl -X GET "<nowiki>https://mcsvc.dynatrace.com/rest/public/downloads/offline-bundle/published</nowiki>" | |||
-H "accept: application/json" | |||
-H "Authorization: Bearer aaA0aAAaAaAAA0AaAAAaaAaaAaAAAaA0AaA0.eyJzdWIiOiJjbHVzdGVyLTBhMDBhMGEwLTkyZWMtMTFlNy1iMWU2LTEyZmJkMWZiMzczMkBkeW5hdHJhY2UtbWFuYWdlZC5jb20iLCJhdWQiOiJkdDBzMDQuTFFWT1FQQVMiLCJ1aWQiOiI5N2Y0OGFhMy1jYmRiLTRkMzEtOGE2YS02NjUyNTQxMzY5MTIiLCJzY29wZSI6InNzbzIwLW1hbmFnZWQtY2x1c3Rlci1vZmZsaW5lLWJ1bmRsZSIsImlzcyI6Imh0dHBzOi8vc3NvLXNwcmludC5keW5hdHJhY2VsYWJzLmNvbTo0NDMiLCJleHAiOjE2MTU0NzcxNTIsImdyYW50VHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsImlhdCI6MTYxNTQ2OTk1Mn0.svn34bJEZbziHVyV7cKW9OWwvBwakzH0Ke_Iu19GV743zrC4zHuX4YQFts-JkEHRYmnVvnQRwPPCakuq0LHVjA"</code> | |||
Если не указано иное, используются следующие коды ответа: | |||
* <code>200</code> — Запрос выполнен успешно. | |||
* <code>400</code> — Некорректный запрос. Запрос не выполнен. В тексте ответа содержатся дополнительные сведения. | |||
* <code>401</code> — Ошибка доступа. Аутентификация токена не удалась. Проверьте, есть ли у вашего токена необходимые разрешения. | |||
* <code>404</code> — Не найдено. Запрашиваемый ресурс не найден. Проверьте правильность вашего ввода. | |||
* <code>429</code> — Слишком много запросов. Контроллер Задач сейчас занят, повторите попытку позже. | |||
== Офлайн-пакеты == | |||
* [[Получить список доступных пакетов и обновлений]] | |||
* [[Получить офлайн-пакет]] |
Версия 17:50, 22 сентября 2022
Чтобы пройти аутентификацию для использования API Контроллера Задач, вам необходим действительный клиентский токен OAuth REST API
. Доступ к API контролируется областью, а это означает, что вам также нужны соответствующие разрешения, назначенные токену. Проделайте шаги ниже, чтобы узнать, какие разрешения необходимы для его использования.
- Зарегистрируйте клиента (Создание клиентского SSO).
- Сгенерируйте токен (Создание SSO-токена). В настоящее время поддерживается только область
sso20-managed-cluster-offline-bundle
, которая позволяет создавать URL-адреса для скачивания пакетов обновлений. - Выполняйте аутентификацию в вызовах API. Присоедините токен к заголовку HTTP авторизации, предшествующему области
Bearer
.
Пример аутентификации:
curl -X GET "https://mcsvc.dynatrace.com/rest/public/downloads/offline-bundle/published"
-H "accept: application/json"
-H "Authorization: Bearer aaA0aAAaAaAAA0AaAAAaaAaaAaAAAaA0AaA0.eyJzdWIiOiJjbHVzdGVyLTBhMDBhMGEwLTkyZWMtMTFlNy1iMWU2LTEyZmJkMWZiMzczMkBkeW5hdHJhY2UtbWFuYWdlZC5jb20iLCJhdWQiOiJkdDBzMDQuTFFWT1FQQVMiLCJ1aWQiOiI5N2Y0OGFhMy1jYmRiLTRkMzEtOGE2YS02NjUyNTQxMzY5MTIiLCJzY29wZSI6InNzbzIwLW1hbmFnZWQtY2x1c3Rlci1vZmZsaW5lLWJ1bmRsZSIsImlzcyI6Imh0dHBzOi8vc3NvLXNwcmludC5keW5hdHJhY2VsYWJzLmNvbTo0NDMiLCJleHAiOjE2MTU0NzcxNTIsImdyYW50VHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsImlhdCI6MTYxNTQ2OTk1Mn0.svn34bJEZbziHVyV7cKW9OWwvBwakzH0Ke_Iu19GV743zrC4zHuX4YQFts-JkEHRYmnVvnQRwPPCakuq0LHVjA"
Если не указано иное, используются следующие коды ответа:
200
— Запрос выполнен успешно.400
— Некорректный запрос. Запрос не выполнен. В тексте ответа содержатся дополнительные сведения.401
— Ошибка доступа. Аутентификация токена не удалась. Проверьте, есть ли у вашего токена необходимые разрешения.404
— Не найдено. Запрашиваемый ресурс не найден. Проверьте правильность вашего ввода.429
— Слишком много запросов. Контроллер Задач сейчас занят, повторите попытку позже.