[ aws . cloudwatch ]
get-metric-stream
Описание
Возвращает информацию о потоке метрик, который вы указали.
См. также: Документация API AWS
Синтаксис
get-metric-stream
--name <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]
Параметры
--name (строка)
--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
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование определенного профиля из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отображение версии данного инструмента.
--color (строка)
Включение/выключение цветного вывода.
- on
- off
- auto
--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.
Получение информации о потоке метрик
Следующий get-metric-stream пример отображает информацию о потоке метрик с именем QuickFull-GuaFbs в указанной учетной записи.
aws cloudwatch get-metric-stream \
--name QuickFull-GuaFbs
Вывод:
{
"Arn": "arn:aws:cloudwatch:us-east-1:123456789012:metric-stream/QuickFull-GuaFbs",
"Name": "QuickFull-GuaFbs",
"FirehoseArn": "arn:aws:firehose:us-east-1:123456789012:deliverystream/MetricStreams-QuickFull-GuaFbs-WnySbECG",
"RoleArn": "arn:aws:iam::123456789012:role/service-role/MetricStreams-FirehosePutRecords-JN10W9B3",
"State": "running",
"CreationDate": "2024-10-11T18:48:59.187000+00:00",
"LastUpdateDate": "2024-10-11T18:48:59.187000+00:00",
"OutputFormat": "json",
"IncludeLinkedAccountsMetrics": false
}
Дополнительную информацию см. в разделе Использование потоков метрик в Руководстве пользователя Amazon CloudWatch.
Вывод
Arn -> (строка)
Name -> (строка)
IncludeFilters -> (список)
Если этот массив пространств имён метрик присутствует, то только эти пространства имён метрик будут переданы в поток метрик.
(структура)
Эта структура содержит имя пространства имён метрик и, необязательно, список имён метрик, которые включаются или исключаются из потока метрик.
Фильтр потока метрик может включать до 1000 имён в сумме. Это ограничение относится к сумме имён пространств имён и имён метрик в фильтрах. Например, это может включать 10 фильтров пространств имён метрик с по 99 метриками в каждом или 20 фильтров пространств имён с по 49 метриками в каждом.
Namespace -> (строка)
Имя пространства имён метрик для данного фильтра.
Пространство имён может содержать только печатаемые символы ASCII (диапазон ASCII от 32 до 126). Оно должно содержать как минимум один символ, отличный от пробела.
MetricNames -> (список)
Имена метрик, которые включаются или исключаются из потока метрик.
Если этот параметр опущен, все метрики в пространстве имён включаются или исключаются, в зависимости от того, является ли данный фильтр фильтром включения или исключения.
Каждое имя метрики может содержать только печатаемые символы ASCII (диапазон ASCII от 32 до 126). Каждое имя метрики должно содержать как минимум один символ, отличный от пробела.
(строка)
ExcludeFilters -> (список)
Если этот массив пространств имён метрик присутствует, то только эти пространства имён метрик не будут переданы в поток метрик. В этом случае все остальные пространства имён метрик в аккаунте будут переданы в поток метрик.
(структура)
Эта структура содержит имя пространства имён метрик и, необязательно, список имён метрик, которые включаются или исключаются из потока метрик.
Фильтр потока метрик может включать до 1000 имён в сумме. Это ограничение относится к сумме имён пространств имён и имён метрик в фильтрах. Например, это может включать 10 фильтров пространств имён метрик с по 99 метриками в каждом или 20 фильтров пространств имён с по 49 метриками в каждом.
Namespace -> (строка)
Имя пространства имён метрик для данного фильтра.
Пространство имён может содержать только печатаемые символы ASCII (диапазон ASCII от 32 до 126). Оно должно содержать как минимум один символ, отличный от пробела.
MetricNames -> (список)
Имена метрик, которые включаются или исключаются из потока метрик.
Если этот параметр опущен, все метрики в пространстве имён включаются или исключаются, в зависимости от того, является ли данный фильтр фильтром включения или исключения.
Каждое имя метрики может содержать только печатаемые символы ASCII (диапазон ASCII от 32 до 126). Каждое имя метрики должно содержать как минимум один символ, отличный от пробела.
(строка)
FirehoseArn -> (строка)
RoleArn -> (строка)
State -> (строка)
running и stopped .CreationDate -> (метка времени)
LastUpdateDate -> (метка времени)
OutputFormat -> (строка)
json , opentelemetry1.0 и opentelemetry0.7 . Дополнительную информацию о форматах вывода потоков метрик см. в разделе Форматы вывода потоков метрик.StatisticsConfigurations -> (список)
Каждый элемент в этом массиве отображает информацию об одной или нескольких метриках, которые включают дополнительные статистические данные в поток метрик. Дополнительную информацию об дополнительных статистических данных см. в разделе Определения статистических данных CloudWatch.
(структура)
По умолчанию поток метрик всегда отправляет MAX , MIN , SUM и SAMPLECOUNT статистические данные для каждой передаваемой метрики. Эта структура содержит информацию для одной метрики, которая включает дополнительные статистические данные в поток. Дополнительную информацию о статистике см. в CloudWatch в разделе Определения статистических данных CloudWatch.
IncludeMetrics -> (список)
Массив пар имён и пространств имён метрик, которые передают дополнительные статистические данные, указанные в значении параметра AdditionalStatistics. В массиве может быть до 100 пар.
Все метрики, соответствующие сочетанию имени метрики и пространства имён, будут переданы с дополнительными статистическими данными, независимо от их размерностей.
(структура)
Этот объект содержит информацию об одной метрике, которая должна передаваться с дополнительными статистическими данными.
Namespace -> (строка)
MetricName -> (строка)
AdditionalStatistics -> (список)
Список дополнительных статистических данных, которые будут переданы для метрик, перечисленных в массиве IncludeMetrics в этой структуре. Этот список может содержать до 20 статистик.
Если OutputFormat для потока равно opentelemetry1.0 или opentelemetry0.7 , единственно допустимые значения - p*??* `` percentile statistics such as ``p90 , p99 и т. д.
Если OutputFormat для потока равно json , допустимые значения включают аббревиатуры всех статистических данных, перечисленных в Определения статистических данных CloudWatch . Например, это включает tm98, wm90 , PR(:300) и т. д.
(строка)
IncludeLinkedAccountsMetrics -> (логическое значение)
true, и этот поток метрик находится в аккаунте мониторинга, то поток включает метрики из исходных аккаунтов, к которым аккаунт мониторинга привязан.
© Copyright 2025, Amazon Web Services. Created using Sphinx.