[ aws . apigatewayv2 ]
get-domain-name
Описание
Получает имя домена.
См. также: Документацию API AWS
Синтаксис
get-domain-name
--domain-name <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]
Параметры
--domain-name (строка)
--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-domain-name пример отображает информацию о пользовательском имени домена.
aws apigatewayv2 get-domain-name \
--domain-name api.example.com
Вывод:
{
"ApiMappingSelectionExpression": "$request.basepath",
"DomainName": "api.example.com",
"DomainNameConfigurations": [
{
"ApiGatewayDomainName": "d-1234.execute-api.us-west-2.amazonaws.com",
"CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/123456789012-1234-1234-1234-12345678",
"EndpointType": "REGIONAL",
"HostedZoneId": "123456789111",
"SecurityPolicy": "TLS_1_2",
"DomainNameStatus": "AVAILABLE"
}
],
"Tags": {}
}
Дополнительную информацию см. в разделе «Настройка пользовательского имени домена регионального API Gateway» в Руководстве разработчика Amazon API Gateway.
Вывод
ApiMappingSelectionExpression -> (строка)
DomainName -> (строка)
DomainNameConfigurations -> (список)
Настройки имени домена.
(структура)
Настройка имени домена.
ApiGatewayDomainName -> (строка)
CertificateArn -> (строка)
CertificateName -> (строка)
CertificateUploadDate -> (метка времени)
DomainNameStatus -> (строка)
DomainNameStatusMessage -> (строка)
EndpointType -> (строка)
HostedZoneId -> (строка)
IpAddressType -> (строка)
SecurityPolicy -> (строка)
OwnershipVerificationCertificateArn -> (строка)
MutualTlsAuthentication -> (структура)
Настройка взаимной аутентификации TLS для пользовательского имени домена.
TruststoreUri -> (строка)
TruststoreVersion -> (строка)
TruststoreWarnings -> (список)
Список предупреждений, которые API Gateway возвращает во время обработки вашего хранилища доверия. Недействительные сертификаты генерируют предупреждения. Взаимная аутентификация TLS всё ещё включена, но некоторые клиенты могут не иметь доступа к вашему API. Для решения предупреждений загрузите новое хранилище доверия в S3, а затем обновите своё имя домена, чтобы использовать новую версию.
(строка)
Tags -> (карта)
Коллекция тегов, связанных с именем домена.
ключ -> (строка)
значение -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.