describe-service-deployments

Описание

Описывает одну или несколько ваших развертываний сервисов.

Развертывание сервиса происходит при выпуске обновления программного обеспечения для сервиса. Дополнительную информацию см. в разделе Просмотр истории сервиса с помощью развертываний сервиса Amazon ECS.

См. также: Документация API AWS

Синтаксис

  describe-service-deployments
--service-deployment-arns <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--service-deployment-arns (список)

ARN развертывания сервиса.

Вы можете указать не более 20 ARN.

(строка)

Синтаксис:

"string" "string" ...

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставляемому --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения, используя значение, предоставленное в JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. При отсутствии значения или значении input выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример YAML-ввода, который можно использовать с --cli-input-yaml. При указании значения output он проверит входные данные команды и вернёт JSON-выход для данной команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в генерируемом JSON-скелете.

Общие параметры

--debug (булево)

Включить отладовую запись журнала.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (булево)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команд.

json
текст
таблица
yaml
yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

вкл
выкл
авто

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (строка)

Файл сертификата CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной строкой base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для конфигурированного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (булево)

Отключить кли-пэджер для вывода.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запросы параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной среды. См. Использование кавычек со строками в руководстве пользователя AWS CLI.

Для описания деталей развертывания сервиса

Следующий describe-service-deployments пример возвращает детали развертывания сервиса для развертывания сервиса с ARN arn:aws:ecs:us-east-1:123456789012:service-deployment/example-cluster/example-service/ejGvqq2ilnbKT9qj0vLJe.

aws ecs describe-service-deployments \
    --service-deployment-arn arn:aws:ecs:us-east-1:123456789012:service-deployment/example-cluster/example-service/ejGvqq2ilnbKT9qj0vLJe

Вывод:

{
    "serviceDeployments": [
        {
            "serviceDeploymentArn": "arn:aws:ecs:us-east-1:123456789012:service-deployment/example-cluster/example-service/ejGvqq2ilnbKT9qj0vLJe",
            "serviceArn": "arn:aws:ecs:us-east-1:123456789012:service/example-cluster/example-service",
            "clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/example-cluster",
            "createdAt": "2024-10-31T08:03:30.917000-04:00",
            "startedAt": "2024-10-31T08:03:32.510000-04:00",
            "finishedAt": "2024-10-31T08:05:04.527000-04:00",
            "updatedAt": "2024-10-31T08:05:04.527000-04:00",
            "sourceServiceRevisions": [],
            "targetServiceRevision": {
                "arn": "arn:aws:ecs:us-east-1:123456789012:service-revision/example-cluster/example-service/1485800978477494678",
                "requestedTaskCount": 1,
                "runningTaskCount": 1,
                "pendingTaskCount": 0
            },
            "status": "SUCCESSFUL",
            "deploymentConfiguration": {
                "deploymentCircuitBreaker": {
                    "enable": true,
                    "rollback": true
                },
                "maximumPercent": 200,
                "minimumHealthyPercent": 100,
                "alarms": {
                    "alarmNames": [],
                    "rollback": false,
                    "enable": false
                }
            },
            "deploymentCircuitBreaker": {
                "status": "MONITORING_COMPLETE",
                "failureCount": 0,
                "threshold": 3
            },
            "alarms": {
                "status": "DISABLED"
            }
        }
    ],
    "failures": []
}

Дополнительную информацию см. в разделе Просмотр истории сервиса с помощью развертываний сервиса Amazon ECS в руководстве разработчика Amazon ECS.

Вывод

serviceDeployments -> (список)

Список развертываний сервисов, описанных в документе.

(структура)

Информация о развертывании сервиса.

Развертывания сервисов предоставляют исчерпывающий обзор ваших развертываний. Для получения информации о развертываниях сервисов см. раздел «Просмотр истории сервиса с помощью развертываний сервиса Amazon ECS» в * Руководстве разработчика Amazon Elastic Container Service *.

serviceDeploymentArn -> (строка)

Идентификатор ресурса (ARN) развертывания сервиса.

serviceArn -> (строка)

Идентификатор ресурса (ARN) сервиса для данного развертывания сервиса.

clusterArn -> (строка)

Идентификатор ресурса (ARN) кластера, в котором размещен сервис.

createdAt -> (метка времени)

Время создания развертывания сервиса. Формат: ГГГГ-ММ-ДД ЧЧ:ММ:СС.SSSSSS.

startedAt -> (метка времени)

Время начала развертывания сервиса. Формат: ГГГГ-ММ-ДД ЧЧ:ММ:СС.SSSSSS.

finishedAt -> (метка времени)

Время завершения развертывания сервиса. Формат: ГГГГ-ММ-ДД ЧЧ:ММ:СС.SSSSSS.

stoppedAt -> (метка времени)

Время остановки развертывания сервиса. Формат: ГГГГ-ММ-ДД ЧЧ:ММ:СС.SSSSSS.

Развертывание сервиса останавливается, когда происходит любое из следующих действий:

Пользователь вручную останавливает развертывание
Опция отката не используется для механизма обнаружения сбоев (разрыва цепи или на основе тревог), и сервис терпит неудачу.

updatedAt -> (метка времени)

Время последнего обновления развертывания сервиса. Формат: ГГГГ-ММ-ДД ЧЧ:ММ:СС.SSSSSS.

sourceServiceRevisions -> (список)

Текущая конфигурация развертываемой рабочей нагрузки.

(структура)

Информация о количестве запрошенных, ожидающих и выполняемых задач для ревизии сервиса.

arn -> (строка)

Идентификатор ресурса (ARN) ревизии сервиса.

requestedTaskCount -> (целое число)

Количество запрошенных задач для ревизии сервиса.

runningTaskCount -> (целое число)

Количество выполняемых задач для ревизии сервиса.

pendingTaskCount -> (целое число)

Количество ожидающих задач для ревизии сервиса.

targetServiceRevision -> (структура)

Конфигурация рабочей нагрузки, которая развертывается.

arn -> (строка)

Идентификатор ресурса (ARN) ревизии сервиса.

requestedTaskCount -> (целое число)

Количество запрошенных задач для ревизии сервиса.

runningTaskCount -> (целое число)

Количество выполняемых задач для ревизии сервиса.

pendingTaskCount -> (целое число)

Количество ожидающих задач для ревизии сервиса.

status -> (строка)

Состояние развертывания сервиса.

statusReason -> (строка)

Информация о причинах, по которым развертывание сервиса находится в текущем состоянии. Например, разрыв цепи обнаружил сбой.

deploymentConfiguration -> (структура)

Необязательные параметры развертывания, которые управляют количеством задач, выполняемых во время развертывания, и порядком остановки и запуска задач.

deploymentCircuitBreaker -> (структура)

Примечание

Разрыв цепи развертывания можно использовать только для сервисов, использующих тип развертывания с постепенным обновлением (ECS).

Разрыв цепи развертывания определяет, произойдет ли сбой развертывания сервиса, если сервис не может достичь стабильного состояния. Если вы используете разрыв цепи развертывания, развертывание сервиса перейдет в состояние ошибки и прекратит запуск новых задач. Если вы используете опцию отката, при сбое развертывания сервиса сервис откатывается до последнего развертывания, которое завершилось успешно. Дополнительную информацию см. в разделе «Постепенное обновление» в Руководстве разработчика Amazon Elastic Container Service

enable -> (логическое значение)

Определяет, следует ли использовать логику разрыва цепи развертывания для сервиса.

rollback -> (логическое значение)

Определяет, следует ли настроить Amazon ECS на откат сервиса в случае сбоя развертывания сервиса. Если откат включен, при сбое развертывания сервиса сервис откатывается до последнего развертывания, которое завершилось успешно.

maximumPercent -> (целое число)

Если сервис использует тип развертывания с постепенным обновлением (ECS), параметр maximumPercent представляет собой верхний предел количества задач вашего сервиса, которые допускаются в состоянии RUNNING или PENDING во время развертывания, в процентах от desiredCount (округленное вниз до ближайшего целого числа). Этот параметр позволяет определить размер пакета развертывания. Например, если ваш сервис использует планировщик сервисов REPLICA и имеет desiredCount четыре задачи и значение maximumPercent 200%, планировщик может запустить четыре новые задачи перед остановкой четырех старых задач (при условии, что доступны необходимые ресурсы кластера). Значение по умолчанию maximumPercent для сервиса, использующего планировщик сервисов REPLICA, равно 200%.

Планировщик Amazon ECS использует этот параметр для замены неисправных задач, сначала запуская задачи-заменители, а затем останавливая неисправные задачи, если ресурсы кластера для запуска задач-заменителей доступны. Дополнительную информацию о том, как планировщик заменяет неисправные задачи, см. в разделе «Сервисы Amazon ECS».

Если сервис использует типы развертывания «синий/зеленый» (CODE_DEPLOY) или EXTERNAL, и задачи в сервисе используют тип запуска EC2, значение **максимального процента** устанавливается по умолчанию. Значение **максимального процента** используется для определения верхнего предела количества задач в сервисе, которые остаются в состоянии RUNNING, в то время как экземпляры контейнеров находятся в состоянии DRAINING.

Примечание

Вы не можете указать пользовательское значение maximumPercent для сервиса, использующего типы развертывания «синий/зеленый» (CODE_DEPLOY) или EXTERNAL и имеющего задачи, которые используют тип запуска EC2.

Если сервис использует типы развертывания «синий/зеленый» (CODE_DEPLOY) или EXTERNAL, и задачи в сервисе используют тип запуска Fargate, значение максимального процента не используется. Значение все равно возвращается при описании вашего сервиса.

minimumHealthyPercent -> (целое число)

Если сервис использует тип развертывания с постепенным обновлением (ECS), minimumHealthyPercent представляет собой нижний предел количества задач вашего сервиса, которые должны оставаться в состоянии RUNNING во время развертывания, в процентах от desiredCount (округленное вверх до ближайшего целого числа). Этот параметр позволяет развернуть сервис без использования дополнительных ресурсов кластера. Например, если ваш сервис имеет desiredCount четыре задачи и значение minimumHealthyPercent 50%, планировщик сервиса может остановить две существующие задачи, чтобы освободить ресурсы кластера перед запуском двух новых задач.

Если какие-либо задачи неисправны, и если maximumPercent не позволяет планировщику Amazon ECS запускать задачи-заменители, планировщик останавливает неисправные задачи по одной — используя minimumHealthyPercent в качестве ограничения — чтобы освободить ресурсы для запуска задач-заменителей. Дополнительную информацию о том, как планировщик заменяет неисправные задачи, см. в разделе «Сервисы Amazon ECS».

Для сервисов, не использующих балансировщик нагрузки, следует отметить следующее:

Сервис считается работоспособным, если все основные контейнеры в задачах сервиса проходят проверки работоспособности.
Если у задачи нет основных контейнеров с определенными проверками работоспособности, планировщик сервиса будет ждать 40 секунд после того, как задача перейдет в состояние RUNNING, прежде чем задача будет учитываться в общей сумме минимального процента работоспособных задач.
Если у задачи есть один или несколько основных контейнеров с определенными проверками работоспособности, планировщик сервиса будет ждать, пока задача не достигнет работоспособного состояния, прежде чем учитывать ее в общей сумме минимального процента работоспособных задач. Задача считается работоспособной, когда все основные контейнеры в задаче прошли проверки работоспособности. Время ожидания планировщика сервиса определяется настройками проверки работоспособности контейнера.

Для сервисов, использующих балансировщик нагрузки, следует отметить следующее:

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

Значение по умолчанию для сервиса-реплики для minimumHealthyPercent равно 100%. Значение по умолчанию minimumHealthyPercent для сервиса, использующего планировщик сервисов DAEMON, составляет 0% для командной строки, Amazon Web Services SDK и API и 50% для консоли управления Amazon Web Services.

Минимальное количество работоспособных задач во время развертывания равно desiredCount, умноженному на minimumHealthyPercent /100, округленному вверх до ближайшего целого значения.

Если сервис использует типы развертывания «синий/зеленый» (CODE_DEPLOY) или EXTERNAL и запускает задачи, которые используют тип запуска EC2, значение **минимального процента работоспособных задач** устанавливается по умолчанию. Значение **минимального процента работоспособных задач** используется для определения нижнего предела количества задач в сервисе, которые остаются в состоянии RUNNING, в то время как экземпляры контейнеров находятся в состоянии DRAINING.

Примечание

Вы не можете указать пользовательское значение minimumHealthyPercent для сервиса, использующего типы развертывания «синий/зеленый» (CODE_DEPLOY) или EXTERNAL и имеющего задачи, которые используют тип запуска EC2.

Если сервис использует типы развертывания «синий/зеленый» (CODE_DEPLOY) или EXTERNAL и запускает задачи, которые используют тип запуска Fargate, значение минимального процента работоспособности не используется, хотя оно возвращается при описании вашего сервиса.

alarms -> (структура)

Информация о CloudWatch тревогах.

alarmNames -> (список)

Одно или несколько имен тревог CloudWatch. Используйте «,» для разделения тревог.

(строка)

rollback -> (логическое значение)

Определяет, следует ли настроить Amazon ECS на откат сервиса в случае сбоя развертывания сервиса. Если откат используется, при сбое развертывания сервиса сервис откатывается до последнего развертывания, которое завершилось успешно.

enable -> (логическое значение)

Определяет, следует ли использовать опцию CloudWatch тревоги в процессе развертывания сервиса.

rollback -> (структура)

Варианты отката, используемые развертыванием сервиса при сбое развертывания.

reason -> (строка)

Причина отката. Например, откат был инициирован защитой от отказов.

startedAt -> (метка времени)

Время начала отката. Формат: ГГГГ-ММ-ДД ЧЧ:мм:сс.СССССС.

serviceRevisionArn -> (строка)

ARN пересмотра сервиса, развернутого в рамках отката.

deploymentCircuitBreaker -> (структура)

Настройка защиты от отказов, определяющая сбой развертывания сервиса.

status -> (строка)

Статус защиты от отказов. Amazon ECS не использует защиту от отказов для сбоев развертывания сервисов, когда статус равен DISABLED.

failureCount -> (целое число)

Количество раз, когда защита от отказов обнаружила сбой развертывания сервиса.

threshold -> (целое число)

Порог, определяющий сбой развертывания сервиса.

Защита от отказов развертывания вычисляет значение порога, а затем использует его для определения того, когда развертывание необходимо перевести в состояние FAILED. Защита от отказов развертывания имеет минимальный порог 3 и максимальный порог 200. И использует значения в следующем выражении для определения сбоя развертывания.

0.5 * desired task count

alarms -> (структура)

Сигналы CloudWatch, определяющие сбой развертывания сервиса.

status -> (строка)

Статус проверки сигналов. Amazon ECS не использует сигналы для сбоев развертывания сервисов, когда статус равен DISABLED.

alarmNames -> (список)

Имя сигналов CloudWatch, определяющих сбой развертывания сервиса. Сигналы разделены запятыми.

(строка)

triggeredAlarmNames -> (список)

Одно или несколько имен сигналов CloudWatch, которые были сработаны во время развертывания сервиса. Имена сигналов разделены запятыми.

(строка)

failures -> (список)

Любые сбои, связанные с вызовом.

Если вы описываете развертывание с пересмотром сервиса, созданным до 25 октября 2024 года, вызов завершается сбоем. Сбой включает в себя ARN пересмотра сервиса и причину, установленную в значение MISSING.

(структура)

Неудачный ресурс. Список распространенных причин см. в разделе «Причины ошибок API» в Руководстве разработчика Amazon Elastic Container Service.

arn -> (строка)

Amazon Resource Name (ARN) неудачного ресурса.

reason -> (строка)

Причина сбоя.

detail -> (строка)

Подробности сбоя.

END_OF_DOCUMENT_MARKER