Spec-Zone.ru › AWS CLI v2

[ aws . apigateway ]

создание-этапа

Описание

Создает новый ресурс Stage, который ссылается на существующее Развертывание для API.

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

Синтаксис

  create-stage
--rest-api-id <value>
--stage-name <value>
--deployment-id <value>
[--description <value>]
[--cache-cluster-enabled | --no-cache-cluster-enabled]
[--cache-cluster-size <value>]
[--variables <value>]
[--documentation-version <value>]
[--canary-settings <value>]
[--tracing-enabled | --no-tracing-enabled]
[--tags <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]

Параметры

--rest-api-id (строка)

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

--stage-name (строка)

Имя ресурса Stage. Имена этапов могут содержать только буквенно-цифровые символы, дефисы и подчеркивания. Максимальная длина — 128 символов.

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

Идентификатор ресурса Deployment для ресурса Stage.

--description (строка)

Описание ресурса Stage.

--cache-cluster-enabled | --no-cache-cluster-enabled (логическое значение)

Включено ли кэширование кластеров для этапа.

--cache-cluster-size (строка)

Ёмкость кэша этапа в ГБ. Для получения дополнительной информации о выборе размера кэша, см. Включение кэширования API для повышения отзывчивости.

Возможные значения:

  • 0.5
  • 1.6
  • 6.1
  • 13.5
  • 28.4
  • 58.2
  • 118
  • 237

--variables (карта)

Карта, определяющая переменные этапа для нового ресурса Stage. Имена переменных могут содержать буквенно-цифровые символы и символы подчеркивания, а значения должны соответствовать [A-Za-z0-9-._~:/?#&=,]+ .

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

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

Сокращенный синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--documentation-version (строка)

Версия связанной документации API.

--canary-settings (структура)

Настройки развертывания канцлера для данного этапа.

percentTraffic -> (двойное)

Процент (0-100) трафика, перенаправленного на развертывание канцлера.

deploymentId -> (строка)

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

stageVariableOverrides -> (карта)

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

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

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

useStageCache -> (логическое значение)

Флаг логического типа, указывающий, использует ли развертывание канцлера кэш этапа или нет.

Сокращенный синтаксис:

percentTraffic=double,deploymentId=string,stageVariableOverrides={KeyName1=string,KeyName2=string},useStageCache=boolean

Синтаксис JSON:

{
  "percentTraffic": double,
  "deploymentId": "string",
  "stageVariableOverrides": {"string": "string"
    ...},
  "useStageCache": true|false
}

--tracing-enabled | --no-tracing-enabled (логическое значение)

Указывает, включено ли активное трассирование с X-ray для этапа.

--tags (карта)

Ключевое-значение отображение строк. Допустимый набор символов [a-zA-Z+-=._:/]. Ключ тега может содержать до 128 символов и не должен начинаться с aws: . Значение тега может содержать до 256 символов.

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

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

Сокращенный синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"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
  • таблица
  • 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.

Для создания этапа в API, который будет содержать существующее развертывание

Команда:

aws apigateway create-stage --rest-api-id 1234123412 --stage-name 'dev' --description 'Development stage' --deployment-id a1b2c3

Для создания этапа в API, который будет содержать существующее развертывание и пользовательские переменные этапа

Команда:

aws apigateway create-stage --rest-api-id 1234123412 --stage-name 'dev' --description 'Development stage' --deployment-id a1b2c3 --variables key='value',otherKey='otherValue'

Вывод

deploymentId -> (строка)

Идентификатор развертывания (Deployment), к которому указывает этап.

clientCertificateId -> (строка)

Идентификатор клиентского сертификата для этапа API.

stageName -> (строка)

Имя этапа — это первый сегмент пути в универсальном идентификаторе ресурса (URI) вызова API Gateway. Имена этапов могут содержать только буквенно-цифровые символы, дефисы и нижние подчеркивания. Максимальная длина — 128 символов.

description -> (строка)

Описание этапа.

cacheClusterEnabled -> (булево)

Указывает, включен ли кластер кэша для этапа. Чтобы включить кэш на уровне метода, установите CachingEnabled в true для метода.

cacheClusterSize -> (строка)

Ёмкость кэша этапа в ГБ. Дополнительную информацию о выборе размера кэша см. в разделе Включение кэширования API для повышения отзывчивости.

cacheClusterStatus -> (строка)

Состояние кластера кэша для этапа, если он включен.

methodSettings -> (массив)

Массив, определяющий параметры метода для ресурса Stage. Ключи (обозначенные как /{method_setting_key ниже) — пути к методам, определенные как {resource_path}/{http_method} для отдельной переопределения метода или /\*/\* для переопределения всех методов на этапе.

key -> (строка)

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

Определяет свойства настроек метода.

metricsEnabled -> (булево)

Указывает, включены ли метрики Amazon CloudWatch для этого метода.

loggingLevel -> (строка)

Указывает уровень ведения журнала для этого метода, который влияет на записи журналов, отправляемые в Amazon CloudWatch Logs. Допустимые значения — OFF , ERROR и INFO . Выберите ERROR, чтобы записывать в CloudWatch Logs только записи уровня ошибок, или выберите INFO, чтобы включать все ERROR события, а также дополнительные информационные события.

dataTraceEnabled -> (булево)

Указывает, включен ли отслеживание данных для этого метода, что влияет на записи журналов, отправляемые в Amazon CloudWatch Logs. Это может быть полезно для устранения неполадок с API, но может привести к записи конфиденциальных данных. Мы рекомендуем не включать этот параметр для API в рабочей среде.

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

Указывает предел ограничения сброса.

throttlingRateLimit -> (вещественное число)

Указывает предел скорости ограничения.

cachingEnabled -> (булево)

Указывает, должны ли кэшироваться ответы и возвращаться для запросов. Для кэширования ответов должен быть включен кластер кэша на этапе.

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

Указывает время жизни (TTL) в секундах для кэшированных ответов. Чем выше TTL, тем дольше ответ будет кэшироваться.

cacheDataEncrypted -> (булево)

Указывает, зашифрованы ли кэшированные ответы.

requireAuthorizationForCacheControl -> (булево)

Указывает, требуется ли авторизация для запроса проверки кэша.

unauthorizedCacheControlHeaderStrategy -> (строка)

Указывает, как обрабатывать незащищенные запросы для проверки кэша.

variables -> (массив)

Массив, определяющий переменные этапа для ресурса Stage. Имена переменных могут содержать буквенно-цифровые символы и символы подчеркивания, а значения должны соответствовать [A-Za-z0-9-._~:/?#&=,]+ .

key -> (строка)

value -> (строка)

documentationVersion -> (строка)

Версия связанной документации API.

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

Настройки для ведения журнала доступа на данном этапе.

format -> (строка)

Формат записей журнала доступа в одну строку, как указано выбранными переменными $context. Формат должен включать по крайней мере $context.requestId .

destinationArn -> (строка)

Идентификатор ресурса Amazon (ARN) группы журналов CloudWatch Logs или потока доставки Kinesis Data Firehose для получения журналов доступа. Если вы указываете поток доставки Kinesis Data Firehose, имя потока должно начинаться с amazon-apigateway- .

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

Настройки для развертывания «канарейки» на данном этапе.

percentTraffic -> (вещественное число)

Процент (0-100) трафика, перенаправляемого на развертывание «канарейки».

deploymentId -> (строка)

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

stageVariableOverrides -> (массив)

Переменные этапа, переопределенные для развертывания «канарейки», включая новые переменные этапа, введенные в «канарейке». Эти переменные этапа представлены в виде массива пар «имя переменной этапа — значение».

key -> (строка)

value -> (строка)

useStageCache -> (булево)

Флаг Boolean для указания того, использует ли развертывание «канарейки» кэш этапа или нет.

tracingEnabled -> (булево)

Указывает, включено ли активное отслеживание с помощью X-ray для этапа.

webAclArn -> (строка)

ARN веб-защиты (WebAcl), связанной с этапом.

tags -> (массив)

Коллекция тегов. Каждый элемент тега связан с данным ресурсом.

key -> (строка)

value -> (строка)

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

Метка времени создания этапа.

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

Метка времени последнего обновления этапа.

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

Spec-Zone.ru

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