Help Center/ Cloud Eye/ API Reference/ API v2/ Alarm Templates/ Creating a Custom Alarm Template
Updated on 2024-04-30 GMT+08:00
View PDF
Share

Creating a Custom Alarm Template

Function

This API is used to create a custom alarm template.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v2/{project_id}/alarm-templates

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the tenant ID.

Minimum: 1

Maximum: 64

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the tenant token.

Minimum: 1

Maximum: 16384
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

template_name

Yes

String

Specifies the name of an alarm template. The name must start with a letter and can contain 1 to 128 characters, including letters, digits, underscores (_), and hyphens (-).

template_type

No

Integer

Specifies the type of a custom alarm template. 0 indicates an alarm template for metrics. 2 indicates an alarm template for events.

Enumeration values:

  • 0
  • 2

template_description

No

String

Provides supplementary information about an alarm template. The description can contain 0 to 256 characters and is left blank by default.

policies

Yes

Array of Policies objects

Specifies alarm policies in an alarm template.

Array Length: 1 - 50
Table 4 Policies

Parameter

Mandatory

Type

Description

namespace

Yes

String

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

dimension_name

No

String

Specifies the resource dimension, which must start with a letter. A dimension can contain up to 32 characters, including only digits, letters, underscores (_), and hyphens (-). Use commas (,) to separate multiple dimensions. DimensionName in event alarm templates must be left blank.

metric_name

Yes

String

Specifies the metric name.

period

Yes

Integer

Specifies the interval (seconds) for checking whether the alarm rule conditions are met.

Enumeration values:

  • 0
  • 1
  • 300
  • 1200
  • 3600
  • 14400
  • 86400

filter

Yes

String

Specifies the data rollup method.

Regex Pattern: ^(average|variance|min|max|sum)$

comparison_operator

Yes

String

Specifies the 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

Specifies the alarm threshold.

Minimum: 0

Maximum: 1.7976931348623156E108

unit

No

String

Specifies the data unit. The value can contain up to 32 characters.

Minimum: 0

Maximum: 32

count

Yes

Integer

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

alarm_level

No

Integer

Specifies the alarm severity, which can be 1 (critical), ** 2** (major), 3 (minor), or 4 (informational).

suppress_duration

Yes

Integer

Specifies the alarm suppression period, in seconds. When the period is 0, only one alarm is generated.

Enumeration values:

  • 0
  • 300
  • 600
  • 900
  • 1800
  • 3600
  • 10800
  • 21600
  • 43200
  • 86400

Response Parameters

Status code: 201

Table 5 Response body parameters

Parameter

Type

Description

template_id

String

Specifies the ID of an alarm template. The ID starts with at and is followed by up to 64 characters, including letters and digits.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

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

Failed to verify parameters.

401

Not authenticated.

403

Authentication failed.

500

Internal system error.

Error Codes

See Error Codes.

Parent topic: Alarm Templates