Help Center/ Cloud Eye/ API Reference/ API V2/ Alarm Templates/ Creating a Custom Alarm Template

Updated on 2025-11-20 GMT+08:00

View PDF

Creating a Custom Alarm Template

Function

This API is used to create a custom alarm template.

URI

POST /v2/{project_id}/alarm-templates

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. It is 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 from the API or console. For details, see Obtaining a Project ID. Constraints N/A Range 1 to 64 characters Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Constraints N/A Range 1 to 16,384 characters Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
template_name	Yes	String	Definition Alarm template name. Constraints N/A Range The value allows 1 to 128 characters. It must start with a letter and can contain letters, digits, underscores (_), and hyphens (-). Default Value N/A
template_type	No	Integer	Definition Custom alarm template type. Constraints N/A Range The value can be: 0: metric type 2: event type Default Value 0
template_description	No	String	Definition Alarm template description. Constraints N/A Range [0,256] Default Value An empty string
is_overwrite	No	Boolean	Definition Whether to overwrite the existing alarm template with the same name. Constraints N/A Range A boolean value, which can be: true: Overwrite the alarm template with the same name. false: Create an alarm template instead of overwriting the alarm template with the same name. Default Value false
policies	Yes	Array of Policies objects	Definition Alarm policies in an alarm template. Constraints A maximum of 1,000 policies can be configured.

**Table 4** Policies
Parameter	Mandatory	Type	Description
namespace	Yes	String	Definition Namespace of a service. For details about the namespace of each service, see Service Namespaces. Constraints N/A Range The value is in the service.item format. The values of service and item must be a string, starting with a letter and containing only digits (0–9), letters (case-insensitive), and underscores (_). The value must contain 3 to 32 characters. Default Value N/A
dimension_name	No	String	Definition Resource dimension. Constraints The DimensionName field of the event alarm template is empty. Range The value must start with a letter. Each dimension allows a maximum of 32 characters and can only contain digits, letters, underscores (_), and hyphens (-). Multiple dimensions are separated by commas (,). A maximum of four dimensions are supported. Example: instance_id for single-dimension scenarios and instance_id,disk for multi-dimension scenarios. Default Value N/A
metric_name	Yes	String	Definition Metric name of a resource. For details about the metrics of each service, see Service Metric Names. Constraints N/A Range The value must start with a letter and can only contain digits, letters, underscores (_), and hyphens (-). It allows 1 to 96 characters. For example, the ECS metric cpu_util indicates the CPU usage of an ECS. The DDS metric mongo001_command_ps indicates the command execution frequency. Default Value N/A
extra_info	No	MetricExtraInfo object	Definition Additional information about the alarm policy. Constraints N/A
period	Yes	Integer	Definition Interval (seconds) for checking whether the alarm rule conditions are met. Constraints N/A Range The value can be: 0: default value. This value can be used for event alarms. 1: original metric period. For example, if the original period of an RDS metric is 60s, the metric data is collected and calculated every 60s. 300: The metric data is collected and calculated every 5 minutes. 1200: The metric data is collected and calculated every 20 minutes. 3600: The metric data is collected and calculated every hour. 14400: The metric data is collected and calculated every 4 hours. 86400: The metric data is collected and calculated every day. Default Value N/A
filter	Yes	String	Definition Aggregation method. Constraints N/A Range average, variance, min, max, or sum Default Value N/A
comparison_operator	Yes	String	Definition Threshold symbol. Constraints The threshold symbols for metric alarms are >, >=, <, <=, =, !=, cycle_decrease, cycle_increase, and cycle_wave. The threshold symbols for event alarms are >, >=, <, <=, =, and !=. Range The value can be >, <, >=, <=, =, !=, cycle_decrease, cycle_increase, or cycle_wave. cycle_decrease indicates the decrease relative to the last period; cycle_increase indicates the increase relative to the last period; cycle_wave indicates the increase or decrease relative to the last period. Default Value N/A
value	No	Number	Definition Alarm threshold. Constraints 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. Range N/A Default Value N/A
hierarchical_value	No	HierarchicalValue object	Definition Multi-level alarm threshold. Constraints If there are both hierarchical_value and value, hierarchical_value is used. When you create or modify an alarm rule, you can set only one threshold in the following scenarios: The alarm type is Metric and the alarm policy is Trigger an alarm when all policies are met. The alarm type is Event.
unit	No	String	Definition Data unit. The value can contain a maximum of 32 characters. Constraints N/A Range 0 to 32 characters Default Value N/A
selected_unit	No	String	Definition The metric unit you selected. It is used for subsequent metric data display and calculation. Constraints N/A Range 0 to 64 characters Default Value N/A
count	Yes	Integer	Definition Number of times that the alarm triggering conditions are met. Constraints N/A Range 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. Default Value N/A
type	No	String	Definition Alarm policy type. This API has been deprecated. Constraints N/A Range The value can only be auto. Default Value N/A
alarm_level	No	Integer	Definition Alarm severity. Constraints N/A Range The value can be: 1: critical 2: major 3: minor 4: Informational Default Value N/A
suppress_duration	No	Integer	Definition Alarm suppression interval, in seconds. Constraints N/A Range The value can be: 0: An alarm is not suppressed in the immediate triggering scenario, and is generated only once in the accumulated triggering scenario. 300: An alarm is generated every 5 minutes once the alarm triggering condition is met. 600: An alarm is generated every 10 minutes once the alarm triggering condition is met. 900: An alarm is generated every 15 minutes once the alarm triggering condition is met. 1800: An alarm is generated every 30 minutes once the alarm triggering condition is met. 3600: An alarm is generated every 60 minutes once the alarm triggering condition is met. 10800: An alarm is generated every 3 hours once the alarm triggering condition is met. 21600: An alarm is generated every 6 hours once the alarm triggering condition is met. 43200: An alarm is generated every 12 hours once the alarm triggering condition is met. 86400: An alarm is generated once every day once the alarm triggering condition is met. Default Value N/A

**Table 5** MetricExtraInfo
Parameter	Mandatory	Type	Description
origin_metric_name	Yes	String	Definition Original metric name. Constraints N/A Range 0 to 4,096 characters Default Value N/A
metric_prefix	No	String	Definition Metric name prefix. Constraints N/A Range 0 to 4,096 characters Default Value N/A
custom_proc_name	No	String	Definition Name of a process. Constraints N/A Range [0,250] Default Value N/A
metric_type	No	String	Definition Metric type. Constraints N/A Range 0 to 32 characters Default Value N/A

**Table 6** HierarchicalValue
Parameter	Mandatory	Type	Description
critical	No	Double	Definition Threshold for critical alarms. Constraints N/A Range [-1.7976931348623157e+108, 1.7976931348623157e+108] Default Value N/A
major	No	Double	Definition Threshold for major alarms. Constraints N/A Range [-1.7976931348623157e+108, 1.7976931348623157e+108] Default Value N/A
minor	No	Double	Definition Threshold for minor alarms. Constraints N/A Range [-1.7976931348623157e+108, 1.7976931348623157e+108] Default Value N/A
info	No	Double	Definition Threshold for informational alarms. Constraints N/A Range [-1.7976931348623157e+108, 1.7976931348623157e+108] Default Value N/A

Response Parameters

Status code: 201

**Table 7** Response body parameters
Parameter	Type	Description
template_id	String	Definition: Alarm template ID. Range: The value starts with at and allows 2 to 64 characters. It can contain letters and digits.
overwrite_result	OverwriteResultResp object	Definition Whether to overwrite an existing template with the same name.

**Table 8** OverwriteResultResp
Parameter	Type	Description
success_ids	String	Definition: ID of the template that is overwritten. Range: 2 to 64 characters
failed_ids	String	Definition: ID of the template that is not overwritten. Range: 2 to 64 characters

Status code: 400

**Table 9** Response body parameters
Parameter	Type	Description
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.

Status code: 401

**Table 10** Response body parameters
Parameter	Type	Description
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.

Status code: 403

**Table 11** Response body parameters
Parameter	Type	Description
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.

Status code: 500

**Table 12** Response body parameters
Parameter	Type	Description
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.

Example Requests

Creating a custom alarm template whose template_name is my_template, count is 2, suppress_duration is 300, and alarm_level is 2.

{
  "template_name" : "my_template",
  "template_description" : "hello world",
  "policies" : [ {
    "namespace" : "SYS.ECS",
    "dimension_name" : "instance_id",
    "metric_name" : "cpu_util",
    "period" : 300,
    "filter" : "sum",
    "comparison_operator" : ">",
    "value" : 2,
    "unit" : "bit/s",
    "count" : 2,
    "alarm_level" : 2,
    "suppress_duration" : 300
  } ]
}

Example Responses

Status code: 201

Created

{
  "template_id" : "at1628592157541dB1klWgY6"
}

Status Codes

Status Code	Description
201	Created
400	Parameter verification failed.
401	Not authenticated.
403	Authentication failed.
500	Internal system error.

Error Codes

See Error Codes.

Parent topic: Alarm Templates

Previous topic: Alarm Templates

Next topic: Deleting Custom Alarm Templates in Batches

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel