Spec-Zone.ru › AWS CLI v2

[ aws . iotwireless ]

get-metrics

Описание

Получение сводных метрик для этой учетной записи AWS.

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

Синтаксис

  get-metrics
[--summary-metric-queries <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]

Параметры

--summary-metric-queries (список)

Список запросов для получения сводных метрик.

(структура)

Объект запроса сводной метрики.

QueryId -> (строка)

Идентификатор запроса сводной метрики.

MetricName -> (строка)

Имя метрики.

Dimensions -> (список)

Размеры сводной метрики.

(структура)

Необходимый список размеров для метрики.

name -> (строка)

Имя размера.

value -> (строка)

Значение размера.

AggregationPeriod -> (строка)

Период агрегирования сводной метрики.

StartTimestamp -> (временная метка)

Начальная временная метка для запроса сводной метрики.

EndTimestamp -> (временная метка)

Конечная временная метка для запроса сводной метрики.

Сокращенная форма:

QueryId=string,MetricName=string,Dimensions=[{name=string,value=string},{name=string,value=string}],AggregationPeriod=string,StartTimestamp=timestamp,EndTimestamp=timestamp ...

Синтаксис JSON:

[
  {
    "QueryId": "string",
    "MetricName": "DeviceRSSI"|"DeviceSNR"|"DeviceRoamingRSSI"|"DeviceRoamingSNR"|"DeviceUplinkCount"|"DeviceDownlinkCount"|"DeviceUplinkLostCount"|"DeviceUplinkLostRate"|"DeviceJoinRequestCount"|"DeviceJoinAcceptCount"|"DeviceRoamingUplinkCount"|"DeviceRoamingDownlinkCount"|"GatewayUpTime"|"GatewayDownTime"|"GatewayRSSI"|"GatewaySNR"|"GatewayUplinkCount"|"GatewayDownlinkCount"|"GatewayJoinRequestCount"|"GatewayJoinAcceptCount"|"AwsAccountUplinkCount"|"AwsAccountDownlinkCount"|"AwsAccountUplinkLostCount"|"AwsAccountUplinkLostRate"|"AwsAccountJoinRequestCount"|"AwsAccountJoinAcceptCount"|"AwsAccountRoamingUplinkCount"|"AwsAccountRoamingDownlinkCount"|"AwsAccountDeviceCount"|"AwsAccountGatewayCount"|"AwsAccountActiveDeviceCount"|"AwsAccountActiveGatewayCount",
    "Dimensions": [
      {
        "name": "DeviceId"|"GatewayId",
        "value": "string"
      }
      ...
    ],
    "AggregationPeriod": "OneHour"|"OneDay"|"OneWeek",
    "StartTimestamp": timestamp,
    "EndTimestamp": timestamp
  }
  ...
]

--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.

Вывод

SummaryMetricQueryResults -> (список)

Список полученных сводных метрик.

(структура)

Результат операции агрегирования сводных метрик.

QueryId -> (строка)

Идентификатор запроса операции агрегирования сводных метрик.

QueryStatus -> (строка)

Статус результата запроса сводной метрики.

Error -> (строка)

Сообщение об ошибке для результата запроса сводной метрики.

MetricName -> (строка)

Имя результата запроса сводной метрики.

Dimensions -> (список)

Размеры метрики.

(структура)

Необходимый список размеров для метрики.

name -> (строка)

Имя размера.

value -> (строка)

Значение размера.

AggregationPeriod -> (строка)

Период агрегирования метрики.

StartTimestamp -> (временная метка)

Начальная временная метка для запроса сводной метрики.

EndTimestamp -> (временная метка)

Конечная временная метка для запроса сводной метрики.

Timestamps -> (список)

Временная метка каждого результата агрегирования.

(временная метка)

Values -> (список)

Список агрегированных результатов запроса сводной метрики.

(структура)

Агрегированные значения метрики.

Min -> (двойное число)

Минимальное значение всех точек данных, собранных за период агрегирования.

Max -> (двойное число)

Максимальное значение всех точек данных, собранных за период агрегирования.

Sum -> (двойное число)

Сумма значений всех точек данных, собранных за период агрегирования.

Avg -> (двойное число)

Среднее значение всех точек данных, собранных за период агрегирования.

Std -> (двойное число)

Среднеквадратическое отклонение значений всех точек данных, собранных за период агрегирования.

P90 -> (двойное число)

90-й процентиль значений всех точек данных, собранных за период агрегирования.

Unit -> (строка)

Единицы измерения для интерпретации результата агрегирования.

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

Spec-Zone.ru

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