Spec-Zone.ru › AWS CLI v2

[ aws . pi ]

get-resource-metadata

Описание

Получение метаданных для различных функций. Например, метаданные могут указывать, включена или выключена функция на конкретном экземпляре БД.

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

Синтаксис

  get-resource-metadata
--service-type <value>
--identifier <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
  • DOCDB

--identifier (строка)

Неизменяемый идентификатор источника данных, уникальный для региона Amazon Web Services. Performance Insights собирает метрики из этого источника данных. Для использования экземпляра БД в качестве источника данных укажите его DbiResourceId значение. Например, укажите db-ABCDEFGHIJKLMNOPQRSTU1VW2X .

--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-auto-prompt (логическое значение)

Автоматически запросить параметры входных данных CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматический запрос параметров входных данных CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Смотрите руководство по началу работы в руководстве пользователя AWS CLI для получения дополнительной информации.

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

Получение метаданных ресурса для базы данных

Следующий get-resource-metadata пример получает метаданные ресурса для базы данных db-abcdefg123456789. Ответ показывает, что статистика SQL digest включена.

aws pi get-resource-metadata \
    --service-type RDS \
    --identifier db-abcdefg123456789

Вывод:

{
    "Identifier": "db-abcdefg123456789",
    "Features":{
        "SQL_DIGEST_STATISTICS":{
            "Status": "ENABLED"
        }
    }
}

Для получения дополнительной информации о статистике SQL для Performance Insights, см. Статистика SQL для Performance Insights в руководстве пользователя Amazon RDS и Статистика SQL для Performance Insights в руководстве пользователя Amazon Aurora.

Вывод

Идентификатор -> (строка)

Неизменяемый идентификатор источника данных, уникальный для региона Amazon Web Services. Performance Insights собирает метрики из этого источника данных. Для использования экземпляра БД в качестве источника данных укажите его DbiResourceId значение. Например, укажите db-ABCDEFGHIJKLMNOPQRSTU1VW2X .

Функции -> (массив)

Метаданные для различных функций. Например, метаданные могут указывать, включена или выключена функция на конкретном экземпляре БД.

ключ -> (строка)

значение -> (структура)

Метаданные для функции. Например, метаданные могут указывать, включена или выключена функция на конкретном экземпляре БД.

Статус -> (строка)

Статус функции на экземпляре БД. Возможные значения включают следующие:

  • ENABLED - Функция включена на экземпляре.
  • DISABLED - Функция отключена на экземпляре.
  • UNSUPPORTED - Функция не поддерживается на экземпляре.
  • ENABLED_PENDING_REBOOT - Функция включена на экземпляре, но для ее действия требуется перезагрузка.
  • DISABLED_PENDING_REBOOT - Функция отключена на экземпляре, но для ее действия требуется перезагрузка.
  • UNKNOWN - Статус функции не удалось определить.

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

Spec-Zone.ru

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