Spec-Zone.ru › AWS CLI v2

[ aws . route53domains ]

list-domains

Описание

Этот оператор возвращает все доменные имена, зарегистрированные в Amazon Route 53 для текущей учетной записи Amazon Web Services, если не используются условия фильтрации.

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

list-domains является операцией с постраничным выводом. Для получения всего набора результатов могут быть вызваны несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлечь данные из результатов следующих выражений запроса: Domains

Синтаксис

  list-domains
[--filter-conditions <value>]
[--sort-condition <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--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]

Параметры

--filter-conditions (список)

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

(структура)

Информация для фильтрации списка доменов, возвращаемых оператором ListDomains.

Name -> (строка)

Имя поля, которое должно использоваться для фильтрации списка доменов.

Operator -> (строка)

Значения операторов для фильтрации доменных имен. Значения могут быть:

  • LE : Меньше или равно
  • GE : Больше или равно
  • BEGINS_WITH : Начинается с

Values -> (список)

Массив строк, представляющих значения для сравнения. В настоящее время поддерживается только 1 элемент в списке.

(строка)

Сокращенный синтаксис:

Name=string,Operator=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "DomainName"|"Expiry",
    "Operator": "LE"|"GE"|"BEGINS_WITH",
    "Values": ["string", ...]
  }
  ...
]

--sort-condition (структура)

Сложный тип, содержащий информацию о запрошенном порядке доменов в возвращаемом списке.

Name -> (строка)

Поле, используемое для сортировки списка доменов. Это может быть либо имя, либо срок действия домена. Обратите внимание, что если filterCondition используется в одном и том же вызове ListDomains, поле, используемое для сортировки, должно совпадать с полем, используемым для фильтрации.

SortOrder -> (строка)

Порядок сортировки списка доменов. Либо возрастающий (ASC), либо убывающий (DES).

Сокращенный синтаксис:

Name=string,SortOrder=string

Синтаксис JSON:

{
  "Name": "DomainName"|"Expiry",
  "SortOrder": "ASC"|"DESC"
}

--max-items (целое число)

Общее количество элементов, которые необходимо вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS Command Line Interface.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в формате JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, поскольку строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Маркер для указания точки начала постраничного вывода. Это NextToken из ранее укороченного ответа.

Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить таймаут вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS Command Line Interface.

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

Следующая команда list-domains выводит сводную информацию о доменах, зарегистрированных в текущей учетной записи AWS.

Эта команда работает только в регионе us-east-1. Если ваш регион по умолчанию установлен на us-east-1, вы можете опустить параметр region.

aws route53domains list-domains
    --region us-east-1

Вывод:

{
    "Domains": [
        {
            "DomainName": "example.com",
            "AutoRenew": true,
            "TransferLock": true,
            "Expiry": 1602712345.0
        },
        {
            "DomainName": "example.net",
            "AutoRenew": true,
            "TransferLock": true,
            "Expiry": 1602723456.0
        },
        {
            "DomainName": "example.org",
            "AutoRenew": true,
            "TransferLock": true,
            "Expiry": 1602734567.0
        }
    ]
}

Вывод

Domains -> (список)

Список доменов.

(структура)

Сводная информация об одном домене.

DomainName -> (строка)

Имя домена, к которому относится сводная информация.

AutoRenew -> (логическое)

Указывает, обновляется ли домен автоматически при истечении срока действия.

TransferLock -> (логическое)

Указывает, заблокирован ли домен от несанкционированной передачи другому участнику.

Expiry -> (метка времени)

Дата истечения срока действия домена в формате Unix и координированное всемирное время (UTC).

NextPageMarker -> (строка)

Если доменов больше, чем вы указали для MaxItems в запросе, отправьте другой запрос и включите значение NextPageMarker в значение Marker.

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

Spec-Zone.ru

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