Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-byoip-cidrs

Описание

Описывает диапазоны IP-адресов, указанные в вызовах ProvisionByoipCidr.

Чтобы описать пулы адресов, созданные при резервировании диапазонов адресов, используйте DescribePublicIpv4Pools или DescribeIpv6Pools.

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

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

Синтаксис

  describe-byoip-cidrs
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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]

Параметры

--dry-run | --no-dry-run (boolean)

Проверяет, есть ли у вас необходимые разрешения для действия, без фактического выполнения запроса, и возвращает ответ об ошибке. Если у вас есть необходимые разрешения, ответ об ошибке будет DryRunOperation. В противном случае это будет UnauthorizedOperation.

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

--starting-token (string)

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

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

--page-size (integer)

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

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

--max-items (integer)

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

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

--generate-cli-skeleton (string) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если указано без значения или со значением input, выводит JSON-ввод, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример ввода YAML, который можно использовать с --cli-input-yaml. При указании значения output он проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (boolean)

Включить отладку регистрации.

--endpoint-url (string)

Переопределяет URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение по умолчанию по проверке SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную обработку. Если автоматическая постраничная обработка отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования для вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот параметр указан.

--ca-bundle (string)

Файл сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить постраничный вывод кли.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

Чтобы описать резервируемые диапазоны адресов

Следующий пример describe-byoip-cidrs отображает подробности о диапазонах общедоступных IPv4-адресов, которые вы зарезервировали для использования AWS.

aws ec2 describe-byoip-cidrs

Вывод:

{
    "ByoipCidrs": [
        {
            "Cidr": "203.0.113.25/24",
            "StatusMessage": "ipv4pool-ec2-1234567890abcdef0",
            "State": "provisioned"
        }
    ]
}

Вывод

ByoipCidrs -> (список)

Информация о диапазонах адресов.

(структура)

Информация о диапазоне адресов, зарезервированном для использования с ресурсами Amazon Web Services с использованием собственных IP-адресов (BYOIP).

Cidr -> (строка)

Диапазон адресов в CIDR-нотации.

Description -> (строка)

Описание диапазона адресов.

AsnAssociations -> (список)

Связи BYOIP CIDR с ASN.

(структура)

Автономный номер системы (ASN) и связь BYOIP CIDR.

Asn -> (строка)

ASN связи.

Cidr -> (строка)

CIDR связи.

StatusMessage -> (строка)

Сообщение о статусе связи.

State -> (строка)

Состояние связи.

StatusMessage -> (строка)

В случае успеха содержит ID пула адресов. В противном случае содержит сообщение об ошибке.

State -> (строка)

Состояние диапазона адресов.

  • advertised : Диапазон адресов рекламируется Amazon Web Services в интернет.
  • deprovisioned : Диапазон адресов деактивирован.
  • failed-deprovision : Запрос на деактивацию диапазона адресов не удался. Убедитесь, что все EIP из диапазона были удалены, и повторите попытку.
  • failed-provision : Запрос на резервирование диапазона адресов не удался.
  • pending-deprovision : Вы отправили запрос на деактивацию диапазона адресов, и он находится в ожидании.
  • pending-provision : Вы отправили запрос на резервирование диапазона адресов, и он находится в ожидании.
  • provisioned : Диапазон адресов зарезервирован и может быть рекламирован. В настоящее время диапазон не рекламируется.
  • provisioned-not-publicly-advertisable : Диапазон адресов зарезервирован и не может быть рекламирован.

NetworkBorderGroup -> (строка)

Если у вас включены локальные зоны, при резервировании и рекламе BYOIPv4 CIDR вы можете выбрать группу сетевых границ для локальных зон. Тщательно выберите группу сетевых границ, так как EIP и связанный с ним ресурс Amazon Web Services должны находиться в одной группе сетевых границ.

Вы можете резервировать диапазоны адресов BYOIP и рекламировать их в следующих группах сетевых границ локальных зон:

  • us-east-1-dfw-2
  • us-west-2-lax-1
  • us-west-2-phx-2

Примечание

В настоящее время вы не можете резервировать или рекламировать диапазоны адресов BYOIPv6 в локальных зонах.

NextToken -> (строка)

Маркер для получения следующей страницы результатов. Это значение null, когда больше результатов возвращать не нужно.

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

Spec-Zone.ru

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