describe-cluster-parameters
Описание
Возвращает подробный список параметров, содержащихся в указанной группе параметров Amazon Redshift. Для каждого параметра ответ включает информацию, такую как имя параметра, описание, тип данных, значение, возможность изменения значения параметра и т. д.
Вы можете указать фильтр source, чтобы получить параметры только определенного типа. Например, чтобы получить параметры, изменённые действиями пользователя, такими как из ModifyClusterParameterGroup, вы можете указать source равным user.
Дополнительную информацию о параметрах и группах параметров см. в разделе Amazon Redshift Parameter Groups в руководстве Amazon Redshift Cluster Management Guide.
См. также: AWS API Documentation
describe-cluster-parameters является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлечь данные из результатов следующих выражений запроса: Parameters
Синтаксис
describe-cluster-parameters
--parameter-group-name <value>
[--source <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]
Параметры
--parameter-group-name (строка)
--source (строка)
Типы параметров для возврата. Укажите user, чтобы показать параметры, отличающиеся от значений по умолчанию. Аналогично, укажите engine-default, чтобы показать параметры, совпадающие с параметрами группы по умолчанию.
По умолчанию возвращаются все типы параметров.
Допустимые значения: user | engine-default
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, указанному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Передача произвольных двоичных значений с помощью значения JSON невозможна, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания точки начала постраничного отображения. Это NextToken из ранее обрезанного ответа.
Примеры использования см. в разделе Постраничная навигация в руководстве AWS Command Line Interface User Guide.
--page-size (целое число)
Размер каждой страницы для вызова AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить таймауты вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничная навигация в руководстве AWS Command Line Interface User Guide.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды будет указан NextToken. Для возобновления постраничной навигации необходимо указать значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничная навигация в руководстве AWS Command Line Interface User Guide.
--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
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование определенного профиля из файла учетных данных.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/окружения.
--version (строка)
Отображение версии этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- on
- off
- auto
--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 User Guide.
Если не указано иное, во всех примерах используются правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. раздел Использование кавычек со строками в руководстве AWS CLI User Guide.
Получение параметров для заданной группы параметров кластера
В этом примере получаются параметры для указанной группы параметров. По умолчанию вывод выполняется в формате JSON.
Команда:
aws redshift describe-cluster-parameters --parameter-group-name myclusterparametergroup
Результат:
{
"Parameters": [
{
"Description": "Sets the display format for date and time values.",
"DataType": "string",
"IsModifiable": true,
"Source": "engine-default",
"ParameterValue": "ISO, MDY",
"ParameterName": "datestyle"
},
{
"Description": "Sets the number of digits displayed for floating-point values",
"DataType": "integer",
"IsModifiable": true,
"AllowedValues": "-15-2",
"Source": "engine-default",
"ParameterValue": "0",
"ParameterName": "extra_float_digits"
},
(...remaining output omitted...)
]
}
Вы также можете получить ту же информацию в текстовом формате, используя параметр --output text.
Команда:
aws redshift describe-cluster-parameters --parameter-group-name myclusterparametergroup --output text
Результат:
RESPONSEMETADATA cdac40aa-64cc-11e2-9e70-918437dd236d
Sets the display format for date and time values. string True engine-default ISO, MDY datestyle
Sets the number of digits displayed for floating-point values integer True -15-2 engine-default 0 extra_float_digits
This parameter applies a user-defined label to a group of queries that are run during the same session.. string True engine-default default query_group
require ssl for all databaseconnections boolean True true,false engine-default false require_ssl
Sets the schema search order for names that are not schema-qualified. string True engine-default $user, public search_path
Aborts any statement that takes over the specified number of milliseconds. integer True engine-default 0 statement_timeout
wlm json configuration string True engine-default \[{"query_concurrency":5}] wlm_json_configuration
Вывод
Parameters -> (список)
Список экземпляров Parameter. Каждый экземпляр содержит параметры одной группы параметров кластера.
(структура)
Описание параметра в группе параметров кластера.
ParameterName -> (строка)
ParameterValue -> (строка)
ParameterName равно wlm_json_configuration, максимальный размер ParameterValue составляет 8000 символов.Description -> (строка)
Source -> (строка)
DataType -> (строка)
AllowedValues -> (строка)
ApplyType -> (строка)
IsModifiable -> (булево)
true, параметр может быть изменён. Некоторые параметры имеют последствия для безопасности или работы, которые препятствуют их изменению.MinimumEngineVersion -> (строка)
Marker -> (строка)
Marker и повторив команду. Если поле Marker пусто, все записи ответа для запроса получены.
© Copyright 2025, Amazon Web Services. Created using Sphinx.