Spec-Zone.ru › AWS CLI v2

[ aws . redshift ]

describe-cluster-subnet-groups

Описание

Возвращает один или несколько объектов группы подсетей кластера, содержащих метаданные о группах подсетей вашего кластера. По умолчанию эта операция возвращает информацию обо всех группах подсетей кластера, определённых в вашей учётной записи Amazon Web Services.

Если вы укажете как ключи тегов, так и значения тегов в одном запросе, Amazon Redshift возвращает все группы подсетей, которые соответствуют любой комбинации указанных ключей и значений. Например, если у вас есть owner и environment в качестве ключей тегов, и admin и test в качестве значений тегов, возвращаются все группы подсетей, имеющие любую комбинацию этих значений.

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

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

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

Синтаксис

  describe-cluster-subnet-groups
[--cluster-subnet-group-name <value>]
[--tag-keys <value>]
[--tag-values <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]

Параметры

--cluster-subnet-group-name (строка)

Имя группы подсетей кластера, для которой требуется информация.

--tag-keys (список)

Ключ или ключи тега, для которых вы хотите получить все соответствующие группы подсетей кластера, связанные с указанным ключом или ключами. Например, предположим, что у вас есть группы подсетей, помеченные ключами owner и environment. Если вы укажете оба этих ключа тега в запросе, Amazon Redshift возвращает ответ с группами подсетей, у которых связан один или оба этих ключа тега.

(строка)

Синтаксис:

"string" "string" ...

--tag-values (список)

Значение или значения тега, для которых вы хотите получить все соответствующие группы подсетей кластера, связанные с указанным значением или значениями тега. Например, предположим, что у вас есть группы подсетей, помеченные значениями admin и test. Если вы укажете оба эти значения тега в запросе, Amazon Redshift возвращает ответ с группами подсетей, у которых связанно одно или оба этих значения тега.

(строка)

Синтаксис:

"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 (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 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.

Получение описания всех групп подсетей кластера

В этом примере возвращается описание всех групп подсетей кластера. По умолчанию вывод находится в формате JSON.

Команда:

aws redshift describe-cluster-subnet-groups

Результат:

{
   "ClusterSubnetGroups": [
      {
         "Subnets": [
            {
               "SubnetStatus": "Active",
               "SubnetIdentifier": "subnet-763fdd1c",
               "SubnetAvailabilityZone": {
                  "Name": "us-east-1a"
               }
            }
         ],
         "VpcId": "vpc-7e3fdd14",
         "SubnetGroupStatus": "Complete",
         "Description": "My subnet group",
         "ClusterSubnetGroupName": "mysubnetgroup"
      }
   ],
   "ResponseMetadata": {
      "RequestId": "37fa8c89-6990-11e2-8f75-ab4018764c77"
   }
}

Вывод

Маркер -> (строка)

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

ClusterSubnetGroups -> (список)

Список экземпляров ClusterSubnetGroup.

(структура)

Описание группы подсетей.

ClusterSubnetGroupName -> (строка)

Имя группы подсетей кластера.

Description -> (строка)

Описание группы подсетей кластера.

VpcId -> (строка)

ID VPC группы подсетей кластера.

SubnetGroupStatus -> (строка)

Состояние группы подсетей кластера. Возможные значения — Complete, Incomplete и Invalid.

Subnets -> (список)

Список элементов VPC Subnet.

(структура)

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

SubnetIdentifier -> (строка)

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

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

Name -> (строка)

Имя зоны доступности.

SupportedPlatforms -> (список)

(структура)

Список поддерживаемых платформ для заказуемых кластеров.

Name -> (строка)

SubnetStatus -> (строка)

Состояние подсети.

Tags -> (список)

Список тегов для группы подсетей кластера.

(структура)

Тег, состоящий из пары имя/значение для ресурса.

Key -> (строка)

Ключ или имя тега ресурса.

Value -> (строка)

Значение тега ресурса.

SupportedClusterIpAddressTypes -> (список)

Типы IP-адресов, поддерживаемые данной группой подсетей кластера. Возможные значения — ipv4 и dualstack.

(строка)

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

Spec-Zone.ru

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