Enabling One-Click Monitoring

project_id

Yes

String

Definition

Tenant ID.

Constraints:

None

Value range:

Project ID, used to specify the project that an asset belongs to. You can query the assets of a project by project ID. You can obtain the project ID by calling an API or on the console. For details, see Obtaining a Project ID. The value must contain of 1 to 64 characters.

Default value:

None

Content-Type

No

String

Definition

MIME type of the request body.

Constraints:

None

Value range:

The value can contain 1 to 64 characters.

Default value:

The default type is application/json; charset=UTF-8.

Default value:

application/json; charset=UTF-8

X-Auth-Token

No

String

Definition

User token.

Constraints:

None

Value range:

The value can contain 1 to 16,384 characters.

Default value:

None

one_click_alarm_id

Yes

String

One-click monitoring ID for a service.

dimension_names

Yes

DimensionNames object

Dimensions in metric and event alarm rules that have one-click monitoring enabled. One-click monitoring must be enabled for at least one type of alarm rules.

notification_enabled

Yes

Boolean

Whether to enable alarm notification. true: enabled; false: disabled.

alarm_notifications

No

Array of Notification objects

Action to be triggered by the alarm.

ok_notifications

No

Array of Notification objects

Action to be triggered after an alarm is cleared.

notification_begin_time

No

String

Time when the alarm notification was enabled.

notification_end_time

No

String

Time when the alarm notification was disabled.

effective_timezone

No

String

Time zone, for example, GMT-08:00, GMT+08:00, or GMT+0:00.

notification_manner

No

String

Notification mode, which can be NOTIFICATION_GROUP (notification groups), TOPIC_SUBSCRIPTION (topic subscriptions), or NOTIFICATION_POLICY (notification policies).

Enumeration values:

• NOTIFICATION_GROUP

• TOPIC_SUBSCRIPTION

• NOTIFICATION_POLICY

notification_policy_ids

No

Array of strings

Associated notification policy IDs.

is_reset

No

Boolean

Whether to reset the default policy of one-click monitoring.

Default value:

true

one_click_update_alarms

No

Array of one_click_update_alarms objects

Parameters required when alarm policies and notifications need to be modified at the same time when one-click monitoring is enabled. Currently, you can only modify the notification policies.

metric

Yes

Array of strings

Dimensions in metric alarm rules that have one-click monitoring enabled. One-click monitoring are disabled by default for unspecified dimensions.

event

Yes

Array of strings

Dimensions in event alarm rules that have one-click monitoring enabled. One-click monitoring are disabled by default for unspecified dimensions. "" indicates enable one-click monitoring for all dimensions.

type

Yes

String

Notification type. The value can be notification (SMN notifications), contact (account contacts), contactGroup (notification groups), or autoscaling (AS notifications). autoscaling is used only in AS and is not recommended. groupwatch, ecsRecovery, and iecAction are no longer used.

Enumeration values:

• notification

• autoscaling

• groupwatch

• ecsRecovery

• contact

• contactGroup

• iecAction

notification_list

Yes

Array of strings

List of objects to be notified if the alarm status changes. The value of topicUrn can be obtained from SMN. For details, see section "Querying Topics". If type is set to notification, the value of notificationList cannot be left blank. If type is set to autoscaling, the value of notification_list must be left blank. Note: If alarm_action_enabled is set to true, alarm_actions, ok_actions, or both of them must be specified. If both alarm_actions and ok_actions are specified, their notification_list values must be the same.

alarm_id

No

String

ID of an alarm rule, which starts with al and is followed by 22 characters, including letters and digits.

name

No

String

Name of an alarm rule. The name can contain 1 to 128 characters, including only letters, digits, underscores (_), and hyphens (-).

description

No

String

Alarm rule description. The description can contain 0 to 256 characters.

namespace

No

String

Namespace of a service. For details about the namespace of each service, see Namespace.

policies

No

Array of Policy objects

Alarm policies.

resources

No

Array<Array<Dimension>>

Resource list. Associated resources can be obtained by calling the API for querying resources in an alarm rule.

type

No

String

Definition:

Alarm rule type.

Constraints:

None

Value range:

Enumerated value. ALL_INSTANCE indicates alarm rules for metrics of all resources. RESOURCE_GROUP indicates alarm rules for metrics of resources in a resource group. MULTI_INSTANCE indicates alarm rules for metrics of specified resources. EVENT.SYS indicates alarm rules for system events. EVENT.CUSTOM indicates alarm rules for custom events. DNSHealthCheck indicates alarm rules for health checks.

Default value:

None

Enumeration values:

• EVENT.SYS

• EVENT.CUSTOM

• DNSHealthCheck

• RESOURCE_GROUP

• MULTI_INSTANCE

• ALL_INSTANCE

enabled

No

Boolean

Whether to enable the alarm rule. true: enabled; false: disabled.

notification_enabled

No

Boolean

Whether to enable alarm notification. true: enabled; false: disabled.

alarm_notifications

No

Array of Notification objects

Action to be triggered by the alarm.

ok_notifications

No

Array of Notification objects

Action to be triggered after an alarm is cleared.

notification_begin_time

No

String

Time when the alarm notification was enabled.

notification_end_time

No

String

Time when the alarm notification was disabled.

notification_manner

No

String

Notification method. The value can be NOTIFICATION_POLICY, NOTIFICATION_GROUP, or TOPIC_SUBSCRIPTION.

Enumeration values:

• NOTIFICATION_POLICY

• NOTIFICATION_GROUP

• TOPIC_SUBSCRIPTION

notification_policy_ids

No

Array of strings

Associated notification policy IDs.

metric_name

Yes

String

Metric name of a resource. The name must start with a letter and contain only digits, letters, and underscores. The length ranges from 1 to 64 characters. For example, cpu_util of an ECS indicates the CPU usage of the ECS. mongo001_command_ps in DDS indicates the command execution frequency. For details about the metric name of each service, see Service metric name.

period

Yes

Integer

Monitoring period of a metric, in seconds. The default value is 0. For an event alarm, set this parameter to 0. 1 indicates the original rollup period of a metric. For example, if the original rollup period of an RDS metric is 60s, its data point is calculated every 60 seconds. For details about the original rollup period of each cloud service metric, see Services Interconnected with Cloud Eye. 300 indicates that the metric rollup period is 5 minutes.

Value range:

0-86400

Enumeration values:

• 0

• 1

• 300

• 1200

• 3600

• 14400

• 86400

filter

Yes

String

Aggregation mode. average: average value; variance: variance; min: minimum value; max: maximum value; sum: sum; tp99: 99 percentile; tp95: 95 percentile; tp90: 90 percentile

comparison_operator

Yes

String

Threshold symbol. The value can be >, <, >=, <=, =, !=, cycle_decrease, cycle_increase, or cycle_wave. cycle_decrease indicates the decrease compared with the last period, cycle_increase indicates the increase compared with the last period, and cycle_wave indicates the increase or decrease compared with the last period. All of them can be used in alarm rules for metrics. >, <, >=, <=, =, and != can be used for alarm rules for events.

value

No

Number

Alarm threshold If there is only one threshold, value and alarm_level are used in pairs. If there are both hierarchical_value and value, hierarchical_value is used. For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS cpu_util to 80. For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS cpu_util to 80 in Services Interconnected with Cloud Eye.

hierarchical_value

No

HierarchicalValue object

Multi-level alarm threshold. If there are both hierarchical_value and value, hierarchical_value prevails.

When you create or modify an alarm rule, you can set only one threshold in the following scenarios:

1. The alarm type is Metric and the alarm policy is Trigger an alarm when all policies are met.

2. The alarm type is Event.

unit

No

String

Data unit.

count

Yes

Integer

Number of consecutive alarm triggering times. For event alarms, the value ranges from 1 to 180. For metric and website alarms, the value can be 1, 2, 3, 4, 5, 10, 15, 30, 60, 90, 120, or 180.

suppress_duration

No

Integer

Alarm suppression time, in seconds. This parameter corresponds to the last field in the alarm policy when an alarm rule is created on the Cloud Eye console. This field is used to avoid frequent alarms. 0 indicates that the alarm is not suppressed and alarms are generated as long as the conditions are met. 300 indicates that an alarm is generated every 5 minutes as long as the alarm triggering conditions are met.

Value range:

0-86400

Enumeration values:

• 0

• 300

• 600

• 900

• 1800

• 3600

• 10800

• 21600

• 43200

• 86400

level

No

Integer

Alarm severity, which can be 1 (critical), ** 2** (major), 3 (minor), or 4 (informational). The default value is 2.

namespace

No

String

namespace and dimension_name need to be specified for product-level rules. For details about the namespace of each service, see Service namespace.

Regex Pattern: ^((([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*)|)$

dimension_name

No

String

The namespace and dimension_name parameters are added to the product-level rule to specify the policy to which the product belongs. Currently, a maximum of four dimensions are supported. For details about the metric dimension name of each service resource, see [Service dimension name] (ces_03_0059.xml). Example: instance_id in the single-dimension scenario; instance_id,disk in the multi-dimension scenario

Regex Pattern: ^(([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-|\.){0,31}(,([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-|\.){0,31}){0,3}|)$

critical

No

Double

Threshold for critical alarms.

Value range:

-1.7976931348623156E108-1.7976931348623156E108

major

No

Double

Threshold for major alarms.

Value range:

-1.7976931348623156E108-1.7976931348623156E108

minor

No

Double

Threshold for minor alarms.

Value range:

-1.7976931348623156E108-1.7976931348623156E108

info

No

Double

Threshold for informational alarms.

Value range:

-1.7976931348623156E108-1.7976931348623156E108

name

Yes

String

Dimension of a resource. For example, the dimension of an ECS can be instance_id. A maximum of four dimensions are supported. For the metric dimension of each resource, see Service metric dimension.

Regex Pattern: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-)*$

value

No

String

Value of a resource dimension, which is the resource ID, for example, 4270ff17-aba3-4138-89fa-820594c39755.

Regex Pattern: ^((([a-z]|[A-Z]|[0-9]|\*|_|/|#|\(|\)){1}([a-z]|[A-Z]|[0-9]|_|-|\.|\*|/|#|\(|\))*))$

one_click_alarm_id

String

One-click monitoring ID for a service.

error_code

String

Status codes customized by each cloud service when a request error occurs.

error_msg

String

Request error message.

request_id

String

Request ID.

error_code

String

Status codes customized by each cloud service when a request error occurs.

error_msg

String

Request error message.

request_id

String

Request ID.

error_code

String

Status codes customized by each cloud service when a request error occurs.

error_msg

String

Request error message.

request_id

String

Request ID.

error_code

String

Status codes customized by each cloud service when a request error occurs.

error_msg

String

Request error message.

request_id

String

Request ID.

201

Created

400

Parameter verification failed.

401

Not authenticated.

403

Authentication failed.

500

Internal system error.