get-service-level-objective

Описание

Возвращает информацию об одном SLO, созданном в аккаунте.

См. также: AWS API Documentation

Синтаксис

  get-service-level-objective
--id <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]

Параметры

--id (строка)

ARN или имя SLO, о котором требуется получить информацию. ARNs SLO можно найти, используя операцию ListServiceLevelObjectives.

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

Вывод

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

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

Arn -> (строка)

ARN данного SLO.

Name -> (строка)

Имя данного SLO.

Description -> (строка)

Описание, созданное для данного SLO.

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

Дата и время создания данного SLO. При использовании в API HTTP-запроса в сыром формате, он форматируется как yyyy-MM-dd'T'HH:mm:ss. Например, 2019-07-01T23:59:59.

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

Время последнего обновления данного SLO. При использовании в API HTTP-запроса в сыром формате, он форматируется как yyyy-MM-dd'T'HH:mm:ss. Например, 2019-07-01T23:59:59.

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

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

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

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

KeyAttributes -> (карта)

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

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

key -> (строка)

value -> (строка)

OperationName -> (строка)

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

MetricType -> (строка)

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

MetricDataQueries -> (список)

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

(структура)

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

Каждый 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. Если вы укажете единицу измерения, операция вернет только данные, собранные с указанной единицей измерения. Если вы укажете единицу измерения, не соответствующую собранным данным, результаты операции будут равны null. 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 -> (строка)

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

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

Структура, содержащая информацию о метрике производительности, которую отслеживает этот показатель уровня обслуживания (SLO), если это 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, которую собирают сигналы приложения, это поле отображает, какая из этих метрик используется.

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 -> (целое число)

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

Stat -> (строка)

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

Unit -> (строка)

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

Expression -> (строка)

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

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

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

Label -> (строка)

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

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

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 -> (строка)

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

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 -> (структура)

В одном объекте 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. Если вы укажете единицу, операция возвращает только данные, собранные с указанной единицей. Если вы укажете единицу, которая не соответствует собранным данным, результаты операции будут равны null. 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 -> (строка)

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

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

Unit -> (строка)

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

Expression -> (строка)

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

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

В каждом объекте 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 -> (строка)

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

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 -> (строка)

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

EvaluationType -> (строка)

Показывает, является ли это SLO на основе периода или SLO на основе запроса.

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.

BurnRateConfigurations -> (список)

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

(структура)

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

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

скорость выгорания = скорость ошибок за период обратного отсчета / (100% - процент цели достижения)

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

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

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

MetricSourceType -> (строка)

Отображает тип источника метрики SLI для данного SLO. Поддерживаемые типы:

Операция службы
Зависимость службы
Метрика CloudWatch