Spec-Zone.ru › AWS CLI v2

[ aws . apprunner ]

describe-service

Описание

Возвращает полное описание сервиса App Runner.

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

Синтаксис

  describe-service
--service-arn <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]

Параметры

--service-arn (строка)

Amazon Resource Name (ARN) сервиса App Runner, для которого требуется описание.

--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 для получения дополнительной информации.

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

Для описания сервиса

Следующий describe-service пример получает описание сервиса App Runner.

aws apprunner describe-service \
    --cli-input-json file://input.json

Содержимое input.json:

{
    "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa"
}

Вывод:

{
    "Service": {
        "CreatedAt": "2020-11-20T19:05:25Z",
        "UpdatedAt": "2020-11-20T19:05:25Z",
        "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa",
        "ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa",
        "ServiceName": "python-app",
        "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com",
        "SourceConfiguration": {
            "AuthenticationConfiguration": {
                "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e"
            },
            "AutoDeploymentsEnabled": true,
            "CodeRepository": {
                "CodeConfiguration": {
                    "CodeConfigurationValues": {
                        "BuildCommand": "pip install -r requirements.txt",
                        "Port": "8080",
                        "Runtime": "PYTHON_3",
                        "RuntimeEnvironmentVariables": [
                            {
                                "NAME": "Jane"
                            }
                        ],
                        "StartCommand": "python server.py"
                    },
                    "ConfigurationSource": "Api"
                },
                "RepositoryUrl": "https://github.com/my-account/python-hello",
                "SourceCodeVersion": {
                    "Type": "BRANCH",
                    "Value": "main"
                }
            }
        },
        "Status": "RUNNING",
        "InstanceConfiguration": {
            "CPU": "1 vCPU",
            "Memory": "3 GB"
        }
    }
}

Вывод

Сервис -> (структура)

Полное описание сервиса App Runner, указанного в этом запросе.

ИмяСервиса -> (строка)

Имя сервиса, предоставленное клиентом.

ИдентификаторСервиса -> (строка)

Идентификатор, сгенерированный App Runner для этого сервиса. Он уникален в пределах региона Amazon Web Services.

ArnСервиса -> (строка)

Amazon Resource Name (ARN) этого сервиса.

UrlСервиса -> (строка)

Поддомен URL, сгенерированный App Runner для этого сервиса. Вы можете использовать этот URL для доступа к вашему веб-приложению.

ДатаСоздания -> (метка времени)

Время создания сервиса App Runner. Формат — метка времени Unix.

ДатаОбновления -> (метка времени)

Время последнего обновления сервиса App Runner. Формат — метка времени Unix.

ДатаУдаления -> (метка времени)

Время удаления сервиса App Runner. Формат — метка времени Unix.

Статус -> (строка)

Текущее состояние сервиса App Runner. Эти значения означают следующее.

  • CREATE_FAILED – Сервис не был создан. Неудачный сервис неприменим и всё ещё учитывается в вашем квоте сервисов. Для устранения неполадок прочитайте события и журналы ошибок, измените параметры, которые нужно исправить, и перестройте свой сервис, используя UpdateService .
  • DELETE_FAILED – Сервис не был удален и не может быть успешно восстановлен. Повторите вызов удаления сервиса, чтобы убедиться, что все связанные ресурсы удалены.

КонфигурацияИсточника -> (структура)

Исходный код, развернутый в сервисе App Runner. Это может быть код или образ репозитория.

РепозиторийКода -> (структура)

Описание репозитория исходного кода.

Вы должны предоставить либо этот элемент, либо ImageRepository (но не оба).

UrlРепозитория -> (строка)

Расположение репозитория, содержащего исходный код.

ВерсияИсходногоКода -> (структура)

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

Тип -> (строка)

Тип идентификатора версии.

Для репозитория на базе Git ветки представляют версии.

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

Версия исходного кода.

Для репозитория на базе Git имя ветки соответствует определенной версии. App Runner использует последнюю коммитацию в ветке.

КонфигурацияКода -> (структура)

Настройка для сборки и запуска сервиса из репозитория исходного кода.

Примечание

CodeConfiguration требуется только для запроса CreateService.

ИсточникКонфигурации -> (строка)

Источник конфигурации App Runner. Значения интерпретируются следующим образом:

  • REPOSITORY – App Runner считывает значения конфигурации из файла apprunner.yaml в репозитории исходного кода и игнорирует CodeConfigurationValues .
  • API – App Runner использует значения конфигурации, предоставленные в CodeConfigurationValues, и игнорирует файл apprunner.yaml в репозитории исходного кода.

ЗначенияКонфигурацииКода -> (структура)

Базовая конфигурация для сборки и запуска сервиса App Runner. Используйте ее для быстрого запуска сервиса App Runner без предоставления файла apprunner.yaml в репозитории исходного кода (или игнорирования файла, если он существует).

Средство выполнения -> (строка)

Тип среды выполнения для сборки и запуска сервиса App Runner. Представляет среду выполнения языка программирования.

КомандаСборки -> (строка)

Команда, которую App Runner выполняет для сборки вашего приложения.

КомандаЗапуска -> (строка)

Команда, которую App Runner выполняет для запуска вашего приложения.

Порт -> (строка)

Порт, к которому ваше приложение подключено в контейнере.

По умолчанию: 8080

ПеременныеСредыВыполнения -> (массив)

Переменные среды, доступные вашему запущенному сервису App Runner. Массив пар ключ-значение.

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

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

СекретыСредыВыполнения -> (массив)

Массив пар ключ-значение, представляющих секреты и параметры, которые ссылаются на ваш сервис как на переменную среды. Поддерживаемые значения — это полный Amazon Resource Name (ARN) секрета Secrets Manager или полный ARN параметра в Amazon Web Services Systems Manager Parameter Store.

Примечание

  • Если параметр Amazon Web Services Systems Manager Parameter Store существует в том же регионе Amazon Web Services, что и запускаемый вами сервис, вы можете использовать полный ARN или имя секрета. Если параметр существует в другом регионе, то должен быть указан полный ARN.
  • В настоящее время не поддерживается перекрестная ссылка на параметр Amazon Web Services Systems Manager Parameter Store из другой учетной записи.

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

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

ДиректорияИсточника -> (строка)

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

РепозиторийОбраза -> (структура)

Описание репозитория исходного образа.

Вы должны предоставить либо этот элемент, либо CodeRepository (но не оба).

ИдентификаторОбраза -> (строка)

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

Для образа в Amazon Elastic Container Registry (Amazon ECR) это имя образа. Для формата имени образа см. Выполнение pull-запроса изображения в Руководстве пользователя Amazon ECR.

КонфигурацияОбраза -> (структура)

Конфигурация для запуска указанного образа.

ПеременныеСредыВыполнения -> (массив)

Переменные среды, доступные вашему запущенному сервису App Runner. Массив пар ключ-значение.

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

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

КомандаЗапуска -> (строка)

Необязательная команда, которую App Runner выполняет для запуска приложения в исходном изображении. Если задана, эта команда переопределяет команду запуска по умолчанию Docker-изображения.

Порт -> (строка)

Порт, к которому ваше приложение подключено в контейнере.

По умолчанию: 8080

СекретыСредыВыполнения -> (массив)

Массив пар ключ-значение, представляющих секреты и параметры, которые ссылаются на ваш сервис как на переменную среды. Поддерживаемые значения — это полный Amazon Resource Name (ARN) секрета Secrets Manager или полный ARN параметра в Amazon Web Services Systems Manager Parameter Store.

Примечание

  • Если параметр Amazon Web Services Systems Manager Parameter Store существует в том же регионе Amazon Web Services, что и запускаемый вами сервис, вы можете использовать полный ARN или имя секрета. Если параметр существует в другом регионе, то должен быть указан полный ARN.
  • В настоящее время не поддерживается перекрестная ссылка на параметр Amazon Web Services Systems Manager Parameter Store из другой учетной записи.

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

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

ТипРепозиторияОбраза -> (строка)

Тип репозитория образов. Это отражает поставщика репозитория и является ли репозиторий частным или общедоступным.

АвтоматическиеРазвертыванияВключены -> (булево)

Если true, непрерывная интеграция из репозитория исходного кода включена для сервиса App Runner. Каждое изменение репозитория (включая любые изменения исходного кода или новую версию образа) запускает развертывание.

По умолчанию: App Runner устанавливает значение false для исходного образа, который использует общедоступный репозиторий ECR или репозиторий ECR, находящийся в другой учетной записи Amazon Web Services, чем учетная запись сервиса. App Runner устанавливает значение true во всех других случаях (которые в настоящее время включают репозиторий исходного кода или исходный образ, использующий репозиторий ECR в той же учетной записи).

КонфигурацияАвторизации -> (структура)

Описывает ресурсы, необходимые для проверки подлинности доступа к некоторым репозиториям исходного кода.

ConnectionArn -> (строка)

Amazon Resource Name (ARN) подключения App Runner, которое позволяет сервису App Runner подключаться к репозиторию исходного кода. Требуется для репозиториев кода GitHub.

AccessRoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, которая предоставляет сервису App Runner доступ к репозиторию исходного кода. Требуется для репозиториев изображений ECR (но не для общедоступных репозиториев ECR).

КонфигурацияВиртуальнойМашины -> (структура)

Конфигурация времени выполнения виртуальных машин (масштабируемых единиц) этого сервиса.

Cpu -> (строка)

Количество процессорных единиц, зарезервированных для каждой виртуальной машины вашего сервиса App Runner.

По умолчанию: 1 vCPU

Память -> (строка)

Количество памяти в МБ или ГБ, зарезервированное для каждой виртуальной машины вашего сервиса App Runner.

По умолчанию: 2 GB

InstanceRoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, предоставляющей разрешения вашему сервису App Runner. Это разрешения, которые необходимы вашему коду при обращении к любым API Amazon Web Services.

КонфигурацияШифрования -> (структура)

Ключ шифрования, который App Runner использует для шифрования журналов сервиса и копии репозитория исходного кода, которую App Runner поддерживает для сервиса. Это может быть либо ключ шифрования, предоставленный клиентом, либо управляемый Amazon Web Services.

KmsKey -> (строка)

ARN ключа KMS, используемого для шифрования.

КонфигурацияПроверкиСостояния -> (структура)

Настройки проверки работоспособности, которые App Runner выполняет для мониторинга работоспособности этого сервиса.

Protocol -> (строка)

Протокол IP, который App Runner использует для выполнения проверок работоспособности вашего сервиса.

Если вы установите Protocol в значение HTTP, App Runner отправляет запросы проверки работоспособности на HTTP-путь, указанный в Path.

По умолчанию: TCP

Path -> (строка)

URL, на который отправляются запросы проверки работоспособности.

Path применимо только в случае, если вы установите Protocol в значение HTTP.

По умолчанию: "/"

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

Интервал времени в секундах между проверками работоспособности.

По умолчанию: 5

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

Время в секундах ожидания ответа проверки работоспособности перед принятием решения о его сбое.

По умолчанию: 2

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

Количество последовательных успешных проверок, которое должно быть выполнено, прежде чем App Runner определит, что сервис работает корректно.

По умолчанию: 1

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

Количество последовательных неудачных проверок, которое должно быть выполнено, прежде чем App Runner определит, что сервис не работает корректно.

По умолчанию: 5

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

Сводная информация для ресурса автоматического масштабирования App Runner, связанного с этим сервисом.

AutoScalingConfigurationArn -> (строка)

Amazon Resource Name (ARN) этой конфигурации автоматического масштабирования.

AutoScalingConfigurationName -> (строка)

Имя конфигурации автоматического масштабирования, заданное пользователем. Оно может использоваться в нескольких пересмотрах конфигурации.

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

Ревизия этой конфигурации автоматического масштабирования. Она уникальна среди всех активных конфигураций ("Status": "ACTIVE" ) с тем же AutoScalingConfigurationName.

Status -> (строка)

Текущее состояние конфигурации автоматического масштабирования. Если состояние ревизии конфигурации - INACTIVE, она была удалена и больше не может использоваться. Неактивные ревизии конфигурации удаляются навсегда некоторое время спустя после удаления.

CreatedAt -> (временная метка)

Время создания конфигурации автоматического масштабирования. Формат — метка времени Unix.

HasAssociatedService -> (булево)

Указывает, есть ли у этой конфигурации автоматического масштабирования связанный с ней сервис App Runner. Значение true указывает на то, что с ней связаны один или несколько сервисов. Значение false указывает на отсутствие связанных сервисов.

IsDefault -> (булево)

Указывает, должна ли эта конфигурация автоматического масштабирования использоваться в качестве значения по умолчанию для нового сервиса App Runner, у которого нет указанного ARN конфигурации автоматического масштабирования во время создания. В каждой учетной записи может быть только один параметр по умолчанию AutoScalingConfiguration на регион. Параметр по умолчанию AutoScalingConfiguration может быть любой ревизией в рамках той же AutoScalingConfigurationName.

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

Настройки конфигурации, связанные с сетевым трафиком веб-приложения, которое выполняет этот сервис.

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

Настройки сетевой конфигурации для исходящего трафика сообщений.

EgressType -> (строка)

Тип конфигурации исходящего трафика.

Установите значение DEFAULT для доступа к ресурсам, размещенным в общедоступных сетях.

Установите значение VPC для связывания вашего сервиса с настраиваемой VPC, указанной в VpcConnectorArn.

VpcConnectorArn -> (строка)

Amazon Resource Name (ARN) соединителя VPC App Runner, который вы хотите связать со своим сервисом App Runner. Действительно только при EgressType = VPC.

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

Настройки сетевой конфигурации для входящего трафика сообщений.

IsPubliclyAccessible -> (булево)

Указывает, доступен ли ваш сервис App Runner публично. Установите значение True, чтобы сделать сервис публично доступным. Установите значение False, чтобы сделать сервис доступным только изнутри Amazon VPC.

IpAddressType -> (строка)

App Runner предоставляет возможность выбора между Internet Protocol версии 4 (IPv4) и дуальным стеком (IPv4 и IPv6) для вашей конфигурации входящей общедоступной сети. Это необязательный параметр. Если вы не укажете IpAddressType, по умолчанию будет выбран IPv4.

Примечание

В настоящее время App Runner поддерживает дуальный стек только для общедоступного конечной точки. Для частной конечной точки поддерживается только IPv4. Если вы обновите сервис, использующий дуальный стек общедоступной конечной точки, до частной конечной точки, ваш сервис App Runner будет по умолчанию поддерживать только IPv4 для частной конечной точки и не будет получать трафик, исходящий от конечной точки IPv6.

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

Конфигурация наблюдаемости этого сервиса.

ObservabilityEnabled -> (булево)

Когда true, с сервисом связан ресурс конфигурации наблюдаемости, и указан ObservabilityConfigurationArn.

ObservabilityConfigurationArn -> (строка)

Amazon Resource Name (ARN) конфигурации наблюдаемости, связанной с сервисом. Указывается только когда ObservabilityEnabled равен true.

Укажите ARN с именем и номером ревизии для связи с этой ревизией. Например: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3

Укажите только имя, чтобы связать последнюю ревизию. Например: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing

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

Spec-Zone.ru

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