get-api-cache
Описание
Извлекает объект ApiCache.
См. также: Документацию AWS API
Синтаксис
get-api-cache
--api-id <value>
[--cli-input-json | --cli-input-yaml]
[--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]
Параметры
--api-id (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения из JSON. Передать произвольные двоичные значения с помощью JSON-значения в виде строки невозможно, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--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
- таблица
- 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.
Вывод
apiCache -> (структура)
Объект ApiCache.
ttl -> (целое число)
Время жизни в секундах для записей кеша.
Допустимые значения: от 1 до 3600 секунд.
apiCachingBehavior -> (строка)
Поведение кеширования.
- FULL_REQUEST_CACHING : Все запросы от одного пользователя кешируются. Отдельные решатели автоматически кешируются. Все вызовы API будут пытаться возвращать ответы из кеша.
- PER_RESOLVER_CACHING : Кешируются отдельные решатели, которые вы указываете.
- OPERATION_LEVEL_CACHING : Полные запросы кешируются вместе и возвращаются без выполнения решателей.
transitEncryptionEnabled -> (логическое значение)
atRestEncryptionEnabled -> (логическое значение)
type -> (строка)
Тип экземпляра кеша. Допустимые значения:
SMALLMEDIUMLARGEXLARGELARGE_2XLARGE_4X-
LARGE_8X(недоступно во всех регионах) LARGE_12X
Исторически типы экземпляров идентифицировались значением в стиле EC2. По состоянию на июль 2020 года это устарело, и следует использовать вышеуказанные универсальные идентификаторы.
Следующие устаревшие типы экземпляров доступны, но их использование не рекомендуется:
- T2_SMALL : Тип экземпляра t2.small.
- T2_MEDIUM : Тип экземпляра t2.medium.
- R4_LARGE : Тип экземпляра r4.large.
- R4_XLARGE : Тип экземпляра r4.xlarge.
- R4_2XLARGE : Тип экземпляра r4.2xlarge.
- R4_4XLARGE : Тип экземпляра r4.4xlarge.
- R4_8XLARGE : Тип экземпляра r4.8xlarge.
status -> (строка)
Состояние экземпляра кеша.
- AVAILABLE : Экземпляр доступен для использования.
- CREATING : Экземпляр в процессе создания.
- DELETING : Экземпляр в процессе удаления.
- MODIFYING : Экземпляр в процессе изменения.
- FAILED : Экземпляр не создан.
healthMetricsConfig -> (строка)
Управление тем, как метрики состояния кеша будут передаваться в CloudWatch. Метрики состояния кеша включают:
- NetworkBandwidthOutAllowanceExceeded: Упакованные сетевые пакеты из-за превышения совокупного ограничения пропускной способности. Это полезно для диагностики узких мест в конфигурации кеша.
- EngineCPUUtilization: Использование ЦП (в процентах), выделенное для процесса Redis. Это полезно для диагностики узких мест в конфигурации кеша.
Метрики будут регистрироваться по идентификатору API. Вы можете установить значение ENABLED или DISABLED.
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|