describe-subnet-groups
Описание
Возвращает список описаний групп подсетей. Если указано имя группы подсетей, список будет содержать только описание этой группы.
См. также: Документация API AWS
describe-subnet-groups является постраничной операцией. Для получения всего набора результатов могут быть вызваны несколько API-запросов. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в постраничном ответе, аргумент --query должен извлекать данные из результатов следующих выражений запроса: SubnetGroups
Синтаксис
describe-subnet-groups
[--subnet-group-names <value>]
[--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]
Параметры
--subnet-group-names (список)
Имя группы подсетей.
(строка)
Синтаксис:
"string" "string" ...
--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 (булево)
Включить отладочную регистрацию.
--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 (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом и не будет ограничено по времени. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 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 в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования на подобие Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. Использование кавычек со строками в руководстве пользователя AWS CLI.
Для описания групп подсетей, определенных в DAX
Следующий describe-subnet-groups пример извлекает данные для групп подсетей, определенных в DAX.
aws dax describe-subnet-groups
Вывод:
{
"SubnetGroups": [
{
"SubnetGroupName": "default",
"Description": "Default CacheSubnetGroup",
"VpcId": "vpc-ee70a196",
"Subnets": [
{
"SubnetIdentifier": "subnet-874953af",
"SubnetAvailabilityZone": "us-west-2d"
},
{
"SubnetIdentifier": "subnet-bd3d1fc4",
"SubnetAvailabilityZone": "us-west-2a"
},
{
"SubnetIdentifier": "subnet-72c2ff28",
"SubnetAvailabilityZone": "us-west-2c"
},
{
"SubnetIdentifier": "subnet-09e6aa42",
"SubnetAvailabilityZone": "us-west-2b"
}
]
}
]
}
Дополнительные сведения см. в разделе Управление кластерами DAX в руководстве разработчика Amazon DynamoDB.
Вывод
NextToken -> (строка)
SubnetGroups -> (список)
Массив групп подсетей. Каждый элемент массива представляет собой отдельную группу подсетей.
(структура)
Представляет вывод одной из следующих операций:
- CreateSubnetGroup
- ModifySubnetGroup
SubnetGroupName -> (строка)
Description -> (строка)
VpcId -> (строка)
Subnets -> (список)
Список подсетей, связанных с группой подсетей.
(структура)
Представляет подсеть, связанную с кластером DAX. Этот параметр относится к подсетям, определенным в виртуальной частной сети Amazon (Amazon VPC) и используемым с DAX.
SubnetIdentifier -> (строка)
SubnetAvailabilityZone -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|