describe-subnet-groups
Описание
Возвращает список описаний групп подсетей. Если указано имя группы подсетей, список содержит только описание этой группы.
См. также: Документацию API AWS
describe-subnet-groups — это операция с постраничной передачей. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную передачу, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной передачей аргумент --query должен извлечь данные из результатов следующих выражений запроса: SubnetGroups
Синтаксис
describe-subnet-groups
[--subnet-group-name <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-name (строка)
--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 (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 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-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запросы параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. использование кавычек со строками в Руководстве пользователя AWS CLI.
Чтобы получить список групп подсетей
Следующая команда describe-subnet-groups` возвращает список групп подсетей.
aws memorydb describe-subnet-groups
Вывод
{
"SubnetGroups": [
{
"Name": "my-sg",
"Description": "pat-sg",
"VpcId": "vpc-86xxx4fc",
"Subnets": [
{
"Identifier": "subnet-faxx84a6",
"AvailabilityZone": {
"Name": "us-east-1b"
}
},
{
"Identifier": "subnet-56xxf61b",
"AvailabilityZone": {
"Name": "us-east-1a"
}
}
],
"ARN": "arn:aws:memorydb:us-east-1:49165xxxxxx:subnetgroup/my-sg"
}
]
}
Дополнительную информацию см. в разделе Подсети и группы подсетей в Руководстве пользователя MemoryDB.
Вывод
NextToken -> (строка)
SubnetGroups -> (список)
Список групп подсетей. Каждый элемент списка содержит подробную информацию об одной группе.
(структура)
Представляет результат одной из следующих операций:
- CreateSubnetGroup
- UpdateSubnetGroup
Группа подсетей — это набор подсетей (обычно частных), которые можно назначить для ваших кластеров, работающих в среде Amazon Virtual Private Cloud (VPC).
Name -> (строка)
Description -> (строка)
VpcId -> (строка)
Subnets -> (список)
Список подсетей, связанных с группой подсетей.
(структура)
Представляет подсеть, связанную с кластером. Этот параметр относится к подсетям, определённым в Amazon Virtual Private Cloud (Amazon VPC) и используемым с MemoryDB.
Identifier -> (строка)
AvailabilityZone -> (структура)
Доступная зона, в которой расположена подсеть
Name -> (строка)
SupportedNetworkTypes -> (список)
Типы сетей, поддерживаемые данной подсетью. Возвращает массив строк, которые могут включать «ipv4», «ipv6» или оба, указывая, поддерживает ли подсеть только IPv4, только IPv6 или дуплексные развертывания.
(строка)
ARN -> (строка)
SupportedNetworkTypes -> (список)
Типы сетей, поддерживаемые данной группой подсетей. Возвращает массив строк, которые могут включать «ipv4», «ipv6» или оба, указывая типы IP-адресов, которые могут использоваться для кластеров, развернутых в этой группе подсетей.
(строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|