describe-reserved-db-instances
Описание
Возвращает информацию о резервированных базах данных для данной учетной записи или о конкретной резервированной базе данных.
См. также: Документация API AWS
describe-reserved-db-instances является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: ReservedDBInstances
Синтаксис
describe-reserved-db-instances
[--reserved-db-instance-id <value>]
[--reserved-db-instances-offering-id <value>]
[--db-instance-class <value>]
[--duration <value>]
[--product-description <value>]
[--offering-type <value>]
[--multi-az | --no-multi-az]
[--lease-id <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]
Параметры
--reserved-db-instance-id (строка)
--reserved-db-instances-offering-id (строка)
--db-instance-class (строка)
--duration (строка)
Значение фильтра продолжительности, указанное в годах или секундах. Укажите этот параметр, чтобы отобразить только резервации на этот срок.
Допустимые значения: 1 | 3 | 31536000 | 94608000
--product-description (строка)
--offering-type (строка)
Значение фильтра типа предложения. Укажите этот параметр, чтобы отобразить только доступные предложения, соответствующие указанному типу предложения.
Допустимые значения: "Partial Upfront" | "All Upfront" | "No Upfront"
--multi-az | --no-multi-az (логическое значение)
--lease-id (строка)
Значение фильтра идентификатора аренды. Укажите этот параметр, чтобы отобразить только резервацию, соответствующую указанному идентификатору аренды.
Примечание
Служба поддержки Amazon Web Services может запросить идентификатор аренды по вопросу, связанному с резервированной базой данных.--filters (список)
В настоящее время этот параметр не поддерживается.
(структура)
Пара имя-значение фильтра, используемая для получения более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определённым критериям, таким как идентификаторы. Фильтры, поддерживаемые операцией describe, документированы вместе с операцией describe.
Примечание
В настоящее время в фильтрах не поддерживаются подстановочные знаки.Можно фильтровать следующие действия:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribeDBRecommendationsDescribeDBShardGroupsDescribePendingMaintenanceActions
Имя -> (строка)
Значения -> (список)
Одно или несколько значений фильтра. Значения фильтров чувствительны к регистру.
(строка)
Сокращенный синтаксис:
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 CLI.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS CLI.
--max-items (целое число)
Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken непосредственно вне AWS CLI.
Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS CLI.
--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.
Если не указано иное, во всех примерах используются правила цитирования, аналогичные unix-подобным. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. Дополнительную информацию см. в разделе Использование кавычек со строками в руководстве пользователя AWS CLI.
Для описания резервированных баз данных
Следующий describe-reserved-db-instances пример получает подробности о любых резервированных базах данных в текущей учётной записи AWS.
aws rds describe-reserved-db-instances
Вывод:
{
"ReservedDBInstances": [
{
"ReservedDBInstanceId": "myreservedinstance",
"ReservedDBInstancesOfferingId": "12ab34cd-59af-4b2c-a660-1abcdef23456",
"DBInstanceClass": "db.t3.micro",
"StartTime": "2020-06-01T13:44:21.436Z",
"Duration": 31536000,
"FixedPrice": 0.0,
"UsagePrice": 0.0,
"CurrencyCode": "USD",
"DBInstanceCount": 1,
"ProductDescription": "sqlserver-ex(li)",
"OfferingType": "No Upfront",
"MultiAZ": false,
"State": "payment-pending",
"RecurringCharges": [
{
"RecurringChargeAmount": 0.014,
"RecurringChargeFrequency": "Hourly"
}
],
"ReservedDBInstanceArn": "arn:aws:rds:us-west-2:123456789012:ri:myreservedinstance",
"LeaseId": "a1b2c3d4-6b69-4a59-be89-5e11aa446666"
}
]
}
Дополнительную информацию см. в разделе Резервированные базы данных Amazon RDS в руководстве пользователя Amazon RDS.
Вывод
Маркер -> (строка)
MaxRecords.ReservedDBInstances -> (список)
Список зарезервированных баз данных.
(структура)
Этот тип данных используется в качестве элемента ответа в действиях DescribeReservedDBInstances и PurchaseReservedDBInstancesOffering.
ReservedDBInstanceId -> (строка)
ReservedDBInstancesOfferingId -> (строка)
DBInstanceClass -> (строка)
StartTime -> (метка времени)
Duration -> (целое число)
FixedPrice -> (двойное число)
UsagePrice -> (двойное число)
CurrencyCode -> (строка)
DBInstanceCount -> (целое число)
ProductDescription -> (строка)
OfferingType -> (строка)
MultiAZ -> (булево)
State -> (строка)
RecurringCharges -> (список)
Повторяющаяся цена за запуск этого зарезервированного экземпляра базы данных.
(структура)
Этот тип данных используется в качестве элемента ответа в действиях DescribeReservedDBInstances и DescribeReservedDBInstancesOfferings.
RecurringChargeAmount -> (двойное число)
RecurringChargeFrequency -> (строка)
ReservedDBInstanceArn -> (строка)
LeaseId -> (строка)
Уникальный идентификатор аренды, связанной с зарезервированным экземпляром базы данных.
Примечание
Служба поддержки Amazon Web Services может запросить идентификатор аренды для проблемы, связанной с зарезервированным экземпляром базы данных.
© Copyright 2025, Amazon Web Services. Created using Sphinx.