batch-get-service-level-objective-budget-report

Описание

Используйте эту операцию для получения одного или нескольких отчётов о бюджете уровня обслуживания (SLO).

Бюджет ошибок — это количество времени или запросов в неисправном состоянии, которое ваш сервис может накопить за интервал, прежде чем общее состояние бюджета SLO будет нарушено, и SLO считается невыполненным. Например, SLO с порогом 99,95% и месячным интервалом соответствует бюджету ошибок в 21,9 минуты простоя в месяце из 30 дней.

Отчёты о бюджете включают индикатор состояния, значение достижения и оставшийся бюджет.

Дополнительную информацию о бюджетах ошибок SLO см. в разделе Концепции SLO.

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

Синтаксис

  batch-get-service-level-objective-budget-report
--timestamp <value>
--slo-ids <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]

Параметры

--timestamp (timestamp)

Дата и время, для которых требуется отчёт. Выражается в миллисекундах с момента 00:00:00 1 января 1970 года по UTC.

--slo-ids (list)

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

(строка)

Синтаксис:

"string" "string" ...

--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 (boolean)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования выходных данных команды.

json
текст
таблица
yaml
yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла с вашими учётными данными.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

вкл
выкл
авто

--no-sign-request (boolean)

Не подписывать запросы. Учётные данные не будут загружаться, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл с сертификатами CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет рассматриваться как двоичное и будет использовать содержимое файла напрямую, независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Отключить постраничный вывод.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

Дата и время —> (timestamp)

Дата и время отчёта. Выражается в миллисекундах с момента 00:00:00 1 января 1970 года по UTC.

Отчёты —> (список)

Массив структур, где каждая структура — это один отчёт о бюджете.

(структура)

Структура, содержащая отчёт о бюджете SLO, который вы запросили.

Arn —> (строка)

ARN SLO, для которого предназначен этот отчёт.

Имя —> (строка)

Имя SLO, для которого предназначен этот отчёт.

Тип оценки —> (строка)

Отображает, предназначен ли этот отчёт о бюджете для SLO на основе периода или SLO на основе запросов.

Статус бюджета —> (строка)

Статус SLO в отношении бюджета ошибок за весь интервал.

OK означает, что у SLO был остаток бюджета выше порога предупреждения на момент времени, который вы указали в TimeStamp.
WARNING означает, что остаток бюджета SLO был ниже порога предупреждения на момент времени, который вы указали в TimeStamp.
BREACHED означает, что бюджет SLO был исчерпан на момент времени, который вы указали в TimeStamp.
INSUFFICIENT_DATA означает, что указанные начальное и конечное время были до создания SLO или что данные достижения отсутствуют.

Достижение —> (двойное)

Число от 0 до 100, которое представляет процент успешности вашего приложения по сравнению с целью, заданной SLO.

Если это SLO на основе периода, число представляет собой процент периодов времени, в которых служба достигла целевого показателя достижения SLO на момент запроса.

Если это SLO на основе запросов, число представляет собой число успешных запросов, делённое на общее число запросов, умноженное на 100, в течение указанного диапазона времени в вашем запросе.

TotalBudgetSeconds —> (целое число)

Общее количество секунд в бюджете ошибок для интервала. Это поле включается только в том случае, если SLO является SLO на основе периода.

BudgetSecondsRemaining —> (целое число)

Сумма бюджета, оставшаяся, прежде чем статус SLO станет BREACHING, на момент времени, указанный в параметре Timestemp запроса. Если это значение отрицательное, то SLO уже в статусе BREACHING.

Это поле включается только в том случае, если SLO является SLO на основе периода.

TotalBudgetRequests —> (целое число)

Это поле отображается только для SLO на основе запросов. Оно отображает общее количество неудачных запросов, которые могут быть допущены в течение периода времени между началом интервала и отметкой времени, указанной в запросе отчёта о бюджете. Оно основано на общем количестве запросов, произошедших, и проценте, указанном в целевом показателе достижения. Если количество неудачных запросов соответствует этому числу или превышает его, значит, SLO в настоящее время нарушается.

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

BudgetRequestsRemaining —> (целое число)

Это поле отображается только для SLO на основе запросов. Оно отображает количество неудачных запросов, которые могут быть допущены, прежде чем появятся новые успешные запросы, и приложение всё ещё соответствует своей цели SLO.

Это число может меняться между различными отчётами, в зависимости от того, сколько успешных запросов и сколько неудачных запросов происходит в это время.

Sli —> (структура)

Структура, содержащая информацию об измерителе производительности, за которым следит данная ЦЕЛЬ УРОВНЯ УСЛУГ.

SliMetric -> (структура)

Структура, содержащая информацию об измерителе, за которым следит ЦЕЛЬ УРОВНЯ УСЛУГ.

KeyAttributes -> (отображение)

Это отображение «строка-строка», содержащее информацию о типе объекта, к которому относится эта ЦЕЛЬ УРОВНЯ УСЛУГ. Оно может включать следующие поля.

Type обозначает тип объекта, к которому относится эта ЦЕЛЬ УРОВНЯ УСЛУГ.
ResourceType указывает тип ресурса. Это поле используется только в том случае, если значение поля Type равно Resource или AWS::Resource.
Name указывает имя объекта. Это используется только в том случае, если значение поля Type равно Service, RemoteService или AWS::Service.
Identifier идентифицирует объекты ресурсов данного ресурса. Это используется только в том случае, если значение поля Type равно Resource или AWS::Resource.
Environment указывает место размещения этого объекта или то, к чему он относится.

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

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

OperationName -> (строка)

Если ЦЕЛЬ УРОВНЯ УСЛУГ отслеживает определенную операцию службы, в этом поле отображается имя этой операции.

MetricType -> (строка)

Если ЦЕЛЬ УРОВНЯ УСЛУГ отслеживает либо метрику LATENCY, либо метрику AVAILABILITY, которую собирают Сигналы Приложений, в этом поле отображается используемая метрика.

MetricDataQueries -> (список)

Если эта ЦЕЛЬ УРОВНЯ УСЛУГ отслеживает метрику CloudWatch или результат математического выражения метрики CloudWatch, эта структура содержит информацию об этой метрике или выражении.

(структура)

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

Каждый элемент MetricDataQuery в массиве MetricDataQueries определяет либо метрику для извлечения, либо математическое выражение метрики для выполнения над извлеченными метриками. Один массив MetricDataQueries может содержать до 20 элементов MetricDataQuery в массиве. 20 элементов могут включать до 10 элементов, содержащих параметр MetricStat для получения метрики, и до 10 элементов, содержащих параметр Expression для выполнения математического выражения. Из этих элементов Expression ровно один должен иметь значение true для ReturnData. Результат этого выражения используется для ЦЕЛИ УРОВНЯ УСЛУГ.

Дополнительную информацию о математических выражениях метрик см. в разделе CloudWatchUse metric math.

В каждом элементе MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба.

Id -> (строка)

Короткое имя, используемое для привязки этого объекта к результатам в ответе. Это Id должно быть уникальным внутри массива MetricDataQueries. Если вы выполняете математические выражения над этим набором данных, это имя представляет эти данные и может служить переменной в математическом выражении метрики. Допустимые символы — буквы, цифры и символ подчеркивания. Первый символ должен быть строчной буквой.

MetricStat -> (структура)

Метрика, которая будет использоваться непосредственно для ЦЕЛИ УРОВНЯ УСЛУГ или будет использоваться в математическом выражении, которое будет использоваться для ЦЕЛИ УРОВНЯ УСЛУГ.

В одном объекте MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба.

Metric -> (структура)

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

Namespace -> (строка)

Пространство имен метрики. Дополнительную информацию см. в разделе Пространства имен.

MetricName -> (строка)

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

Dimensions -> (список)

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

(структура)

Размер — это пара «имя/значение», которая является частью идентификатора метрики. Поскольку размеры являются частью уникального идентификатора метрики, каждый раз, когда вы добавляете уникальную пару «имя/значение» в одну из ваших метрик, вы создаете новую вариацию этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени размера, а фактический идентификатор экземпляра — в качестве значения для этого размера.

Вы можете назначить до 30 размеров метрике.

Name -> (строка)

Имя размера. Имена размеров должны содержать только символы ASCII, должны содержать как минимум один символ, отличный от пробела, и не могут начинаться с двоеточия (:). ASCII-управляющие символы не поддерживаются в качестве части имен размеров.

Value -> (строка)

Значение размера. Значения размеров должны содержать только символы ASCII и должны содержать как минимум один символ, отличный от пробела. ASCII-управляющие символы не поддерживаются в качестве части значений размеров.

Period -> (целое число)

Детализация, в секундах, используемая для метрики. Для метрик с регулярным разрешением детализация может составлять не менее одной минуты (60 секунд) и должна быть кратна 60. Для метрик с высоким разрешением, которые собираются с интервалами менее одной минуты, детализация может составлять 1, 5, 10, 30, 60 или любое кратное 60. Метрики с высоким разрешением — это те метрики, которые хранятся вызовом PutMetricData, который включает StorageResolution 1 секунды.

Stat -> (строка)

Статистика, используемая для сравнения с пороговым значением. Это может быть любая статистика CloudWatch или расширенная статистика. Дополнительную информацию о статистике см. в разделе определения статистики CloudWatch.

Unit -> (строка)

Если вы опустите Unit, возвращаются все данные, собранные с любыми единицами измерения, вместе с соответствующими единицами, указанными при отправке данных в CloudWatch. Если вы укажете единицу измерения, операция вернет только данные, собранные с указанной единицей измерения. Если вы укажете единицу измерения, которая не соответствует собранным данным, результаты операции будут равны null. CloudWatch не выполняет преобразования единиц измерения.

Expression -> (строка)

Это поле может содержать математическое выражение метрики, которое должно выполняться над другими метриками, которые вы извлекаете в этой структуре MetricDataQueries.

Математическое выражение может использовать Id других метрик или запросов, чтобы ссылаться на эти метрики, а также может использовать Id других выражений для использования результата этих выражений. Дополнительную информацию о математических выражениях метрик см. в руководстве пользователя Amazon CloudWatch в разделе Синтаксис и функции математических выражений метрик.

В каждом объекте MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба.

Label -> (строка)

Чловекочитаемое метка для этой метрики или выражения. Это особенно полезно, если это выражение, чтобы вы знали, что оно представляет. Если метрика или выражение показаны в виджете панели мониторинга CloudWatch, метка отображается. Если Label опущено, CloudWatch генерирует значение по умолчанию.

Вы можете вставить динамические выражения в метку, чтобы сделать ее более информативной. Дополнительную информацию см. в разделе Использование динамических меток.

ReturnData -> (булево)

Используйте это только в том случае, если вы используете математическое выражение метрики для ЦЕЛИ УРОВНЯ УСЛУГ. Укажите true для ReturnData, чтобы использовать только один результат выражения в качестве сигнала тревоги. Для всех других метрик и выражений в той же операции CreateServiceLevelObjective укажите ReturnData как false.

Period -> (целое число)

Детализация, в секундах, возвращаемых точек данных для этой метрики. Для метрик с регулярным разрешением детализация может составлять не менее одной минуты (60 секунд) и должна быть кратна 60. Для метрик с высоким разрешением, которые собираются с интервалами менее одной минуты, детализация может составлять 1, 5, 10, 30, 60 или любое кратное 60. Метрики с высоким разрешением — это те метрики, которые хранятся вызовом PutMetricData, который включает StorageResolution 1 секунды.

Если параметр StartTime указывает отметку времени, которая больше, чем 3 часа назад, вы должны указать период следующим образом, иначе точки данных в этом диапазоне времени не будут возвращены:

Время начала между 3 часами и 15 днями назад — используйте кратное 60 секунд (1 минута).
Время начала между 15 и 63 днями назад — используйте кратное 300 секунд (5 минут).
Время начала более чем 63 дня назад — используйте кратное 3600 секунд (1 час).

AccountId -> (строка)

Идентификатор учетной записи, в которой находится эта метрика. Если вы выполняете эту операцию в учетной записи мониторинга, используйте это для указания учетной записи-источника, откуда извлекать эту метрику.

DependencyConfig -> (структура)

Идентифицирует зависимость с помощью DependencyKeyAttributes и DependencyOperationName.

DependencyKeyAttributes -> (отображение)

Это отображение «строка-строка». Оно может включать следующие поля.

Type обозначает тип объекта.
ResourceType указывает тип ресурса. Это поле используется только в том случае, если значение поля Type равно Resource или AWS::Resource.
Name указывает имя объекта. Это используется только в том случае, если значение поля Type равно Service, RemoteService или AWS::Service.
Identifier идентифицирует объекты ресурсов этого ресурса. Это используется только в том случае, если значение поля Type равно Resource или AWS::Resource.
Environment указывает место размещения этого объекта или то, к чему он относится.

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

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

DependencyOperationName -> (строка)

Имя вызываемой операции в зависимости.

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

Значение, с которым сравнивается метрика SLI.

ComparisonOperator -> (строка)

Арифметическая операция, используемая при сравнении указанной метрики с пороговым значением.

RequestBasedSli -> (структура)

В этой структуре содержится информация о метрике производительности, за которой отслеживает SLO, основанный на запросах.

RequestBasedSliMetric -> (структура)

Структура, содержащая информацию о метрике, за которой следит SLO.

KeyAttributes -> (карта)

Это карта строка-строка, содержащая информацию о типе объекта, к которому относится этот SLO. Она может включать следующие поля.

Type обозначает тип объекта, к которому относится этот SLO.
ResourceType указывает тип ресурса. Это поле используется только тогда, когда значение поля Type равно Resource или AWS::Resource.
Name указывает имя объекта. Это используется только если значение поля Type равно Service, RemoteService или AWS::Service.
Identifier идентифицирует объекты ресурсов данного ресурса. Это используется только если значение поля Type равно Resource или AWS::Resource.
Environment указывает расположение, где размещен этот объект, или к чему он относится.

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

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

OperationName -> (строка)

Если SLO отслеживает определённую операцию сервиса, в этом поле отображается имя этой операции.

MetricType -> (строка)

Если SLO отслеживает метрику LATENCY или AVAILABILITY, собранную Application Signals, в этом поле отображается, какая из этих метрик используется.

TotalRequestCountMetric -> (список)

Эта структура определяет метрику, используемую в качестве количества «всех запросов» для SLO, основанного на запросах. Значение, наблюдаемое для этой метрики, делится на количество «хороших запросов» или «плохих запросов», наблюдаемых для метрики, определённой в MonitoredRequestCountMetric.

(структура)

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

Каждый MetricDataQuery в массиве MetricDataQueries указывает либо метрику для получения, либо выражение математической операции над полученными метриками. Один массив MetricDataQueries может включать до 20 структур MetricDataQuery в массиве. Эти 20 структур могут включать до 10 структур, содержащих параметр MetricStat для получения метрики, и до 10 структур, содержащих параметр Expression для выполнения математической операции. Из этих структур Expression ровно одна должна иметь значение true для параметра ReturnData. Результат этого выражения используется для SLO.

Дополнительную информацию об выражениях математических операций над метриками см. в CloudWatchUse metric math.

В каждом объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Id -> (строка)

Короткое имя, используемое для привязки этого объекта к результатам в ответе. Это Id должно быть уникальным внутри массива MetricDataQueries. Если вы выполняете математические операции над этим набором данных, это имя представляет эти данные и может служить переменной в выражении математической операции над метриками. Допустимые символы — буквы, цифры и знак подчеркивания. Первый символ должен быть строчной буквой.

MetricStat -> (структура)

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

В каждом объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Metric -> (структура)

Метрика, используемая в качестве показателя уровня обслуживания, включая имя метрики, пространство имён и измерения.

Namespace -> (строка)

Пространство имён метрики. Дополнительную информацию см. в раздела Namespaces.

MetricName -> (строка)

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

Dimensions -> (список)

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

(структура)

Измерение — это пара имя/значение, которая является частью идентификатора метрики. Поскольку измерения являются частью уникального идентификатора метрики, каждый раз, когда вы добавляете уникальную пару имя/значение к одной из ваших метрик, вы создаёте новую вариацию этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени измерения и фактический идентификатор экземпляра в качестве значения этого измерения.

Вы можете назначить до 30 измерений метрике.

Name -> (строка)

Имя измерения. Имена измерений должны содержать только символы ASCII, должны содержать хотя бы один символ, не являющийся пробелом, и не могут начинаться с двоеточия (:). ASCII-управляющие символы не поддерживаются как часть имён измерений.

Value -> (строка)

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

Period -> (целое число)

Дробность, в секундах, используемая для метрики. Для метрик с обычным разрешением период может быть как минимум одной минутой (60 секунд) и должен быть кратен 60. Для метрик с высоким разрешением, которые собираются с интервалами менее одной минуты, период может быть 1, 5, 10, 30, 60 или любым кратным 60. Метрики с высоким разрешением — это метрики, сохранённые с помощью вызова PutMetricData, включающего StorageResolution в 1 секунду.

Stat -> (строка)

Статистика, используемая для сравнения с порогом. Это может быть любая статистика CloudWatch или расширенная статистика. Дополнительную информацию о статистиках см. в CloudWatch statistics definitions.

Unit -> (строка)

Если вы опустите Unit, будут возвращены все данные, собранные с любым типом единиц измерения, вместе с соответствующими единицами измерения, которые были указаны при отправке данных в CloudWatch. Если вы укажете единицу измерения, операция вернёт только данные, собранные с указанной единицей измерения. Если вы укажете единицу измерения, не соответствующую собранным данным, результаты операции будут null. CloudWatch не выполняет преобразования единиц измерения.

Expression -> (строка)

Это поле может содержать выражение математической операции над метриками, которые вы получаете в этой структуре MetricDataQueries.

Выражение математической операции может использовать Id других метрик или запросов, чтобы сослаться на эти метрики, а также может использовать Id других выражений, чтобы использовать результат этих выражений. Дополнительную информацию об выражениях математических операций над метриками см. в Руководстве пользователя Amazon CloudWatch , раздел Metric Math Syntax and Functions.

В каждом объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Label -> (строка)

Человекочитаемое описание метрики или выражения. Это особенно полезно, если это выражение, чтобы вы понимали, что оно обозначает. Если метрика или выражение отображается в виджете панели управления CloudWatch, отображается описание. Если Label опущено, CloudWatch генерирует значение по умолчанию.

Вы можете вставлять динамические выражения в описание, чтобы сделать его более информативным. Дополнительную информацию см. в Using Dynamic Labels.

ReturnData -> (булево)

Используйте это только если вы используете выражение математической операции для SLO. Укажите true для ReturnData, чтобы получить только результат одного выражения для использования в качестве сигнала тревоги. Для всех других метрик и выражений в той же операции CreateServiceLevelObjective укажите ReturnData в качестве значения для false.

Period -> (целое число)

Дробность, в секундах, возвращаемых точек данных для этой метрики. Для метрик с обычным разрешением период может быть как минимум одной минутой (60 секунд) и должен быть кратен 60. Для метрик с высоким разрешением, которые собираются с интервалами менее одной минуты, период может быть 1, 5, 10, 30, 60 или любым кратным 60. Метрики с высоким разрешением — это метрики, сохранённые с помощью вызова PutMetricData, включающего StorageResolution в 1 секунду.

Если параметр StartTime указывает временную метку, которая старше 3 часов, вы должны указать период следующим образом, иначе точки данных в этом диапазоне времени не будут возвращены:

Время начала между 3 часами и 15 днями назад — используйте кратное 60 секунд (1 минута).
Время начала между 15 и 63 днями назад — используйте кратное 300 секунд (5 минут).
Время начала более 63 дней назад — используйте кратное 3600 секунд (1 час).

AccountId -> (строка)

Идентификатор учётной записи, где расположена эта метрика. Если вы выполняете эту операцию в учётной записи мониторинга, используйте это для указания исходной учётной записи, чтобы получить эту метрику.

MonitoredRequestCountMetric -> (структура помеченного объединения)

Эта структура определяет метрику, используемую в качестве значения «хороший запрос» или «плохой запрос» для SLO на основе запросов. Это значение, наблюдаемое для метрики, определенной в TotalRequestCountMetric, делится на число, полученное для MonitoredRequestCountMetric, чтобы определить процент успешных запросов, отслеживаемых этим SLO.

Примечание

Это структура помеченных объединений. Можно установить только один из следующих ключевых элементов верхнего уровня: GoodCountMetric, BadCountMetric.

GoodCountMetric -> (список)

Если вы хотите подсчитать «хорошие запросы», чтобы определить процент успешных запросов для этого SLO на основе запросов, укажите метрику, используемую как «хорошие запросы», в этой структуре.

(структура)

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

Каждый MetricDataQuery в массиве MetricDataQueries указывает либо метрику для извлечения, либо математическое выражение для метрик, подлежащих выполнению над извлечёнными метриками. Один массив MetricDataQueries может содержать до 20 структур MetricDataQuery в массиве. Эти 20 структур могут содержать до 10 структур с параметром MetricStat для извлечения метрики и до 10 структур с параметром Expression для выполнения математического выражения. Из этих структур Expression ровно одна должна иметь значение true для ReturnData. Результат этого выражения используется для SLO.

Дополнительную информацию о математических выражениях для метрик см. в CloudWatchUse metric math.

В каждом объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Id -> (строка)

Короткое имя, используемое для связи этого объекта с результатами в ответе. Это Id должно быть уникальным в массиве MetricDataQueries. Если вы выполняете математические выражения над этим набором данных, это имя представляет эти данные и может служить переменной в математическом выражении метрики. Допустимые символы — буквы, цифры и символ подчеркивания. Первый символ должен быть строчной буквой.

MetricStat -> (структура)

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

В одном объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Metric -> (структура)

Метрика, используемая в качестве показателя уровня обслуживания, включая имя метрики, пространство имен и измерения.

Namespace -> (строка)

Пространство имен метрики. Дополнительную информацию см. в Namespaces.

MetricName -> (строка)

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

Dimensions -> (список)

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

(структура)

Измерение — это пара «имя/значение», которая является частью идентификатора метрики. Поскольку измерения являются частью уникального идентификатора метрики, каждый раз, когда вы добавляете уникальную пару «имя/значение» к одной из своих метрик, вы создаёте новую разновидность этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени измерения, а фактический идентификатор экземпляра — в качестве значения этого измерения.

Вы можете назначить до 30 измерений одной метрике.

Name -> (строка)

Имя измерения. Имена измерений должны содержать только символы ASCII, должны включать хотя бы один символ, не являющийся пробелом, и не должны начинаться с двоеточия (:). ASCII-управляющие символы не поддерживаются в именах измерений.

Value -> (строка)

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

Period -> (целое число)

Гранularity (разрешение), в секундах, используемая для метрики. Для метрик с обычным разрешением период может составлять не менее одной минуты (60 секунд) и должен быть кратен 60. Для метрик с высоким разрешением, которые собираются с интервалами менее одной минуты, период может составлять 1, 5, 10, 30, 60 или любое кратное 60. Метрики с высоким разрешением — это те метрики, которые хранятся с помощью вызова PutMetricData, который включает в себя StorageResolution в 1 секунду.

Stat -> (строка)

Статистика, используемая для сравнения с пороговым значением. Это может быть любая статистика CloudWatch или расширенная статистика. Дополнительную информацию о статистике см. в определениях CloudWatch statistics definitions.

Unit -> (строка)

Если вы опустите Unit, то все данные, собранные с любым типом единиц измерения, будут возвращены вместе с соответствующими единицами, указанными при отправке данных в CloudWatch. Если вы укажете единицы измерения, операция вернёт только данные, собранные с указанием этих единиц измерения. Если вы укажете единицы измерения, не соответствующие собранным данным, результаты операции будут null. CloudWatch не выполняет преобразования единиц измерения.

Expression -> (строка)

Это поле может содержать математическое выражение для метрики, которое будет выполнено над другими метриками, извлекаемыми в структуре MetricDataQueries.

Математическое выражение может использовать Id других метрик или запросов для ссылки на эти метрики, а также может использовать Id других выражений для использования результата этих выражений. Дополнительную информацию о математических выражениях для метрик см. в разделе Синтаксис и функции математических выражений для метрик в руководстве пользователя Amazon CloudWatch.

В каждом объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Label -> (строка)

Человекопонятное описание для этой метрики или выражения. Это особенно полезно, если это выражение, чтобы понимать, что оно представляет. Если метрика или выражение отображаются в виджете панели CloudWatch, отображается метка. Если Label опущена, CloudWatch генерирует значение по умолчанию.

Вы можете использовать динамические выражения в метке, чтобы сделать ее более описательной. Дополнительную информацию см. в Using Dynamic Labels.

ReturnData -> (булево)

Используйте только в том случае, если вы используете математическое выражение для метрики в качестве SLO. Укажите true для ReturnData, чтобы использовать только результат одного выражения в качестве сигнала тревоги. Для всех других метрик и выражений в той же операции CreateServiceLevelObjective укажите ReturnData как false.

Period -> (целое число)

Гранularity (разрешение), в секундах, возвращаемых данных для этой метрики. Для метрик с обычным разрешением период может составлять не менее одной минуты (60 секунд) и должен быть кратен 60. Для метрик с высоким разрешением, которые собираются с интервалами менее одной минуты, период может составлять 1, 5, 10, 30, 60 или любое кратное 60. Метрики с высоким разрешением — это те метрики, которые хранятся с помощью вызова PutMetricData, который включает в себя StorageResolution в 1 секунду.

Если параметр StartTime указывает метку времени более чем за 3 часа назад, вы должны указать период следующим образом, иначе не будут возвращены данные в этом диапазоне времени:

Время начала между 3 часами и 15 днями назад — используйте кратное 60 секундам (1 минута).
Время начала между 15 и 63 днями назад — используйте кратное 300 секундам (5 минут).
Время начала более чем 63 дня назад — используйте кратное 3600 секундам (1 час).

AccountId -> (строка)

Идентификатор учетной записи, в которой расположена эта метрика. Если вы выполняете эту операцию в учетной записи мониторинга, используйте это для указания целевой учетной записи источника для извлечения этой метрики.

BadCountMetric -> (список)

Если вы хотите посчитать «плохие запросы», чтобы определить процент успешных запросов для данного SLO, основанного на запросах, укажите метрику, используемую как «плохие запросы» в этой структуре.

(структура)

Каждый MetricDataQuery в массиве MetricDataQueries указывает либо метрику для извлечения, либо математическое выражение метрики, которое должно быть выполнено над извлеченными метриками. Один массив MetricDataQueries может включать до 20 структур MetricDataQuery в массиве. 20 структур могут включать до 10 структур, содержащих параметр MetricStat для извлечения метрики, и до 10 структур, содержащих параметр Expression для выполнения математического выражения. Из этих структур Expression ровно одна должна иметь значение true для ReturnData . Результат этого выражения используется для SLO.

Дополнительную информацию о математических выражениях метрик см. в CloudWatchUse metric math.

В каждом объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Id -> (строка)

Короткое имя, используемое для привязки этого объекта к результатам в ответе. Это Id должно быть уникальным в массиве MetricDataQueries. Если вы выполняете математические выражения над этим набором данных, это имя представляет эти данные и может служить переменной в математическом выражении метрики. Допустимые символы — буквы, цифры и знак подчеркивания. Первый символ должен быть строчной буквой.

MetricStat -> (структура)

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

В одном объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Metric -> (структура)

Namespace -> (строка)

Пространство имен метрики. Дополнительную информацию см. в Namespaces.

MetricName -> (строка)

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

Dimensions -> (список)

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

(структура)

Измерение — это пара «имя/значение», являющаяся частью идентификатора метрики. Поскольку измерения являются частью уникального идентификатора метрики, каждый раз, когда вы добавляете уникальную пару «имя/значение» к одной из ваших метрик, вы создаете новую разновидность этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени измерения, а фактический идентификатор экземпляра — в качестве значения этого измерения.

Вы можете назначить до 30 измерений метрике.

Name -> (строка)

Имя измерения. Имена измерений должны содержать только символы ASCII, содержать хотя бы один символ, отличный от пробела, и не начинаться с двоеточия (:). ASCII-управляющие символы не поддерживаются в именах измерений.

Value -> (строка)

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

Period -> (целое число)

Грань, в секундах, используемая для метрики. Для метрик с регулярным разрешением период может быть не менее одной минуты (60 секунд) и должен быть кратен 60. Для метрик с высоким разрешением, которые собираются с интервалами менее одной минуты, период может быть 1, 5, 10, 30, 60 или любым кратным 60. Метрики с высоким разрешением — это метрики, хранящиеся с помощью вызова PutMetricData, который включает в себя StorageResolution 1 секунды.

Stat -> (строка)

Статистика, используемая для сравнения с порогом. Это может быть любая статистика CloudWatch или расширенная статистика. Дополнительную информацию о статистике см. в определениях статистики CloudWatch.

Unit -> (строка)

Если вы опустите Unit, все данные, собранные с любым единицей измерения, будут возвращены вместе с соответствующими единицами, которые были указаны при отправке данных в CloudWatch. Если вы укажете единицу измерения, операция вернет только данные, собранные с указанной единицей измерения. Если вы укажете единицу измерения, которая не соответствует собранным данным, результаты операции будут нулевыми. CloudWatch не выполняет преобразование единиц измерения.

Expression -> (строка)

Это поле может содержать математическое выражение метрики, которое должно быть выполнено над другими метриками, которые вы извлекаете в этой структуре MetricDataQueries.

Математическое выражение может использовать Id других метрик или запросов для ссылки на эти метрики, а также может использовать Id других выражений для использования результата этих выражений. Дополнительную информацию о математических выражениях метрик см. в разделе «Синтаксис и функции математических выражений метрик» в Руководстве пользователя Amazon CloudWatch.

В каждом объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Label -> (строка)

Понятное пользователю описание метрики или выражения. Это особенно полезно, если это выражение, чтобы вы знали, что представляет значение. Если метрика или выражение отображаются в виджете панели управления CloudWatch, отображается метка. Если Label опущено, CloudWatch генерирует значение по умолчанию.

Вы можете помещать динамические выражения в метку, чтобы она была более описательной. Дополнительную информацию см. в разделе «Использование динамических меток».

ReturnData -> (логическое значение)

Используйте это только в том случае, если вы используете математическое выражение метрики для SLO. Укажите true для ReturnData только для одного результата выражения для использования в качестве сигнала тревоги. Для всех других метрик и выражений в той же операции CreateServiceLevelObjective укажите ReturnData как false.

Period -> (целое число)

Грань, в секундах, возвращаемых точек данных для этой метрики. Для метрик с регулярным разрешением период может быть не менее одной минуты (60 секунд) и должен быть кратен 60. Для метрик с высоким разрешением, которые собираются с интервалами менее одной минуты, период может быть 1, 5, 10, 30, 60 или любым кратным 60. Метрики с высоким разрешением — это метрики, хранящиеся с помощью вызова PutMetricData, который включает в себя StorageResolution 1 секунды.

Если параметр StartTime указывает отметку времени, которая больше, чем 3 часа назад, вы должны указать период следующим образом, иначе точки данных в этом временном диапазоне не будут возвращены:

Время начала между 3 часами и 15 днями назад — используйте кратное 60 секундам (1 минута).
Время начала между 15 и 63 днями назад — используйте кратное 300 секундам (5 минут).
Время начала более 63 дней назад — используйте кратное 3600 секундам (1 час).

AccountId -> (строка)

Идентификатор учетной записи, где расположена эта метрика. Если вы выполняете эту операцию в учетной записи мониторинга, используйте это для указания учетной записи-источника, откуда нужно извлечь эту метрику.

DependencyConfig -> (структура)

Определяет зависимость с помощью DependencyKeyAttributes и DependencyOperationName.

DependencyKeyAttributes -> (словарь)

Это словарь «строка-строка». Он может включать следующие поля.

Type обозначает тип объекта.
ResourceType указывает тип ресурса. Это поле используется только тогда, когда значение поля Type равно Resource или AWS::Resource.
Name указывает имя объекта. Это используется только если значение поля Type равно Service, RemoteService или AWS::Service.
Identifier идентифицирует объекты ресурсов этого ресурса. Это используется только если значение поля Type равно Resource или AWS::Resource.
Environment указывает расположение размещения этого объекта или то, к чему он относится.

key -> (строка)

value -> (строка)

DependencyOperationName -> (строка)

Имя вызываемой операции в зависимости.

MetricThreshold -> (двойное значение)

Это значение — это порог, к которому сравниваются наблюдаемые значения метрик метрики SLI.

ComparisonOperator -> (строка)

Арифметическая операция, используемая при сравнении указанной метрики с порогом.

Goal -> (структура)

В этой структуре содержатся атрибуты, определяющие цель SLO. Сюда входит период времени для оценки и порог достижения.

Interval -> (структура помеченного объединения)

Период времени, используемый для оценки SLO. Он может быть либо календарным интервалом, либо скользящим интервалом.

Если вы опустите этот параметр, используется скользящий интервал в 7 дней.

Примечание

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

RollingInterval -> (структура)

Если интервал является скользящим, эта структура содержит спецификации интервала.

DurationUnit -> (строка)

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

Duration -> (целое число)

Указывает длительность каждого скользящего интервала. Например, если Duration равно 7, а DurationUnit равно DAY, каждый скользящий интервал составляет семь дней.

CalendarInterval -> (структура)

Если интервал является календарным, эта структура содержит спецификации интервала.

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

Дата и время начала первого интервала. Убедитесь, что выбранное время настраивает интервалы так, как вам нужно. Например, если вам нужны еженедельные интервалы, начинающиеся в понедельник в 6:00 утра, убедитесь, что вы указали начальное время, которое приходится на понедельник в 6:00 утра.

При использовании в API сырой HTTP-запроса он форматируется как время эпохи во секундах. Например: 1698778057

Как только один календарный интервал заканчивается, автоматически начинается другой.

DurationUnit -> (строка)

Указывает единицу измерения календарного интервала.

Duration -> (целое число)

Указывает длительность каждого календарного интервала. Например, если Duration равно 1, а DurationUnit равно MONTH, каждый интервал составляет один месяц, согласованный с календарем.

AttainmentGoal -> (двойное значение)

Порог, определяющий, достигается ли цель.

Если это SLO на основе периода, целевое значение достижения — это процент хороших периодов, которые соответствуют требованиям порога, по отношению ко всем периодам в интервале. Например, целевое значение достижения 99,9% означает, что в вашем интервале вы нацеливаетесь на 99,9% периодов, находящихся в здоровом состоянии.

Если это SLO на основе запросов, целевое значение достижения — это процент запросов, которые должны быть успешными, чтобы достичь целевого значения достижения.

Если вы опустите этот параметр, 99 используется для представления 99% в качестве целевого значения достижения.

WarningThreshold -> (двойное значение)

Процент оставшегося бюджета от общего бюджета, для которого вы хотите получать предупреждения. Если вы опустите этот параметр, будет использоваться значение по умолчанию 50,0.

Errors -> (список)

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

(структура)

Структура, содержащая информацию об одной ошибке, произошедшей во время операции BatchGetServiceLevelObjectiveBudgetReport.

Name -> (строка)

Имя SLO, к которому относится эта ошибка.

Arn -> (строка)

ARN SLO, к которому относится эта ошибка.

ErrorCode -> (строка)

Код ошибки для этой ошибки.

ErrorMessage -> (строка)

Сообщение об этой ошибке.