- What's New
- Function Overview
- Service Overview
- Getting Started
-
User Guide
- Overview
- Permissions Management
-
Cloud Resource Monitoring
- Resource Groups
-
Server Monitoring
- Overview
- Cloud Eye Plug-in (Agent)
- Process Monitoring
- Viewing Server Monitoring Metrics
- Creating an Alarm Rule to Monitor a Server
- Viewing Server Monitoring Details
- Cloud Service Monitoring
- Task Center
- Visualization (Dashboards)
-
Alarm Management
- Overview
- Alarm Rules
- Alarm Records
-
Alarm Templates
- Viewing Alarm Templates
- Creating a Custom Template or Custom Event Template
- Modifying a Custom Template or Custom Event Template
- Deleting a Custom Template or Custom Event Template
- Copying a Custom Template or Custom Event Template
- Associating a Custom Template with a Resource Group
- Importing and Exporting Custom Template or Custom Event Templates
- Alarm Notifications
- Example: Creating an Alarm Rule to Monitor ECS CPU Usage
- One-Click Monitoring
- Alarm Masking
- Event Monitoring
- Access Center
- Data Dump
- Quotas and Audit
- Cloud Product Metrics
- Change History
- Best Practices
-
API Reference
- Before You Start
- API Overview
- Calling APIs
- Getting Started
-
API V1
- API Version Management
- Metrics
-
Alarm Rules
- Querying Alarm Rules
- Querying Details of an Alarm Rule
- Enabling or Disabling an Alarm Rule
- Deleting an Alarm Rule
- Creating an Alarm Rule
- Creating a Custom Alarm Template
- Deleting a Custom Alarm Template
- Querying the Alarm History of an Alarm Rule
- Querying Custom Alarm Templates
- Updating a Custom Alarm Template
- Modifying an Alarm Rule
- Monitoring Data
- Quotas
- Resource Groups
- Event Monitoring
-
API V2
- Alarm Rules
- Resources in an Alarm Rule
- Alarm Policies
- Alarm Notifications
- Alarm Records
- Alarm Templates
- Alarm Rules Associated with an Alarm Template
- Resource Groups
- Resources in a Resource Group
-
One-Click Monitoring
- Enabling One-Click Monitoring
- Querying Services and Resources That Support One-Click Monitoring
- Querying Alarm Rules of One Service in One-Click Monitoring
- Batch Enabling or Disabling Alarm Rules of One Service in One-Click Monitoring
- Batch Disabling One-Click Motoring
- Batch Modifying Alarm Notifications in Alarm Rules for One Service That Has One-Click Monitoring Enabled
- Batch Enabling or Disabling Alarm Policies in Alarm Rules for One Service That Has One-Click Monitoring Enabled
-
Alarm Notification Masking
- Creating Alarm Notification Masking Rules in Batches
- Modifying the Masking Time of Alarm Notification Masking Rules in Batches
- Modifying an Alarm Notification Masking Rule
- Deleting Alarm Notification Masking Rules in Batches
- Querying Alarm Notification Masking Rules
- Querying Resources for Which Alarm Notifications Have Been Masked
- Dashboards
- Graphs
- Resource Tags
- Metric Management
- API V3
-
Permissions Policies and Supported Actions
- Introduction
- Supported Actions of the API Version Management APIs
- Supported Actions of the Metric Management API
- Supported Actions of the Alarm Rule Management APIs
- Supported Actions of the Monitoring Data Management APIs
- Supported Actions of the Quota Management API
- Supported Actions of the Event Monitoring API
- Common Parameters
- Appendix
- Change History
- SDK Reference
-
FAQs
-
General Consulting
- What Is Rollup?
- How Long Is Metric Data Retained?
- How Many Rollup Methods Does Cloud Eye Support?
- How Can I Export Collected Data?
- What Should I Do If I See Garbled Chinese Characters in an Exported CSV File?
- Why Can't a User of an Enterprise Project View the One-Click Monitoring Function?
- Why Can't a User of an Enterprise Project Select All Resources When Configuring Alarm Rules?
-
Server Monitoring
-
Agent Installation
- How Do I Configure DNS and Security Groups?
- How Do I Configure an Agency?
- How Does the Cloud Eye Agent Obtain a Temporary AK/SK by Authorization?
- What OSs Does the Agent Support?
- Resource Usage and Circuit Breaker Pattern of Agent
- What Should I Do If the Monitoring Is Periodically Interrupted or the Agent Status Keeps Changing?
- What Should I Do If a Service Port Is Used by the Agent?
- Troubleshooting Agent One-Click Restoration Failures
- No Monitoring Data Is Displayed After One-Click Restoration Performed for the Agent
- Does the Server Monitoring Agent Affect Server Performance?
- Troubleshooting the Problem of Reported Metrics Being Discarded
- Metrics
-
Agent Statuses
- How Can I Quickly Restore Agent Configurations?
- What Should I Do If the Agent Status Is Faulty?
- What Should I Do If the Agent Status Is Stopped?
- What Should I Do If the Agent Status Is Running But There Is No Monitoring Data?
- What Can I Do If No Monitoring Data Is Displayed After One-Click Agent Restoration? (Old Agent)
- How Can I Enable the OS Monitoring for a New ECS?
- Agent Status Description and Troubleshooting Methods
- How Do I Obtain Debug Logs of the Agent?
-
Agent Installation
-
Alarm Notifications or False Alarms
- What Is an Alarm Notification? How Many Types of Alarm Notifications Are There? How Can I Configure an Alarm Notification?
- What Alarm Status Does Cloud Eye Support?
- What Alarm Severities Does Cloud Eye Support?
- When Will an "Insufficient data" Alarm Be Triggered?
- How Do I Monitor and View the Disk Usage?
- How Can I Change the Phone Number and Email Address for Receiving Alarm Notifications?
- How Can a User Account Receive Alarm Notifications?
- Why Did I Receive a Bandwidth Overflow Notification While There Being No Bandwidth Overflow Record in the Monitoring Data?
-
Monitored Data Exceptions
- Why Is the Monitoring Data Not Displayed on the Cloud Eye Console?
- Why I Cannot See the Monitoring Data on the Cloud Eye Console After Purchasing Cloud Service Resources?
- Why Doesn't the Cloud Eye Console Display the OS Monitoring Data or Why Isn't the Data Displayed Immediately After the Agent Is Installed and Configured on an ECS?
- Why Is Basic Monitoring Data Inconsistent with Data Monitored by the OS?
- Why Are the Network Traffic Metric Values in Cloud Eye Different from Those Detected in ECS?
- Why Is the Metric Collection Point Lost During Certain Periods of Time?
- Why Are the Four Metrics Memory Usage, Disk Usage, Inband Incoming Rate, and Inband Outgoing Rate Not Displayed for an ECS?
- What Are the Impacts on ECS Metrics If UVP VMTools Is Not Installed on ECSs?
- Why Are the Inbound Bandwidth and Outbound Bandwidth Negative?
- Metric Descriptions
-
User Permissions
- What Should I Do If the IAM Account Permissions Are Abnormal?
- What Can I Do If the System Displays a Message Indicating Insufficient Permissions When I Access Cloud Eye?
- What Can I Do If the System Displays a Message Indicating Insufficient Permissions When I Click Configure on the Server Monitoring Page?
-
General Consulting
- Videos
-
More Documents
-
User Guide (ME-Abu Dhabi Region)
- Product Introduction
- Getting Started
- Dashboards
- Resource Groups
- Using the Alarm Function
-
Server Monitoring
- Introduction to Server Monitoring
- Agent Installation and Configuration
- Agent Features per Version
- Installing and Configuring the Agent on a Linux ECS or BMS
- Installing and Configuring the Agent on a Windows ECS
- Installing the Agents in Batches on Linux ECSs
- Managing the Agent
- Installing the Direct Connect Metric Collection Plug-ins
- Process Monitoring
- Viewing Server Monitoring Metrics
- Creating an Alarm Rule to Monitor a Server
- Custom Monitoring
- Event Monitoring
- Task Center
- Data Dump
- Cloud Service Monitoring
- Auditing Operation Records on Cloud Eye
- Permissions Management
- Quota Adjustment
- Services Interconnected with Cloud Eye
-
FAQs
-
General Consulting
- What Is Rollup?
- How Long Is Metric Data Retained?
- How Many Rollup Methods Does Cloud Eye Support?
- How Can I Export Collected Data?
- Which Services Does Cloud Eye Support Permission- and Region-based Monitoring in the Enterprise Project Dimension?
- Which Cloud Eye Resources Support the Enterprise Project Feature?
- Why Can a User of an Enterprise Project View the Resource Information of the Account on the Overview Page?
-
Server Monitoring
- How Can I Quickly Restore the Agent Configuration?
- How Can I Make a Newly Purchased ECS Monitor Its OS?
- Why Is a BMS with the Agent Installed Displayed in the ECS List on the Server Monitoring Page?
- What OSs Does the Agent Support?
- What Statuses Does the Agent Have?
- What Should I Do If the Monitoring Period Is Interrupted or the Agent Status Keeps Changing?
- What Should I Do If the Service Port Is Used by the Agent?
- How Can I Create an Agency?
- What Can't I Create Another Agency?
- What Should I Do If Agency CESAgentAutoConfigAgency Failed to Be Automatically Created?
- What Can I Do If Agency CESAgentAutoConfigAgency Is Invalid?
- Will the Agent Affect the Server Performance?
- What Should I Do If the Agent Status Is Faulty?
- What Should I Do If the Agent Status Is Stopped?
- What Should I Do If the Agent Status Is Running But There Is No Monitoring Data?
- How Do I Troubleshoot the Agent One-Click Restoration Failure?
- What Can I Do If No Monitoring Data Is Displayed After One-Click Agent Restoration?
-
Alarm Notifications or False Alarms
- What Is an Alarm Notification? How Many Types of Alarm Notifications Are There?
- What Alarm Status Does Cloud Eye Support?
- What Alarm Severities Does Cloud Eye Support?
- When Will an "Insufficient data" Alarm Be Triggered?
- How Do I Monitor and View the Disk Usage?
- How Can I Change the Mobile Number and Email Address for Receiving Alarm Notifications?
- How Can an IAM User Receive Alarm Notifications?
- Why Did I Receive a Bandwidth Overflow Notification While There Being No Bandwidth Overflow Record in the Monitoring Data?
-
Monitored Data Exceptions
- Why Is the Monitoring Data Not Displayed on the Cloud Eye Console?
- Why I Cannot See the Monitoring Data on the Cloud Eye Console After Purchasing Cloud Service Resources?
- Why Is OS Monitoring Data Not Displayed or Not Displayed Immediately After the Agent Is Installed and Configured on a server?
- Why Is Basic Monitoring Data Inconsistent with the Data Monitored by the OS?
- Why Are the Network Traffic Metric Values in Cloud Eye Different from Those Detected in ECS?
- Why Is the Metric Collection Point Lost During a Certain Period of Time?
- Why Are Memory Usage, Disk Usage, Inband Incoming Rate, and Inband Outgoing Rate Not Displayed for an ECS?
- What Are the Impacts on ECS Metrics If UVP VMTools Is Not Installed on ECSs?
- Why Are the Inbound Bandwidth and Outbound Bandwidth Negative?
- Metric Descriptions
- User Permissions
-
General Consulting
-
API Reference (ME-Abu Dhabi Region)
- Before You Start
- API Overview
- Calling APIs
- API DescriptionAPI V1
- API v2
-
Permissions Policies and Supported Actions
- Introduction
- Supported Actions of the API Version Management APIs
- Supported Actions of the Metric Management API
- Supported Actions of the Alarm Rule Management APIs
- Supported Actions of the Monitoring Data Management APIs
- Supported Actions of the Quota Management API
- Supported Actions of the Event Monitoring API
- Common Parameters
- Appendix
- Change History
-
User Guide (Paris Region)
- Product Introduction
- Getting Started
- Monitoring Panels
- Using the Alarm Function
- Custom Monitoring
- Services Interconnected with Cloud Eye
- FAQs
- Change History
- API Reference (Paris Region)
-
User Guide (Kuala Lumpur Region)
- Product Introduction
- Getting Started
- Dashboards
- Resource Groups
- Using the Alarm Function
-
Server Monitoring
- Introduction to Server Monitoring
- Agent Installation and Configuration
- Agent Features per Version
- Installing and Configuring the Agent on a Linux ECS or BMS
- Installing and Configuring the Agent on a Windows ECS
- Installing the Agents in Batches on Linux ECSs
- Managing the Agent
- Process Monitoring
- Viewing Server Monitoring Metrics
- Creating an Alarm Rule to Monitor a Server
- Custom Monitoring
- Event Monitoring
- Data Dump
- Auditing Operation Records on Cloud Eye
- Permissions Management
- Quota Adjustment
- Services Interconnected with Cloud Eye
-
FAQs
- General Consulting
-
Server Monitoring
- How Can I Quickly Restore the Agent Configuration?
- Why Is a BMS with the Agent Installed Displayed in the ECS List on the Server Monitoring Page?
- What OSs Does the Agent Support?
- What Statuses Does the Agent Have?
- What Should I Do If the Monitoring Period Is Interrupted or the Agent Status Keeps Changing?
- What Should I Do If the Service Port Is Used by the Agent?
- How Can I Create an Agency?
- What Can't I Create Another Agency?
- What Should I Do If Agency CESAgentAutoConfigAgency Failed to Be Automatically Created?
- What Can I Do If Agency CESAgentAutoConfigAgency Is Invalid?
- Will the Agent Affect the Server Performance?
- What Should I Do If the Agent Status Is Faulty?
-
Alarm Notifications or False Alarms
- What Is an Alarm Notification? How Many Types of Alarm Notifications Are There?
- What Alarm Status Does Cloud Eye Support?
- What Alarm Severities Does Cloud Eye Support?
- When Will an "Insufficient data" Alarm Be Triggered?
- How Can I Change the Mobile Number and Email Address for Receiving Alarm Notifications?
- How Can an IAM User Receive Alarm Notifications?
- Why Did I Receive a Bandwidth Overflow Notification While There Being No Bandwidth Overflow Record in the Monitoring Data?
-
Monitored Data Exceptions
- Why Is the Monitoring Data Not Displayed on the Cloud Eye Console?
- Why I Cannot See the Monitoring Data on the Cloud Eye Console After Purchasing Cloud Service Resources?
- Why Is OS Monitoring Data Not Displayed or Not Displayed Immediately After the Agent Is Installed and Configured on a server?
- Why Is Basic Monitoring Data Inconsistent with the Data Monitored by the OS?
- Why Are the Network Traffic Metric Values in Cloud Eye Different from Those Detected in ECS?
- Why Is the Metric Collection Point Lost During a Certain Period of Time?
- Why Are Memory Usage, Disk Usage, Inband Incoming Rate, and Inband Outgoing Rate Not Displayed for an ECS?
- What Are the Impacts on ECS Metrics If UVP VMTools Is Not Installed on ECSs?
- User Permissions
- Change History
- API Reference (Kuala Lumpur Region)
-
User Guide (Ankara Region)
- Product Introduction
- Getting Started
- Dashboards
- Resource Groups
- Using the Alarm Function
-
Server Monitoring
- Introduction to Server Monitoring
- Agent Installation and Configuration
- Installing and Configuring the Agent on a Linux ECS
- Installing and Configuring the Agent on a Windows ECS
- Installing the Agents in Batches on Linux ECSs
- Managing the Agent
- Process Monitoring
- Viewing Server Monitoring Metrics
- Creating an Alarm Rule to Monitor a Server
- Custom Monitoring
- Event Monitoring
- Cloud Service Monitoring
- Permissions Management
- Quota Adjustment
- Services Interconnected with Cloud Eye
-
FAQs
- General Consulting
-
Server Monitoring
- How Can I Quickly Restore the Agent Configuration?
- What OSs Does the Agent Support?
- How Do I Query the Current Agent Version?
- What Should I Do If the Service Port Is Used by the Agent?
- How Can I Create an Agency?
- What Can't I Create Another Agency?
- What Should I Do If Agency CESAgentAutoConfigAgency Failed to Be Automatically Created?
- What Can I Do If Agency CESAgentAutoConfigAgency Is Invalid?
- Will the Agent Affect the Server Performance?
- What Should I Do If the Agent Status Is Faulty?
- Alarm Notifications or False Alarms
- Monitored Data Exceptions
- User Permissions
- Change History
- API Reference (Ankara Region)
-
User Guide (ME-Abu Dhabi Region)
- General Reference
Copied.
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the tenant ID. Minimum: 1 Maximum: 64 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the tenant token. Minimum: 1 Maximum: 16384 |
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:
|
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 |
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:
|
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 |
Alarm severity, which can be 1 (critical), ** 2** (major), 3 (minor), or 4 (informational). The default value is 2. |
suppress_duration |
Yes |
Integer |
Specifies the alarm suppression period, in seconds. When the period is 0, only one alarm is generated. Enumeration values:
|
Response Parameters
Status code: 201
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
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
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
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
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot