API учётных данных AWS - POST новые учётные данные
Создает новую конфигурацию учетных данных AWS. Проверьте состояние подключения для этих учетных данных через 10 минут с запросом GET учетные данные .
Тело не должно предоставлять идентификатор. Сервер Ключ-АСТРОМ автоматически присваивает идентификатор.
Запрос использует и создает в качестве полезной нагрузки application/json
формат.
POST | Ключ-АСТРОМ Managed для управления | https://{your-domain}/e/{your-environment-id}/api/config/v1/aws/credentials
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/aws/credentials
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. WriteConfig
Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
body | AwsCredentialsConfig | Тело JSON запроса. Содержит параметры новой конфигурации учетных данных AWS. | body | необязательный |
Объекты тела запроса
Объект AwsCredentialsConfig
Конфигурация учетных данных AWS.
Элемент | Тип | Описание | Необходимость |
---|---|---|---|
metadata | ConfigurationMetadata | Метаданные, полезные для отладки | необязательный |
id | string | Уникальный идентификатор учетных данных. | необязательный |
connectionStatus | string | Состояние подключения к среде AWS.
Элемент может содержать эти значения
|
необязательный |
label | string | Имя учетных данных. | необходимый |
partitionType | string | Тип раздела AWS.
Элемент может содержать эти значения
|
необходимый |
authenticationData | AwsAuthenticationData | Учетные данные для аутентификации AWS. | необходимый |
taggedOnly | boolean | Отслеживайте только ресурсы с указанными тегами AWS ( true ) или все ресурсы ( false ).
|
необходимый |
tagsToMonitor | AwsConfigTag[] | Список тегов AWS для мониторинга.
Вы можете указать до 10 тегов. Применимо, только если для параметра taggedOnly установлено значение |
необходимый |
supportingServicesToMonitor | AwsSupportingServiceConfig[] | Устарело . Для управления сервисами используйте операцию /aws/credentials/{id}/services . Встроенные сервисы здесь не поддерживаются.
Список сервисов AWS, которые нужно отслеживать. Доступные службы перечислены в операции /aws/supportedServices . Для каждого сервиса можно указать список метрик и измерений. Список поддерживаемых метрик и измерений для данного сервиса можно посмотреть в документации . Список метрик можно пропустить (установить значение null), в результате чего для мониторинга будет выбран рекомендуемый (по умолчанию) набор метрик и параметров. |
необязательный |
Объект ConfigurationMetadata
Метаданные, полезные для отладки
Элемент | Тип | Описание | Необходимость |
---|---|---|---|
configurationVersions | integer[] | Отсортированный список номеров версий конфигурации. | необязательный |
currentConfigurationVersions | string[] | Отсортированный список номеров версий конфигурации. | необязательный |
clusterVersion | string | Версия Ключ-АСТРОМ. | необязательный |
Объект AwsAuthenticationData
Учетные данные для аутентификации AWS.
Элемент | Тип | Описание | Необходимость |
---|---|---|---|
type | string | Тип аутентификации: на основе ролей или на основе ключей.
Элемент может содержать эти значения
|
необходимый |
keyBasedAuthentication | KeyBasedAuthentication | Учетные данные для аутентификации на основе ключей. | необязательный |
roleBasedAuthentication | RoleBasedAuthentication | Учетные данные для аутентификации на основе ролей. | необязательный |
Объект KeyBasedAuthentication
Учетные данные для аутентификации на основе ключей.
Элемент | Тип | Описание | Необходимость |
---|---|---|---|
accessKey | string | Идентификатор ключа доступа. | необходимый |
secretKey | string | Секретный ключ доступа. | необходимый |
Объект RoleBasedAuthentication
Учетные данные для аутентификации на основе ролей.
Элемент | Тип | Описание | Необходимость |
---|---|---|---|
iamRole | string | Роль IAM, которую Ключ-АСТРОМ будет использовать для получения данных мониторинга. | необходимый |
accountId | string | Идентификатор учетной записи Amazon. | необходимый |
externalId | string | Токен внешнего идентификатора для настройки роли IAM.
Вы можете получить его с |
необязательный |
Объект AwsConfigTag
Тег AWS ресурса, за которым нужно следить.
Элемент | Тип | Описание | Необходимость |
---|---|---|---|
name | string | Ключ тега AWS. | необходимый |
value | string | Значение тега AWS. | необходимый |
Объект AwsSupportingServiceConfig
Сервис, за которым нужно следить.
Элемент | Тип | Описание | Необходимость |
---|---|---|---|
name | string | Название службы. Действительные имена поддерживаемых сервисов можно узнать с помощью /aws/supportedServices restAPI. | необходимый |
monitoredMetrics | AWS Supporting Service Metric [] | Список метрик, которые нужно отслеживать для этой службы. Если список пуст, то будет отслеживаться рекомендуемый список метрик для этой службы. | необязательный |
Объект AwsSupportingServiceMetric
Метрика обслуживания, которую нужно отслеживать.
Элемент | Тип | Описание | Необходимость |
---|---|---|---|
name | string | Имя метрики сервиса. | необходимый |
statistic | string | Статистика (агрегация), которая будет использоваться для метрики. Значение AVG_MIN_MAX — это сразу 3 статистики: AVERAGE, MINIMUM и MAXIMUM.
Элемент может содержать эти значения
|
необходимый |
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"
]
}
]
}
]
}
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
201 | EntityShortRepresentation | Успех. Создана новая конфигурация учетных данных AWS. Тело ответа содержит идентификатор конфигурации.
Проверьте состояние подключения для этих учетных данных через 10 минут с |
400 | ErrorEnvelope | Неуспешно. Ввод недействителен. |
Объекты тела ответа
Объект EntityShortRepresentation
Краткое представление объекта Ключ-АСТРОМ.
Элемент | Тип | Описание |
---|---|---|
id | string | Идентификатор объекта Ключ-АСТРОМ. |
name | string | Имя объекта Ключ-АСТРОМ. |
description | string | Краткое описание объекта Ключ-АСТРОМ. |
JSON-модель тела ответа
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Astromkey entity",
"description": "Astromkey entity for the REST API example"
}
GET токен внешнего идентификатора
Получает токен внешнего идентификатора для настройки роли IAM.
Запрос создает в качестве полезной нагрузки application/json
формат.
GET | Ключ-АСТРОМ Managed для управления | https://{your-domain}/e/{your-environment-id}/api/config/v1/aws/iamExternalId
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/aws/iamExternalId
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. ReadConfig
Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | AwsIamToken | Успех |
Объекты тела ответа
Объект AwsIamToken
Токен внешнего идентификатора для настройки роли IAM в AWS.
Элемент | Тип | Описание |
---|---|---|
token | string | Токен внешнего идентификатора для настройки роли IAM в AWS. |
JSON-модель тела ответа
{
"token": "string"
}
Проверка полезной нагрузки
Мы рекомендуем вам проверить полезную нагрузку перед ее отправкой с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.
Запрос использует в качестве полезной нагрузки application/json
формат.
POST | Ключ-АСТРОМ Managed для управления | https://{your-domain}/e/{your-environment-id}/api/config/v1/aws/credentials/validator
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/aws/credentials/validator
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. WriteConfig
Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
204 | Подтверждено. Представленная конфигурация действительна. Ответ не имеет тела. | |
400 | ErrorEnvelope | Неуспешно. Ввод недействителен. |