Spec-Zone.ru › AWS CLI v2

[ aws . deploy ]

batch-get-deployment-targets

Описание

Возвращает массив одного или нескольких целевых объектов, связанных с развертыванием. Этот метод работает со всеми типами вычислений и должен использоваться вместо устаревшего BatchGetDeploymentInstances. Максимальное количество возвращаемых целевых объектов составляет 25.

Тип возвращаемых целевых объектов зависит от платформы вычислений или метода развертывания развертывания:

  • EC2/На локальных компьютерах : Информация о целевых объектах экземпляров Amazon EC2.
  • Lambda : Информация о целевых объектах функций Lambda.
  • Amazon ECS : Информация о целевых объектах служб Amazon ECS.
  • CloudFormation : Информация о целевых объектах развертываний «синий/зелёный», инициированных обновлением стека CloudFormation.

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

Синтаксис

  batch-get-deployment-targets
--deployment-id <value>
--target-ids <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]

Параметры

--deployment-id (строка)

Уникальный идентификатор развертывания.

--target-ids (список)

Уникальные идентификаторы целевых объектов развертывания. Платформа вычислений развертывания определяет тип целевых объектов и их форматы. Максимальное количество идентификаторов целевых объектов развертывания, которое вы можете указать, составляет 25.

  • Для развертываний, использующих платформу вычислений EC2/На локальных компьютерах, идентификаторы целевых объектов — это идентификаторы экземпляров Amazon EC2 или локальных компьютеров, а их тип целевого объекта — instanceTarget.
  • Для развертываний, использующих платформу вычислений Lambda, идентификаторы целевых объектов — это имена функций Lambda, а их тип целевого объекта — instanceTarget.
  • Для развертываний, использующих платформу вычислений Amazon ECS, идентификаторы целевых объектов — это пары кластеров и служб Amazon ECS, указанные в формате <clustername>:<servicename>. Их тип целевого объекта — ecsTarget.
  • Для развертываний, развернутых с помощью CloudFormation, идентификаторы целевых объектов — это идентификаторы стеков CloudFormation. Их тип целевого объекта — cloudFormationTarget.

(строка)

Синтаксис:

"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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Для получения целевых объектов, связанных с развертыванием

Следующий пример batch-get-deployment-targets возвращает информацию об одном из целевых объектов, связанных с указанным развертыванием.

aws deploy batch-get-deployment-targets \
    --deployment-id "d-1A2B3C4D5" \
    --target-ids "i-01a2b3c4d5e6f1111"

Вывод:

{
    "deploymentTargets": [
        {
            "deploymentTargetType": "InstanceTarget",
            "instanceTarget": {
                "lifecycleEvents": [
                    {
                        "startTime": 1556918592.162,
                        "lifecycleEventName": "ApplicationStop",
                        "status": "Succeeded",
                        "endTime": 1556918592.247,
                        "diagnostics": {
                            "scriptName": "",
                            "errorCode": "Success",
                            "logTail": "",
                            "message": "Succeeded"
                        }
                    },
                    {
                        "startTime": 1556918593.193,
                        "lifecycleEventName": "DownloadBundle",
                        "status": "Succeeded",
                        "endTime": 1556918593.981,
                        "diagnostics": {
                            "scriptName": "",
                            "errorCode": "Success",
                            "logTail": "",
                            "message": "Succeeded"
                        }
                    },
                    {
                        "startTime": 1556918594.805,
                        "lifecycleEventName": "BeforeInstall",
                        "status": "Succeeded",
                        "endTime": 1556918681.807,
                        "diagnostics": {
                            "scriptName": "",
                            "errorCode": "Success",
                            "logTail": "",
                            "message": "Succeeded"
                        }
                    }
                ],
                "targetArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-01a2b3c4d5e6f1111",
                "deploymentId": "d-1A2B3C4D5",
                "lastUpdatedAt": 1556918687.504,
                "targetId": "i-01a2b3c4d5e6f1111",
                "status": "Succeeded"
            }
        }
    ]
}

Дополнительную информацию см. в BatchGetDeploymentTargets в Справочнике по API AWS CodeDeploy.

Вывод

deploymentTargets -> (список)

Список целевых объектов для развертывания. Каждый целевой объект содержит сведения о целевом объекте, такие как его состояние и события жизненного цикла. Тип целевых объектов зависит от вычислительной платформы развертывания.

  • EC2/На локальных компьютерах : Каждый целевой объект представляет собой экземпляр Amazon EC2 или локальный компьютер.
  • Lambda : Целевой объект — это конкретная версия функции Lambda.
  • Amazon ECS : Целевой объект — это служба Amazon ECS.
  • CloudFormation : Целевой объект — это развертывание CloudFormation по принципу «синий/зеленый».

(структура)

Информация о целевом объекте развертывания.

deploymentTargetType -> (строка)

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

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

Информация о целевом объекте для развертывания, использующего вычислительную платформу EC2/На локальных компьютерах.

deploymentId -> (строка)

Уникальный идентификатор развертывания.

targetId -> (строка)

Уникальный идентификатор целевого объекта развертывания, имеющего тип instanceTarget .

targetArn -> (строка)

Amazon Resource Name (ARN) целевого объекта.

status -> (строка)

Состояние целевого экземпляра развертывания EC2/На локальных компьютерах.

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

Дата и время, когда целевой экземпляр был обновлен развертыванием.

lifecycleEvents -> (список)

События жизненного цикла развертывания для этого целевого экземпляра.

(структура)

Информация о событии жизненного цикла развертывания.

lifecycleEventName -> (строка)

Имя события жизненного цикла развертывания, например ApplicationStop , BeforeInstall , AfterInstall , ApplicationStart или ValidateService .

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

Диагностическая информация о событии жизненного цикла развертывания.

errorCode -> (строка)

Соответствующий код ошибки:

  • Success: Указанный скрипт был выполнен.
  • ScriptMissing: Указанный скрипт не был найден в указанном месте.
  • ScriptNotExecutable: Указанный скрипт не является распознаваемым исполняемым файлом.
  • ScriptTimedOut: Указанный скрипт не завершил выполнение в указанный период времени.
  • ScriptFailed: Указанный скрипт завершился с ошибкой.
  • UnknownError: Указанный скрипт не был выполнен по неизвестной причине.

scriptName -> (строка)

Имя скрипта.

message -> (строка)

Сообщение, связанное с ошибкой.

logTail -> (строка)

Последняя часть диагностического журнала.

Если доступно, CodeDeploy возвращает до последних 4 КБ диагностического журнала.

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

Метка времени, указывающая, когда началось событие жизненного цикла развертывания.

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

Метка времени, указывающая, когда закончилось событие жизненного цикла развертывания.

status -> (строка)

Состояние события жизненного цикла развертывания:

  • Pending: Событие жизненного цикла развертывания находится в ожидании.
  • InProgress: Событие жизненного цикла развертывания выполняется.
  • Succeeded: Событие жизненного цикла развертывания выполнено успешно.
  • Failed: Событие жизненного цикла развертывания завершилось с ошибкой.
  • Skipped: Событие жизненного цикла развертывания пропущено.
  • Unknown: Событие жизненного цикла развертывания неизвестно.

instanceLabel -> (строка)

Метка, определяющая, является ли экземпляр исходной целью (BLUE) или целевым экземпляром замены (GREEN).

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

Информация о целевом объекте для развертывания, использующего платформу Lambda.

deploymentId -> (строка)

Уникальный идентификатор развертывания.

targetId -> (строка)

Уникальный идентификатор целевого объекта развертывания, имеющего тип lambdaTarget .

targetArn -> (строка)

Amazon Resource Name (ARN) целевого объекта.

status -> (строка)

Состояние целевой функции Lambda развертывания Lambda.

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

Дата и время, когда целевая функция Lambda была обновлена развертыванием.

lifecycleEvents -> (список)

События жизненного цикла развертывания для этой целевой функции Lambda.

(структура)

Информация о событии жизненного цикла развертывания.

lifecycleEventName -> (строка)

Имя события жизненного цикла развертывания, например ApplicationStop , BeforeInstall , AfterInstall , ApplicationStart или ValidateService .

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

Диагностическая информация о событии жизненного цикла развертывания.

errorCode -> (строка)

Соответствующий код ошибки:

  • Success: Указанный скрипт был выполнен.
  • ScriptMissing: Указанный скрипт не был найден в указанном месте.
  • ScriptNotExecutable: Указанный скрипт не является распознаваемым исполняемым файлом.
  • ScriptTimedOut: Указанный скрипт не завершил выполнение в указанный период времени.
  • ScriptFailed: Указанный скрипт завершился с ошибкой.
  • UnknownError: Указанный скрипт не был выполнен по неизвестной причине.

scriptName -> (строка)

Имя скрипта.

message -> (строка)

Сообщение, связанное с ошибкой.

logTail -> (строка)

Последняя часть диагностического журнала.

Если доступно, CodeDeploy возвращает до последних 4 КБ диагностического журнала.

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

Метка времени, указывающая, когда началось событие жизненного цикла развертывания.

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

Метка времени, указывающая, когда закончилось событие жизненного цикла развертывания.

status -> (строка)

Состояние события жизненного цикла развертывания:

  • Pending: Событие жизненного цикла развертывания находится в ожидании.
  • InProgress: Событие жизненного цикла развертывания выполняется.
  • Succeeded: Событие жизненного цикла развертывания выполнено успешно.
  • Failed: Событие жизненного цикла развертывания завершилось с ошибкой.
  • Skipped: Событие жизненного цикла развертывания пропущено.
  • Unknown: Событие жизненного цикла развертывания неизвестно.

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

Объект LambdaFunctionInfo, описывающий целевую функцию Lambda.

functionName -> (строка)

Имя функции Lambda.

functionAlias -> (строка)

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

currentVersion -> (строка)

Версия функции Lambda, на которую направлен производственный трафик.

targetVersion -> (строка)

Версия функции Lambda, на которую направлен производственный трафик после развертывания функции Lambda.

targetVersionWeight -> (двойное число)

Процент производственного трафика, получаемый целевой версией функции Lambda.

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

Информация о целевом ресурсе для развертывания, использующего платформу вычислений Amazon ECS.

deploymentId -> (string)

Уникальный идентификатор развертывания.

targetId -> (string)

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

targetArn -> (string)

Amazon Resource Name (ARN) целевого ресурса.

lastUpdatedAt -> (timestamp)

Дата и время последнего обновления целевого приложения Amazon ECS при развертывании.

lifecycleEvents -> (list)

События жизненного цикла развертывания для данного целевого приложения Amazon ECS.

(structure)

Информация о событии жизненного цикла развертывания.

lifecycleEventName -> (string)

Имя события жизненного цикла развертывания, например ApplicationStop , BeforeInstall , AfterInstall , ApplicationStart или ValidateService .

diagnostics -> (structure)

Диагностическая информация о событии жизненного цикла развертывания.

errorCode -> (string)

Соответствующий код ошибки:

  • Success: Указанный скрипт был выполнен.
  • ScriptMissing: Указанный скрипт не был найден по указанному пути.
  • ScriptNotExecutable: Указанный скрипт не является распознаваемым исполняемым файлом.
  • ScriptTimedOut: Указанный скрипт не был завершён в указанный период времени.
  • ScriptFailed: Указанный скрипт не был выполнен ожидаемым образом.
  • UnknownError: Указанный скрипт не был выполнен по неизвестной причине.

scriptName -> (string)

Имя скрипта.

message -> (string)

Сообщение, связанное с ошибкой.

logTail -> (string)

Последняя часть диагностического журнала.

Если доступно, CodeDeploy возвращает последние 4 КБ диагностического журнала.

startTime -> (timestamp)

Отметка времени начала события жизненного цикла развертывания.

endTime -> (timestamp)

Отметка времени завершения события жизненного цикла развертывания.

status -> (string)

Статус события жизненного цикла развертывания:

  • Pending: Событие жизненного цикла развертывания ожидает выполнения.
  • InProgress: Событие жизненного цикла развертывания выполняется.
  • Succeeded: Событие жизненного цикла развертывания выполнено успешно.
  • Failed: Событие жизненного цикла развертывания завершилось с ошибкой.
  • Skipped: Событие жизненного цикла развертывания пропущено.
  • Unknown: Событие жизненного цикла развертывания неизвестно.

status -> (string)

Статус целевого приложения Amazon ECS развертывания Amazon ECS.

taskSetsInfo -> (list)

Объекты ECSTaskSet, связанные с целевым ресурсом ECS.

(structure)

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

identifer -> (string)

Уникальный идентификатор ECSTaskSet .

desiredCount -> (long)

Количество задач в наборе задач. Во время развертывания с типом вычислений Amazon ECS CodeDeploy инструктирует Amazon ECS создать новый набор задач и использует это значение для определения количества создаваемых задач. После создания обновленного набора задач CodeDeploy переключает трафик на новый набор задач.

pendingCount -> (long)

Количество задач в наборе задач, находящихся в статусе PENDING во время развертывания Amazon ECS. Задача в состоянии PENDING готовится к переходу в состояние RUNNING. Набор задач переходит в статус PENDING при первом запуске или при перезапуске после состояния STOPPED.

runningCount -> (long)

Количество задач в наборе задач, находящихся в статусе RUNNING во время развертывания Amazon ECS. Задача в состоянии RUNNING выполняется и готова к использованию.

status -> (string)

Статус набора задач. Существует три допустимых статуса набора задач:

  • PRIMARY : Указывает, что набор задач обрабатывает трафик производства.
  • ACTIVE : Указывает, что набор задач не обрабатывает трафик производства.
  • DRAINING : Указывает, что задачи в наборе задач останавливаются, а соответствующие целевые ресурсы удаляются из группы целей.

trafficWeight -> (double)

Процент трафика, обрабатываемый этим набором задач.

targetGroup -> (structure)

Группа целей, связанная с набором задач. Группа целей используется CodeDeploy для управления трафиком к набору задач.

name -> (string)

Для развертываний «синий/зеленый» — имя группы целей, из которой удаляются экземпляры в исходной среде и с которой регистрируются экземпляры в среде замены. Для развертываний на месте — имя группы целей, из которой экземпляры удаляются, чтобы они не обрабатывали трафик во время развертывания, и с которой они повторно регистрируются после завершения развертывания.

taskSetLabel -> (string)

Метка, определяющая, является ли набор задач ECS исходной целью (BLUE ) или целевой заменой (GREEN ).

cloudFormationTarget -> (structure)

Информация о целевом ресурсе, который будет обновлен развертыванием CloudFormation «синий/зеленый». Этот тип целевого ресурса используется для всех развертываний, инициированных обновлением стека CloudFormation.

deploymentId -> (string)

Уникальный идентификатор развертывания CloudFormation «синий/зеленый».

targetId -> (string)

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

lastUpdatedAt -> (timestamp)

Дата и время последнего обновления целевого приложения при развертывании CloudFormation «синий/зеленый».

lifecycleEvents -> (list)

События жизненного цикла развертывания CloudFormation «синий/зеленый» для этого целевого приложения.

(structure)

Информация о событии жизненного цикла развертывания.

lifecycleEventName -> (string)

Имя события жизненного цикла развертывания, например ApplicationStop , BeforeInstall , AfterInstall , ApplicationStart или ValidateService .

diagnostics -> (structure)

Диагностическая информация о событии жизненного цикла развертывания.

errorCode -> (string)

Соответствующий код ошибки:

  • Success: Указанный скрипт был выполнен.
  • ScriptMissing: Указанный скрипт не был найден по указанному пути.
  • ScriptNotExecutable: Указанный скрипт не является распознаваемым исполняемым файлом.
  • ScriptTimedOut: Указанный скрипт не был завершён в указанный период времени.
  • ScriptFailed: Указанный скрипт не был выполнен ожидаемым образом.
  • UnknownError: Указанный скрипт не был выполнен по неизвестной причине.

scriptName -> (string)

Имя скрипта.

message -> (string)

Сообщение, связанное с ошибкой.

logTail -> (string)

Последняя часть диагностического журнала.

Если доступно, CodeDeploy возвращает последние 4 КБ диагностического журнала.

startTime -> (timestamp)

Отметка времени начала события жизненного цикла развертывания.

endTime -> (timestamp)

Отметка времени завершения события жизненного цикла развертывания.

status -> (string)

Статус события жизненного цикла развертывания:

  • Pending: Событие жизненного цикла развертывания ожидает выполнения.
  • InProgress: Событие жизненного цикла развертывания выполняется.
  • Succeeded: Событие жизненного цикла развертывания выполнено успешно.
  • Failed: Событие жизненного цикла развертывания завершилось с ошибкой.
  • Skipped: Событие жизненного цикла развертывания пропущено.
  • Unknown: Событие жизненного цикла развертывания неизвестно.

status -> (string)

Статус целевого приложения развертывания CloudFormation «синий/зеленый».

resourceType -> (string)

Тип ресурса для развертывания CloudFormation «синий/зеленый».

targetVersionWeight -> (double)

Процент трафика производства, который получает целевая версия развертывания CloudFormation «синий/зеленый».

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

Spec-Zone.ru

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