get-distribution-metric-data

Описание

Возвращает точки данных определенного метрики для распределения Amazon Lightsail контент-сети доставки (CDN).

Метрики сообщают об использовании ваших ресурсов и количестве ошибок, генерируемых ими. Регулярно отслеживайте и собирайте данные метрики, чтобы поддерживать надежность, доступность и производительность ваших ресурсов.

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

Синтаксис

  get-distribution-metric-data
--distribution-name <value>
--metric-name <value>
--start-time <value>
--end-time <value>
--period <value>
--unit <value>
--statistics <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]

Параметры

--distribution-name (строка)

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

Используйте действие GetDistributions, чтобы получить список имён распределения, которые можно указать.

--metric-name (строка)

Метрика, для которой требуется вернуть информацию.

Допустимые имена метрики распределения перечислены ниже вместе с наиболее полезной statistics для включения в ваш запрос и опубликованным значением unit.

**Requests ** - Общее количество запросов от зрителей, полученных вашим распределением Lightsail, для всех HTTP-методов и для запросов HTTP и HTTPS. Statistics : Наиболее полезная статистика — Sum. Unit : Опубликованная единица измерения — None.
**BytesDownloaded ** - Количество байтов, загруженных зрителями для запросов GET, HEAD и OPTIONS. Statistics : Наиболее полезная статистика — Sum. Unit : Опубликованная единица измерения — None.
**BytesUploaded ** - Количество байтов, загруженных в ваш источник вашим распределением Lightsail, с использованием запросов POST и PUT. Statistics : Наиболее полезная статистика — Sum. Unit : Опубликованная единица измерения — None.
**TotalErrorRate ** - Процент всех запросов от зрителей, для которых код состояния HTTP ответа был 4xx или 5xx. Statistics : Наиболее полезная статистика — Average. Unit : Опубликованная единица измерения — Percent.
**4xxErrorRate ** - Процент всех запросов от зрителей, для которых код состояния HTTP ответа был 4xx. В этих случаях клиент или зритель клиента могли совершить ошибку. Например, код состояния 404 (Не найдено) означает, что клиент запросил объект, который не удалось найти. Statistics : Наиболее полезная статистика — Average. Unit : Опубликованная единица измерения — Percent.
**5xxErrorRate ** - Процент всех запросов от зрителей, для которых код состояния HTTP ответа был 5xx. В этих случаях сервер происхождения не удовлетворил запросы. Например, код состояния 503 (Сервис недоступен) означает, что сервер происхождения в настоящее время недоступен. Statistics : Наиболее полезная статистика — Average. Unit : Опубликованная единица измерения — Percent.

Возможные значения:

Requests
BytesDownloaded
BytesUploaded
TotalErrorRate
Http4xxErrorRate
Http5xxErrorRate

--start-time (отметка времени)

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

Ограничения:

Указано в координированном всемирном времени (UTC).
Указано в формате времени Unix. Например, если вы хотите использовать начальное время 1 октября 2018 года в 20:00 по UTC, укажите 1538424000 как начальное время.

Вы можете преобразовать понятное для человека время в формат Unix-времени, используя конвертер, такой как Epoch converter.

--end-time (отметка времени)

Конец временного интервала, для которого необходимо получить данные метрики.

Ограничения:

Указано в координированном всемирном времени (UTC).
Указано в формате времени Unix. Например, если вы хотите использовать конечное время 1 октября 2018 года в 21:00 по UTC, укажите 1538427600 как конечное время.

--period (целое число)

Гранность в секундах для точек данных метрики, которые будут возвращены.

--unit (строка)

Единица измерения для запроса данных метрики.

Допустимые единицы зависят от запрашиваемых данных метрики. Допустимые единицы измерения для каждой доступной метрики см. в параметре metricName.

Возможные значения:

Seconds
Microseconds
Milliseconds
Bytes
Kilobytes
Megabytes
Gigabytes
Terabytes
Bits
Kilobits
Megabits
Gigabits
Terabits
Percent
Count
Bytes/Second
Kilobytes/Second
Megabytes/Second
Gigabytes/Second
Terabytes/Second
Bits/Second
Kilobits/Second
Megabits/Second
Gigabits/Second
Terabits/Second
Count/Second
None

--statistics (список)

Статистика для метрики.

Доступны следующие статистики:

Minimum - Наименьшее значение, наблюдаемое в течение указанного периода. Используйте это значение, чтобы определить низкий объём активности для вашего приложения.
Maximum - Наибольшее значение, наблюдаемое в течение указанного периода. Используйте это значение, чтобы определить высокий объём активности для вашего приложения.
Sum - Все значения, отправленные для соответствующей метрики, добавленные вместе. Вы можете использовать эту статистику, чтобы определить общий объём метрики.
Average - Значение Sum / SampleCount в течение указанного периода. Сравнивая эту статистику со значениями Minimum и Maximum, вы можете определить весь объём метрики и насколько близко среднее использование к значениям Minimum и Maximum. Это сравнение поможет вам узнать, когда необходимо увеличить или уменьшить ваши ресурсы.
SampleCount - Подсчёт, или количество, точек данных, используемых для статистического расчёта.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  Minimum
  Maximum
  Sum
  Average
  SampleCount

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

Вывод

metricName -> (строка)

Имя возвращаемой метрики.

metricData -> (список)

Массив объектов, описывающих возвращённые данные метрики.

(структура)

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

average -> (двойное)

Среднее значение.

maximum -> (двойное)

Максимальное значение.

minimum -> (двойное)

Минимальное значение.

sampleCount -> (двойное)

Количество выборок.

sum -> (двойное)

Сумма.

timestamp -> (метка времени)

Метка времени (1479816991.349).

unit -> (строка)

Единица измерения.

END_OF_DOCUMENT_MARKER