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

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

DELETE	Ключ-АСТРОМ для управления	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}

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

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

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

Параметры

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

Ответ

Коды ответов

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

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

Объект AwsCredentialsConfig

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

Элемент	Тип	Описание
metadata	ConfigurationMetadata	Метаданные, полезные для отладки
id	string	Уникальный идентификатор учетных данных.
connectionStatus	string	Состояние подключения к среде AWS. CONNECTED: Было соединение в течение последних 10 минут. DISCONNECTED: возникла проблема с установлением соединения с использованием этих учетных данных. Проверьте правильность данных. UNINITIALIZED: для этих учетных данных никогда не было установлено успешное соединение. Элемент может содержать эти значения CONNECTED DISCONNECTED UNINITIALIZED
label	string	Имя учетных данных.
partitionType	string	Тип раздела AWS. Элемент может содержать эти значения AWS_CN AWS_DEFAULT AWS_US_GOV
authenticationData	AwsAuthenticationData	Учетные данные для аутентификации AWS.
taggedOnly	boolean	Отслеживайте только ресурсы с указанными тегами AWS ( true) или все ресурсы ( false).
tagsToMonitor	AwsConfigTag[]	Список тегов AWS для мониторинга. Вы можете указать до 10 тегов. Применимо, только если для параметра taggedOnly установлено значение true.
supportingServicesToMonitor	AwsSupportingServiceConfig[]	Устарело : Для управления услугами используйте операцию /aws/credentials/{id}/services . Встроенные сервисы здесь не поддерживаются. Список сервисов AWS, которые нужно отслеживать. Доступные службы перечислены в операции /aws/supportedServices . Для каждой услуги можно указать список метрик и измерений. Список поддерживаемых метрик и измерений для данного сервиса можно посмотреть в документации . Список метрик можно пропустить (установить значение null), в результате чего для мониторинга будет выбран рекомендуемый (по умолчанию) набор метрик и параметров.

Объект ConfigurationMetadata

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

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

Объект AwsAuthenticationData

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

Элемент	Тип	Описание
type	string	Тип аутентификации: на основе ролей или на основе ключей. Элемент может содержать эти значения KEYS ROLE
keyBasedAuthentication	KeyBasedAuthentication	Учетные данные для аутентификации на основе ключей.
roleBasedAuthentication	RoleBasedAuthentication	Учетные данные для аутентификации на основе ролей.

Объект KeyBasedAuthentication

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

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

Объект RoleBasedAuthentication

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

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

Объект AwsConfigTag

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

Элемент	Тип	Описание
name	string	Ключ тега AWS.
value	string	Значение тега AWS.

Объект 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"
  },
  "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"
          ]
        }
      ]
    }
  ]
}

Формат ответа

Успешный запрос не возвращает никакого содержимого.