POST токен*: различия между версиями
ENetrebin (обсуждение | вклад) (Новая страница: «Создает новый токен АктивногоШлюза. Токен будет принадлежать пользователю, которому пр...») |
ENetrebin (обсуждение | вклад) |
||
| Строка 1: | Строка 1: | ||
Создает новый токен | Создает новый токен ActiveGate. | ||
Токен будет принадлежать пользователю, которому принадлежит токен, используемый для аутентификации вызова. | Токен будет принадлежать пользователю, которому принадлежит токен, используемый для аутентификации вызова. | ||
| Строка 9: | Строка 9: | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens</nowiki></code> | ||
|- | |- | ||
| | |Среда ActiveGate | ||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGateTokens</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGateTokens</nowiki></code> | ||
|} | |} | ||
== Аутентификация == | == Аутентификация == | ||
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Создание токенов | Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Создание токенов ActiveGate ( <code>activeGateTokenManagement.create</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] . | ||
== Параметры == | == Параметры == | ||
| Строка 26: | Строка 26: | ||
|body | |body | ||
|ActiveGateTokenCreate | |ActiveGateTokenCreate | ||
|Тело JSON запроса. Содержит параметры нового токена | |Тело JSON запроса. Содержит параметры нового токена ActiveGate. | ||
|body | |body | ||
|требуется | |требуется | ||
| Строка 34: | Строка 34: | ||
==== Объект <code>ActiveGateTokenCreate</code> ==== | ==== Объект <code>ActiveGateTokenCreate</code> ==== | ||
Параметры нового токена | Параметры нового токена ActiveGate. | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
| Строка 112: | Строка 112: | ||
==== Объект <code>ActiveGateTokenCreated</code> ==== | ==== Объект <code>ActiveGateTokenCreated</code> ==== | ||
Недавно созданный токен | Недавно созданный токен ActiveGate. | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
| Строка 120: | Строка 120: | ||
|id | |id | ||
|string | |string | ||
|Идентификатор токена | |Идентификатор токена ActiveGate, состоящий из префикса и общедоступной части токена. | ||
|- | |- | ||
|token | |token | ||
| Строка 139: | Строка 139: | ||
== Пример == | == Пример == | ||
В этом примере запрос создает новый токен | В этом примере запрос создает новый токен ActiveGate для среды ActiveGate. Токен действителен в течение двух недель (14 дней) с момента создания. | ||
Маркер API передается в заголовке авторизации . | Маркер API передается в заголовке авторизации . | ||
| Строка 145: | Строка 145: | ||
==== Curl ==== | ==== Curl ==== | ||
<code>curl --request GET \ | <code>curl --request GET \ | ||
--url <nowiki>https://mySampleEnv.live. | --url <nowiki>https://mySampleEnv.live.dynatrace.com//api/v2/activeGateTokens</nowiki> \ | ||
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \ | --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \ | ||
--header 'Content-Type: application/json' \ | --header 'Content-Type: application/json' \ | ||
| Строка 156: | Строка 156: | ||
==== URL-адрес запроса ==== | ==== URL-адрес запроса ==== | ||
<code><nowiki>https://mySampleEnv.live. | <code><nowiki>https://mySampleEnv.live.dynatrace.com//api/v2/activeGateTokens</nowiki></code> | ||
==== Тело запроса ==== | ==== Тело запроса ==== | ||
Текущая версия на 17:06, 13 февраля 2023
Создает новый токен ActiveGate.
Токен будет принадлежать пользователю, которому принадлежит токен, используемый для аутентификации вызова.
Запрос создает и использует application/json формат.
| POST | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens
|
| Среда ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGateTokens
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Создание токенов ActiveGate ( activeGateTokenManagement.create) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| body | ActiveGateTokenCreate | Тело JSON запроса. Содержит параметры нового токена ActiveGate. | body | требуется |
Объекты тела запроса
Объект ActiveGateTokenCreate
Параметры нового токена ActiveGate.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| name | string | Имя токена. | требуется |
| expirationDate | string | Срок действия токена.
Вы можете использовать один из следующих форматов:
Если не установлено, срок действия токена никогда не истекает. |
по желанию |
| seedToken | boolean | Токен является начальным токеном ( true) или отдельным токеном ( false).
Мы рекомендуем использовать индивидуальный токен (false). |
по желанию |
| activeGateType | string | Тип АктивногоШлюза, для которого действителен токен.
Элемент может содержать эти значения
|
требуется |
JSON-модель тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
{
"name": "myToken",
"expirationDate": "now+14d",
"seedToken": false,
"activeGateType": "ENVIRONMENT"
}
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 201 | ActiveGateTokenCreated | Успех. Токен создан. Тело ответа содержит секрет токена. |
| 400 | ErrorEnvelope | Не удалось. Ввод недействителен. |
Объекты тела ответа
Объект ActiveGateTokenCreated
Недавно созданный токен ActiveGate.
| Элемент | Тип | Описание |
|---|---|---|
| id | string | Идентификатор токена ActiveGate, состоящий из префикса и общедоступной части токена. |
| token | string | Секрет токена. |
| expirationDate | string | Дата истечения срока действия токена в формате ISO 8601 ( yyyy-MM-dd'T'HH:mm:ss.SSS'Z').
|
JSON-модель тела ответа
{
"id": "dt0g02.4KWZO5EF",
"token": "dt0g02.4KWZO5EF.XT47R5DRADJIZUFOX4UDNOKTSUSABGLN7XSMJG7UXHRXKNY4WLORH4OF4T75MG7E",
"expirationDate": "2020-11-24T08:15:30.144Z"
}
Пример
В этом примере запрос создает новый токен ActiveGate для среды ActiveGate. Токен действителен в течение двух недель (14 дней) с момента создания.
Маркер API передается в заголовке авторизации .
Curl
curl --request GET \
--url https://mySampleEnv.live.dynatrace.com//api/v2/activeGateTokens \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
--header 'Content-Type: application/json' \
--data '{
"name": "REST test",
"expirationDate": "now+14d",
"seedToken": false,
"activeGateType": "ENVIRONMENT"
}'
URL-адрес запроса
https://mySampleEnv.live.dynatrace.com//api/v2/activeGateTokens
Тело запроса
{
"name": "REST test",
"expirationDate": "now+14d",
"seedToken": false,
"activeGateType": "ENVIRONMENT"
}
Тело ответа
{
"id": "dt0g02.xyz789",
"token": "dt0g02.xyz789.987654321zyxwvutsrq",
"expirationDate": "2021-12-14T13:42:31.148Z"
}
Код ответа
201