Help Center/ Cloud Eye/ API Reference/ API v2/ Alarm Templates/ Querying Details of an Alarm Template

Updated on 2024-04-30 GMT+08:00

View PDF

Querying Details of an Alarm Template

Function

This API is used to query details of an 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

GET /v2/{project_id}/alarm-templates/{template_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the tenant ID. Minimum: 1 Maximum: 64
template_id	Yes	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. Minimum: 2 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

Response Parameters

Status code: 200

**Table 3** 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.
template_name	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	String	Specifies the type of an alarm template. custom indicates custom alarm templates, and system indicates default alarm templates. Enumeration values: system custom
create_time	String	Specifies the time when an alarm template was created.
template_description	String	Provides supplementary information about an alarm template. The description can contain 0 to 256 characters and is left blank by default.
policies	Array of GetPolicies objects	Specifies alarm policies in an alarm template. Array Length: 1 - 50

**Table 4** GetPolicies
Parameter	Type	Description
namespace	String	Specifies the namespace of a service. For details about the namespace of each service, see Namespace.
dimension_name	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	String	Specifies the metric name.
period	Integer	Specifies the interval (seconds) for checking whether the alarm rule conditions are met. Enumeration values: 0 1 300 1200 3600 14400 86400
filter	String	Specifies the data rollup method. Regex Pattern: ^(average\|variance\|min\|max\|sum)$
comparison_operator	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	Number	Specifies the alarm threshold. Minimum: 0 Maximum: 2.34854258277383E108
unit	String	Specifies the data unit. The value can contain up to 32 characters. Minimum: 0 Maximum: 32
count	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	Integer	Specifies the alarm severity, which can be 1 (critical), 2 (major), 3 (minor), or 4 (informational).
suppress_duration	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

Status code: 400

**Table 5** 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 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: 403

**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: 404

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

Querying details of an alarm template

/v2/{project_id}/alarm-templates/{template_id}

Example Responses

Status code: 200

{
  "template_id" : "at1628592157541dB1klWgY6",
  "template_name" : "my_template",
  "template_type" : "custom",
  "create_time" : "2006-01-02T15:04:05.000Z",
  "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
  } ]
}