Spec-Zone.ru › AWS CLI v2

[ aws . es ]

describe-reserved-elasticsearch-instances

Описание

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

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

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

Синтаксис

  describe-reserved-elasticsearch-instances
[--reserved-elasticsearch-instance-id <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-elasticsearch-instance-id (строка)

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

--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.

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

Просмотр всех зарезервированных экземпляров

Следующий describe-elasticsearch-domains пример предоставляет сводку всех зарезервированных экземпляров в регионе.

aws es describe-reserved-elasticsearch-instances

Вывод:

{
    "ReservedElasticsearchInstances": [{
        "FixedPrice": 100.0,
        "ReservedElasticsearchInstanceOfferingId": "1a2a3a4a5-1a2a-3a4a-5a6a-1a2a3a4a5a6a",
        "ReservationName": "my-reservation",
        "PaymentOption": "PARTIAL_UPFRONT",
        "UsagePrice": 0.0,
        "ReservedElasticsearchInstanceId": "9a8a7a6a-5a4a-3a2a-1a0a-9a8a7a6a5a4a",
        "RecurringCharges": [{
            "RecurringChargeAmount": 0.603,
            "RecurringChargeFrequency": "Hourly"
        }],
        "State": "payment-pending",
        "StartTime": 1522872571.229,
        "ElasticsearchInstanceCount": 3,
        "Duration": 31536000,
        "ElasticsearchInstanceType": "m4.2xlarge.elasticsearch",
        "CurrencyCode": "USD"
    }]
}

Дополнительную информацию см. в разделе Зарезервированные экземпляры в Руководстве разработчика Amazon Elasticsearch Service.

Вывод

NextToken -> (строка)

Предоставляет идентификатор для получения результатов постраничной обработки.

ReservedElasticsearchInstances -> (список)

Список зарезервированных экземпляров Elasticsearch.

(структура)

Подробности зарезервированного экземпляра Elasticsearch.

ReservationName -> (строка)

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

ReservedElasticsearchInstanceId -> (строка)

Уникальный идентификатор для резервирования.

ReservedElasticsearchInstanceOfferingId -> (строка)

Идентификатор предложения.

ElasticsearchInstanceType -> (строка)

Тип экземпляра Elasticsearch, предлагаемый зарезервированным предложением.

StartTime -> (метка времени)

Время начала резервирования.

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

Продолжительность, в секундах, для которой зарезервирован экземпляр Elasticsearch.

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

Вперед фиксированная стоимость, которую вы будете платить за покупку конкретного предложения зарезервированного экземпляра Elasticsearch.

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

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

CurrencyCode -> (строка)

Код валюты для предложения зарезервированного экземпляра Elasticsearch.

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

Количество зарезервированных экземпляров Elasticsearch.

State -> (строка)

Состояние зарезервированного экземпляра Elasticsearch.

PaymentOption -> (строка)

Вариант оплаты, как определено в предложении зарезервированного экземпляра Elasticsearch.

RecurringCharges -> (список)

Плата за вашу учетную запись независимо от того, создаете ли вы какие-либо домены, используя предложение экземпляра.

(структура)

Содержит конкретную цену и частоту периодических платежей за зарезервированный экземпляр Elasticsearch или предложение зарезервированного экземпляра Elasticsearch.

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

Денежная сумма периодической платы.

RecurringChargeFrequency -> (строка)

Частота периодической платы.

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

Spec-Zone.ru

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