Spec-Zone.ru › AWS CLI v2

[ aws . apigateway ]

get-integration

Описание

Получение настроек интеграции.

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

Синтаксис

  get-integration
--rest-api-id <value>
--resource-id <value>
--http-method <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.

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

Указывает идентификатор ресурса запроса get integration.

--http-method (строка)

Указывает HTTP-метод запроса get integration.

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

Для получения конфигурации интеграции для HTTP-метода, определенного в ресурсе REST API

Команда:

aws apigateway get-integration --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET

Вывод:

{
    "httpMethod": "POST",
    "integrationResponses": {
        "200": {
            "responseTemplates": {
                "application/json": null
            },
            "statusCode": "200"
        }
    },
    "cacheKeyParameters": [],
    "type": "AWS",
    "uri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:My_Function/invocations",
    "cacheNamespace": "y9h6rt"
}

Вывод

type -> (строка)

Указывает тип интеграции метода API. Допустимое значение — одно из следующих:

Для интеграций HTTP и HTTP-прокси, каждая интеграция может указать протокол (http/https ), порт и путь. Поддерживаются стандартные порты 80 и 443, а также пользовательские порты выше 1024. Интеграция HTTP или HTTP-прокси с connectionType VPC_LINK называется частной интеграцией и использует VpcLink для подключения API Gateway к балансировщику нагрузки сети VPC.

httpMethod -> (строка)

Указывает тип HTTP-метода интеграции. Для свойства Type, если вы укажете MOCK , это свойство является необязательным. Для интеграций Lambda вы должны установить метод интеграции на POST . Для всех других типов вы должны указать это свойство.

uri -> (строка)

Указывает универсальный идентификатор ресурса (URI) конечной точки интеграции.

Для HTTP или HTTP_PROXY интеграций URI должен быть полностью сформированным, закодированным HTTP(S) URL в соответствии со спецификацией RFC-3986 для стандартных интеграций. Если connectionType VPC_LINK , укажите имя DNS Network Load Balancer. Для AWS или AWS_PROXY интеграций URI имеет вид arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api} . Здесь {Region} — регион API Gateway (например, us-east-1); {service} — имя интегрированной службы Amazon Web Services (например, s3); и {subdomain} — выделенный домен, поддерживаемый определенными службами Amazon Web Services для быстрого поиска имени хоста. action может использоваться для API службы Amazon Web Services, основанного на действиях, используя строку запроса Action={name}&{p1}={v1}&p2={v2}…. Результирующее {service_api} относится к поддерживаемому действию {name} плюс любые необходимые входные параметры. В качестве альтернативы можно использовать путь для API службы Amazon Web Services, основанного на пути. Результирующее service_api относится к пути к ресурсу службы Amazon Web Services, включая регион интегрированной службы Amazon Web Services, если применимо. Например, для интеграции с API S3 GetObject URI может быть либо arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}, либо arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}.

connectionType -> (строка)

Тип сетевого соединения с конечной точкой интеграции. Допустимое значение — INTERNET для соединений через общедоступный маршрутизируемый интернет или VPC_LINK для частных соединений между API Gateway и балансировщиком нагрузки сети в VPC. Значение по умолчанию — INTERNET.

connectionId -> (строка)

Идентификатор VpcLink, используемый для интеграции, когда connectionType=VPC_LINK и неопределено, в противном случае.

credentials -> (строка)

Указывает необходимые учетные данные для интеграции, если таковые имеются. Для интеграций AWS доступно три варианта. Чтобы указать роль IAM для принятия API Gateway, используйте Amazon Resource Name (ARN) роли. Чтобы потребовать, чтобы идентификатор вызывающего пользователя передавался из запроса, укажите строку arn:aws:iam::\*:user/\* . Для использования разрешений на основе ресурсов в поддерживаемых службах Amazon Web Services, укажите null.

requestParameters -> (карта)

Карта ключ-значение, определяющая параметры запроса, которые передаются из запроса метода в бэкэнд. Ключ — имя параметра запроса интеграции, а соответствующее значение — значение параметра запроса метода или статическое значение, которое должно быть заключено в одинарные кавычки и предварительно закодировано, как требуется бэкэндом. Значение параметра запроса метода должно соответствовать шаблону method.request.{location}.{name} , где location является querystring, path или header, и name должно быть допустимым и уникальным именем параметра запроса метода.

key -> (строка)

value -> (строка)

requestTemplates -> (карта)

Представляет карту шаблонов Velocity, которые применяются к полезной нагрузке запроса на основе значения заголовка Content-Type, отправленного клиентом. Значение типа содержимого — ключ в этой карте, а шаблон (в качестве строки) — значение.

key -> (строка)

value -> (строка)

passthroughBehavior -> (строка)

Указывает, как тело запроса метода с неотображенным типом содержимого будет передаваться в запрос интеграции в бэкэнд без преобразования. Тип содержимого не отображается, если шаблон отображения не определен в интеграции или тип содержимого не соответствует ни одному из отображаемых типов содержимого, как указано в requestTemplates . Допустимое значение — одно из следующих: WHEN_NO_MATCH : пропускает тело запроса метода через запрос интеграции в бэкэнд без преобразования, когда тип содержимого запроса метода не соответствует ни одному из типов содержимого, связанных с шаблонами отображения, определенными в запросе интеграции. WHEN_NO_TEMPLATES : пропускает тело запроса метода через запрос интеграции в бэкэнд без преобразования, когда в запросе интеграции не определен ни один шаблон отображения. Если шаблон определен, когда выбран этот параметр, запрос метода с неотображенным типом содержимого будет отклонен с ответом HTTP 415 Unsupported Media Type. NEVER : отклоняет запрос метода с ответом HTTP 415 Unsupported Media Type, когда тип содержимого запроса метода не соответствует ни одному из типов содержимого, связанных с шаблонами отображения, определенными в запросе интеграции, или в запросе интеграции не определен ни один шаблон отображения.

contentHandling -> (строка)

Указывает, как обрабатывать преобразования типов содержимого полезной нагрузки запроса. Поддерживаемые значения — CONVERT_TO_BINARY и CONVERT_TO_TEXT, с соответствующим поведением:

Если это свойство не определено, полезная нагрузка запроса будет передаваться от запроса метода к запросу интеграции без изменений, при условии, что passthroughBehavior настроен на поддержку передачи полезной нагрузки.

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

Пользовательский тайм-аут от 50 до 29000 миллисекунд. Значение по умолчанию — 29000 миллисекунд или 29 секунд.

cacheNamespace -> (строка)

Указывает группу связанных кэшированных параметров. По умолчанию API Gateway использует идентификатор ресурса в качестве cacheNamespace . Вы можете указать тот же cacheNamespace для разных ресурсов, чтобы получить одинаковые кэшированные данные для запросов к разным ресурсам.

cacheKeyParameters -> (список)

Список параметров запроса, значения которых API Gateway кэширует. Чтобы быть допустимыми значениями для cacheKeyParameters , эти параметры также должны быть указаны для метода requestParameters.

(строка)

integrationResponses -> (карта)

Указывает ответы интеграции.

key -> (строка)

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

Представляет ответ интеграции. Код состояния должен сопоставляться с существующим MethodResponse, и параметры и шаблоны могут использоваться для преобразования ответа бэкэнда.

statusCode -> (строка)

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

selectionPattern -> (строка)

Указывает шаблон регулярного выражения (regex), используемый для выбора ответа интеграции на основе ответа из бэкэнда. Например, если ответ при успехе ничего не возвращает, а ответ при ошибке возвращает какую-то строку, вы можете использовать регулярное выражение .+ для соответствия ответу при ошибке. Однако убедитесь, что ответ при ошибке не содержит символов новой строки (\n) в таких случаях. Если бэкэнд является функцией Lambda, соответствует заголовку ошибки Lambda. Для всех других HTTP и бэкэндов Amazon Web Services соответствует коду HTTP-статуса.

responseParameters -> (карта)

Карта ключ-значение, определяющая параметры ответа, которые передаются в ответ метода из бэкэнда. Ключ — имя параметра заголовка ответа метода, а сопоставленное значение — значение заголовка ответа интеграции, статическое значение, заключенное в пару одинарных кавычек, или выражение JSON из тела ответа интеграции. Ключ сопоставления должен соответствовать шаблону method.response.header.{name} , где name — допустимое и уникальное имя заголовка. Сопоставленное нестатическое значение должно соответствовать шаблону integration.response.header.{name} или integration.response.body.{JSON-expression} , где name — допустимое и уникальное имя заголовка ответа, а JSON-expression — допустимое выражение JSON без префикса $.

key -> (строка)

value -> (строка)

responseTemplates -> (карта)

Указывает шаблоны, используемые для преобразования тела ответа интеграции. Шаблоны ответов представлены в виде карты ключ/значение, где тип содержимого является ключом, а шаблон — значением.

key -> (строка)

value -> (строка)

contentHandling -> (строка)

Указывает, как обрабатывать преобразования типов содержимого полезной нагрузки ответа. Поддерживаемые значения — CONVERT_TO_BINARY и CONVERT_TO_TEXT, с соответствующим поведением:

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

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

Указывает конфигурацию TLS для интеграции.

insecureSkipVerification -> (булево)

Указывает, пропускать ли проверку того, выдан ли сертификат для конечной точки интеграции авторитетным центром сертификации. Это не рекомендуется, но оно позволяет использовать сертификаты, подписанные частными центрами сертификации, или самоподписанные сертификаты. Если включено, API Gateway по-прежнему выполняет основную проверку сертификата, которая включает проверку срока действия сертификата, имени хоста и наличия корневого сертификата. Поддерживается только для HTTP и HTTP_PROXY интеграций.

Предупреждение

Включение insecureSkipVerification не рекомендуется, особенно для интеграций с общедоступными HTTPS-конечными точками. Если вы включите insecureSkipVerification, вы увеличиваете риск атак «человек посередине».

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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