Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-vpcs

Описание

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

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

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

Синтаксис

  describe-vpcs
[--filters <value>]
[--vpc-ids <value>]
[--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]

Параметры

--filters (список)

Фильтры.

  • cidr - Основной IPv4 CIDR-блок VPC. Указанный вами CIDR-блок должен точно соответствовать CIDR-блоку VPC для возврата информации о VPC. Должен содержать слеш, за которым следуют одна или две цифры (например, /28).
  • cidr-block-association.cidr-block - IPv4 CIDR-блок, связанный с VPC.
  • cidr-block-association.association-id - Идентификатор связи IPv4 CIDR-блока, связанного с VPC.
  • cidr-block-association.state - Состояние IPv4 CIDR-блока, связанного с VPC.
  • dhcp-options-id - Идентификатор набора параметров DHCP.
  • ipv6-cidr-block-association.ipv6-cidr-block - IPv6 CIDR-блок, связанный с VPC.
  • ipv6-cidr-block-association.ipv6-pool - Идентификатор пула адресов IPv6, из которого выделяется IPv6 CIDR-блок.
  • ipv6-cidr-block-association.association-id - Идентификатор связи IPv6 CIDR-блока, связанного с VPC.
  • ipv6-cidr-block-association.state - Состояние IPv6 CIDR-блока, связанного с VPC.
  • is-default - Указывает, является ли VPC основным VPC.
  • owner-id - Идентификатор учётной записи Amazon Web Services, владеющей VPC.
  • state - Состояние VPC (pending | available).
  • tag - Комбинация ключ/значение тега, назначенного ресурсу. Используйте ключ тега в имени фильтра и значение тега в качестве значения фильтра. Например, чтобы найти все ресурсы, имеющие тег с ключом Owner и значением TeamA, укажите tag:Owner для имени фильтра и TeamA для значения фильтра.
  • tag-key - Ключ тега, назначенного ресурсу. Используйте этот фильтр, чтобы найти все ресурсы, которым назначен тег с указанным ключом, независимо от значения тега.
  • vpc-id - Идентификатор VPC.

(структура)

Пара имя-значение фильтра, используемая для возврата более конкретного списка результатов из операции описания. Фильтры могут использоваться для соответствия набору ресурсов по определенным критериям, таким как теги, атрибуты или идентификаторы.

Если вы указываете несколько фильтров, фильтры объединяются с AND, и запрос возвращает только результаты, которые соответствуют всем указанным фильтрам.

Дополнительную информацию см. в разделе Список и фильтрация с помощью командной строки и API в руководстве Amazon EC2 User Guide.

Имя -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

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

(строка)

Укороченный синтаксис:

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

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--vpc-ids (список)

Идентификаторы VPC.

(строка)

Синтаксис:

"string" "string" ...

--dry-run | --no-dry-run (булево)

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

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

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

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

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

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

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

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

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

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

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

--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 User Guide для получения дополнительной информации.

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

Пример 1: Описание всех ваших VPC

Следующий пример describe-vpcs получает сведения о ваших VPC.

aws ec2 describe-vpcs

Вывод:

{
    "Vpcs": [
        {
            "CidrBlock": "30.1.0.0/16",
            "DhcpOptionsId": "dopt-19edf471",
            "State": "available",
            "VpcId": "vpc-0e9801d129EXAMPLE",
            "OwnerId": "111122223333",
            "InstanceTenancy": "default",
            "CidrBlockAssociationSet": [
                {
                    "AssociationId": "vpc-cidr-assoc-062c64cfafEXAMPLE",
                    "CidrBlock": "30.1.0.0/16",
                    "CidrBlockState": {
                        "State": "associated"
                    }
                }
            ],
            "IsDefault": false,
            "Tags": [
                {
                    "Key": "Name",
                    "Value": "Not Shared"
                }
            ]
        },
        {
            "CidrBlock": "10.0.0.0/16",
            "DhcpOptionsId": "dopt-19edf471",
            "State": "available",
            "VpcId": "vpc-06e4ab6c6cEXAMPLE",
            "OwnerId": "222222222222",
            "InstanceTenancy": "default",
            "CidrBlockAssociationSet": [
                {
                    "AssociationId": "vpc-cidr-assoc-00b17b4eddEXAMPLE",
                    "CidrBlock": "10.0.0.0/16",
                    "CidrBlockState": {
                        "State": "associated"
                    }
                }
            ],
            "IsDefault": false,
            "Tags": [
                {
                    "Key": "Name",
                    "Value": "Shared VPC"
                }
            ]
        }
    ]
}

Пример 2: Описание указанного VPC

Следующий пример describe-vpcs получает сведения об указанном VPC.

aws ec2 describe-vpcs \
    --vpc-ids vpc-06e4ab6c6cEXAMPLE

Вывод:

{
    "Vpcs": [
        {
            "CidrBlock": "10.0.0.0/16",
            "DhcpOptionsId": "dopt-19edf471",
            "State": "available",
            "VpcId": "vpc-06e4ab6c6cEXAMPLE",
            "OwnerId": "111122223333",
            "InstanceTenancy": "default",
            "CidrBlockAssociationSet": [
                {
                    "AssociationId": "vpc-cidr-assoc-00b17b4eddEXAMPLE",
                    "CidrBlock": "10.0.0.0/16",
                    "CidrBlockState": {
                        "State": "associated"
                    }
                }
            ],
            "IsDefault": false,
            "Tags": [
                {
                    "Key": "Name",
                    "Value": "Shared VPC"
                }
            ]
        }
    ]
}

Вывод

NextToken -> (строка)

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

Vpcs -> (список)

Информация о VPC.

(структура)

Описание VPC.

OwnerId -> (строка)

Идентификатор учётной записи Amazon Web Services, владеющей VPC.

InstanceTenancy -> (строка)

Допустимая аренда экземпляров, запущенных в VPC.

Ipv6CidrBlockAssociationSet -> (список)

Информация об IPv6 CIDR-блоках, связанных с VPC.

(структура)

Описание IPv6 CIDR-блока, связанного с VPC.

AssociationId -> (строка)

Идентификатор ассоциации для IPv6 CIDR-блока.

Ipv6CidrBlock -> (строка)

IPv6 CIDR-блок.

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

Информация о состоянии CIDR-блока.

State -> (строка)

Состояние CIDR-блока.

StatusMessage -> (строка)

Сообщение о состоянии CIDR-блока, если применимо.

NetworkBorderGroup -> (строка)

Название уникального набора зон доступности, локальных зон или зон Wavelength, из которых Amazon Web Services рекламирует IP-адреса, например, us-east-1-wl1-bos-wlz-1.

Ipv6Pool -> (строка)

Идентификатор пула IPv6-адресов, из которого выделяется IPv6 CIDR-блок.

Ipv6AddressAttribute -> (строка)

Общедоступные IPv6-адреса — это адреса, рекламируемые в интернете Amazon Web Services. Приватные IP-адреса не рекламируются и не могут быть рекламированы в интернете Amazon Web Services.

IpSource -> (строка)

Источник, который выделил пространство IP-адресов. byoip или amazon указывает на пространство общедоступных IP-адресов, выделенное Amazon, или пространство, которое вы выделили с помощью Bring your own IP (BYOIP). none указывает на приватное пространство.

CidrBlockAssociationSet -> (список)

Информация об IPv4 CIDR-блоках, связанных с VPC.

(структура)

Описание IPv4 CIDR-блока, связанного с VPC.

AssociationId -> (строка)

Идентификатор ассоциации для IPv4 CIDR-блока.

CidrBlock -> (строка)

IPv4 CIDR-блок.

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

Информация о состоянии CIDR-блока.

State -> (строка)

Состояние CIDR-блока.

StatusMessage -> (строка)

Сообщение о состоянии CIDR-блока, если применимо.

IsDefault -> (булево)

Указывает, является ли VPC стандартным VPC.

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

VpcId -> (строка)

VpcEncryptionControlId -> (строка)

Mode -> (строка)

State -> (строка)

StateMessage -> (строка)

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

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

State -> (строка)

StateMessage -> (строка)

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

State -> (строка)

StateMessage -> (строка)

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

State -> (строка)

StateMessage -> (строка)

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

State -> (строка)

StateMessage -> (строка)

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

State -> (строка)

StateMessage -> (строка)

Tags -> (список)

(структура)

Описание тега.

Key -> (строка)

Ключ тега.

Ограничения: Ключи тегов чувствительны к регистру и поддерживают максимум 127 символов Юникода. Не может начинаться с aws:.

Value -> (строка)

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

Ограничения: Значения тегов чувствительны к регистру и поддерживают максимум 256 символов Юникода.

Tags -> (список)

Любые теги, назначенные VPC.

(структура)

Описание тега.

Key -> (строка)

Ключ тега.

Ограничения: Ключи тегов чувствительны к регистру и поддерживают максимум 127 символов Юникода. Не может начинаться с aws:.

Value -> (строка)

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

Ограничения: Значения тегов чувствительны к регистру и поддерживают максимум 256 символов Юникода.

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

Состояние VPC Block Public Access (BPA).

InternetGatewayBlockMode -> (строка)

Режим VPC BPA.

  • off: VPC BPA не включен, и трафик разрешён к интернет-шлюзам и интернет-шлюзам только исходящего трафика в этой области.
  • block-bidirectional: Заблокировать весь трафик к и из интернет-шлюзов и интернет-шлюзов только исходящего трафика в этой области (за исключением исключённых VPC и подсетей).
  • block-ingress: Заблокировать весь интернет-трафик для VPC в этой области (за исключением исключённых VPC или подсетей). Разрешён только трафик к и из шлюзов NAT и интернет-шлюзов только исходящего трафика, поскольку эти шлюзы разрешают только установление исходящих соединений.

VpcId -> (строка)

Идентификатор VPC.

State -> (строка)

Текущее состояние VPC.

CidrBlock -> (строка)

Основной IPv4 CIDR-блок для VPC.

DhcpOptionsId -> (строка)

Идентификатор набора параметров DHCP, ассоциированных с VPC.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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