Spec-Zone.ru › AWS CLI v2

[ aws . lightsail ]

get-domain

Описание

Возвращает информацию о конкретном наборе записей домена.

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

Синтаксис

  get-domain
--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
  • text
  • таблица
  • 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 отображает данные о домене example.com.

Примечание: операции API Lightsail, связанные с доменами, доступны только в регионе AWS us-east-1. Если ваш профиль CLI настроен на использование другого региона, необходимо добавить параметр `` –region us-east-1``, иначе команда завершится с ошибкой.

aws lightsail get-domain \
    --domain-name example.com \
    --region us-east-1

Вывод:

{
    "domain": {
        "name": "example.com",
        "arn": "arn:aws:lightsail:global:111122223333:Domain/28cda903-3f15-44b2-9baf-3EXAMPLEb304",
        "supportCode": "6EXAMPLE3362//hostedzone/ZEXAMPLEONGSC1",
        "createdAt": 1570728588.6,
        "location": {
            "availabilityZone": "all",
            "regionName": "global"
        },
        "resourceType": "Domain",
        "tags": [],
        "domainEntries": [
            {
                "id": "-1682899164",
                "name": "example.com",
                "target": "192.0.2.0",
                "isAlias": false,
                "type": "A"
            },
            {
                "id": "1703104243",
                "name": "example.com",
                "target": "ns-137.awsdns-17.com",
                "isAlias": false,
                "type": "NS"
            },
            {
                "id": "-1038331153",
                "name": "example.com",
                "target": "ns-1710.awsdns-21.co.uk",
                "isAlias": false,
                "type": "NS"
            },
            {
                "id": "-2107289565",
                "name": "example.com",
                "target": "ns-692.awsdns-22.net",
                "isAlias": false,
                "type": "NS"
            },
            {
                "id": "1582095705",
                "name": "example.com",
                "target": "ns-1436.awsdns-51.org",
                "isAlias": false,
                "type": "NS"
            },
            {
                "id": "-1769796132",
                "name": "example.com",
                "target": "ns-1710.awsdns-21.co.uk. awsdns-hostmaster.amazon.com. 1 7200 900 1209600 86400",
                "isAlias": false,
                "type": "SOA"
            }
        ]
    }
}

Вывод

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

Массив пар ключ-значение, содержащих информацию о вашем запросе get domain.

name -> (строка)

Имя домена.

arn -> (строка)

Amazon Resource Name (ARN) набора записей домена (arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).

supportCode -> (строка)

Код поддержки. Укажите этот код в своем письме в службу поддержки, если у вас есть вопросы об экземпляре или другом ресурсе в Lightsail. Этот код поможет нашей команде поддержки быстрее найти вашу информацию в Lightsail.

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

Дата создания набора записей домена.

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

AWS регион и зоны доступности, где был создан набор записей домена.

availabilityZone -> (строка)

Зона доступности. Следует формату us-east-2a (регистрозависимо).

regionName -> (строка)

Имя региона Amazon Web Services.

resourceType -> (строка)

Тип ресурса.

tags -> (список)

Ключи и необязательные значения тегов для ресурса. Дополнительную информацию о тегах в Lightsail см. в руководстве разработчика Amazon Lightsail.

(структура)

Описание ключа тега и необязательного значения, назначенного ресурсу Amazon Lightsail.

Дополнительную информацию о тегах в Lightsail см. в руководстве разработчика Amazon Lightsail.

key -> (строка)

Ключ тега.

Ограничения: Ключи тегов принимают не более 128 символов, цифр, пробелов в UTF-8 или следующих символов: + - = . _ : / @

value -> (строка)

Значение тега.

Ограничения: Значения тегов принимают не более 256 символов, цифр, пробелов в UTF-8 или следующих символов: + - = . _ : / @

domainEntries -> (список)

Массив пар ключ-значение, содержащих информацию о записях домена.

(структура)

Описание записи набора записей домена.

id -> (строка)

Идентификатор записи набора записей домена.

name -> (строка)

Имя домена.

target -> (строка)

Целевой IP-адрес (192.0.2.0) или имя сервера AWS (ns-111.awsdns-22.com.).

Для балансировщиков нагрузки Lightsail значение выглядит как ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. Для распределений Lightsail значение выглядит как exampled1182ne.cloudfront.net. Для служб контейнеров Lightsail значение выглядит как container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Убедитесь, что также задано isAlias на true при настройке записи A для балансировщика нагрузки, распределения или службы контейнеров Lightsail.

isAlias -> (логическое значение)

В случае true указывает, является ли запись домена псевдонимом, используемым балансировщиком нагрузки Lightsail, службой контейнеров Lightsail, распределением CDN Lightsail или другим ресурсом Amazon Web Services. Вы можете включить запись псевдонима (типа A) в свой запрос, которая указывает на имя DNS балансировщика нагрузки, службы контейнеров, распределения CDN или другого ресурса Amazon Web Services и направляет трафик на этот ресурс.

type -> (строка)

Тип записи домена, например адрес IPv4 (A), адрес IPv6 (AAAA), каноническое имя (CNAME), почтовый обменник (MX), сервер имен (NS), начало зоны авторитета (SOA), локатор службы (SRV) или текст (TXT).

Следующие типы записей домена могут быть использованы:

  • A
  • AAAA
  • CNAME
  • MX
  • NS
  • SOA
  • SRV
  • TXT

options -> (карта)

(Устарело) Параметры записи домена.

Примечание

В выпусках до 29 ноября 2017 года этот параметр не включался в ответ API. Сейчас он устарел.

key -> (строка)

value -> (строка)

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

Объект, описывающий состояние делегирования домена Route 53 в зону DNS Lightsail.

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

Объект, описывающий состояние записей серверов имен, автоматически добавленных в домен Route 53 Lightsail.

code -> (строка)

Код состояния обновления серверов имен.

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

  • SUCCEEDED - Записи серверов имен были успешно обновлены.
  • PENDING - Обновление записей серверов имен выполняется.
  • FAILED - Обновление записей серверов имен завершилось неудачей.
  • STARTED - Автоматическое обновление записей серверов имен началось.

message -> (строка)

Сообщение, описывающее причину кода состояния.

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

Описание состояния удаления зоны размещения Amazon Route 53 для домена, который автоматически делегируется в зону DNS Amazon Lightsail.

code -> (строка)

Код состояния удаления.

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

  • SUCCEEDED - Зона размещения была успешно удалена.
  • PENDING - Удаление зоны размещения выполняется.
  • FAILED - Удаление зоны размещения завершилось неудачей.
  • STARTED - Удаление зоны размещения началось.

message -> (строка)

Сообщение, описывающее причину кода состояния.

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

Spec-Zone.ru

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