Получение свойства события: различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) (Новая страница: «Получает сведения о свойстве события. Запрос создает <code>application/json</code>полезную нагрузку....») |
ENetrebin (обсуждение | вклад) |
||
| (не показаны 3 промежуточные версии этого же участника) | |||
| Строка 2: | Строка 2: | ||
Запрос создает <code>application/json</code>полезную нагрузку. | Запрос создает <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="3" | | | rowspan="3" |GET | ||
| | |Managed | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties/{propertyKey}</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties/{propertyKey}</nowiki></code> | ||
|- | |- | ||
| Строка 14: | Строка 10: | ||
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/eventProperties/{propertyKey}</nowiki></code> | |<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/eventProperties/{propertyKey}</nowiki></code> | ||
|- | |- | ||
|Окружающая среда | |Окружающая среда АктивногоШлюза | ||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventProperties/{propertyKey}</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventProperties/{propertyKey}</nowiki></code> | ||
|} | |} | ||
== Аутентификация == | == Аутентификация == | ||
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение событий ( <code>events.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация . | Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение событий ( <code>events.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] . | ||
== Параметры == | == Параметры == | ||
| Строка 30: | Строка 26: | ||
|- | |- | ||
|свойствоКлюч | |свойствоКлюч | ||
| | |string | ||
|Ключ свойства события, который вы запрашиваете. | |Ключ свойства события, который вы запрашиваете. | ||
|дорожка | |дорожка | ||
| Строка 59: | Строка 55: | ||
|- | |- | ||
|отображаемое имя | |отображаемое имя | ||
| | |string | ||
|Отображаемое имя свойства события. | |Отображаемое имя свойства события. | ||
| Строка 65: | Строка 61: | ||
|- | |- | ||
|доступный для записи | |доступный для записи | ||
| | |boolean | ||
|Указывает, может ли свойство быть установлено во время приема события. | |Указывает, может ли свойство быть установлено во время приема события. | ||
| Строка 71: | Строка 67: | ||
|- | |- | ||
|ключ | |ключ | ||
| | |string | ||
|Ключ свойства события. | |Ключ свойства события. | ||
| Строка 77: | Строка 73: | ||
|- | |- | ||
|описание | |описание | ||
| | |string | ||
|Краткое описание свойства события. | |Краткое описание свойства события. | ||
Текущая версия на 05:52, 25 апреля 2022
Получает сведения о свойстве события.
Запрос создает application/jsonполезную нагрузку.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties/{propertyKey}
|
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/eventProperties/{propertyKey}
| |
| Окружающая среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventProperties/{propertyKey}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение событий ( events.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | В | Необходимый |
|---|---|---|---|---|
| свойствоКлюч | string | Ключ свойства события, который вы запрашиваете. | дорожка | обязательный |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | Сведения о свойстве события | Успех |
Объекты тела ответа
Объект _ EventPropertyDetail
Конфигурация свойства события.
| Элемент | Тип | Описание |
|---|---|---|
| отображаемое имя | string | Отображаемое имя свойства события.
Может быть |
| доступный для записи | boolean | Указывает, может ли свойство быть установлено во время приема события.
Может быть |
| ключ | string | Ключ свойства события.
Может быть |
| описание | string | Краткое описание свойства события.
Может быть |
JSON-модель тела ответа
{
"displayName": "Custom description",
"writable": true,
"key": "dt.event.description",
"description": "string"
}
Пример
В этом примере запрос запрашивает сведения о свойстве пользовательского источника события.
Маркер API передается в заголовке авторизации .
Curl
curl --request GET \
--url 'https://mySampleEnv.live.dynatrace.com/api/v2/eventProperties/dt.event.source' \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.dynatrace.com/api/v2/eventProperties/dt.event.source
Тело ответа
{
"key": "dt.event.source",
"displayName": "Custom source",
"description": "The name or ID of the external source of the event",
"writable": true
}
Код ответа
200
