API учётных данных AWS - PUT службы мониторинга

Материал из Документация Ключ-АСТРОМ
Версия от 16:49, 16 марта 2023; ENetrebin (обсуждение | вклад) (Новая страница: «Обновляет список сервисов AWS, отслеживаемых конфигурацией AWS. Обратите внимание, что зап...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

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

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

PUT Ключ-АСТРОМ Managed для управления https://{your-domain}/e/{your-environment-id}/aws/credentials/{id}/services
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/aws/credentials/{id}/services

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

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. `WriteConfig` (Write configuration)

Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр Тип Описание In Необходимость
id string Идентификатор учетных данных AWS, который необходимо обновить с новой конфигурацией отслеживаемых сервисов. path необходимый
body AwsMonitoredServicesDto Тело JSON запроса. Содержит обновленную конфигурацию отслеживаемых сервисов для учетных данных AWS. body необязательный

Объекты тела запроса

Объект AwsMonitoredServicesDto

Элемент Тип Описание Необходимость
metadata ConfigurationMetadata Метаданные, полезные для отладки необязательный
services AwsSupportingServiceConfig[] Список сервисов AWS, которые нужно отслеживать. Доступные службы перечислены в операции /aws/supportedServices .

Для каждой услуги можно указать список метрик и измерений. Список поддерживаемых метрик и измерений для данного сервиса можно посмотреть в документации .

Список метрик можно пропустить (установить значение null), в результате чего для мониторинга будет выбран рекомендуемый (по умолчанию) набор метрик и параметров. Для встроенных сервисов настройка списка метрик не поддерживается, поэтому он должен быть нулевым.

необходимый

Объект ConfigurationMetadata

Метаданные, полезные для отладки

Элемент Тип Описание Необходимость
configurationVersions integer[] Отсортированный список номеров версий конфигурации. необязательный
currentConfigurationVersions string[] Отсортированный список номеров версий конфигурации. необязательный
clusterVersion string Версия Ключ-АСТРОМ. необязательный

Объект AwsSupportingServiceConfig

Служба, за которой нужно следить.

Элемент Тип Описание Необходимость
name string Название службы. Действительные имена поддерживаемых сервисов можно узнать с помощью /aws/supportedServices restAPI. необходимый
monitoredMetrics AwsSupportingServiceMetric[] Список метрик, которые нужно отслеживать для этой службы. Если список пуст, то будет отслеживаться рекомендуемый список метрик для этой службы. необязательный

Объект AwsSupportingServiceMetric

Метрика обслуживания, которую нужно отслеживать.

Элемент Тип Описание Необходимость
name string Имя метрики сервиса. необходимый
statistic string Статистика (агрегация), которая будет использоваться для метрики. Значение AVG_MIN_MAX — это сразу 3 статистики: AVERAGE, MINIMUM и MAXIMUM.

Элемент может содержать эти значения

  • AVERAGE
  • AVG_MIN_MAX
  • MAXIMUM
  • MINIMUM
  • SAMPLE_COUNT
  • SUM
 необходимый
dimensions string[] Список имен параметров метрики. необходимый

JSON-модель тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. 

{
  "metadata": {
    "configurationVersions": [
      4,
      2
    ],
    "currentConfigurationVersions": [
      "1.0.4",
      "1.23"
    ],
    "clusterVersion": "1.192.1"
  },
  "services": [
    {
      "name": "string",
      "monitoredMetrics": [
        {
          "name": "string",
          "statistic": "AVERAGE",
          "dimensions": [
            "string"
          ]
        }
      ]
    }
  ]
}

Ответ

Коды ответов

Код Тип Описание
204 Успех. Конфигурация учетных данных AWS обновлена. Ответ не имеет тела.
400 ErrorEnvelope Неуспешно. Ввод недействителен.

Проверка полезной нагрузки

Мы рекомендуем вам проверить полезную нагрузку перед ее отправкой с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.

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

POST Ключ-АСТРОМ Managed для управления https://{your-domain}/e/{your-environment-id}/aws/credentials/{id}/services/validator
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/aws/credentials/{id}/services/validator

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

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. `WriteConfig` (Write configuration)

Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Ответ

Коды ответов

Код Тип Описание
204 Подтверждено. Представленная конфигурация действительна. Ответ не имеет тела.
400 ErrorEnvelope Неуспешно. Ввод недействителен.
Источник — https://doc.ruscomtech.ru/index.php?title=API_учётных_данных_AWS_-_PUT_службы_мониторинга&oldid=2610