GET готовые работы*: различия между версиями

Текущая версия от 09:12, 26 декабря 2024

Перечисляет выполненные задания по настройке АктивныхШлюзов.

Запрос создает в качестве полезной нагрузки application/jsonформат.

GET	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement`
GET	Среда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement`

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

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Read ActiveGates ( activeGates.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр	Тип	Описание	In	Необходимость
from	string	Начало запрошенного периода времени для задания удаленного управления конфигурацией. Вы можете использовать один из следующих форматов: Отметка времени в миллисекундах UTC. Человекочитаемый формат `2021-01-25T05:57:01.123+01:00`. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо `T`. Секунды и доли секунды не являются обязательными. Относительный таймфрейм, назад. Формат: `now-NU/A`, где `N`количество времени, `U`единица времени и `A`выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, `now-1y/w`это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: `now-NU`. Поддерживаемые единицы времени для относительного таймфрейма: `m`: минуты `h`: часы `d`: дни `w`: недели `M`: месяцы `y`: годы	query	по желанию
to	string	Конец запрошенного периода времени для задания удаленного управления конфигурацией. Вы можете использовать один из следующих форматов: Отметка времени в миллисекундах UTC. Человекочитаемый формат `2021-01-25T05:57:01.123+01:00`. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо `T`. Секунды и доли секунды не являются обязательными. Относительный таймфрейм, назад. Формат: `now-NU/A`, где `N`количество времени, `U`единица времени и `A`выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, `now-1y/w`это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: `now-NU`. Поддерживаемые единицы времени для относительного таймфрейма: `m`: минуты `h`: часы `d`: дни `w`: недели `M`: месяцы `y`: годы Если не установлено, используется текущая метка времени.	query	по желанию

Ответ

Коды ответов

Код	Тип	Описание
200	RemoteConfigurationManagementJobList	Успех

Объекты тела ответа

Объект `RemoteConfigurationManagementJobList`

Список заданий удаленного управления конфигурацией.

Элемент	Тип	Описание
рабочие места	RemoteConfigurationManagementJobSummary[]	Список заданий удаленного управления конфигурацией.

Объект `RemoteConfigurationManagementJobSummary`

Задание удаленного управления конфигурацией с основными данными.

Элемент	Тип	Описание
entityType	string	Тип объектов, измененных удаленным управлением конфигурацией. Элемент может содержать эти значения `ACTIVE_GATE` `ONE_AGENT`
id	string	Идентификатор задания удаленного управления конфигурацией.
startTime	string	Дата (в формате ISO 8601: гггг-ММ-дд'Т'ЧЧ:мм:сс.ССС'Z') запуска задания удаленного управления конфигурацией.
endTime	string	Дата (в формате ISO 8601: гггг-ММ-дд'Т'ЧЧ:мм:сс.ССС'Z') завершения задания удаленного управления конфигурацией. Это поле присутствует только для готовых работ.

JSON-модель тела ответа

<{
  "jobs": [
    {
      "entityType": "ACTIVE_GATE or ONE_AGENT",
      "id": "7974003406714390819",
      "startTime": "2020-11-05T08:15:30.144Z",
      "endTime": "2020-11-05T08:15:30.144Z"
    }
  ]
}

@@ Строка 1: / Строка 1: @@
-Перечисляет выполненные задания по настройке ActiveGates.
+Перечисляет выполненные задания по настройке АктивныхШлюзов.
-Запрос создает <code>application/json</code>полезную нагрузку.
+Запрос создает в качестве полезной нагрузки <code>application/json</code>формат.
 {| class="wikitable"
-| rowspan="3" |ПОЛУЧИТЬ
+| rowspan="2" |GET
-|Удалось
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement</nowiki></code>
 |-
-|SaaS
+|Среда АктивногоШлюза
-|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/remoteConfigurationManagement</nowiki></code>
-|-
-|Окружающая среда ActiveGate
 |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement</nowiki></code>
 |}
 == Аутентификация ==
-Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Read ActiveGates ( <code>activeGates.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
+Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Read ActiveGates ( <code>activeGates.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
 == Параметры ==
@@ Строка 22: / Строка 19: @@
 !Тип
 !Описание
-!В
+!In
-!Необходимый
+!Необходимость
 |-
-|из
+|from
-|нить
+|string
 |Начало запрошенного периода времени для задания удаленного управления конфигурацией.
@@ Строка 34: / Строка 31: @@
 * Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
 * Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
-** <code>m</code>: минут
+** <code>m</code>: минуты
 ** <code>h</code>: часы
-** <code>d</code>: дней
+** <code>d</code>: дни
 ** <code>w</code>: недели
 ** <code>M</code>: месяцы
 ** <code>y</code>: годы
-|запрос
+|query
 |по желанию
 |-
-|к
+|to
-|нить
+|string
 |Конец запрошенного периода времени для задания удаленного управления конфигурацией.
@@ Строка 52: / Строка 49: @@
 * Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
 * Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
-** <code>m</code>: минут
+** <code>m</code>: минуты
 ** <code>h</code>: часы
-** <code>d</code>: дней
+** <code>d</code>: дни
 ** <code>w</code>: недели
 ** <code>M</code>: месяцы
@@ Строка 60: / Строка 57: @@
 Если не установлено, используется текущая метка времени.
-|запрос
+|query
 |по желанию
 |}
@@ Строка 73: / Строка 70: @@
 |-
 |200
-|Список заданий удаленного управления конфигурацией
+|RemoteConfigurationManagementJobList
 |Успех
 |}
@@ Строка 79: / Строка 76: @@
 === Объекты тела ответа ===
-==== Объект _ <code>RemoteConfigurationManagementJobList</code> ====
+==== Объект <code>RemoteConfigurationManagementJobList</code> ====
 Список заданий удаленного управления конфигурацией.
 {| class="wikitable"
@@ Строка 87: / Строка 84: @@
 |-
 |рабочие места
-|Сводка задания удаленного управления конфигурацией []
+|RemoteConfigurationManagementJobSummary[]
 |Список заданий удаленного управления конфигурацией.
 |}
-==== Объект _ <code>RemoteConfigurationManagementJobSummary</code> ====
+==== Объект <code>RemoteConfigurationManagementJobSummary</code> ====
 Задание удаленного управления конфигурацией с основными данными.
 {| class="wikitable"
@@ Строка 98: / Строка 95: @@
 !Описание
 |-
-|тип объекта
+|entityType
-|нить
+|string
 |Тип объектов, измененных удаленным управлением конфигурацией.
@@ Строка 107: / Строка 104: @@
 * <code>ONE_AGENT</code>
 |-
-|я бы
+|id
-|нить
+|string
 |Идентификатор задания удаленного управления конфигурацией.
 |-
-|время начала
+|startTime
-|нить
+|string
 |Дата (в формате ISO 8601: гггг-ММ-дд'Т'ЧЧ:мм:сс.ССС'Z') запуска задания удаленного управления конфигурацией.
 |-
-|время окончания
+|endTime
-|нить
+|string
 |Дата (в формате ISO 8601: гггг-ММ-дд'Т'ЧЧ:мм:сс.ССС'Z') завершения задания удаленного управления конфигурацией. Это поле присутствует только для готовых работ.
 |}
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "jobs": [
       {