Spec-Zone.ru › AWS CLI v2

[ aws . route53 ]

list-hosted-zones-by-name

Описание

Возвращает список ваших зон размещения в лексикографическом порядке. Ответ включает элемент HostedZones для каждой зоны размещения, созданной текущей учетной записью Amazon Web Services.

ListHostedZonesByName сортирует зоны размещения по имени с обратным порядком меток. Например:

com.example.www.

Обратите внимание на заключительную точку, которая может изменить порядок сортировки в некоторых случаях.

Если имя домена включает управляющие символы или Punycode, ListHostedZonesByName сортирует имя домена с использованием значения, закодированного с помощью управляющих символов или Punycode, который является форматом сохранения Amazon Route 53 в своей базе данных. Например, для создания зоны размещения для exämple.com, вы указываете ex344mple.com для имени домена. ListHostedZonesByName сортирует его как:

com.ex\344mple.

Метки обращаются и сортируются в алфавитном порядке с использованием закодированного значения. Дополнительную информацию об допустимых форматах имен доменов, включая международные доменные имена, см. в разделе DNS Domain Name Format в Руководстве разработчика Amazon Route 53.

Route 53 возвращает до 100 элементов в каждом ответе. Если у вас много зон размещения, используйте параметр MaxItems, чтобы перечислять их группами по 100. Ответ включает значения, которые помогают переходить от одной группы MaxItems зон размещения к следующей:

  • Элементы DNSName и HostedZoneId в ответе содержат значения, если таковые имеются, указанные для параметров dnsname и hostedzoneid в запросе, который произвел текущий ответ.
  • Элемент MaxItems в ответе содержит значение, если таковое имеется, которое вы указали для параметра maxitems в запросе, который произвел текущий ответ.
  • Если значение IsTruncated в ответе равно true, существует больше зон размещения, связанных с текущей учетной записью Amazon Web Services. Если IsTruncated равно false, этот ответ включает последнюю зону размещения, связанную с текущей учетной записью. Элементы NextDNSName и NextHostedZoneId опущены из ответа.
  • Элементы NextDNSName и NextHostedZoneId в ответе содержат имя домена и идентификатор зоны размещения следующей зоны размещения, связанной с текущей учетной записью Amazon Web Services. Если вы хотите перечислить больше зон размещения, сделайте еще один вызов к ListHostedZonesByName и укажите значение NextDNSName и NextHostedZoneId в параметрах dnsname и hostedzoneid соответственно.

См. также: AWS API Documentation

Синтаксис

  list-hosted-zones-by-name
[--dns-name <value>]
[--hosted-zone-id <value>]
[--max-items <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]

Параметры

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

(Необязательно) Для вашего первого запроса к ListHostedZonesByName, включите параметр dnsname только если вы хотите указать имя первой зоны размещения в ответе. Если вы не включите параметр dnsname, Amazon Route 53 вернет все зоны размещения, созданные текущей учетной записью Amazon Web Services, в порядке ASCII. Для последующих запросов включите оба параметра dnsname и hostedzoneid. Для dnsname укажите значение NextDNSName из предыдущего ответа.

--hosted-zone-id (строка)

(Необязательно) Для вашего первого запроса к ListHostedZonesByName, не включайте параметр hostedzoneid.

Если у вас больше зон размещения, чем значение параметра maxitems, ListHostedZonesByName возвращает только первые maxitems зоны размещения. Чтобы получить следующую группу зон размещения, отправьте еще один запрос к ListHostedZonesByName и включите оба параметра dnsname и hostedzoneid. Для значения hostedzoneid укажите значение элемента NextHostedZoneId из предыдущего ответа.

--max-items (строка)

Максимальное количество зон размещения, которое должно быть включено в тело ответа для этого запроса. Если у вас более maxitems зон размещения, тогда значение элемента IsTruncated в ответе равно true, а значения NextDNSName и NextHostedZoneId указывают первую зону размещения в следующей группе зон размещения.

--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-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix-подобных оболочек. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки терминала. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Следующая команда перечисляет до 100 зон размещения, отсортированных по имени домена:

aws route53 list-hosted-zones-by-name

Вывод:

{
  "HostedZones": [
      {
          "ResourceRecordSetCount": 2,
          "CallerReference": "test20150527-2",
          "Config": {
              "Comment": "test2",
              "PrivateZone": false
          },
          "Id": "/hostedzone/Z119WBBTVP5WFX",
          "Name": "2.example.com."
      },
      {
          "ResourceRecordSetCount": 2,
          "CallerReference": "test20150527-1",
          "Config": {
              "Comment": "test",
              "PrivateZone": false
          },
          "Id": "/hostedzone/Z3P5QSUBK4POTI",
          "Name": "www.example.com."
      }
  ],
  "IsTruncated": false,
  "MaxItems": "100"
}

Следующая команда перечисляет зоны размещения, отсортированные по имени, начиная с www.example.com:

aws route53 list-hosted-zones-by-name --dns-name www.example.com

Вывод:

{
  "HostedZones": [
      {
          "ResourceRecordSetCount": 2,
          "CallerReference": "mwunderl20150527-1",
          "Config": {
              "Comment": "test",
              "PrivateZone": false
          },
          "Id": "/hostedzone/Z3P5QSUBK4POTI",
          "Name": "www.example.com."
      }
  ],
  "DNSName": "www.example.com",
  "IsTruncated": false,
  "MaxItems": "100"
}

Вывод

HostedZones -> (список)

Сложный тип, содержащий общую информацию о размещённой зоне.

(структура)

Сложный тип, содержащий общую информацию о размещённой зоне.

Id -> (строка)

Идентификатор, назначенный Amazon Route 53 размещённой зоне при её создании.

Name -> (строка)

Имя домена. Для публичных размещённых зон это имя, зарегистрированное у вашего регистратора DNS.

Дополнительную информацию о том, как указывать символы, отличные от a-z , 0-9 и - (тире), а также о том, как указывать международные доменные имена, см. в разделе CreateHostedZone.

CallerReference -> (строка)

Значение, заданное вами для CallerReference при создании размещённой зоны.

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

Сложный тип, содержащий элементы Comment и PrivateZone. Если элементы HostedZoneConfig и Comment были опущены из запроса, элементы Config и Comment не появятся в ответе.

Comment -> (строка)

Любые комментарии, которые вы хотите добавить к размещённой зоне.

PrivateZone -> (булево)

Значение, указывающее, является ли это частной размещённой зоной.

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

Количество наборов записей ресурсов в размещённой зоне.

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

Если размещённая зона была создана другой службой, то это та служба, которая её создала. Если размещённая зона создана другой службой, её нельзя редактировать или удалять с помощью Route 53.

ServicePrincipal -> (строка)

Если проверка работоспособности или размещённая зона были созданы другой службой, эта служба. Когда ресурс создан другой службой, его нельзя редактировать или удалять с помощью Amazon Route 53.

Description -> (строка)

Если проверка работоспособности или размещённая зона были созданы другой службой, необязательное описание, которое может предоставить другая служба. Когда ресурс создан другой службой, его нельзя редактировать или удалять с помощью Amazon Route 53.

DNSName -> (строка)

Для последующих вызовов ListHostedZonesByName, значение DNSName соответствует значению, заданному для параметра dnsname в запросе, который породил текущий ответ.

HostedZoneId -> (строка)

Идентификатор, назначенный Amazon Route 53 размещённой зоне при её создании.

IsTruncated -> (булево)

Флаг, указывающий, есть ли ещё размещённые зоны для отображения. Если ответ усечён, вы можете получить следующую группу размещённых зон, снова вызвав ListHostedZonesByName и указав значения элементов NextDNSName и NextHostedZoneId в параметрах dnsname и hostedzoneid соответственно.

NextDNSName -> (строка)

Если IsTruncated имеет значение true, значение NextDNSName является именем первой размещённой зоны в следующей группе размещённых зон. Вызовите ListHostedZonesByName снова и укажите значения NextDNSName и NextHostedZoneId в параметрах dnsname и hostedzoneid соответственно.

Этот элемент присутствует только если IsTruncated равно true.

NextHostedZoneId -> (строка)

Если IsTruncated имеет значение true, значение NextHostedZoneId идентифицирует первую размещённую зону в следующей группе размещённых зон. Вызовите ListHostedZonesByName снова и укажите значения NextDNSName и NextHostedZoneId в параметрах dnsname и hostedzoneid соответственно.

Этот элемент присутствует только если IsTruncated равно true.

MaxItems -> (строка)

Значение, которое вы указали для параметра maxitems в вызове ListHostedZonesByName, который породил текущий ответ.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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