Spec-Zone.ru › AWS CLI v2

[ aws . opsworks ]

describe-deployments

Описание

Запрашивает описание указанного набора развертываний.

Примечание

Этот вызов принимает только один параметр для идентификации ресурса.

Требуемые разрешения: для использования этого действия пользователь IAM должен иметь уровень разрешений «Показать», «Развернуть» или «Управлять» для стека или прикрепленный к нему политику, которая явно предоставляет разрешения. Дополнительную информацию о разрешениях пользователей см. в разделе Управление разрешениями пользователей.

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

Синтаксис

  describe-deployments
[--stack-id <value>]
[--app-id <value>]
[--deployment-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]

Параметры

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

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

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

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

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

Массив идентификаторов развертываний, которые нужно описать. Если вы включаете этот параметр, команда возвращает описание указанных развертываний. В противном случае она возвращает описание всех развертываний.

(строка)

Синтаксис:

"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 (строка)

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

  • on
  • off
  • auto

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

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

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

Следующая describe-deployments команда описывает развертывания в указанном стеке.

aws opsworks --region us-east-1 describe-deployments --stack-id 38ee91e2-abdc-4208-a107-0b7168b3cc7a

Вывод:

{
  "Deployments": [
      {
          "StackId": "38ee91e2-abdc-4208-a107-0b7168b3cc7a",
          "Status": "successful",
          "CompletedAt": "2013-07-25T18:57:49+00:00",
          "DeploymentId": "6ed0df4c-9ef7-4812-8dac-d54a05be1029",
          "Command": {
              "Args": {},
              "Name": "undeploy"
          },
          "CreatedAt": "2013-07-25T18:57:34+00:00",
          "Duration": 15,
          "InstanceIds": [
              "8c2673b9-3fe5-420d-9cfa-78d875ee7687",
              "9e588a25-35b2-4804-bd43-488f85ebe5b7"
          ]
      },
      {
          "StackId": "38ee91e2-abdc-4208-a107-0b7168b3cc7a",
          "Status": "successful",
          "CompletedAt": "2013-07-25T18:56:41+00:00",
          "IamUserArn": "arn:aws:iam::123456789012:user/someuser",
          "DeploymentId": "19d3121e-d949-4ff2-9f9d-94eac087862a",
          "Command": {
              "Args": {},
              "Name": "deploy"
          },
          "InstanceIds": [
              "8c2673b9-3fe5-420d-9cfa-78d875ee7687",
              "9e588a25-35b2-4804-bd43-488f85ebe5b7"
          ],
          "Duration": 72,
          "CreatedAt": "2013-07-25T18:55:29+00:00"
      }
  ]
}

Дополнительная информация

Дополнительную информацию см. в разделе Развертывание приложений в руководстве пользователя AWS OpsWorks.

Вывод

Deployments -> (список)

Массив объектов Deployment, описывающих развертывания.

(структура)

Описывает развертывание стека или приложения.

DeploymentId -> (строка)

Идентификатор развертывания.

StackId -> (строка)

Идентификатор стека.

AppId -> (строка)

Идентификатор приложения.

CreatedAt -> (строка)

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

CompletedAt -> (строка)

Дата завершения развертывания.

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

Продолжительность развертывания.

IamUserArn -> (строка)

ARN пользователя IAM.

Comment -> (строка)

Определяемый пользователем комментарий.

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

Используется для указания команды стека или развертывания.

Name -> (строка)

Определяет операцию. Вы можете указать только одну команду.

Для стеков доступны следующие команды:

  • execute_recipes: Выполнить один или несколько рецептов. Для указания рецептов установите параметр Args с именем recipes в список рецептов, которые нужно выполнить. Например, для выполнения phpapp::appsetup, установите Args в {"recipes":["phpapp::appsetup"]}.
  • install_dependencies: Установить зависимости стека.
  • update_custom_cookbooks: Обновить пользовательские кулинарные книги стека.
  • update_dependencies: Обновить зависимости стека.

Примечание

Команды update_dependencies и install_dependencies поддерживаются только для Linux-инстансов. Вы можете успешно выполнить команды на Windows-инстансах, но они ничего не сделают.

Для приложений доступны следующие команды:

  • deploy: Развернуть приложение. Приложения Ruby on Rails имеют необязательный параметр Args с именем migrate. Установите Args в {“migrate”:[“true”]} для миграции базы данных. Значение по умолчанию — {“migrate”:[“false”]}.
  • rollback: Вернуть приложение к предыдущей версии. При обновлении приложения OpsWorks Stacks сохраняет предыдущую версию, до максимум пяти версий. Вы можете использовать эту команду для возврата приложения до четырех версий.
  • start: Запустить веб- или прикладной сервер приложения.
  • stop: Остановить веб- или прикладной сервер приложения.
  • restart: Перезапустить веб- или прикладной сервер приложения.
  • undeploy: Отменить развертывание приложения.

Args -> (карта)

Аргументы этих команд, которые принимают аргументы. Он должен быть установлен на JSON-объект со следующим форматом:

{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}

Команда update_dependencies принимает два аргумента:

  • upgrade_os_to — Указывает версию Amazon Linux, на которой должны работать инстансы, например, Amazon Linux 2. Вы также должны установить аргумент allow_reboot в значение true.
  • allow_reboot — Указывает, разрешить ли OpsWorks Stacks перезагружать инстансы при необходимости после установки обновлений. Этот аргумент может быть установлен либо в true, либо в false. Значение по умолчанию — false.

Например, для обновления инстанса до Amazon Linux 2018.03, установите Args следующим образом.

{ "upgrade_os_to":["Amazon Linux 2018.03"], "allow_reboot":["true"] }

key -> (строка)

value -> (список)

(строка)

Status -> (строка)

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

  • running
  • successful
  • failed

CustomJson -> (строка)

Строка, содержащая пользовательский JSON. Он может использоваться для переопределения соответствующих значений атрибутов конфигурации стека по умолчанию для стека или для передачи данных рецептам. Строка должна иметь следующий формат:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

Дополнительную информацию о пользовательском JSON см. в разделе Использование пользовательского JSON для изменения атрибутов конфигурации стека.

InstanceIds -> (список)

Идентификаторы целевых инстансов.

(строка)

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

Spec-Zone.ru

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