Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

describe-engine-default-parameters

Описание

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

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

describe-engine-default-parameters является постраничным запросом. Для получения всего набора результатов могут быть вызваны несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлечь данные из результатов следующих выражений запроса: EngineDefaults.Parameters

Синтаксис

  describe-engine-default-parameters
--db-parameter-group-family <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]

Параметры

--db-parameter-group-family (строка)

Название семейства групп параметров БД.

Допустимые значения:

  • aurora-mysql5.7
  • aurora-mysql8.0
  • aurora-postgresql10
  • aurora-postgresql11
  • aurora-postgresql12
  • aurora-postgresql13
  • aurora-postgresql14
  • custom-oracle-ee-19
  • custom-oracle-ee-cdb-19
  • db2-ae
  • db2-se
  • mariadb10.2
  • mariadb10.3
  • mariadb10.4
  • mariadb10.5
  • mariadb10.6
  • mysql5.7
  • mysql8.0
  • oracle-ee-19
  • oracle-ee-cdb-19
  • oracle-ee-cdb-21
  • oracle-se2-19
  • oracle-se2-cdb-19
  • oracle-se2-cdb-21
  • postgres10
  • postgres11
  • postgres12
  • postgres13
  • postgres14
  • sqlserver-ee-11.0
  • sqlserver-ee-12.0
  • sqlserver-ee-13.0
  • sqlserver-ee-14.0
  • sqlserver-ee-15.0
  • sqlserver-ex-11.0
  • sqlserver-ex-12.0
  • sqlserver-ex-13.0
  • sqlserver-ex-14.0
  • sqlserver-ex-15.0
  • sqlserver-se-11.0
  • sqlserver-se-12.0
  • sqlserver-se-13.0
  • sqlserver-se-14.0
  • sqlserver-se-15.0
  • sqlserver-web-11.0
  • sqlserver-web-12.0
  • sqlserver-web-13.0
  • sqlserver-web-14.0
  • sqlserver-web-15.0

--filters (список)

Фильтр, который указывает один или несколько параметров для описания.

Поддерживается только фильтр parameter-name. Список результатов включает только информацию о параметрах с этими именами.

(структура)

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

Примечание

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

Следующие действия могут быть отфильтрованы:

  • DescribeDBClusterBacktracks
  • DescribeDBClusterEndpoints
  • DescribeDBClusters
  • DescribeDBInstances
  • DescribeDBRecommendations
  • DescribeDBShardGroups
  • DescribePendingMaintenanceActions

Имя -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

Одно или несколько значений фильтра. Значения фильтров чувствительны к регистру.

(строка)

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

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

Синтаксис JSON:

[
  {
    "Name": "string",
    "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 (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.

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

Для описания информации о параметрах по умолчанию для движка и системы базы данных

Следующий пример describe-engine-default-parameters возвращает данные для параметров по умолчанию движка и системы для баз данных MySQL 5.7.

aws rds describe-engine-default-parameters \
    --db-parameter-group-family mysql5.7

Вывод:

{
    "EngineDefaults": {
        "Parameters": [
            {
                "ParameterName": "allow-suspicious-udfs",
                "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded",
                "Source": "engine-default",
                "ApplyType": "static",
                "DataType": "boolean",
                "AllowedValues": "0,1",
                "IsModifiable": false
            },
            ...some output truncated...
        ]
    }
}

Дополнительную информацию см. в разделе «Работа с группами параметров БД» в Руководстве пользователя Amazon RDS.

Вывод

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

Содержит результат успешного вызова действия DescribeEngineDefaultParameters.

DBParameterGroupFamily -> (строка)

Указывает имя семейства группы параметров БД, к которому применяются параметры по умолчанию движка.

Marker -> (строка)

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

Parameters -> (список)

Содержит список параметров по умолчанию движка.

(структура)

Этот тип данных используется в качестве параметра запроса в действиях ModifyDBParameterGroup и ResetDBParameterGroup.

Этот тип данных используется в качестве элемента ответа в действиях DescribeEngineDefaultParameters и DescribeDBParameters.

ParameterName -> (строка)

Имя параметра.

ParameterValue -> (строка)

Значение параметра.

Description -> (строка)

Предоставляет описание параметра.

Source -> (строка)

Источник значения параметра.

ApplyType -> (строка)

Указывает тип параметров, специфичных для движка.

DataType -> (строка)

Указывает допустимый тип данных для параметра.

AllowedValues -> (строка)

Указывает допустимый диапазон значений для параметра.

IsModifiable -> (булево)

Указывает, можно (true ) или нельзя (false ) изменять параметр. Некоторые параметры имеют последствия для безопасности или работы, которые препятствуют их изменению.

MinimumEngineVersion -> (строка)

Наиболее ранняя версия движка, к которой может применяться параметр.

ApplyMethod -> (строка)

Указывает, когда необходимо применять обновления параметров.

SupportedEngineModes -> (список)

Допустимые режимы работы базы данных.

(строка)

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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