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

Материал из Документация Ключ-АСТРОМ

Список сервисов AWS, отслеживаемых конфигурацией AWS.

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

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

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

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

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

Параметры

Параметр Тип Описание In Необходимость
id string Идентификатор указанной конфигурации учетных данных AWS. path необходимый

Ответ

Коды ответов

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

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

Объект 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"
          ]
        }
      ]
    }
  ]
}
Источник — https://doc.ruscomtech.ru/index.php?title=API_учётных_данных_AWS_-_GET_службы_мониторинга&oldid=2609