API учётных данных AWS - GET учётные данные

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

Получает конфигурацию указанных учетных данных AWS.

Запрос создает application/jsonполезную нагрузку.

ПОЛУЧАТЬ УдалосьКлюч-АСТРОМ для правительства https://{your-domain}/e/{your-environment-id}/api/config/v1/aws/credentials/{id}
Окружающая среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/aws/credentials/{id}

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

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

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

Параметры

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

Ответ

Коды ответов

Код Тип Описание
200 Конфигурация учетных данных AWS Успех

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

Объект _ AwsCredentialsConfig

Конфигурация учетных данных AWS.

Элемент Тип Описание
метаданные Метаданные конфигурации Метаданные, полезные для отладки
идентификатор нить Уникальный идентификатор учетных данных.
состояние соединения нить Состояние подключения к среде AWS.
  • CONNECTED: Было соединение в течение последних 10 минут.
  • DISCONNECTED: возникла проблема с установлением соединения с использованием этих учетных данных. Проверьте правильность данных.
  • UNINITIALIZED: для этих учетных данных никогда не было установлено успешное соединение.

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

  • CONNECTED
  • DISCONNECTED
  • UNINITIALIZED
этикетка нить Имя учетных данных.
тип раздела нить Тип раздела AWS.

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

  • AWS_CN
  • AWS_DEFAULT
  • AWS_US_GOV
аутентификацияДанные Данные аутентификации AWS Учетные данные для аутентификации AWS.
taggedOnly логический Отслеживайте только ресурсы с указанными тегами AWS ( true) или все ресурсы ( false).
тегиToMonitor Тег конфигурации AWS [] Список тегов AWS для мониторинга.

Вы можете указать до 10 тегов.

Применимо, только если для параметра taggedOnly установлено значение true.

supportServicesToMonitor Конфигурация службы поддержки AWS [] Устаревший . Для управления услугами используйте операцию /aws/credentials/{id}/services . Встроенные сервисы здесь не поддерживаются.

Список сервисов AWS, которые нужно отслеживать. Доступные службы перечислены в операции /aws/supportedServices .

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

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

Объект _ ConfigurationMetadata

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

Элемент Тип Описание
конфигурацияВерсии целое [] Отсортированный список номеров версий конфигурации.
текущие версии конфигурации строка [] Отсортированный список номеров версий конфигурации.
clusterVersion нить Версия Дайнатрейс.

Объект _ AwsAuthenticationData

Учетные данные для аутентификации AWS.

Элемент Тип Описание
тип нить Тип аутентификации: на основе ролей или на основе ключей.

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

  • KEYS
  • ROLE
keyBasedAuthentication Аутентификация на основе ключа Учетные данные для аутентификации на основе ключей.
Аутентификация на основе ролей Аутентификация на основе ролей Учетные данные для аутентификации на основе ролей.

Объект _ KeyBasedAuthentication

Учетные данные для аутентификации на основе ключей.

Элемент Тип Описание
ключ доступа нить Идентификатор ключа доступа.
Секретный ключ нить Секретный ключ доступа.

Объект _ RoleBasedAuthentication

Учетные данные для аутентификации на основе ролей.

Элемент Тип Описание
iamRole нить Роль IAM, которую Ключ-АСТРОМ будет использовать для получения данных мониторинга.
идентификатор учетной записи нить Идентификатор учетной записи Amazon.
внешний идентификатор нить Токен внешнего идентификатора для настройки роли IAM.

Вы можете получить его с GET /aws/iamExternalIdзапросом.

Объект _ AwsConfigTag

Тег AWS ресурса, за которым нужно следить.

Элемент Тип Описание
имя нить Ключ тега AWS.
ценить нить Значение тега AWS.

Объект _ AwsSupportingServiceConfig

Сервис, за которым нужно следить.

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

Объект _ AwsSupportingServiceMetric

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

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

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

  • AVERAGE
  • AVG_MIN_MAX
  • MAXIMUM
  • MINIMUM
  • SAMPLE_COUNT
  • SUM
размеры строка [] Список имен параметров метрики.

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

{
  "metadata": {
    "configurationVersions": [
      4,
      2
    ],
    "currentConfigurationVersions": [
      "1.0.4",
      "1.23"
    ],
    "clusterVersion": "1.192.1"
  },
  "id": "string",
  "connectionStatus": "CONNECTED",
  "label": "string",
  "partitionType": "AWS_CN",
  "authenticationData": {
    "type": "KEYS",
    "keyBasedAuthentication": {
      "accessKey": "string",
      "secretKey": "string"
    },
    "roleBasedAuthentication": {
      "iamRole": "string",
      "accountId": "string",
      "externalId": "string"
    }
  },
  "taggedOnly": true,
  "tagsToMonitor": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "supportingServicesToMonitor": [
    {
      "name": "string",
      "monitoredMetrics": [
        {
          "name": "string",
          "statistic": "AVERAGE",
          "dimensions": [
            "string"
          ]
        }
      ]
    }
  ]
}
Источник — https://doc.ruscomtech.ru/index.php?title=API_учётных_данных_AWS_-_GET_учётные_данные&oldid=2597