Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-subnets

Описание

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

Для получения дополнительной информации см. Подсети в руководстве пользователя Amazon VPC.

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

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

Синтаксис

  describe-subnets
[--filters <value>]
[--subnet-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 (список)

Фильтры.

  • availability-zone — Доступная зона для подсети. Вы также можете использовать availabilityZone в качестве имени фильтра.
  • availability-zone-id — Идентификатор доступной зоны для подсети. Вы также можете использовать availabilityZoneId в качестве имени фильтра.
  • available-ip-address-count — Количество адресов IPv4 в подсети, доступных для использования.
  • cidr-block — Блок CIDR IPv4 подсети. Указанный вами блок CIDR должен точно совпадать с блоком CIDR подсети, чтобы информация о подсети была возвращена. Вы также можете использовать cidr или cidrBlock в качестве имён фильтров.
  • customer-owned-ipv4-pool — Пул адресов IPv4, принадлежащий клиенту, связанный с подсетью.
  • default-for-az — Указывает, является ли это стандартной подсетью для доступной зоны (true | false). Вы также можете использовать defaultForAz в качестве имени фильтра.
  • enable-dns64 — Указывает, должны ли запросы DNS, отправленные в Amazon-предоставленный DNS-резолвер в этой подсети, возвращать синтетические адреса IPv6 для IPv4-только пунктов назначения.
  • enable-lni-at-device-index — Указывает позицию устройства для локальных сетевых интерфейсов в этой подсети. Например, 1 указывает, что локальные сетевые интерфейсы в этой подсети являются вторичным сетевым интерфейсом (eth1).
  • ipv6-cidr-block-association.ipv6-cidr-block — Блок CIDR IPv6, связанный с подсетью.
  • ipv6-cidr-block-association.association-id — Идентификатор ассоциации для блока CIDR IPv6, связанного с подсетью.
  • ipv6-cidr-block-association.state — Состояние блока CIDR IPv6, связанного с подсетью.
  • ipv6-native — Указывает, является ли эта подсеть подсетью только для IPv6 (true | false).
  • map-customer-owned-ip-on-launch — Указывает, получает ли сетевой интерфейс, созданный в этой подсети (включая сетевой интерфейс, созданный командой RunInstances), адрес IPv4, принадлежащий клиенту.
  • map-public-ip-on-launch — Указывает, получают ли экземпляры, запущенные в этой подсети, публичный IPv4-адрес.
  • outpost-arn — Amazon Resource Name (ARN) Outpost.
  • owner-id — Идентификатор учётной записи Amazon Web Services, владеющей подсетью.
  • private-dns-name-options-on-launch.hostname-type — Тип имени хоста, который следует назначить экземплярам в подсети при запуске. Для подсетей только IPv4 и двойной стековой (IPv4 и IPv6) имя DNS экземпляра может быть основано на адресе IPv4 экземпляра (имя-ip) или идентификаторе экземпляра (имя-ресурса). Для подсетей только IPv6 имя DNS экземпляра должно быть основано на идентификаторе экземпляра (имя-ресурса).
  • private-dns-name-options-on-launch.enable-resource-name-dns-a-record — Указывает, следует ли отвечать на запросы DNS для имён хостов экземпляров с записями DNS A.
  • private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record — Указывает, следует ли отвечать на запросы DNS для имён хостов экземпляров с записями DNS AAAA.
  • state — Состояние подсети (pending | available).
  • subnet-arn — Amazon Resource Name (ARN) подсети.
  • subnet-id — Идентификатор подсети.
  • tag — Комбинация ключ/значение тега, назначенного ресурсу. Используйте ключ тега в имени фильтра и значение тега в качестве значения фильтра. Например, чтобы найти все ресурсы, имеющие тег с ключом Owner и значением TeamA, укажите tag:Owner в качестве имени фильтра и TeamA в качестве значения фильтра.
  • tag-key — Ключ тега, назначенного ресурсу. Используйте этот фильтр для поиска всех ресурсов, которым назначен тег с указанным ключом, независимо от значения тега.
  • vpc-id — Идентификатор VPC для подсети.

(структура)

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

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

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

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

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

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

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

(строка)

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

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

Синтаксис JSON:

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

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

Идентификаторы подсетей.

По умолчанию описываются все ваши подсети.

(строка)

Синтаксис:

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

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

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

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

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

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

Примеры использования см. в разделе Постраничная обработка в руководстве пользователя 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 (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)

Файл с корневым сертификатом для проверки 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 для вывода.

--cli-auto-prompt (boolean)

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

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

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

Примеры

Примечание

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

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

Пример 1: Отображение всех ваших подсетей

Следующий describe-subnets пример отображает подробности ваших подсетей.

aws ec2 describe-subnets

Вывод:

{
    "Subnets": [
        {
            "AvailabilityZone": "us-east-1d",
            "AvailabilityZoneId": "use1-az2",
            "AvailableIpAddressCount": 4089,
            "CidrBlock": "172.31.80.0/20",
            "DefaultForAz": true,
            "MapPublicIpOnLaunch": false,
            "MapCustomerOwnedIpOnLaunch": true,
            "State": "available",
            "SubnetId": "subnet-0bb1c79de3EXAMPLE",
            "VpcId": "vpc-0ee975135dEXAMPLE",
            "OwnerId": "111122223333",
            "AssignIpv6AddressOnCreation": false,
            "Ipv6CidrBlockAssociationSet": [],
            "CustomerOwnedIpv4Pool:": 'pool-2EXAMPLE',
            "SubnetArn": "arn:aws:ec2:us-east-2:111122223333:subnet/subnet-0bb1c79de3EXAMPLE",
            "EnableDns64": false,
            "Ipv6Native": false,
            "PrivateDnsNameOptionsOnLaunch": {
                "HostnameType": "ip-name",
                "EnableResourceNameDnsARecord": false,
                "EnableResourceNameDnsAAAARecord": false
            }
        },
        {
            "AvailabilityZone": "us-east-1d",
            "AvailabilityZoneId": "use1-az2",
            "AvailableIpAddressCount": 4089,
            "CidrBlock": "172.31.80.0/20",
            "DefaultForAz": true,
            "MapPublicIpOnLaunch": true,
            "MapCustomerOwnedIpOnLaunch": false,
            "State": "available",
            "SubnetId": "subnet-8EXAMPLE",
            "VpcId": "vpc-3EXAMPLE",
            "OwnerId": "1111222233333",
            "AssignIpv6AddressOnCreation": false,
            "Ipv6CidrBlockAssociationSet": [],
            "Tags": [
                {
                    "Key": "Name",
                    "Value": "MySubnet"
                }
            ],
            "SubnetArn": "arn:aws:ec2:us-east-1:111122223333:subnet/subnet-8EXAMPLE",
            "EnableDns64": false,
            "Ipv6Native": false,
            "PrivateDnsNameOptionsOnLaunch": {
                "HostnameType": "ip-name",
                "EnableResourceNameDnsARecord": false,
                "EnableResourceNameDnsAAAARecord": false
            }
        }
    ]
}

Дополнительную информацию см. в разделе «Работа с VPC и подсетями» в Руководстве пользователя AWS VPC.

Пример 2: Отображение подсетей конкретной VPC

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

aws ec2 describe-subnets \
    --filters "Name=vpc-id,Values=vpc-3EXAMPLE"

Вывод:

{
    "Subnets": [
        {
            "AvailabilityZone": "us-east-1d",
            "AvailabilityZoneId": "use1-az2",
            "AvailableIpAddressCount": 4089,
            "CidrBlock": "172.31.80.0/20",
            "DefaultForAz": true,
            "MapPublicIpOnLaunch": true,
            "MapCustomerOwnedIpOnLaunch": false,
            "State": "available",
            "SubnetId": "subnet-8EXAMPLE",
            "VpcId": "vpc-3EXAMPLE",
            "OwnerId": "1111222233333",
            "AssignIpv6AddressOnCreation": false,
            "Ipv6CidrBlockAssociationSet": [],
            "Tags": [
                {
                    "Key": "Name",
                    "Value": "MySubnet"
                }
            ],
            "SubnetArn": "arn:aws:ec2:us-east-1:111122223333:subnet/subnet-8EXAMPLE",
            "EnableDns64": false,
            "Ipv6Native": false,
            "PrivateDnsNameOptionsOnLaunch": {
                "HostnameType": "ip-name",
                "EnableResourceNameDnsARecord": false,
                "EnableResourceNameDnsAAAARecord": false
            }
        }
    ]
}

Дополнительную информацию см. в разделе «Работа с VPC и подсетями» в Руководстве пользователя AWS VPC.

Пример 3: Отображение подсетей со специфическим тегом

Следующий describe-subnets пример использует фильтр для получения подробностей о тех подсетях, которые имеют тег CostCenter=123 и параметр --query для отображения идентификаторов подсетей с этим тегом.

aws ec2 describe-subnets \
    --filters "Name=tag:CostCenter,Values=123" \
    --query "Subnets[*].SubnetId" \
    --output text

Вывод:

subnet-0987a87c8b37348ef
subnet-02a95061c45f372ee
subnet-03f720e7de2788d73

Дополнительную информацию см. в разделе «Работа с VPC и подсетями» в Руководстве пользователя Amazon VPC.

Вывод

NextToken -> (строка)

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

Subnets -> (список)

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

(структура)

Описание подсети.

AvailabilityZoneId -> (строка)

Идентификатор зоны доступности подсети.

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

Указывает позицию устройства для локальных сетевых интерфейсов в этой подсети. Например, 1 указывает, что локальные сетевые интерфейсы в этой подсети являются вторичным сетевым интерфейсом (eth1).

MapCustomerOwnedIpOnLaunch -> (boolean)

Указывает, получает ли сетевой интерфейс, созданный в этой подсети (включая сетевой интерфейс, созданный с помощью RunInstances), выделенный IPv4-адрес.

CustomerOwnedIpv4Pool -> (строка)

Пул выделенных IPv4-адресов, связанный с подсетью.

OwnerId -> (строка)

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

AssignIpv6AddressOnCreation -> (boolean)

Указывает, получает ли сетевой интерфейс, созданный в этой подсети (включая сетевой интерфейс, созданный с помощью RunInstances), IPv6-адрес.

Ipv6CidrBlockAssociationSet -> (список)

Информация об IPv6-блоках CIDR, связанных с подсетью.

(структура)

Описание ассоциации между подсетью и блоком IPv6 CIDR.

AssociationId -> (строка)

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

Ipv6CidrBlock -> (строка)

Блок IPv6 CIDR.

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

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

State -> (строка)

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

StatusMessage -> (строка)

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

Ipv6AddressAttribute -> (строка)

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

IpSource -> (строка)

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

Tags -> (список)

Присвоенные подсети теги.

(структура)

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

Key -> (строка)

Ключ тега.

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

Value -> (строка)

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

Ограничения: значения тегов регистрозависимы и принимают не более 256 символов Unicode.

SubnetArn -> (строка)

Amazon Resource Name (ARN) подсети.

OutpostArn -> (строка)

Amazon Resource Name (ARN) Outpost.

EnableDns64 -> (boolean)

Указывает, должны ли запросы DNS к Amazon-DNS Resolver в этой подсети возвращать синтетические IPv6-адреса для IPv4-only узлов назначения.

Ipv6Native -> (boolean)

Указывает, является ли данная подсеть только IPv6.

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

Тип имен хостов, которые должны быть назначены экземплярам в подсети при запуске. Имя хоста экземпляра основано на IPv4-адресе или идентификаторе экземпляра.

HostnameType -> (строка)

Тип имени хоста для EC2-экземпляров. Для IPv4-только подсетей имя хоста экземпляра должно основываться на IPv4-адресе экземпляра. Для IPv6-только подсетей имя хоста экземпляра должно основываться на идентификаторе экземпляра. Для подсетей двойной стековой архитектуры можно указать, используют ли имена DNS IPv4-адрес экземпляра или идентификатор экземпляра.

EnableResourceNameDnsARecord -> (boolean)

Указывает, следует ли отвечать на запросы DNS для имен хостов экземпляров с помощью DNS A-записей.

EnableResourceNameDnsAAAARecord -> (boolean)

Указывает, следует ли отвечать на запросы DNS для имени хоста экземпляра с помощью DNS AAAA-записей.

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

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

InternetGatewayBlockMode -> (строка)

Режим VPC BPA.

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

SubnetId -> (строка)

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

State -> (строка)

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

VpcId -> (строка)

Идентификатор VPC, в котором находится подсеть.

CidrBlock -> (строка)

Блок IPv4 CIDR, назначенный подсети.

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

Количество неиспользуемых частных IPv4-адресов в подсети. IPv4-адреса для любых остановленных экземпляров считаются недоступными.

AvailabilityZone -> (строка)

Зона доступности подсети.

DefaultForAz -> (boolean)

Указывает, является ли данная подсеть основной для зоны доступности.

MapPublicIpOnLaunch -> (boolean)

Указывает, получают ли экземпляры, запущенные в этой подсети, публичный IPv4-адрес.

Amazon Web Services взимает плату за все публичные IPv4-адреса, включая публичные IPv4-адреса, связанные с работающими экземплярами и Elastic IP-адресами. Подробную информацию см. на вкладке «Публичный IPv4-адрес» на странице цен Amazon VPC.

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

Spec-Zone.ru

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