Spec-Zone.ru › AWS CLI v2

[ aws . redshift ]

describe-node-configuration-options

Описание

Возвращает свойства возможных конфигураций узлов, таких как тип узла, количество узлов и использование диска для указанного типа действия.

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

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

Синтаксис

  describe-node-configuration-options
--action-type <value>
[--cluster-identifier <value>]
[--snapshot-identifier <value>]
[--snapshot-arn <value>]
[--owner-account <value>]
[--filters <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]

Параметры

--action-type (строка)

Тип действия, который нужно оценить для возможных конфигураций узлов. Укажите «restore-cluster», чтобы получить комбинации конфигураций на основе существующего снимка. Укажите «recommend-node-config», чтобы получить рекомендации по конфигурации на основе существующего кластера или снимка. Укажите «resize-cluster», чтобы получить комбинации конфигураций для эластичного изменения размера на основе существующего кластера.

Возможные значения:

  • restore-cluster
  • recommend-node-config
  • resize-cluster

--cluster-identifier (строка)

Идентификатор кластера для оценки возможных конфигураций узлов.

--snapshot-identifier (строка)

Идентификатор снимка для оценки возможных конфигураций узлов.

--snapshot-arn (строка)

Идентификатор Amazon Resource Name (ARN) снимка, связанного с сообщением для описания конфигурации узла.

--owner-account (строка)

Используемый учетная запись Amazon Web Services, которая использовалась для создания или копирования снимка. Требуется, если вы восстанавливаете снимок, который вам не принадлежит; необязательно, если снимок вам принадлежит.

--filters (список)

Набор элементов с именем, оператором и значением для фильтрации результатов.

(структура)

Набор элементов для фильтрации возвращаемых конфигураций узлов.

Name -> (строка)

Имя элемента для фильтрации.

Operator -> (строка)

Оператор фильтра. Если имя фильтра NodeType, то поддерживается только оператор ‘in’. Для операторов ‘eq’, ‘lt’, ‘le’, ‘gt’, и ‘ge’ укажите одно значение. Для оператора ‘between’ укажите два значения. Для оператора ‘in’ укажите список значений.

Values -> (список)

Список значений. Сравните Name с Operator и Values. Если имя фильтра NumberOfNodes, значения могут изменяться от 0 до 200. Если имя фильтра EstimatedDiskUtilizationPercent, значения могут изменяться от 0 до 100. Например, фильтр NumberOfNodes (имя) GT (оператор) 3 (значения).

(строка)

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

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

Синтаксис JSON:

[
  {
    "Name": "NodeType"|"NumberOfNodes"|"EstimatedDiskUtilizationPercent"|"Mode",
    "Operator": "eq"|"lt"|"gt"|"le"|"ge"|"in"|"between",
    "Values": ["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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

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

Описание конфигурации узлов

Следующий пример describe-node-configuration-options отображает свойства возможных конфигураций узлов, таких как тип узла, количество узлов и использование диска для указанного снимка кластера.

aws redshift describe-node-configuration-options \
    --action-type restore-cluster \
    --snapshot-identifier rs:mycluster-2019-12-09-16-42-43

Вывод:

{
    "NodeConfigurationOptionList": [
        {
            "NodeType": "dc2.large",
            "NumberOfNodes": 2,
            "EstimatedDiskUtilizationPercent": 19.61
        },
        {
            "NodeType": "dc2.large",
            "NumberOfNodes": 4,
            "EstimatedDiskUtilizationPercent": 9.96
        },
        {
            "NodeType": "ds2.xlarge",
            "NumberOfNodes": 2,
            "EstimatedDiskUtilizationPercent": 1.53
        },
        {
            "NodeType": "ds2.xlarge",
            "NumberOfNodes": 4,
            "EstimatedDiskUtilizationPercent": 0.78
        }
    ]
}

Дополнительную информацию см. в разделе «Покупка резервированных узлов Amazon Redshift» в Руководстве по управлению кластерами Amazon Redshift.

Вывод

NodeConfigurationOptionList -> (список)

Список допустимых конфигураций узлов.

(структура)

Список конфигураций узлов.

NodeType -> (строка)

Тип узла, например, «ra3.4xlarge».

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

Количество узлов.

EstimatedDiskUtilizationPercent -> (двойное значение)

Процент предполагаемого использования диска.

Mode -> (строка)

Категория рекомендации по конфигурации узла.

Marker -> (строка)

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

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

Spec-Zone.ru

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