list-available-resource-metrics
Описание
Получение метрик указанных типов, которые можно запросить для указанного экземпляра БД.
См. также: Документацию API AWS
Синтаксис
list-available-resource-metrics
--service-type <value>
--identifier <value>
--metric-types <value>
[--next-token <value>]
[--max-results <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]
Параметры
--service-type (строка)
Сервис Amazon Web Services, для которого Performance Insights возвращает метрики.
Возможные значения:
RDSDOCDB
--identifier (строка)
DbiResourceId. Например, укажите db-ABCDEFGHIJKLMNOPQRSTU1VWZ.--metric-types (список)
Типы метрик, которые необходимо вернуть в ответе. Допустимые значения в массиве включают следующее:
-
os(метрики счетчиков ОС) - Все движки -
db(метрики загрузки БД) - Все движки, кроме Amazon DocumentDB -
db.sql.stats(метрики запрос по запросу) - Все движки, кроме Amazon DocumentDB -
db.sql_tokenized.stats(метрики сводки запрос по запросу) - Все движки, кроме Amazon DocumentDB
(строка)
Синтаксис:
"string" "string" ...
--next-token (строка)
MaxRecords.--max-results (целое число)
MaxRecords меньше количества существующих элементов, в ответ включается маркер пагинации.--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
- текст
- таблица
- 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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры нужно адаптировать к правилам цитирования вашей терминальной среды. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для получения списка метрик, которые можно запросить для типа метрики в экземпляре БД
Следующий пример list-available-resource-metrics отображает db.load метрики, которые можно запросить для базы данных db-abcdefg123456789.
aws pi list-available-resource-metrics \
--service-type RDS \
--identifier db-abcdefg123456789 \
--metric-types "os" "db"
Вывод:
{
"Metrics": [
{
"Description": "The number of virtual CPUs for the DB instance",
"Metric": "os.general.numVCPUs",
"Unit": "vCPUs"
},
......,
{
"Description": "Time spent reading data file blocks by backends in this instance",
"Metric": "db.IO.read_latency",
"Unit": "Milliseconds per block"
},
......
]
}
Для получения дополнительной информации о метриках в Performance Insights, см. Загрузка базы данных в Руководстве пользователя Amazon RDS и Загрузка базы данных в Руководстве пользователя Amazon Aurora.
Вывод
Метрики -> (список)
Массив доступных для запроса метрик. Каждый элемент массива содержит полное имя, описание и единицу измерения метрики.
(структура)
Объект, содержащий полное имя, описание и единицу измерения метрики.
Метрика -> (строка)
Описание -> (строка)
Единица измерения -> (строка)
NextToken -> (строка)
MaxRecords был указан в предыдущем запросе. Для получения оставшихся записей укажите NextToken в отдельном запросе с этим значением.
© Copyright 2025, Amazon Web Services. Created using Sphinx.