Токены и аутентификация (API): различия между версиями

Текущая версия от 19:27, 23 декабря 2024

API АппОптима / Основное / Токены и аутентификация (API)

Чтобы пройти аутентификацию для использования АппОптима API, вам понадобится действующий токен доступа или действительный токен личного доступа . Доступ к API детализирован, что означает, что вам также потребуются соответствующие разрешения, назначенные токену. См. описание каждого запроса, чтобы узнать, какие разрешения требуются для его использования.

Формат токена

АппОптима использует уникальный формат токенов, состоящий из трех компонентов, разделенных точками (.). Например:
dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM

dt0c01 - Префикс для идентификации токена.
ST2...7YN - Открытая часть токена. 24-значный открытый идентификатор токена. Это значение можно безопасно отображать в пользовательском интерфейсе и использовать для ведения журнала.
G3D...RZM - Секретная часть токена. 64-символьная секретная часть токена, которую можно рассматривать как пароль, поэтому она не отображается в веб-интерфейсе АппОптима (после первоначального создания) и не сохраняется в файлах журнала.

Создание токена

Токен API

Чтобы сгенерировать токен доступа

В меню АппОптима выберите маркеры доступа.
Выберите Создать новый токен .
Введите имя для вашего токена.
Выберите необходимые разрешения для токена.
Выберите «Создать» .
Скопируйте сгенерированный токен в буфер обмена. Сохраните токен в диспетчере паролей для использования в будущем.

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

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

В качестве альтернативы вы можете использовать POST запрос (токен) к API токенов аутентификации для создания токена.

АппОптима не требует уникальных имен токенов. Вы можете создать несколько токенов с одним и тем же именем. Обязательно укажите понятное имя для каждого генерируемого токена. Правильное именование поможет вам эффективно управлять своими токенами и, возможно, удалять их, когда они больше не нужны.

Токен персонального доступа

Для создания токена личного доступа

Выберите меню пользователя в правом верхнем углу страницы.
Выберите токены личного доступа .
Выберите Создать новый токен .
Введите имя для вашего токена.
Выберите необходимые разрешения для токена.
Выберите «Создать» .
Скопируйте сгенерированный токен в буфер обмена. Сохраните токен в диспетчере паролей для использования в будущем.

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

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

В качестве альтернативы вы можете использовать POST запрос (токен) к API токенов аутентификации для создания токена личного доступа.

АппОптима не требует уникальных имен токенов. Вы можете создать несколько токенов с одним и тем же именем. Обязательно укажите понятное имя для каждого генерируемого токена. Правильное именование поможет вам эффективно управлять своими токенами и, возможно, удалять их, когда они больше не нужны.

Разрешения токена

Токен API

АппОптима предоставляет следующие разрешения для токенов API. Вы можете установить их в пользовательском интерфейсе, как описано выше, или через API токенов аутентификации. Некоторые области доступны только через API.

API v2
Имя	Значение API	Описание
Чтение метрик	metrics.read	Предоставляет доступ к GET-запросам Metrics API v2 .
Запись метрик	metrics.write	Предоставляет доступ к удалению пользовательской метрики для запроса к Metrics API v2.
Метрики загрузки	metrics.ingest	Предоставляет доступ к POST запросу ingest data points Metrics API v2.
Чтение логов	logs.read	Предоставляет доступ к GET запросам Log Monitoring API v2.
Логи загрузки	logs.ingest	Предоставляет доступ к POST запросу логов загрузки Log Monitoring API v2.

Токен персонального доступа

АппОптима предоставляет следующие разрешения для токенов личного доступа. Вы можете установить их в пользовательском интерфейсе, как описано выше, или через API токенов аутентификации.

Имя	Значение API	Описание
Чтение токенов API	apiTokens.read	Предоставляет доступ к GET запросам API токенов аутентификации
Запись токенов API	apiTokens.write	Предоставляет доступ к POST, PUT и DELETE запросам API токенов аутентификации

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

У вас есть два варианта передачи токена API: в HTTP-заголовке авторизации или в параметре запроса api-token .

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

Используя заголовок HTTP

Вы можете пройти аутентификацию, прикрепив токен к HTTP-заголовку авторизации. В следующем примере показана аутентификация через HTTP-заголовок:

curl --request GET \ --url https://mySampleEnv.ruscomtech.ru/api/v1/config/clusterversion \ --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \

Используя параметр запроса

Вы можете пройти аутентификацию, добавив токен в качестве значения параметра запроса api-token.

curl --request GET \ --url 'https://mySampleEnv.live.ruscomtech.eu/api/v1/config/clusterversion?api-token=abcdefjhij1234567890' \

Аутентификация в API Explorer

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

Вы также можете разблокировать все эндпоинты, выбрав Авторизовать. В отображаемом диалоговом окне вы можете увидеть, какие разрешения токена необходимы для каждого эндпоинта API. Введя свой токен API в диалоговое окно Доступные авторизации , вы можете разблокировать все связанные эндпоинты API.

@@ Строка 1: / Строка 1: @@
-Чтобы пройти аутентификацию для использования Ключ-АСТРОМ API, вам понадобится действующий [[токен доступа]] или действительный [[токен личного доступа]] . Доступ к API детализирован, что означает, что вам также потребуются соответствующие разрешения, назначенные токену. См. описание каждого запроса, чтобы узнать, какие разрешения требуются для его использования.
+'''''[[API АппОптима]] / [[API АппОптима|Основное]] / Токены и аутентификация (API)'''''
+Чтобы пройти аутентификацию для использования АппОптима API, вам понадобится действующий [[Токены доступа|токен доступа]] или действительный [[Токены доступа|токен личного доступа]] . Доступ к API детализирован, что означает, что вам также потребуются соответствующие разрешения, назначенные токену. См. описание каждого запроса, чтобы узнать, какие разрешения требуются для его использования.
 == Формат токена ==
-Ключ-АСТРОМ использует уникальный формат токенов, состоящий из трех компонентов, разделенных точками (.). Например:<br>
+АппОптима использует уникальный формат токенов, состоящий из трех компонентов, разделенных точками (.). Например:<br>
 dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM
 * dt0c01 - Префикс для идентификации токена.
 * ST2...7YN - Открытая часть токена. 24-значный открытый идентификатор токена. Это значение можно безопасно отображать в пользовательском интерфейсе и использовать для ведения журнала.
-* G3D...RZM - Секретная часть токена. 64-символьная секретная часть токена, которую можно рассматривать как пароль, поэтому она не отображается в веб-интерфейсе Ключ-АСТРОМ (после первоначального создания) и не сохраняется в файлах журнала.
+* G3D...RZM - Секретная часть токена. 64-символьная секретная часть токена, которую можно рассматривать как пароль, поэтому она не отображается в веб-интерфейсе АппОптима (после первоначального создания) и не сохраняется в файлах журнала.
 == Создание токена ==
 === Токен API ===
 Чтобы сгенерировать токен доступа
-# В меню Ключ-АСТРОМ выберите маркеры доступа.
+# В меню АппОптима выберите маркеры доступа.
 # Выберите Создать новый токен .
 # Введите имя для вашего токена.
@@ Строка 24: / Строка 24: @@
 Вы можете назначить несколько разрешений для одного токена или вы можете сгенерировать несколько токенов, каждый с разными уровнями доступа, и использовать их соответствующим образом - проверьте политики безопасности вашей организации, чтобы получить наилучшие рекомендации.
-В качестве альтернативы вы можете использовать [[POST запрос (токен)]] к API токенов аутентификации для создания токена.
+В качестве альтернативы вы можете использовать POST запрос (токен) к API токенов аутентификации для создания токена.
-Ключ-АСТРОМ не требует уникальных имен токенов. Вы можете создать несколько токенов с одним и тем же именем. Обязательно укажите понятное имя для каждого генерируемого токена. Правильное именование поможет вам эффективно управлять своими токенами и, возможно, удалять их, когда они больше не нужны.
+АппОптима не требует уникальных имен токенов. Вы можете создать несколько токенов с одним и тем же именем. Обязательно укажите понятное имя для каждого генерируемого токена. Правильное именование поможет вам эффективно управлять своими токенами и, возможно, удалять их, когда они больше не нужны.
 === Токен персонального доступа ===
@@ Строка 42: / Строка 42: @@
 Вы можете назначить несколько разрешений одному токену или сгенерировать несколько токенов, каждый с разными разрешениями - проверьте политики безопасности вашей организации, чтобы получить наилучшие рекомендации. Вы можете сгенерировать до пяти токенов личного доступа.
-В качестве альтернативы вы можете использовать [[POST запрос (токен)]] к API токенов аутентификации для создания токена личного доступа.
+В качестве альтернативы вы можете использовать POST запрос (токен) к API токенов аутентификации для создания токена личного доступа.
-Ключ-АСТРОМ не требует уникальных имен токенов. Вы можете создать несколько токенов с одним и тем же именем. Обязательно укажите понятное имя для каждого генерируемого токена. Правильное именование поможет вам эффективно управлять своими токенами и, возможно, удалять их, когда они больше не нужны.
+АппОптима не требует уникальных имен токенов. Вы можете создать несколько токенов с одним и тем же именем. Обязательно укажите понятное имя для каждого генерируемого токена. Правильное именование поможет вам эффективно управлять своими токенами и, возможно, удалять их, когда они больше не нужны.
 == Разрешения токена ==
 === Токен API ===
-Ключ-АСТРОМ предоставляет следующие разрешения для токенов API. Вы можете установить их в пользовательском интерфейсе, как описано выше, или через [[API токенов аутентификации]]. Некоторые области доступны только через API.<br>
+АппОптима предоставляет следующие разрешения для токенов API. Вы можете установить их в пользовательском интерфейсе, как описано выше, или через [[Токены и аутентификация (API)|API токенов аутентификации]]. Некоторые области доступны только через API.<br>
 {| class="wikitable"
@@ Строка 58: / Строка 58: @@
 |Чтение метрик
 |metrics.read
-|Предоставляет доступ к GET-запросам [[Metrics API v2]] .
+|Предоставляет доступ к GET-запросам Metrics API v2 .
 |-
 |Запись метрик
 |metrics.write
-|Предоставляет доступ к [[удалению пользовательской метрики]] для запроса к Metrics API v2.
+|Предоставляет доступ к удалению пользовательской метрики для запроса к Metrics API v2.
+|-
+|Метрики загрузки
+|metrics.ingest
+|Предоставляет доступ к POST запросу ingest data points Metrics API v2.
+|-
+|Чтение логов
+|logs.read
+|Предоставляет доступ к GET запросам Log Monitoring API v2.
+|-
+|Логи загрузки
+|logs.ingest
+|Предоставляет доступ к POST запросу логов загрузки Log Monitoring API v2.
+|-
+|
+|
+|
 |}
 === Токен персонального доступа ===
-Ключ-АСТРОМ предоставляет следующие разрешения для токенов личного доступа. Вы можете установить их в пользовательском интерфейсе, как описано выше, или через [[API токенов аутентификации]].<br>
+АппОптима предоставляет следующие разрешения для токенов личного доступа. Вы можете установить их в пользовательском интерфейсе, как описано выше, или через [[Токены и аутентификация (API)|API токенов аутентификации]].<br>
 {| class="wikitable"
@@ Строка 75: / Строка 92: @@
 |Чтение токенов API
 |apiTokens.read
-|Предоставляет доступ к GET запросам  [[API токенов аутентификации]]
+|Предоставляет доступ к GET запросам  [[Токены и аутентификация (API)|API токенов аутентификации]]
 |-
 |Запись токенов API
 |apiTokens.write
-|Предоставляет доступ к POST, PUT и DELETE запросам [[API токенов аутентификации]]
+|Предоставляет доступ к POST, PUT и DELETE запросам [[Токены и аутентификация (API)|API токенов аутентификации]]
 |}
@@ Строка 92: / Строка 109: @@
 <code>
 curl --request GET \<br>
---url https://mySampleEnv.live.dynatrace.com/api/v1/config/clusterversion \<br>
+--url <nowiki>https://mySampleEnv.ruscomtech.ru/api/v1/config/clusterversion</nowiki> \<br>
 --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \ </code>
+=== Используя параметр запроса ===
+Вы можете пройти аутентификацию, добавив токен в качестве значения параметра запроса api-token.
+<code>
+curl --request GET \<br>
+--url '<nowiki>https://mySampleEnv.live.ruscomtech.eu/api/v1/config/clusterversion?api-token=abcdefjhij1234567890'</nowiki> \ </code>
+== Аутентификация в API Explorer ==
+Выберите значок замока рядом с любым эндпоинтом, чтобы отобразить информацию о токенах API, которые защищают этот эндпоинт. Каждый эндпоинт требует определенного типа токена.
+Вы также можете разблокировать все эндпоинты, выбрав '''Авторизовать'''. В отображаемом диалоговом окне вы можете увидеть, какие разрешения токена необходимы для каждого эндпоинта API. Введя свой токен API в диалоговое окно Доступные авторизации , вы можете разблокировать все связанные эндпоинты API.