Modifying All Fields in an Alarm Policy

Function

This API is used to modify all fields in an alarm rule.

Debugging

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ces:alarms:updatePolicies	Write	alarm *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	ces:alarms:put	-

URI

PUT /v2/{project_id}/alarms/{alarm_id}/policies

**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
alarm_id	Yes	String	Definition Alarm rule ID. Constraints N/A Range The value starts with al and is followed by 24 characters of letters, digits, or a combination of both. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
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.
X-Auth-Token	No	String	Definition User token. Constraints: None Value range: The value can contain 1 to 16,384 characters. Default value: None

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
policies	Yes	Array of UpdatePolicyReq objects	Definition Policy information. Constraints You can specify 1 to 50 policies.

**Table 4** UpdatePolicyReq
Parameter	Mandatory	Type	Description
metric_name	Yes	String	Definition Metric name of a resource. For details about the metric names of each resource, see their service documentation. You can navigate there from Services Interconnected with Cloud Eye. Constraints N/A Range The value must start with a letter and can only contain letters, digits, 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 policy. Constraints If the policy does not contain additional information, extra_info does not need to be transferred.
period	Yes	Integer	Definition Metric period, in seconds. For details about the original metric period for each cloud service, see Services Interconnected with Cloud Eye. 0: The alarm is triggered immediately. This value applies only to event scenarios. 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 Constraints N/A Range The value can be:
filter	Yes	String	Definition Aggregation method. Constraints When period is set to 1 (original value), the filter field does not take effect. The default value of filter is average. The filter parameter takes effect only when period is greater than 1. Range average variance min: minimum value. max: maximum value. 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. For details, see Services Interconnected with Cloud Eye. 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 -1.7976931348623157e+108 to 1.7976931348623157e+108 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. Constraints N/A Range [0,32] Default Value N/A
type	No	String	Definition Alarm policy type. This parameter has been deprecated. Constraints N/A Range N/A 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
suppress_duration	No	Integer	Definition Alarm suppression duration, in seconds. This parameter is used to mitigate frequent alarms. Constraints N/A Range The value can be: 0: An event 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
level	No	Integer	Definition Alarm severity. Constraints N/A Range The value can be: 1: critical. 2: major. 3: minor. 4: warning. Default Value 2
namespace	No	String	Definition For details about service namespaces, see Services Interconnected with Cloud Eye. Constraints This parameter is mandatory. namespace and dimension_name need to be specified for cloud product-level rules to specify the resources to which the policy applies. Range The value is in the service.item format. The values of service and item must start with a letter and contain only letters, digits, and underscores (_). 0 to 32 characters. Default Value N/A
dimension_name	No	String	Definition Dimension information of a resource. For details about the dimension names of each resource, see their service documentation. You can navigate there from Services Interconnected with Cloud Eye. Constraints This parameter is mandatory. namespace and dimension_name need to be specified for cloud product-level rules to specify the resources to which the policy applies. Range 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

**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 warnings. Constraints N/A Range [-1.7976931348623157e+108, 1.7976931348623157e+108] Default Value N/A

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
policies	Array of UpdatePolicyResp objects	Definition Policy information.

**Table 8** UpdatePolicyResp
Parameter	Type	Description
metric_name	String	Definition Metric name of a resource. For details about the metric names of each resource, see their service documentation. You can navigate there from Services Interconnected with Cloud Eye. Range The value must start with a letter and can only contain letters, digits, 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.
extra_info	MetricExtraInfoResp object	Definition Additional information about the policy. If the policy does not contain additional information, extra_info does not need to be transferred.
period	Integer	Definition Metric period, in seconds. For details about the original metric period for each cloud service, see Services Interconnected with Cloud Eye. 0: The alarm is triggered immediately. This value applies only to 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. Range The value can be:
filter	String	Definition Aggregation method. Range average variance min: minimum value. max: maximum value. sum
comparison_operator	String	Definition Threshold symbol. 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.
value	Number	Definition Alarm threshold. For details, see Services Interconnected with Cloud Eye. Range -1.7976931348623157e+108 to 1.7976931348623157e+108
hierarchical_value	HierarchicalValueResp object	Definition Multi-level alarm threshold.
unit	String	Definition Data unit. Range [0,32]
type	String	Definition Alarm policy type. This parameter has been deprecated. Range N/A
count	Integer	Definition Number of times that the alarm triggering conditions are met. 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.
suppress_duration	Integer	Definition Alarm suppression duration, in seconds. This parameter is used to mitigate frequent alarms. Range The value can be: 0: An event 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.
level	Integer	Definition Alarm severity. Range The value can be: 1: critical. 2: major. 3: minor. 4: warning.
namespace	String	Definition For details about service namespaces, see Services Interconnected with Cloud Eye. namespace and dimension_name need to be specified for cloud product-level rules to specify the resources to which the policy applies. Range The value is in the service.item format. The values of service and item must start with a letter and contain only letters, digits, and underscores (_). 0 to 32 characters.
dimension_name	String	Definition Dimension name of a resource. For details about the dimension names of each resource, see their service documentation. You can navigate there from Services Interconnected with Cloud Eye. Range A maximum of four dimensions are supported. Example: instance_id for single-dimension scenarios and instance_id,disk for multi-dimension scenarios.

**Table 9** MetricExtraInfoResp
Parameter	Type	Description
origin_metric_name	String	Definition Original metric name. Range [0,4,096]
metric_prefix	String	Definition Metric name prefix. Range [0,4,096]
custom_proc_name	String	Definition Name of a process. Range [0,250]
metric_type	String	Definition Metric type. Range [0,32]

**Table 10** HierarchicalValueResp
Parameter	Type	Description
critical	Double	Definition Threshold for critical alarms. Range [-1.7976931348623157e+108, 1.7976931348623157e+108]
major	Double	Definition Threshold for major alarms. Range [-1.7976931348623157e+108, 1.7976931348623157e+108]
minor	Double	Definition Threshold for minor alarms. Range [-1.7976931348623157e+108, 1.7976931348623157e+108]
info	Double	Definition Threshold for warnings. Range [-1.7976931348623157e+108, 1.7976931348623157e+108]

Status code: 400

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

Modify an alarm policy whose metric name is disk_device_read_bytes_rate, including its metric period, aggregation method, threshold, unit, count, alarm suppression duration, and alarm severity.

{
  "policies" : [ {
    "metric_name" : "disk_device_read_bytes_rate",
    "period" : 1,
    "filter" : "average",
    "comparison_operator" : ">",
    "value" : 75,
    "unit" : "byte/s",
    "count" : 3,
    "suppress_duration" : 10800,
    "level" : 2,
    "namespace" : "AGT.ECS",
    "dimension_name" : "instance_id"
  } ]
}

Example Responses

Status code: 200

Modification succeeded.

{
  "policies" : [ {
    "namespace" : "AGT.ECS",
    "dimension_name" : "instance_id",
    "metric_name" : "disk_device_read_bytes_rate",
    "period" : 1,
    "filter" : "average",
    "comparison_operator" : ">",
    "value" : 75,
    "unit" : "byte/s",
    "count" : 3,
    "type" : "",
    "suppress_duration" : 10800,
    "level" : 2
  } ]
}