get-dimension-key-details
Описание
Получение атрибутов указанной группы измерений для экземпляра базы данных или источника данных. Например, если вы укажете идентификатор SQL, GetDimensionKeyDetails извлекает полное содержимое измерения db.sql.statement, связанного с этим идентификатором. Эта операция полезна, так как GetResourceMetrics и DescribeDimensionKeys не поддерживают извлечение текстов больших SQL-запросов, снимков блокировок и планов выполнения.
См. также: Документацию API AWS
Синтаксис
get-dimension-key-details
--service-type <value>
--identifier <value>
--group <value>
--group-identifier <value>
[--requested-dimensions <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 возвращает данные. Единственное допустимое значение — RDS.
Возможные значения:
RDSDOCDB
--identifier (строка)
DbiResourceId. Например, укажите db-ABCDEFGHIJKLMNOPQRSTU1VW2X.--group (строка)
Имя группы измерений. Performance Insights ищет указанную группу по идентификатору группы измерений. Следующие значения имени группы допустимы:
-
db.execution_plan(только для Amazon RDS и Aurora) -
db.lock_snapshot(только для Aurora) -
db.query(только для Amazon DocumentDB) -
db.sql(только для Amazon RDS и Aurora)
--group-identifier (строка)
Идентификатор группы измерений, из которой необходимо получить детали измерения. Для группы измерений db.sql идентификатор группы — db.sql.id. Следующие значения идентификаторов группы допустимы:
-
db.execution_plan.idдля группы измеренийdb.execution_plan(только для Aurora и RDS) -
db.sql.idдля группы измеренийdb.sql(только для Aurora и RDS) -
db.query.idдля группы измеренийdb.query(только для DocumentDB) - Для группы измерений
db.lock_snapshot,GroupIdentifier— это временная метка эпохи, когда Performance Insights зафиксировал снимок, в секундах. Это значение можно получить с помощью операцииGetResourceMetricsдля периода в 1 секунду.
--requested-dimensions (список)
Список измерений, для которых требуется получить подробные данные в данной группе измерений. Если этот параметр не указан, Performance Insights возвращает все данные измерений в указанной группе измерений. Укажите имена измерений для следующих групп измерений:
-
db.execution_plan— укажите имя измеренияdb.execution_plan.raw_planили сокращённое имя измеренияraw_plan(только для Amazon RDS и Aurora) -
db.lock_snapshot— укажите имя измеренияdb.lock_snapshot.lock_treesили сокращённое имя измеренияlock_trees(только для Aurora) -
db.sql— укажите полное имя измеренияdb.sql.statementили сокращённое имя измеренияstatement(только для Aurora и RDS) -
db.query— укажите полное имя измеренияdb.query.statementили сокращённое имя измеренияstatement(только для DocumentDB)
(строка)
Синтаксис:
"string" "string" ...
--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-auto-prompt (булево)
Автоматически запросить параметры CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросы параметров CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы с AWS CLI в руководстве пользователя AWS CLI.
Если не указано иное, во всех примерах используются правила цитирования, похожие на Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей консоли. См. Использование кавычек со строками в руководстве пользователя AWS CLI.
Получение деталей для заданной группы измерений для экземпляра базы данных
Следующий пример get-dimension-key-details извлекает полное содержимое SQL-запроса для экземпляра базы данных db-10BCD2EFGHIJ3KL4M5NO6PQRS5. --group — db.sql, а --group-identifier — db.sql.id. В этом примере example-sql-id представляет идентификатор SQL, полученный с помощью операций get-resource-metrics или describe-dimension-keys. В этом примере детали измерений доступны. Таким образом, Performance Insights извлекает полное содержимое SQL-запроса, не усекая его.
aws pi get-dimension-key-details \
--service-type RDS \
--identifier db-10BCD2EFGHIJ3KL4M5NO6PQRS5 \
--group db.sql \
--group-identifier example-sql-id \
--requested-dimensions statement
Вывод:
{
"Dimensions":[
{
"Value": "SELECT e.last_name, d.department_name FROM employees e, departments d WHERE e.department_id=d.department_id",
"Dimension": "db.sql.statement",
"Status": "AVAILABLE"
},
...
]
}
Дополнительную информацию об измерениях в Performance Insights см. в разделе Нагрузка базы данных в руководстве пользователя Amazon RDS и Нагрузка базы данных в руководстве пользователя Amazon Aurora.
Вывод
Измерения -> (список)
Подробная информация о запрошенных измерениях.
(структура)
Объект, описывающий детали указанного измерения.
Значение -> (строка)
Значение данных деталей измерения. В зависимости от состояния возврата это значение — либо полный, либо усечённый SQL-запрос для следующих измерений:
-
db.query.statement(Amazon DocumentDB) -
db.sql.statement(Amazon RDS и Aurora)
Измерение -> (строка)
Полное имя измерения. Полное имя включает имя группы и имя ключа. Следующие значения допустимы:
-
db.query.statement(Amazon DocumentDB) -
db.sql.statement(Amazon RDS и Aurora)
Статус -> (строка)
Состояние данных деталей измерения. Возможные значения включают следующие:
-
AVAILABLE— данные деталей измерения готовы к извлечению. -
PROCESSING— данные деталей измерения не готовы к извлечению, так как требуется больше времени обработки. Если запрашиваемые данные деталей имеют статусPROCESSING, Performance Insights возвращает усечённый запрос. -
UNAVAILABLE— данные деталей измерения не удалось собрать успешно.
© Copyright 2025, Amazon Web Services. Created using Sphinx.