Spec-Zone.ru › AWS CLI v2

[ aws . appconfig ]

get-deployment

Описание

Получает информацию о развертывании конфигурации.

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

Синтаксис

  get-deployment
--application-id <value>
--environment-id <value>
--deployment-number <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-id (строка)

Идентификатор приложения, содержащего развертывание, которое нужно получить.

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

Идентификатор среды, содержащей развертывание, которое нужно получить.

--deployment-number (целое число)

Порядковый номер развертывания.

--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.

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

Следующий get-deployment пример отображает детали развертывания в указанном приложении и среде.

aws appconfig get-deployment \
    --application-id 339ohji \
    --environment-id 54j1r29 \
    --deployment-number 1

Вывод:

{
    "ApplicationId": "339ohji",
    "EnvironmentId": "54j1r29",
    "DeploymentStrategyId": "1225qzk",
    "ConfigurationProfileId": "ur8hx2f",
    "DeploymentNumber": 1,
    "ConfigurationName": "Example-Configuration-Profile",
    "ConfigurationLocationUri": "ssm-parameter://Example-Parameter",
    "ConfigurationVersion": "1",
    "DeploymentDurationInMinutes": 15,
    "GrowthType": "LINEAR",
    "GrowthFactor": 25.0,
    "FinalBakeTimeInMinutes": 0,
    "State": "COMPLETE",
    "EventLog": [
        {
            "EventType": "DEPLOYMENT_COMPLETED",
            "TriggeredBy": "APPCONFIG",
            "Description": "Deployment completed",
            "OccurredAt": "2021-09-17T21:59:03.888000+00:00"
        },
        {
            "EventType": "BAKE_TIME_STARTED",
            "TriggeredBy": "APPCONFIG",
            "Description": "Deployment bake time started",
            "OccurredAt": "2021-09-17T21:58:57.722000+00:00"
        },
        {
            "EventType": "PERCENTAGE_UPDATED",
            "TriggeredBy": "APPCONFIG",
            "Description": "Configuration available to 100.00% of clients",
            "OccurredAt": "2021-09-17T21:55:56.816000+00:00"
        },
        {
            "EventType": "PERCENTAGE_UPDATED",
            "TriggeredBy": "APPCONFIG",
            "Description": "Configuration available to 75.00% of clients",
            "OccurredAt": "2021-09-17T21:52:56.567000+00:00"
        },
        {
            "EventType": "PERCENTAGE_UPDATED",
            "TriggeredBy": "APPCONFIG",
            "Description": "Configuration available to 50.00% of clients",
            "OccurredAt": "2021-09-17T21:49:55.737000+00:00"
        },
        {
            "EventType": "PERCENTAGE_UPDATED",
            "TriggeredBy": "APPCONFIG",
            "Description": "Configuration available to 25.00% of clients",
            "OccurredAt": "2021-09-17T21:46:55.187000+00:00"
        },
        {
            "EventType": "DEPLOYMENT_STARTED",
            "TriggeredBy": "USER",
            "Description": "Deployment started",
            "OccurredAt": "2021-09-17T21:43:54.205000+00:00"
        }
    ],
    "PercentageComplete": 100.0,
    "StartedAt": "2021-09-17T21:43:54.205000+00:00",
    "CompletedAt": "2021-09-17T21:59:03.888000+00:00"
}

Для получения более подробной информации см. Шаг 5: Развертывание конфигурации в Руководстве пользователя AWS AppConfig.

Вывод

ApplicationId -> (строка)

Идентификатор приложения, которое было развернуто.

EnvironmentId -> (строка)

Идентификатор среды, которая была развернута.

DeploymentStrategyId -> (строка)

Идентификатор стратегии развертывания, которая была развернута.

ConfigurationProfileId -> (строка)

Идентификатор профиля конфигурации, который был развернут.

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

Порядковый номер развертывания.

ConfigurationName -> (строка)

Имя конфигурации.

ConfigurationLocationUri -> (строка)

Информация о местоположении источника конфигурации.

ConfigurationVersion -> (строка)

Версия конфигурации, которая была развернута.

Description -> (строка)

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

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

Общее время, которое длилось развертывание.

GrowthType -> (строка)

Алгоритм, используемый для определения того, как процент вырос со временем.

GrowthFactor -> (число с плавающей точкой)

Процент целевых элементов, которые получат развернутую конфигурацию в течение каждого интервала.

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

Время, в течение которого AppConfig отслеживал события тревоги, прежде чем считать развертывание завершенным и более не подходящим для автоматического отката.

State -> (строка)

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

EventLog -> (список)

Список, содержащий все события, связанные с развертыванием. Наиболее последние события отображаются первыми.

(структура)

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

EventType -> (строка)

Тип события развертывания. Типы событий развертывания включают начало, остановку или завершение развертывания; обновление процента; начало или остановка периода подготовки; и начало или завершение отката.

TriggeredBy -> (строка)

Сущность, которая инициировала событие развертывания. События могут быть инициированы пользователем, AppConfig, Amazon CloudWatch alarm или внутренней ошибкой.

Description -> (строка)

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

  • Учетная запись Amazon Web Services или ARN Amazon CloudWatch alarm, которая инициировала откат.
  • Процент хостов, которые получили развертывание.
  • Рекомендация попытаться выполнить новое развертывание (в случае внутренней ошибки).

ActionInvocations -> (список)

Список расширений, которые были вызваны в рамках развертывания.

(структура)

Расширение, которое было вызвано в рамках события развертывания.

ExtensionIdentifier -> (строка)

Имя, идентификатор или Amazon Resource Name (ARN) расширения.

ActionName -> (строка)

Имя действия.

Uri -> (строка)

URI расширения, связанный с точкой действия в определении расширения. URI может быть Amazon Resource Name (ARN) одного из следующих: функция Lambda, очередь Amazon Simple Queue Service, тема Amazon Simple Notification Service или стандартный Amazon EventBridge.

RoleArn -> (строка)

Amazon Resource Name (ARN) для роли предположения Identity and Access Management.

ErrorMessage -> (строка)

Сообщение об ошибке при сбое вызова расширения.

ErrorCode -> (строка)

Код ошибки при сбое вызова расширения.

InvocationId -> (строка)

Сгенерированный системой идентификатор для этого вызова.

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

Дата и время события.

PercentageComplete -> (число с плавающей точкой)

Процент целевых элементов, для которых доступно развертывание.

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

Время начала развертывания.

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

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

AppliedExtensions -> (список)

Список расширений, которые были обработаны в рамках развертывания. Расширения, которые ранее были связаны с профилем конфигурации, средой или приложением при вызове StartDeployment.

(структура)

Расширение, которое было вызвано во время развертывания.

ExtensionId -> (строка)

Сгенерированный системой идентификатор расширения.

ExtensionAssociationId -> (строка)

Сгенерированный системой идентификатор для ассоциации.

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

Номер версии расширения.

Parameters -> (карта)

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

ключ -> (строка)

значение -> (строка)

KmsKeyArn -> (строка)

Amazon Resource Name ключа Key Management Service, используемого для шифрования данных конфигурации. Можно шифровать секреты, хранящиеся в Secrets Manager, объекты Amazon Simple Storage Service (Amazon S3), зашифрованные с помощью SSE-KMS, или защищенные строковые параметры, хранящиеся в Amazon Web Services Systems Manager Parameter Store.

KmsKeyIdentifier -> (строка)

Идентификатор ключа Key Management Service (идентификатор ключа, псевдоним ключа или ARN ключа), предоставленный при создании или обновлении ресурса.

VersionLabel -> (строка)

Определяемая пользователем метка для версии размещенной конфигурации AppConfig.

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

Spec-Zone.ru

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