API учётных данных AWS - PUT учётные данные: различия между версиями

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


==== Объект _ <code>AwsAuthenticationData</code> ====
==== Объект <code>AwsAuthenticationData</code> ====
Учетные данные для аутентификации AWS.
Учетные данные для аутентификации AWS.
{| class="wikitable"
{| class="wikitable"
Строка 151: Строка 151:
!Тип
!Тип
!Описание
!Описание
!Необходимый
!Необходимость
|-
|-
|тип
|type
|нить
|string
|Тип аутентификации: на основе ролей или на основе ключей.
|Тип аутентификации: на основе ролей или на основе ключей.


Строка 164: Строка 164:
|-
|-
|keyBasedAuthentication
|keyBasedAuthentication
|Аутентификация на основе ключа
|KeyBasedAuthentication
|Учетные данные для аутентификации на основе ключей.
|Учетные данные для аутентификации на основе ключей.
|необязательный
|необязательный
|-
|-
|Аутентификация на основе ролей
|roleBasedAuthentication
|Аутентификация на основе ролей
|RoleBasedAuthentication
|Учетные данные для аутентификации на основе ролей.
|Учетные данные для аутентификации на основе ролей.
|необязательный
|необязательный
|}
|}


==== Объект _ <code>KeyBasedAuthentication</code> ====
==== Объект <code>KeyBasedAuthentication</code> ====
Учетные данные для аутентификации на основе ключей.
Учетные данные для аутентификации на основе ключей.
{| class="wikitable"
{| class="wikitable"
Строка 180: Строка 180:
!Тип
!Тип
!Описание
!Описание
!Необходимый
!Необходимость
|-
|-
|ключ доступа
|accessKey
|нить
|string
|Идентификатор ключа доступа.
|Идентификатор ключа доступа.
|необходимый
|необходимый
|-
|-
|Секретный ключ
|secretKey
|нить
|string
|Секретный ключ доступа.
|Секретный ключ доступа.
|необходимый
|необходимый
|}
|}


==== Объект _ <code>RoleBasedAuthentication</code> ====
==== Объект <code>RoleBasedAuthentication</code> ====
Учетные данные для аутентификации на основе ролей.
Учетные данные для аутентификации на основе ролей.
{| class="wikitable"
{| class="wikitable"
Строка 199: Строка 199:
!Тип
!Тип
!Описание
!Описание
!Необходимый
!Необходимость
|-
|-
|iamRole
|iamRole
|нить
|string
|Роль IAM, которую Ключ-АСТРОМ будет использовать для получения данных мониторинга.
|Роль IAM, которую Ключ-АСТРОМ будет использовать для получения данных мониторинга.
|необходимый
|необходимый
|-
|-
|идентификатор учетной записи
|accountId
|нить
|string
|Идентификатор учетной записи Amazon.
|Идентификатор учетной записи Amazon.
|необходимый
|необходимый
|-
|-
|внешний идентификатор
|externalId
|нить
|string
|Токен внешнего идентификатора для настройки роли IAM.
|Токен внешнего идентификатора для настройки роли IAM.


Строка 219: Строка 219:
|}
|}


==== Объект _ <code>AwsConfigTag</code> ====
==== Объект <code>AwsConfigTag</code> ====
Тег AWS ресурса, за которым нужно следить.
Тег AWS ресурса, за которым нужно следить.
{| class="wikitable"
{| class="wikitable"
Строка 225: Строка 225:
!Тип
!Тип
!Описание
!Описание
!Необходимый
!Необходимость
|-
|-
|имя
|name
|нить
|string
|Ключ тега AWS.
|Ключ тега AWS.
|необходимый
|необходимый
|-
|-
|ценить
|value
|нить
|string
|Значение тега AWS.
|Значение тега AWS.
|необходимый
|необходимый
|}
|}


==== Объект _ <code>AwsSupportingServiceConfig</code> ====
==== Объект <code>AwsSupportingServiceConfig</code> ====
Сервис, за которым нужно следить.
Служба, за которой нужно следить.
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
!Тип
!Тип
!Описание
!Описание
!Необходимый
!Необходимость
|-
|-
|имя
|name
|нить
|string
|Название службы. Действительные имена поддерживаемых сервисов можно узнать с помощью /aws/supportedServices restAPI.
|Название службы. Действительные имена поддерживаемых сервисов можно узнать с помощью /aws/supportedServices restAPI.
|необходимый
|необходимый
|-
|-
|мониторингМетрики
|monitoredMetrics
|AWS Supporting Service Metric []
|AwsSupportingServiceMetric[]
|Список метрик, которые нужно отслеживать для этой службы. Если список пуст, то будет отслеживаться рекомендуемый список метрик для этой службы.
|Список метрик, которые нужно отслеживать для этой службы. Если список пуст, то будет отслеживаться рекомендуемый список метрик для этой службы.
|необязательный
|необязательный
|}
|}


==== Объект _ <code>AwsSupportingServiceMetric</code> ====
==== Объект <code>AwsSupportingServiceMetric</code> ====
Метрика обслуживания, которую нужно отслеживать.
Метрика обслуживания, которую нужно отслеживать.
{| class="wikitable"
{| class="wikitable"
Строка 263: Строка 263:
!Тип
!Тип
!Описание
!Описание
!Необходимый
!Необходимость
|-
|-
|имя
|name
|нить
|string
|Имя метрики сервиса.
|Имя метрики сервиса.
|необходимый
|необходимый
|-
|-
|статистика
|statistic
|нить
|string
|Статистика (агрегация), которая будет использоваться для метрики. Значение AVG_MIN_MAX — это сразу 3 статистики: AVERAGE, MINIMUM и MAXIMUM.
|Статистика (агрегация), которая будет использоваться для метрики. Значение AVG_MIN_MAX — это сразу 3 статистики: AVERAGE, MINIMUM и MAXIMUM.


Строка 284: Строка 284:
|необходимый
|необходимый
|-
|-
|размеры
|dimensions
|строка []
|string[]
|Список имен параметров метрики.
|Список имен параметров метрики.
|необходимый
|необходимый
Строка 352: Строка 352:
|-
|-
|201
|201
|Краткое представление объекта
|EntityShortRepresentation
|Успех. Создана новая конфигурация учетных данных AWS. Тело ответа содержит идентификатор конфигурации.
|Успех. Создана новая конфигурация учетных данных AWS. Тело ответа содержит идентификатор конфигурации.


Строка 365: Строка 365:
|400
|400
|ErrorEnvelope
|ErrorEnvelope
|Неуспешный. Ввод недействителен.
|Неуспешно. Ввод недействителен.
|}
|}


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


==== Объект _ <code>EntityShortRepresentation</code> ====
==== Объект <code>EntityShortRepresentation</code> ====
Краткое представление объекта Ключ-АСТРОМ.
Краткое представление объекта Ключ-АСТРОМ.
{| class="wikitable"
{| class="wikitable"
Строка 377: Строка 377:
!Описание
!Описание
|-
|-
|идентификатор
|id
|нить
|string
|Идентификатор объекта Ключ-АСТРОМ.
|Идентификатор объекта Ключ-АСТРОМ.
|-
|-
|имя
|name
|нить
|string
|Имя объекта Ключ-АСТРОМ.
|Имя объекта Ключ-АСТРОМ.
|-
|-
|описание
|description
|нить
|string
|Краткое описание сущности Ключ-АСТРОМ.
|Краткое описание объекта Ключ-АСТРОМ.
|}
|}


Строка 400: Строка 400:
Получает токен внешнего идентификатора для настройки роли IAM.
Получает токен внешнего идентификатора для настройки роли IAM.


Запрос создает <code>application/json</code>полезную нагрузку.
Запрос создает в качестве полезной нагрузки <code>application/json</code>формат.
{| class="wikitable"
{| class="wikitable"
| rowspan="2" |GET
| rowspan="2" |GET
Строка 406: Строка 406:
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/aws/iamExternalId</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/aws/iamExternalId</nowiki></code>
|-
|-
|Среда ActiveGate
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/aws/iamExternalId</nowiki></code>
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/aws/iamExternalId</nowiki></code>
|}
|}
Строка 413: Строка 413:
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. <code>ReadConfig</code>
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. <code>ReadConfig</code>


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


=== Ответ ===
=== Ответ ===
Строка 424: Строка 424:
|-
|-
|200
|200
|Токен AWS IAM
|AwsIamToken
|Успех
|Успех
|}
|}
Строка 430: Строка 430:
=== Объекты тела ответа ===
=== Объекты тела ответа ===


==== Объект _ <code>AwsIamToken</code> ====
==== Объект <code>AwsIamToken</code> ====
Токен внешнего идентификатора для настройки роли IAM в AWS.
Токен внешнего идентификатора для настройки роли IAM в AWS.
{| class="wikitable"
{| class="wikitable"
Строка 437: Строка 437:
!Описание
!Описание
|-
|-
|жетон
|token
|нить
|strimg
|Токен внешнего идентификатора для настройки роли IAM в AWS.
|Токен внешнего идентификатора для настройки роли IAM в AWS.
|}
|}
Строка 447: Строка 447:
  }</code>
  }</code>


== Проверить полезную нагрузку ==
== Проверка полезной нагрузки ==
Мы рекомендуем вам проверить полезную нагрузку перед ее отправкой с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.
Мы рекомендуем вам проверить полезную нагрузку перед ее отправкой с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.


Запрос потребляет <code>application/json</code>полезную нагрузку.
Запрос использует в качестве полезной нагрузки <code>application/json</code>формат.
 
Запрос потребляет <code>application/json</code>полезную нагрузку.
{| class="wikitable"
{| class="wikitable"
| rowspan="3" |ПОЧТА
| rowspan="2" |POST
|УдалосьКлюч-АСТРОМ для правительства
|Ключ-АСТРОМ Managed  управления
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/aws/credentials/{id}/validator</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/config/v1/aws/credentials/{id}/validator</nowiki></code>
|-
|-
|SaaS
|Среда АктивногоШлюза
|<code><nowiki>https://{your-environment-id}.live.ruscomtech.ru/api/config/v1/aws/credentials/{id}/validator</nowiki></code>
|-
|Окружающая среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/aws/credentials/{id}/validator</nowiki></code>
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/aws/credentials/{id}/validator</nowiki></code>
|}
|}
Строка 468: Строка 463:
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. <code>WriteConfig</code>
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия. <code>WriteConfig</code>


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


=== Ответ ===
=== Ответ ===
Строка 484: Строка 479:
|400
|400
|ErrorEnvelope
|ErrorEnvelope
|Неуспешный. Ввод недействителен.
|Неуспешно. Ввод недействителен.
|}
|}

Текущая версия на 16:00, 16 марта 2023

Обновляет существующую конфигурацию учетных данных AWS. Проверьте состояние подключения для этих учетных данных через 10 минут с запросом учетных данных GET .

Если конфигурация учетных данных с указанным идентификатором не существует, создается новая конфигурация.

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

PUT Ключ-АСТРОМ 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}

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

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

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

Параметры

Параметр Тип Описание In Необходимость
id string Идентификатор конфигурации учетных данных AWS, которую необходимо обновить. path необходимый
body AwsCredentialsConfig Тело JSON запроса. Содержит обновленные параметры конфигурации учетных данных AWS. body необязательный

Объекты тела запроса

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

Ответ

Коды ответов

Код Тип Описание
201 EntityShortRepresentation Успех. Создана новая конфигурация учетных данных AWS. Тело ответа содержит идентификатор конфигурации.

Проверьте состояние подключения для этих учетных данных через 10 минут с GET /aws/credentials/{id}запросом.

204 Успех. Конфигурация учетных данных AWS обновлена. Ответ не имеет тела.

Проверьте состояние подключения для этих учетных данных через 10 минут с GET /aws/credentials/{id}запросом.

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 strimg Токен внешнего идентификатора для настройки роли IAM в AWS.

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

{
  "token": "string"
}

Проверка полезной нагрузки

Мы рекомендуем вам проверить полезную нагрузку перед ее отправкой с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.

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

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

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

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

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

Ответ

Коды ответов

Код Тип Описание
204 Подтверждено. Представленная конфигурация действительна. Ответ не имеет тела.
400 ErrorEnvelope Неуспешно. Ввод недействителен.
Источник — https://doc.ruscomtech.ru/index.php?title=API_учётных_данных_AWS_-_PUT_учётные_данные&oldid=2606