describe-apps
Описание
Запрашивает описание указанного набора приложений.
Примечание
Требуемые разрешения: Для использования этого действия пользователь IAM должен иметь уровень разрешений «Показать», «Развернуть» или «Управлять» для стека или прикрепленный к нему политику, явно предоставляющую разрешения. Дополнительную информацию о разрешениях пользователей см. в разделе Управление разрешениями пользователей .
См. также: Документация API AWS
Синтаксис
describe-apps
[--stack-id <value>]
[--app-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 (строка)
DescribeApps возвращает описание приложений в указанном стеке.--app-ids (список)
Массив идентификаторов приложений для описания. Если вы используете этот параметр, DescribeApps возвращает описание указанных приложений. В противном случае он возвращает описание каждого приложения.
(строка)
Синтаксис:
"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.
Для описания приложений
Следующая describe-apps команда описывает приложения в указанном стеке.
aws opsworks describe-apps \
--stack-id 38ee91e2-abdc-4208-a107-0b7168b3cc7a \
--region us-east-1
Вывод:
{
"Apps": [
{
"StackId": "38ee91e2-abdc-4208-a107-0b7168b3cc7a",
"AppSource": {
"Url": "https://s3-us-west-2.amazonaws.com/opsworks-demo-assets/simplejsp.zip",
"Type": "archive"
},
"Name": "SimpleJSP",
"EnableSsl": false,
"SslConfiguration": {},
"AppId": "da1decc1-0dff-43ea-ad7c-bb667cd87c8b",
"Attributes": {
"RailsEnv": null,
"AutoBundleOnDeploy": "true",
"DocumentRoot": "ROOT"
},
"Shortname": "simplejsp",
"Type": "other",
"CreatedAt": "2013-08-01T21:46:54+00:00"
}
]
}
Дополнительную информацию см. в разделе Приложения в руководстве пользователя AWS OpsWorks.
Вывод
Приложения -> (список)
Массив App объектов, описывающих указанные приложения.
(структура)
Описание приложения.
AppId -> (строка)
StackId -> (строка)
Shortname -> (строка)
Name -> (строка)
Description -> (строка)
DataSources -> (список)
Источники данных приложения.
(структура)
Описывает источник данных приложения.
Type -> (строка)
AutoSelectOpsworksMysqlInstance , OpsworksMysqlInstance , RdsDbInstance или None .Arn -> (строка)
DatabaseName -> (строка)
Type -> (строка)
AppSource -> (структура)
Объект Source, описывающий репозиторий приложения.
Type -> (строка)
Url -> (строка)
https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz .Username -> (строка)
Этот параметр зависит от типа репозитория.
- Для пакетов Amazon S3 установите
Usernameна соответствующий идентификатор ключа доступа IAM. - Для пакетов HTTP, репозиториев Git и Subversion установите
Usernameна имя пользователя.
Password -> (строка)
Если включен в запросе, параметр зависит от типа репозитория.
- Для пакетов Amazon S3 установите
Passwordна соответствующий секретный ключ доступа IAM. - Для пакетов HTTP и репозиториев Subversion установите
Passwordна пароль.
Дополнительную информацию о безопасном обращении с учетными данными IAM см. в https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html .
В ответах OpsWorks Stacks возвращает *****FILTERED***** вместо фактического значения.
SshKey -> (строка)
В запросах SSH-ключ репозитория.
В ответах OpsWorks Stacks возвращает *****FILTERED***** вместо фактического значения.
Revision -> (строка)
Domains -> (список)
Параметры vhost приложения с несколькими доменами, разделенными запятыми. Например: 'www.example.com, example.com'
(строка)
EnableSsl -> (булево)
SslConfiguration -> (структура)
Объект SslConfiguration с настройками SSL.
Certificate -> (строка)
PrivateKey -> (строка)
Chain -> (строка)
Attributes -> (массив)
Атрибуты стека.
ключ -> (строка)
значение -> (строка)
CreatedAt -> (строка)
Environment -> (список)
Массив объектов EnvironmentVariable, определяющих переменные среды, которые должны быть связаны с приложением. После развертывания приложения эти переменные определяются на соответствующих экземплярах серверов приложения. Дополнительную информацию см. в разделе Переменные среды .
Примечание
Нет конкретного ограничения на количество переменных среды. Однако размер связанной структуры данных (включающей имена переменных, значения и значения флагов защиты) не должен превышать 20 КБ. Этого предела должно быть достаточно для большинства, если не для всех случаев использования, но если вы его превысите, вы вызовете исключение (API) с сообщением «Environment: слишком большой (максимум 20 КБ)».(структура)
Представляет переменную среды приложения.
Key -> (строка)
Value -> (строка)
Secure -> (булево)
Secure в true . DescribeApps возвращает *****FILTERED***** вместо фактического значения. Значение по умолчанию для Secure — false .
© Copyright 2025, Amazon Web Services. Created using Sphinx.