batch-get-deployment-groups
Описание
Получает информацию об одной или нескольких группах развертывания.
См. также: Документацию API AWS
Синтаксис
batch-get-deployment-groups
--application-name <value>
--deployment-group-names <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]
Параметры
--application-name (строка)
--deployment-group-names (список)
Имена групп развертывания.
(строка)
Синтаксис:
"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
- text
- table
- yaml
- yaml-stream
--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 для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запросы параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров вам необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования в стиле Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. Использование кавычек со строками в руководстве пользователя AWS CLI.
Для получения информации об одной или нескольких группах развертывания
Следующий batch-get-deployment-groups пример получает информацию о двух группах развертывания, связанных с указанным приложением CodeDeploy.
aws deploy batch-get-deployment-groups \
--application-name my-codedeploy-application \
--deployment-group-names "[\"my-deployment-group-1\",\"my-deployment-group-2\"]"
Вывод:
{
"deploymentGroupsInfo": [
{
"deploymentStyle": {
"deploymentOption": "WITHOUT_TRAFFIC_CONTROL",
"deploymentType": "IN_PLACE"
},
"autoRollbackConfiguration": {
"enabled": false
},
"onPremisesTagSet": {
"onPremisesTagSetList": []
},
"serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeployServiceRole",
"lastAttemptedDeployment": {
"endTime": 1556912366.415,
"status": "Failed",
"createTime": 1556912355.884,
"deploymentId": "d-A1B2C3111"
},
"autoScalingGroups": [],
"deploymentGroupName": "my-deployment-group-1",
"ec2TagSet": {
"ec2TagSetList": [
[
{
"Type": "KEY_AND_VALUE",
"Value": "my-EC2-instance",
"Key": "Name"
}
]
]
},
"deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111example",
"triggerConfigurations": [],
"applicationName": "my-codedeploy-application",
"computePlatform": "Server",
"deploymentConfigName": "CodeDeployDefault.AllAtOnce"
},
{
"deploymentStyle": {
"deploymentOption": "WITHOUT_TRAFFIC_CONTROL",
"deploymentType": "IN_PLACE"
},
"autoRollbackConfiguration": {
"enabled": false
},
"onPremisesTagSet": {
"onPremisesTagSetList": []
},
"serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeployServiceRole",
"autoScalingGroups": [],
"deploymentGroupName": "my-deployment-group-2",
"ec2TagSet": {
"ec2TagSetList": [
[
{
"Type": "KEY_AND_VALUE",
"Value": "my-EC2-instance",
"Key": "Name"
}
]
]
},
"deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-22222example",
"triggerConfigurations": [],
"applicationName": "my-codedeploy-application",
"computePlatform": "Server",
"deploymentConfigName": "CodeDeployDefault.AllAtOnce"
}
],
"errorMessage": ""
}
Для получения дополнительной информации, см. BatchGetDeploymentGroups в разделе Справочник по API AWS CodeDeploy.
Вывод
deploymentGroupsInfo -> (список)
Информация о группах развертывания.
(структура)
Информация о группе развертывания.
applicationName -> (строка)
deploymentGroupId -> (строка)
deploymentGroupName -> (строка)
deploymentConfigName -> (строка)
ec2TagFilters -> (список)
Теги Amazon EC2, по которым следует фильтровать. Группа развертывания включает экземпляры EC2 со всеми указанными тегами.
(структура)
Информация об одном фильтре тегов EC2.
Key -> (строка)
Value -> (строка)
Type -> (строка)
Тип фильтра тегов:
-
KEY_ONLY: Только ключ. -
VALUE_ONLY: Только значение. -
KEY_AND_VALUE: Ключ и значение.
onPremisesInstanceTagFilters -> (список)
Теги локальных экземпляров, по которым следует фильтровать. Группа развертывания включает локальные экземпляры со всеми указанными тегами.
(структура)
Информация об одном фильтре тегов локального экземпляра.
Key -> (строка)
Value -> (строка)
Type -> (строка)
Тип фильтра тегов локального экземпляра:
- KEY_ONLY: Только ключ.
- VALUE_ONLY: Только значение.
- KEY_AND_VALUE: Ключ и значение.
autoScalingGroups -> (список)
Список связанных групп Auto Scaling.
(структура)
Информация о группе Auto Scaling.
name -> (строка)
hook -> (строка)
Имя запускающего крючка, который CodeDeploy установил в группу Auto Scaling.
Дополнительная информация о запускающем крючке приведена в разделе Как Amazon EC2 Auto Scaling работает с CodeDeploy в руководстве пользователя CodeDeploy.
terminationHook -> (строка)
Имя крючка завершения, который CodeDeploy установил в группу Auto Scaling.
Дополнительная информация о крючке завершения приведена в разделе Включение развертываний при завершении во время событий масштабирования Auto Scaling в руководстве пользователя CodeDeploy.
serviceRoleArn -> (строка)
targetRevision -> (структура)
Информация о целевой ревизии группы развертывания, включая тип и расположение.
revisionType -> (строка)
Тип ревизии приложения:
- S3: Ревизия приложения, хранящаяся в Amazon S3.
- GitHub: Ревизия приложения, хранящаяся в GitHub (только развертывания на EC2/локальные).
- Строка: строка в формате YAML или JSON (только развертывания Lambda).
- AppSpecContent:
AppSpecContentобъект, содержащий содержимое файла AppSpec для развертывания Lambda или Amazon ECS. Содержимое отформатировано как JSON или YAML и хранится как RawString.
s3Location -> (структура)
Информация о расположении ревизии, хранящейся в Amazon S3.
bucket -> (строка)
key -> (строка)
bundleType -> (строка)
Тип файла ревизии приложения. Должен быть одним из следующих:
-
tar: Файл архива tar. -
tgz: Сжатый файл архива tar. -
zip: Файл архива zip. -
YAML: Файл в формате YAML. -
JSON: Файл в формате JSON.
version -> (строка)
Конкретная версия объекта Amazon S3, представляющего сгруппированные артефакты для ревизии приложения.
Если версия не указана, система по умолчанию использует последнюю версию.
eTag -> (строка)
ETag объекта Amazon S3, представляющего сгруппированные артефакты для ревизии приложения.
Если ETag не указан как входной параметр, проверка ETag объекта пропускается.
gitHubLocation -> (структура)
Информация о расположении артефактов приложения, хранящихся в GitHub.
repository -> (строка)
Пара аккаунта и репозитория GitHub, хранящая ссылку на коммит, который представляет сгруппированные артефакты для ревизии приложения.
Указывается как account/repository.
commitId -> (строка)
string -> (структура)
Информация о расположении ревизии развертывания Lambda, хранящейся как RawString.
content -> (строка)
sha256 -> (строка)
appSpecContent -> (структура)
Содержимое файла AppSpec для развертывания Lambda или Amazon ECS. Содержимое отформатировано как JSON или YAML и хранится как RawString.
content -> (строка)
Строка ревизии в формате YAML или JSON.
Для развертывания Lambda содержимое включает имя функции Lambda, псевдоним ее оригинальной версии и псевдоним ее заменяющей версии. Развертывание перенаправляет трафик с оригинальной версии функции Lambda на заменяющую версию.
Для развертывания Amazon ECS содержимое включает имя задачи, информацию о балансировщике нагрузки, который обслуживает трафик контейнеру, и многое другое.
Для обоих типов развертываний содержимое может указывать функции Lambda, которые выполняются в определенных крючках, таких как BeforeInstall, во время развертывания.
sha256 -> (строка)
triggerConfigurations -> (список)
Информация о триггерах, связанных с группой развертывания.
(структура)
Информация о триггерах уведомлений для группы развертывания.
triggerName -> (строка)
triggerTargetArn -> (строка)
triggerEvents -> (список)
Тип или типы событий, для которых активируются уведомления.
(строка)
alarmConfiguration -> (структура)
Список тревог, связанных с группой развертывания.
enabled -> (булево)
ignorePollAlarmFailure -> (булево)
Указывает, должно ли развертывание продолжаться, если информация о текущем состоянии тревог не может быть получена из Amazon CloudWatch. Значение по умолчанию — false.
-
true: Развертывание продолжается, даже если информация о состоянии тревоги не может быть получена из Amazon CloudWatch. -
false: Развертывание останавливается, если информация о состоянии тревоги не может быть получена из Amazon CloudWatch.
alarms -> (список)
Список тревог, настроенных для развертывания или группы развертывания. Максимальное количество тревог — 10.
(структура)
Информация об одной тревоге.
name -> (строка)
autoRollbackConfiguration -> (структура)
Информация об автоматической конфигурации отката, связанной с группой развертывания.
enabled -> (булево)
events -> (список)
Тип или типы событий, которые вызывают откат.
(строка)
deploymentStyle -> (структура)
Информация о типе развертывания (на месте или blue/green) и о том, нужно ли маршрутизировать трафик развертывания через балансировщик нагрузки.
deploymentType -> (строка)
deploymentOption -> (строка)
outdatedInstancesStrategy -> (строка)
Указывает, что происходит, когда новые экземпляры Amazon EC2 запускаются во время развертывания и не получают развернутую ревизию приложения.
Если этот параметр установлен на UPDATE или не указан, CodeDeploy запускает одно или несколько развертываний по обновлению устаревших экземпляров, чтобы применить развернутую ревизию приложения к новым экземплярам Amazon EC2.
Если этот параметр установлен на IGNORE, CodeDeploy не запускает развертывание для обновления новых экземпляров Amazon EC2. Это может привести к тому, что у экземпляров будут разные ревизии.
blueGreenDeploymentConfiguration -> (структура)
Информация о вариантах развертывания blue/green для группы развертывания.
terminateBlueInstancesOnDeploymentSuccess -> (структура)
Информация о том, нужно ли завершать работу экземпляров в исходном флоте во время развертывания blue/green.
действие -> (строка)
Действие, которое нужно выполнить с экземплярами в исходной среде после успешного развертывания blue/green.
-
TERMINATE: Экземпляры завершают работу после указанного времени ожидания. -
KEEP_ALIVE: Экземпляры остаются работающими после их от регистрации из балансировщика нагрузки и удаления из группы развертывания.
terminationWaitTimeInMinutes -> (целое число)
Для развертывания Amazon EC2, количество минут ожидания после успешного развертывания blue/green перед завершением работы экземпляров из исходной среды.
Для развертывания Amazon ECS, количество минут до удаления исходного (синего) набора задач. Во время развертывания Amazon ECS CodeDeploy переключает трафик с исходного (синего) набора задач на заменяющий (зелёный) набор задач.
Максимальное значение составляет 2880 минут (2 дня).
deploymentReadyOption -> (структура)
Информация о действии, которое нужно выполнить, когда новые экземпляры готовы принимать трафик при развертывании blue/green.
действиеПриВремяОжидания -> (строка)
Информация о том, когда перенаправить трафик из исходной среды в заменяющую среду при развертывании blue/green.
- CONTINUE_DEPLOYMENT: Немедленно зарегистрировать новые экземпляры в балансировщике нагрузки после установки новой версии приложения на экземпляры в заменяющей среде.
- STOP_DEPLOYMENT: Не регистрировать новые экземпляры в балансировщике нагрузки, пока перенаправление трафика не будет запущено с помощью ContinueDeployment . Если перенаправление трафика не будет запущено до окончания заданного периода ожидания, статус развертывания будет изменён на Stopped.
waitTimeInMinutes -> (целое число)
STOP_DEPLOYMENT для actionOnTimeout.greenFleetProvisioningOption -> (структура)
Информация о том, как экземпляры подготавливаются для заменяющей среды в развертывании blue/green.
действие -> (строка)
Метод добавления экземпляров в заменяющую среду.
-
DISCOVER_EXISTING: Использовать экземпляры, которые уже существуют или будут созданы вручную. -
COPY_AUTO_SCALING_GROUP: Использовать настройки из указанной группы Auto Scaling для определения и создания экземпляров в новой группе Auto Scaling.
loadBalancerInfo -> (структура)
Информация о балансировщике нагрузки, который нужно использовать в развертывании.
elbInfoList -> (список)
Массив, содержащий информацию о балансировщиках нагрузки, которые нужно использовать для балансировки нагрузки в развертывании. Если вы используете классические балансировщики нагрузки, укажите их в этом массиве.
Примечание
Вы можете добавить до 10 балансировщиков нагрузки в массив.Примечание
Если вы используете балансировщики приложений или сетевые балансировщики, используйте массивtargetGroupInfoList вместо этого.(структура)
Информация о классическом балансировщике нагрузки в Elastic Load Balancing для использования в развертывании. Экземпляры регистрируются непосредственно в балансировщике нагрузки, и трафик направляется в балансировщик нагрузки.
имя -> (строка)
targetGroupInfoList -> (список)
Массив, содержащий информацию о целевых группах для балансировки нагрузки в развертывании. Если вы используете балансировщики приложений и сетевые балансировщики, укажите их соответствующие целевые группы в этом массиве.
Примечание
Вы можете добавить до 10 целевых групп в массив.Примечание
Если вы используете классические балансировщики нагрузки, используйте массивelbInfoList вместо этого.(структура)
Информация о целевой группе в Elastic Load Balancing для использования в развертывании. Экземпляры регистрируются как цели в целевой группе, и трафик направляется в целевую группу.
имя -> (строка)
targetGroupPairInfoList -> (список)
Информация о паре целевых групп. Это массив объектов TargeGroupPairInfo с максимальным размером один.
(структура)
Информация о двух целевых группах и о том, как трафик направляется во время развертывания Amazon ECS. Можно указать необязательный маршрут тестового трафика.
targetGroups -> (список)
Одна пара целевых групп. Одна связана с исходным набором задач. Вторая связана с набором задач, обрабатывающим трафик после завершения развертывания.
(структура)
Информация о целевой группе в Elastic Load Balancing для использования в развертывании. Экземпляры регистрируются как цели в целевой группе, и трафик направляется в целевую группу.
имя -> (строка)
prodTrafficRoute -> (структура)
Путь, используемый балансировщиком нагрузки для перенаправления производственного трафика после завершения развертывания Amazon ECS.
listenerArns -> (список)
Amazon Resource Name (ARN) одного слушателя. Слушатель идентифицирует маршрут между целевой группой и балансировщиком нагрузки. Это массив строк с максимальным размером один.
(строка)
testTrafficRoute -> (структура)
Необязательный путь, используемый балансировщиком нагрузки для перенаправления тестового трафика после развертывания Amazon ECS. Валидация может происходить, пока тестовый трафик обслуживается во время развертывания.
listenerArns -> (список)
Amazon Resource Name (ARN) одного слушателя. Слушатель идентифицирует маршрут между целевой группой и балансировщиком нагрузки. Это массив строк с максимальным размером один.
(строка)
lastSuccessfulDeployment -> (структура)
Информация о последнем успешном развертывании в группе развертывания.
deploymentId -> (строка)
статус -> (строка)
endTime -> (временная метка)
createTime -> (временная метка)
lastAttemptedDeployment -> (структура)
Информация о последнем неудачном развертывании в группе развертывания.
deploymentId -> (строка)
статус -> (строка)
endTime -> (временная метка)
createTime -> (временная метка)
ec2TagSet -> (структура)
Информация о группах тегов, применённых к экземпляру Amazon EC2. В группе развертывания включены только экземпляры Amazon EC2, идентифицированные всеми группами тегов. Нельзя использовать в одном вызове вместе с ec2TagFilters.
ec2TagSetList -> (список)
Список, содержащий другие списки групп тегов экземпляров Amazon EC2. Для включения экземпляра в группу развертывания, он должен быть идентифицирован всеми группами тегов в списке.
(список)
(структура)
Информация об EC2 фильтре тегов.
Ключ -> (строка)
Значение -> (строка)
Тип -> (строка)
Тип фильтра тегов:
-
KEY_ONLY: Только ключ. -
VALUE_ONLY: Только значение. -
KEY_AND_VALUE: Ключ и значение.
onPremisesTagSet -> (структура)
Информация о группах тегов, применённых к локальному экземпляру. В группе развертывания включены только локальные экземпляры, идентифицированные всеми группами тегов. Нельзя использовать в одном вызове вместе с onPremisesInstanceTagFilters.
onPremisesTagSetList -> (список)
Список, содержащий другие списки групп тегов локальных экземпляров. Для включения экземпляра в группу развертывания, он должен быть идентифицирован всеми группами тегов в списке.
(список)
(структура)
Информация о фильтре тегов локального экземпляра.
Ключ -> (строка)
Значение -> (строка)
Тип -> (строка)
Тип фильтра тегов локального экземпляра:
- KEY_ONLY: Только ключ.
- VALUE_ONLY: Только значение.
- KEY_AND_VALUE: Ключ и значение.
computePlatform -> (строка)
Lambda , Server или ECS).ecsServices -> (список)
Целевые службы Amazon ECS в группе развертывания. Это относится только к группам развертывания, использующим платформу вычислений Amazon ECS. Целевая служба Amazon ECS задаётся как пара имени кластера и службы Amazon ECS с использованием формата <clustername>:<servicename>.
(структура)
Содержит имена службы и кластера, используемые для идентификации целевого объекта развертывания Amazon ECS.
имяСлужбы -> (строка)
имяКластера -> (строка)
terminationHookEnabled -> (булево)
Указывает, была ли группа развертывания настроена для установки CodeDeploy-обработчика завершения работы в группе Auto Scaling.
Дополнительную информацию об обработчике завершения работы см. в разделе Как Amazon EC2 Auto Scaling работает с CodeDeploy в Руководстве пользователя CodeDeploy.
errorMessage -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.