[ aws . apigateway ]
get-resource
Описание
Перечисляет информацию о ресурсе.
См. также: Документация AWS API
Синтаксис
get-resource
--rest-api-id <value>
--resource-id <value>
[--embed <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 (строка)
--resource-id (строка)
--embed (список)
Параметр запроса для извлечения указанных ресурсов, вложенных в представлении Resource в ответе. Это embed значение параметра — список, разделенный запятыми. В настоящее время запрос поддерживает только извлечение вложенных ресурсов Method таким способом. Значение параметра запроса должно быть списком с одним значением и содержать "methods" строку. Например, GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods .
(строка)
Синтаксис:
"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.
Для получения информации о ресурсе
Команда:
aws apigateway get-resource --rest-api-id 1234123412 --resource-id zwo0y3
Вывод:
{
"path": "/path",
"pathPart": "path",
"id": "zwo0y3",
"parentId": "uyokt6ij2g"
}
Вывод
id -> (строка)
parentId -> (строка)
pathPart -> (строка)
path -> (строка)
resourceMethods -> (карта)
Получает метод ресурса API для заданного HTTP-глагола.
ключ -> (строка)
значение -> (структура)
Представляет интерфейс для клиентов, с помощью которого клиенты вызывают API для доступа к ресурсам на стороне сервера. Ресурс Method интегрирован с ресурсом Integration. Оба содержат запрос и один или несколько ответов. Запрос метода принимает входные данные клиента, которые передаются на сервер через запрос интеграции. Ответ метода возвращает вывод с сервера клиенту через ответ интеграции. Запрос метода воплощен в ресурсе Method, в то время как запрос интеграции воплощен в ресурсе Integration. С другой стороны, ответ метода представлен ресурсом MethodResponse, а ответ интеграции — ресурсом IntegrationResponse.
httpMethod -> (строка)
authorizationType -> (строка)
NONE для открытого доступа, AWS_IAM для использования разрешений AWS IAM, CUSTOM для использования пользовательского авторизатора или COGNITO_USER_POOLS для использования пула пользователей Cognito.authorizerId -> (строка)
authorizationType должен быть CUSTOM .apiKeyRequired -> (булево)
requestValidatorId -> (строка)
operationName -> (строка)
operationName ListPets для метода GET /pets в примере PetStore.requestParameters -> (карта)
Ключевое-значение карта, определяющая обязательные или необязательные параметры запроса метода, которые могут быть приняты API Gateway. Ключ — это имя параметра запроса метода, соответствующее шаблону method.request.{location}.{name}, где location — querystring, path или header, и name — допустимое и уникальное имя параметра. Значение, связанное с ключом, — это булевский флаг, указывающий, является ли параметр обязательным (true) или необязательным (false). Имена параметров запроса метода, определенные здесь, доступны в Integration для сопоставления с параметрами запроса интеграции или шаблонами.
ключ -> (строка)
значение -> (булево)
requestModels -> (карта)
Ключевое-значение карта, задающая схемы данных, представленные ресурсами Model (как сопоставленное значение) загрузок запросов заданных типов контента (как ключ сопоставления).
ключ -> (строка)
значение -> (строка)
methodResponses -> (карта)
Получает ответ метода, связанный с заданным кодом HTTP-статуса.
ключ -> (строка)
значение -> (структура)
Представляет ответ метода для заданного кода HTTP-статуса, возвращаемого клиенту. Ответ метода передается с сервера через соответствующий ответ интеграции, который можно преобразовать с помощью шаблона сопоставления.
statusCode -> (строка)
responseParameters -> (карта)
Ключевое-значение карта, задающая обязательные или необязательные параметры ответа, которые API Gateway может отправлять обратно вызывающему абоненту. Ключ определяет заголовок ответа метода, а значение указывает, является ли соответствующий заголовок ответа метода обязательным или нет. Выражение ключа должно соответствовать шаблону method.response.header.{name}, где name — допустимое и уникальное имя заголовка. API Gateway передает определенные данные ответа интеграции в заголовки ответа метода, указанные здесь, в соответствии с сопоставлением, которое вы описываете в IntegrationResponse API. Данные ответа интеграции, которые можно сопоставить, включают заголовок ответа интеграции, выраженный в integration.response.header.{name}, статическое значение, заключенное в одинарные кавычки (например, 'application/json'), или JSON-выражение из полезной нагрузки ответа сервера в форме integration.response.body.{JSON-expression}, где JSON-expression — допустимое JSON-выражение без префикса $.
ключ -> (строка)
значение -> (булево)
responseModels -> (карта)
Задает ресурсы Model, используемые для типа контента ответа. Модели ответов представлены в виде пары ключ/значение, где тип контента — ключ, а имя модели — значение.
ключ -> (строка)
значение -> (строка)
methodIntegration -> (структура)
Получает метод интеграции, ответственный за передачу запроса, отправленного клиентом, на бэкенд и выполнение необходимых преобразований для соответствия запроса требованиям бэкенда.
type -> (строка)
Указывает тип интеграции API-метода. Допустимое значение — одно из следующих:
Для интеграций HTTP и HTTP-прокси каждая интеграция может указать протокол (http/https ), порт и путь. Поддерживаются стандартные порты 80 и 443, а также настраиваемые порты выше 1024. Интеграция HTTP или HTTP-прокси с connectionType VPC_LINK называется частной интеграцией и использует VpcLink для подключения API Gateway к балансировщику нагрузки сети VPC.
httpMethod -> (строка)
MOCK , это свойство необязательно. Для интеграций Lambda вы должны установить метод интеграции на POST . Для всех остальных типов вы должны указать это свойство.uri -> (строка)
Указывает универсальный идентификатор ресурса (URI) конечной точки интеграции.
Для интеграций HTTP или HTTP_PROXY URI должен быть полностью сформированным, закодированным URL HTTP(S) в соответствии со спецификацией RFC-3986 для стандартных интеграций. Если connectionType VPC_LINK , укажите имя DNS балансировщика сетевой нагрузки. Для интеграций 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 -> (строка)
connectionType=VPC_LINK и не определено, в противном случае.credentials -> (строка)
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 -> (целое число)
cacheNamespace -> (строка)
cacheNamespace . Вы можете указать тот же cacheNamespace для разных ресурсов, чтобы возвращать одинаковые кешированные данные для запросов к разным ресурсам.cacheKeyParameters -> (список)
Список параметров запроса, значения которых API Gateway кеширует. Чтобы быть допустимыми значениями для cacheKeyParameters , эти параметры также должны быть указаны для метода requestParameters.
(строка)
integrationResponses -> (карта)
Определяет ответы интеграции.
key -> (строка)
value -> (структура)
Представляет ответ интеграции. Код состояния должен соответствовать существующему MethodResponse, и параметры и шаблоны могут использоваться для преобразования ответа бэкенда.
statusCode -> (строка)
selectionPattern -> (строка)
.+ для соответствия ответу об ошибке. Однако убедитесь, что ответ об ошибке не содержит символов новой строки (\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, вы повышаете риск атак «человек посередине».authorizationScopes -> (список)
Список областей авторизации, настроенных для метода. Области используются с COGNITO_USER_POOLS авторизатором для авторизации вызова метода. Авторизация выполняется путем сопоставления областей метода с областями, извлеченными из маркера доступа в входящем запросе. Вызов метода авторизуется, если любая область метода соответствует утвержденной области в марке доступа. В противном случае вызов не авторизован. При настройке области метода клиент должен предоставить маркер доступа вместо маркера идентификатора для целей авторизации.
(строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.