Spec-Zone.ru › AWS CLI v2

[ aws . ecs ]

list-service-deployments

Описание

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

Развертывание сервиса происходит при выпуске обновления программного обеспечения для сервиса. Вы перенаправляете трафик от текущих ревизий сервиса к новым ревизиям сервиса и контролируете количество запущенных задач.

Этот API возвращает значения, используемые для параметров запроса в DescribeServiceRevisions.

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

Синтаксис

  list-service-deployments
--service <value>
[--cluster <value>]
[--status <value>]
[--created-at <value>]
[--next-token <value>]
[--max-results <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 (строка)

ARN или имя сервиса

--cluster (строка)

Кластер, на котором размещен сервис. Это может быть имя кластера или ARN. Начиная с 15 апреля 2023 года, Amazon Web Services не будет принимать новых клиентов в Amazon Elastic Inference (EI) и поможет существующим клиентам перенести свои рабочие нагрузки на варианты, которые предлагают лучшую цену и производительность. Если вы не укажете кластер, используется default.

--status (список)

Необязательный фильтр для сужения результатов. Если вы не укажете статус, все значения статуса будут включены в результат.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  PENDING
  SUCCESSFUL
  STOPPED
  STOP_REQUESTED
  IN_PROGRESS
  ROLLBACK_REQUESTED
  ROLLBACK_IN_PROGRESS
  ROLLBACK_SUCCESSFUL
  ROLLBACK_FAILED

--created-at (структура)

Необязательный фильтр для сужения результатов по дате создания сервиса. Если вы не укажете значение, результат включает все сервисы, созданные до текущего времени. Формат - yyyy-MM-dd HH:mm:ss.SSSSSS.

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

Включает развертывания сервиса в результат, созданные до этого времени. Формат - yyyy-MM-dd HH:mm:ss.SSSSSS.

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

Включает развертывания сервиса в результат, созданные после этого времени. Формат - yyyy-MM-dd HH:mm:ss.SSSSSS.

Сокращенный синтаксис:

before=timestamp,after=timestamp

Синтаксис JSON:

{
  "before": timestamp,
  "after": timestamp
}

--next-token (строка)

Значение nextToken, возвращенное запросом ListServiceDeployments, указывающее на то, что для выполнения запроса доступно больше результатов, и требуются дополнительные вызовы. Если вы указали maxResults, возможно, количество результатов меньше maxResults.

--max-results (целое число)

Максимальное количество результатов развертывания сервиса, которое ListServiceDeployments вернул в результатах постраничного вывода. Когда этот параметр используется, ListServiceDeployments возвращает только maxResults результатов на одной странице вместе с элементом ответа nextToken. Остальные результаты исходного запроса можно увидеть, отправив другой запрос ListServiceDeployments со значением nextToken, возвращенным в предыдущем запросе. Это значение может быть от 1 до 100. Если этот параметр не используется, то ListServiceDeployments возвращает до 20 результатов и значение nextToken, если применимо.

--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 в Руководстве пользователя AWS CLI.

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

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

Следующий пример получает развертывания сервисов для сервиса с именем example-service.

aws ecs list-service-deployments \
    --service arn:aws:ecs:us-east-1:123456789012:service/example-cluster/example-service

Вывод:

{
    "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",
            "startedAt": "2024-10-31T08:03:32.510000-04:00",
            "createdAt": "2024-10-31T08:03:30.917000-04:00",
            "finishedAt": "2024-10-31T08:05:04.527000-04:00",
            "targetServiceRevisionArn": "arn:aws:ecs:us-east-1:123456789012:service-revision/example-cluster/example-service/1485800978477494678",
            "status": "SUCCESSFUL"
        }
    ]
}

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

Вывод

serviceDeployments -> (список)

Обзор развертывания сервиса, включая следующие свойства:

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

(структура)

Свойства развертывания сервиса, возвращаемые при вызове ListServiceDeployments.

Это предоставляет общий обзор развертывания сервиса.

serviceDeploymentArn -> (строка)

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

serviceArn -> (строка)

ARN сервиса для данного развертывания сервиса.

clusterArn -> (строка)

ARN кластера, на котором размещен сервис.

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

Время начала развертывания сервиса. Формат - yyyy-MM-dd HH:mm:ss.SSSSSS.

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

Время создания развертывания сервиса. Формат - yyyy-MM-dd HH:mm:ss.SSSSSS.

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

Время завершения развертывания сервиса. Формат - yyyy-MM-dd HH:mm:ss.SSSSSS.

targetServiceRevisionArn -> (строка)

ARN ревизии сервиса, подлежащей развертыванию.

status -> (строка)

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

statusReason -> (строка)

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

nextToken -> (строка)

Значение nextToken для включения в будущий запрос ListServiceDeployments. Когда результаты запроса ListServiceDeployments превышают maxResults, это значение можно использовать для получения следующей страницы результатов. Это значение равно null, когда больше результатов возвращать не нужно.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API