[ aws . cloudwatch ]
get-metric-widget-image
Описание
Вы можете использовать API GetMetricWidgetImage для получения моментального графика одной или нескольких метрик Amazon CloudWatch в виде растрового изображения. Затем вы можете встроить это изображение в свои службы и продукты, такие как страницы вики, отчеты и документы. Вы также можете регулярно получать изображения, например, каждую минуту, и создавать свой собственный пользовательский интерактивный информационный центр.
График, который вы получаете, может включать все функции графика метрик CloudWatch, включая математические операции с метриками и горизонтальные и вертикальные аннотации.
Для этого API ограничение составляет 20 транзакций в секунду. Каждое действие GetMetricWidgetImage имеет следующие ограничения:
- В графике может быть до 100 метрик.
- Несжатый объём данных до 100 КБ.
См. также: Документация API AWS
Синтаксис
get-metric-widget-image
--metric-widget <value>
[--output-format <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]
Параметры
--metric-widget (строка)
Строка JSON, определяющая растровый график, который нужно получить. Строка включает метрики, которые необходимо включить в график, статистику, аннотации, заголовок, пределы осей и так далее. В каждом вызове GetMetricWidgetImage можно указать только один параметр MetricWidget.
Для получения дополнительной информации о синтаксисе MetricWidget см. GetMetricWidgetImage: Структура и синтаксис виджета метрик.
Если какая-либо метрика на графике не смогла загрузить все запрошенные точки данных, рядом с легендой графика отобразится оранжевый треугольник с восклицательным знаком.
--output-format (строка)
Формат результирующего изображения. Поддерживаются только изображения PNG.
По умолчанию используется png. Если вы укажете png, API возвращает HTTP-ответ с типом контента, установленным на text/xml. Данные изображения находятся в поле MetricWidgetImage. Например:
<GetMetricWidgetImageResponse xmlns=<URLstring>>
<GetMetricWidgetImageResult>
<MetricWidgetImage>
iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...
</MetricWidgetImage>
</GetMetricWidgetImageResult>
<ResponseMetadata>
<RequestId>6f0d4192-4d42-11e8-82c1-f539a07e0e3b</RequestId>
</ResponseMetadata>
</GetMetricWidgetImageResponse>
Настройка image/png предназначена только для пользовательских HTTP-запросов. В большинстве случаев и для всех действий, использующих SDK Amazon Web Services, следует использовать png. Если вы укажете image/png, HTTP-ответ имеет тип контента, установленный на image/png, а тело ответа — изображение PNG.
--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.
Для получения моментального графика CPUUtilization
В следующем примере get-metric-widget-image извлекается моментальный график метрики CPUUtilization экземпляра EC2 с идентификатором i-abcde и сохраняется полученное изображение в файл «image.png» на вашем локальном компьютере.
aws cloudwatch get-metric-widget-image \
--metric-widget '{"metrics":[["AWS/EC2","CPUUtilization","InstanceId","i-abcde"]]}' \
--output-format png \
--output text | base64 --decode > image.png
Эта команда не генерирует вывод.
Вывод
MetricWidgetImage -> (блоб)
© Copyright 2025, Amazon Web Services. Created using Sphinx.