Spec-Zone.ru › AWS CLI v2

[ aws . apigateway ]

получение-ассоциаций-доступа-к-имени-домена

Описание

Представляет коллекцию ресурсов DomainNameAccessAssociations.

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

Синтаксис

  get-domain-name-access-associations
[--position <value>]
[--limit <value>]
[--resource-owner <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]

Параметры

--position (строка)

Текущая позиция постраничной навигации в наборе результатов.

--limit (целое число)

Максимальное количество результатов на странице. Значение по умолчанию 25, максимальное значение 500.

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

Владелец ассоциации доступа к имени домена. Используйте SELF, чтобы отобразить только ассоциации доступа к именам доменов, принадлежащие вашему аккаунту. Используйте OTHER_ACCOUNTS, чтобы отобразить ассоциации доступа к именам доменов с вашими частными пользовательскими именами доменов, которые принадлежат другим аккаунтам AWS.

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

  • SELF
  • OTHER_ACCOUNTS

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

Пример 1: Просмотр всех ассоциаций доступа к имени домена

Следующий get-domain-name-access-associations пример отображает все ассоциации доступа к имени домена.

aws apigateway get-domain-name-access-associations

Вывод:

{
    "items": [
        {
        "domainNameAccessAssociationArn": "arn:aws:apigateway:us-west-2:012345678910:/domainnameaccessassociations/domainname/my.private.domain.tld/vpcesource/vpce-abcd1234efg
        "accessAssociationSource": "vpce-abcd1234efg",
        "accessAssociationSourceType": "VPCE",
        "domainNameArn" : "arn:aws:apigateway:us-west-2:111122223333:/domainnames/private.example.com+abcd1234"
        }
    ]
}

Дополнительную информацию см. в разделе «Пользовательские имена доменов для частных API в API Gateway» в Руководстве разработчика Amazon API Gateway.

Пример 2: Просмотр всех ассоциаций доступа к имени домена, принадлежащих этому аккаунту AWS

Следующий get-domain-name-access-associations пример отображает все ассоциации доступа к именам доменов, принадлежащие текущему аккаунту AWS.

aws apigateway get-domain-name-access-associations \
    --resource-owner SELF

Вывод:

{
    "items": [
        {
        "domainNameAccessAssociationArn": "arn:aws:apigateway:us-west-2:012345678910:/domainnameaccessassociations/domainname/my.private.domain.tld/vpcesource/vpce-abcd1234efg
        "accessAssociationSource": "vpce-abcd1234efg",
        "accessAssociationSourceType": "VPCE",
        "domainNameArn" : "arn:aws:apigateway:us-west-2:111122223333:/domainnames/private.example.com+abcd1234"
        }
    ]
}

Дополнительную информацию см. в разделе «Пользовательские имена доменов для частных API в API Gateway» в Руководстве разработчика Amazon API Gateway.

Вывод

position -> (строка)

items -> (список)

Текущая страница элементов из этой коллекции.

(структура)

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

domainNameAccessAssociationArn -> (строка)

ARN ресурса ассоциации доступа к имени домена.

domainNameArn -> (строка)

ARN имени домена.

accessAssociationSourceType -> (строка)

Тип источника ассоциации доступа к имени домена.

accessAssociationSource -> (строка)

ARN источника ассоциации доступа к имени домена. Для VPCE ARN должен быть VPC-точкой входа.

tags -> (карта)

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

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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