proton

Описание

Это справочник по API сервиса Proton. Он содержит описания, синтаксис и примеры использования каждого из действий и типов данных для сервиса Proton.

Документация по каждому действию отображает параметры запроса API и XML-ответ.

В качестве альтернативы вы можете использовать командную строку Amazon Web Services CLI для доступа к API. Дополнительную информацию можно найти в руководстве пользователя Amazon Web Services Command Line Interface.

Сервис Proton представляет собой двухстороннюю автоматизированную платформу. Администраторы создают шаблоны сервисов, чтобы предоставить стандартизированную инфраструктуру и инструменты развертывания для серверных и контейнерных приложений. Разработчики, в свою очередь, выбирают из доступных шаблонов сервисов для автоматизации развертывания своих приложений или служб.

Так как администраторы определяют инфраструктуру и инструменты, которые Proton развертывает и управляет, им необходимы разрешения для использования всех перечисленных операций API.

Когда разработчики выбирают определенный набор инфраструктуры и инструментов, Proton развертывает их приложения. Для мониторинга своих приложений, работающих на Proton, разработчикам необходимы разрешения на операции API для создания, списка, обновления и удаления сервисов, а также для списка и обновления экземпляров сервиса.

Чтобы узнать больше о Proton, ознакомьтесь с руководством пользователя Proton.

При выполнении запроса API, изменяющего данные, запрос обычно возвращает результат до завершения асинхронных рабочих процессов операции. Операции также могут выйти за пределы времени ожидания или столкнуться с другими проблемами на сервере до завершения, даже если запрос уже вернул результат. Это может затруднить определение успешности запроса. Более того, может потребоваться многократная повторная попытка запроса, чтобы убедиться в успешном завершении операции. Однако, если исходный запрос и последующие повторные попытки будут успешными, операция выполнится несколько раз. Это означает, что вы можете создать больше ресурсов, чем планировали.

Ниже приведены списки API, сгруппированные по методам, обеспечивающим идемпотентность.

Действия API в этом списке поддерживают идемпотентность с использованием маркера клиента. Соответствующие команды Amazon Web Services CLI также поддерживают идемпотентность с использованием маркера клиента. Маркер клиента — это уникальная, регистрозависимая строка длиной до 64 ASCII-символов. Для выполнения идемпотентного запроса API с помощью одного из этих действий укажите маркер клиента в запросе. Рекомендуется не повторно использовать один и тот же маркер клиента для других запросов API. Если вы не предоставите маркер клиента для этих API, маркер клиента по умолчанию будет автоматически предоставлен SDK.

Учитывая, что действие запроса успешно завершилось:

Если вы повторите запрос с использованием того же маркера клиента и тех же параметров, повторная попытка завершится успешно без выполнения каких-либо дополнительных действий, кроме возвращения исходных данных ресурса в ответе.

Если вы повторите запрос с использованием того же маркера клиента, но один или несколько параметров отличаются, повторная попытка выбросит ValidationException с ошибкой IdempotentParameterMismatch.

Маркеры клиентов истекают через восемь часов после отправки запроса. Если вы повторите запрос с истекшим маркером, будет создан новый ресурс.

Если исходный ресурс удален, и вы повторите запрос, будет создан новый ресурс.

Идемпотентные операции создания с маркером клиента:

• CreateEnvironmentTemplateVersion
• CreateServiceTemplateVersion
• CreateEnvironmentAccountConnection

Учитывая, что действие запроса успешно завершилось:

Если вы повторите запрос с API из этой группы, а исходный ресурс не был изменен, повторная попытка завершится успешно без выполнения каких-либо дополнительных действий, кроме возвращения исходных данных ресурса в ответе.

Если исходный ресурс был изменен, повторная попытка выбросит ConflictException.

Если вы повторите запрос с другими входными параметрами, повторная попытка выбросит ValidationException с ошибкой IdempotentParameterMismatch.

Идемпотентные операции создания:

• CreateEnvironmentTemplate
• CreateServiceTemplate
• CreateEnvironment
• CreateService

Учитывая, что действие запроса успешно завершилось:

При повторной попытке запроса с API из этой группы и если ресурс был удален, его метаданные будут возвращены в ответе.

Если вы повторите попытку, и ресурс не существует, ответ будет пустым.

В обоих случаях повторная попытка будет успешной.

Идемпотентные операции удаления:

• DeleteEnvironmentTemplate
• DeleteEnvironmentTemplateVersion
• DeleteServiceTemplate
• DeleteServiceTemplateVersion
• DeleteEnvironmentAccountConnection

Учитывая, что действие запроса успешно завершилось:

Если вы повторите запрос с API из этой группы, если статус исходной операции удаления запроса равен DELETE_IN_PROGRESS, повторная попытка вернёт данные ресурса в ответ без выполнения каких-либо дополнительных действий.

Если исходная операция удаления завершена, повторная попытка вернёт пустой ответ.

Асинхронные идемпотентные операции удаления:

• DeleteEnvironment
• DeleteService

Доступные команды