API учётных данных AWS - GET учётные данные: различия между версиями
ENetrebin (обсуждение | вклад) |
ENetrebin (обсуждение | вклад) |
||
(не показаны 2 промежуточные версии этого же участника) | |||
Строка 53: | Строка 53: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |metadata | ||
| | |ConfigurationMetadata | ||
|Метаданные, полезные для отладки | |Метаданные, полезные для отладки | ||
|- | |- | ||
| | |id | ||
| | |string | ||
|Уникальный идентификатор учетных данных. | |Уникальный идентификатор учетных данных. | ||
|- | |- | ||
| | |connectionStatus | ||
| | |string | ||
|Состояние подключения к среде AWS. | |Состояние подключения к среде AWS. | ||
Строка 75: | Строка 75: | ||
* <code>UNINITIALIZED</code> | * <code>UNINITIALIZED</code> | ||
|- | |- | ||
| | |label | ||
| | |string | ||
|Имя учетных данных. | |Имя учетных данных. | ||
|- | |- | ||
| | |partitionType | ||
| | |string | ||
|Тип раздела AWS. | |Тип раздела AWS. | ||
Строка 89: | Строка 89: | ||
* <code>AWS_US_GOV</code> | * <code>AWS_US_GOV</code> | ||
|- | |- | ||
| | |authenticationData | ||
| | |AwsAuthenticationData | ||
|Учетные данные для аутентификации AWS. | |Учетные данные для аутентификации AWS. | ||
|- | |- | ||
|taggedOnly | |taggedOnly | ||
| | |boolean | ||
|Отслеживайте только ресурсы с указанными тегами AWS ( <code>true</code>) или все ресурсы ( <code>false</code>). | |Отслеживайте только ресурсы с указанными тегами AWS ( <code>true</code>) или все ресурсы ( <code>false</code>). | ||
|- | |- | ||
| | |tagsToMonitor | ||
| | |AwsConfigTag[] | ||
|Список тегов AWS для мониторинга. | |Список тегов AWS для мониторинга. | ||
Строка 105: | Строка 105: | ||
Применимо, только если для параметра taggedOnly установлено значение <code>true</code>. | Применимо, только если для параметра taggedOnly установлено значение <code>true</code>. | ||
|- | |- | ||
| | |supportingServicesToMonitor | ||
| | |AwsSupportingServiceConfig[] | ||
|Устаревший . Для управления услугами используйте операцию /aws/credentials/{id}/services . Встроенные сервисы здесь не поддерживаются. | |Устаревший . Для управления услугами используйте операцию /aws/credentials/{id}/services . Встроенные сервисы здесь не поддерживаются. | ||
Строка 116: | Строка 116: | ||
|} | |} | ||
==== Объект | ==== Объект <code>ConfigurationMetadata</code> ==== | ||
Метаданные, полезные для отладки | Метаданные, полезные для отладки | ||
{| class="wikitable" | {| class="wikitable" | ||
Строка 123: | Строка 123: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |configurationVersions | ||
| | |integer[] | ||
|Отсортированный список номеров версий конфигурации. | |Отсортированный список номеров версий конфигурации. | ||
|- | |- | ||
| | |currentConfigurationVersions | ||
| | |string[] | ||
|Отсортированный список номеров версий конфигурации. | |Отсортированный список номеров версий конфигурации. | ||
|- | |- | ||
|clusterVersion | |clusterVersion | ||
| | |string | ||
|Версия | |Версия Ключ-АСТРОМ. | ||
|} | |} | ||
==== Объект | ==== Объект <code>AwsAuthenticationData</code> ==== | ||
Учетные данные для аутентификации AWS. | Учетные данные для аутентификации AWS. | ||
{| class="wikitable" | {| class="wikitable" | ||
Строка 143: | Строка 143: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |type | ||
| | |string | ||
|Тип аутентификации: на основе ролей или на основе ключей. | |Тип аутентификации: на основе ролей или на основе ключей. | ||
Строка 153: | Строка 153: | ||
|- | |- | ||
|keyBasedAuthentication | |keyBasedAuthentication | ||
| | |KeyBasedAuthentication | ||
|Учетные данные для аутентификации на основе ключей. | |Учетные данные для аутентификации на основе ключей. | ||
|- | |- | ||
| | |roleBasedAuthentication | ||
| | |RoleBasedAuthentication | ||
|Учетные данные для аутентификации на основе ролей. | |Учетные данные для аутентификации на основе ролей. | ||
|} | |} | ||
==== Объект | ==== Объект <code>KeyBasedAuthentication</code> ==== | ||
Учетные данные для аутентификации на основе ключей. | Учетные данные для аутентификации на основе ключей. | ||
{| class="wikitable" | {| class="wikitable" | ||
Строка 168: | Строка 168: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |accessKey | ||
| | |string | ||
|Идентификатор ключа доступа. | |Идентификатор ключа доступа. | ||
|- | |- | ||
| | |secretKey | ||
| | |string | ||
|Секретный ключ доступа. | |Секретный ключ доступа. | ||
|} | |} | ||
==== Объект | ==== Объект <code>RoleBasedAuthentication</code> ==== | ||
Учетные данные для аутентификации на основе ролей. | Учетные данные для аутентификации на основе ролей. | ||
{| class="wikitable" | {| class="wikitable" | ||
Строка 185: | Строка 185: | ||
|- | |- | ||
|iamRole | |iamRole | ||
| | |string | ||
|Роль IAM, которую Ключ-АСТРОМ будет использовать для получения данных мониторинга. | |Роль IAM, которую Ключ-АСТРОМ будет использовать для получения данных мониторинга. | ||
|- | |- | ||
| | |accountId | ||
| | |string | ||
|Идентификатор учетной записи Amazon. | |Идентификатор учетной записи Amazon. | ||
|- | |- | ||
| | |externalId | ||
| | |string | ||
|Токен внешнего идентификатора для настройки роли IAM. | |Токен внешнего идентификатора для настройки роли IAM. | ||
Строка 199: | Строка 199: | ||
|} | |} | ||
==== Объект | ==== Объект <code>AwsConfigTag</code> ==== | ||
Тег AWS ресурса, за которым нужно следить. | Тег AWS ресурса, за которым нужно следить. | ||
{| class="wikitable" | {| class="wikitable" | ||
Строка 206: | Строка 206: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |name | ||
| | |string | ||
|Ключ тега AWS. | |Ключ тега AWS. | ||
|- | |- | ||
| | |value | ||
| | |string | ||
|Значение тега AWS. | |Значение тега AWS. | ||
|} | |} | ||
==== Объект | ==== Объект <code>AwsSupportingServiceConfig</code> ==== | ||
Сервис, за которым нужно следить. | Сервис, за которым нужно следить. | ||
{| class="wikitable" | {| class="wikitable" | ||
Строка 222: | Строка 222: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |name | ||
| | |string | ||
|Название службы. Действительные имена поддерживаемых сервисов можно узнать с помощью /aws/supportedServices restAPI. | |Название службы. Действительные имена поддерживаемых сервисов можно узнать с помощью /aws/supportedServices restAPI. | ||
|- | |- | ||
| | |monitoredMetrics | ||
| | |AwsSupportingServiceMetric[] | ||
|Список метрик, которые нужно отслеживать для этой службы. Если список пуст, то будет отслеживаться рекомендуемый список метрик для этой службы. | |Список метрик, которые нужно отслеживать для этой службы. Если список пуст, то будет отслеживаться рекомендуемый список метрик для этой службы. | ||
|} | |} | ||
==== Объект | ==== Объект <code>AwsSupportingServiceMetric</code> ==== | ||
Метрика обслуживания, которую нужно отслеживать. | Метрика обслуживания, которую нужно отслеживать. | ||
{| class="wikitable" | {| class="wikitable" | ||
Строка 238: | Строка 238: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |name | ||
| | |string | ||
|Имя метрики сервиса. | |Имя метрики сервиса. | ||
|- | |- | ||
| | |statistic | ||
| | |string | ||
|Статистика (агрегация), которая будет использоваться для метрики. Значение AVG_MIN_MAX — это сразу 3 статистики: AVERAGE, MINIMUM и MAXIMUM. | |Статистика (агрегация), которая будет использоваться для метрики. Значение AVG_MIN_MAX — это сразу 3 статистики: AVERAGE, MINIMUM и MAXIMUM. | ||
Строка 255: | Строка 255: | ||
* <code>SUM</code> | * <code>SUM</code> | ||
|- | |- | ||
| | |dimensions | ||
| | |string [] | ||
|Список имен параметров метрики. | |Список имен параметров метрики. | ||
|} | |} |
Текущая версия на 15:38, 16 марта 2023
Получает конфигурацию указанных учетных данных AWS.
Запрос создает в качестве полезной нагрузки application/json
формат.
GET | Ключ-АСТРОМ Managed для управления | 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
Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
id | string | Идентификатор указанной конфигурации учетных данных AWS. | path | необходимый |
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | AwsCredentialsConfig | Успех |
Объекты тела ответа
Объект 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 | AwsSupportingServiceMetric[] | Список метрик, которые нужно отслеживать для этой службы. Если список пуст, то будет отслеживаться рекомендуемый список метрик для этой службы. |
Объект 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"
]
}
]
}
]
}