Data Types

Last updated: 2020-07-03 10:55:40

BindingPolicyObjectDimension

Dimensions of instances bound to a policy

Used by actions: BindingPolicyObject.

Name Type Required Description
Region String Yes Region name.
RegionId Integer No Region ID.
Dimensions String No Dimensions.
EventDimensions String No Event dimensions.

CreatePolicyGroupCondition

Alarm threshold condition passed in when a policy is created.

Used by actions: CreatePolicyGroup.

Name Type Required Description
MetricId Integer Yes Metric ID.
AlarmNotifyType Integer Yes Alarm sending and converging type. The value 0 indicates that alarms are sent consecutively. The value 1 indicates that alarms are sent exponentially.
AlarmNotifyPeriod Integer Yes Alarm sending period in seconds. The value <0 indicates that no alarm will be triggered. The value 0 indicates that an alarm is triggered only once. The value >0 indicates that an alarm is triggered at the interval of triggerTime.
CalcType Integer No Comparative type. The value 1 indicates greater than. The value 2 indicates greater than or equal to. The value 3 indicates smaller than. The value 4 indicates smaller than or equal to. The value 5 indicates equal to. The value 6 indicates not equal to. This parameter is optional if a default comparative type is configured for the metric.
CalcValue Float No Comparative value. This parameter is optional if the metric has no requirement.
CalcPeriod Integer No Data aggregation period in seconds. This parameter is optional if the metric has a default value.
ContinuePeriod Integer No Number of consecutive periods after which an alarm will be triggered.
RuleId Integer No If a metric is created based on a template, the RuleId of the metric in the template must be passed in.

CreatePolicyGroupEventCondition

Event alarm condition passed in when a policy is created.

Used by actions: CreatePolicyGroup.

Name Type Required Description
EventId Integer Yes Alarm event ID.
AlarmNotifyType Integer Yes Alarm sending and converging type. The value 0 indicates that alarms are sent consecutively. The value 1 indicates that alarms are sent exponentially.
AlarmNotifyPeriod Integer Yes Alarm sending period in seconds. The value <0 indicates that no alarm will be triggered. The value 0 indicates that an alarm is triggered only once. The value >0 indicates that an alarm is triggered at the interval of triggerTime.
RuleId Integer No If a metric is created based on a template, the RuleId of the metric in the template must be passed in.

DataPoint

Monitoring data point

Used by actions: GetMonitorData.

Name Type Description
Dimensions Array of Dimension Combination of instance object dimensions
Timestamps Array of Float The array of timestamps indicating at which points in time there is data. Missing timestamps have no data points (i.e., missed)
Values Array of Float The array of monitoring values, which is in one-to-one correspondence to Timestamps

DescribeAccidentEventListAlarms

Output parameter type of the DescribeAccidentEventList API

Used by actions: DescribeAccidentEventList.

Name Type Description
BusinessTypeDesc String Event type.
Note: This field may return null, indicating that no valid value was found.
AccidentTypeDesc String Event type.
Note: This field may return null, indicating that no valid value was found.
BusinessID Integer ID of the event type. The value 1 indicates service issues. The value 2 indicates other subscriptions.
Note: This field may return null, indicating that no valid value was found.
EventStatus Integer Event status ID. The value 0 indicates that the event has been recovered. The value 1 indicates that the event has not been recovered.
Note: This field may return null, indicating that no valid value was found.
AffectResource String Affected object.
Note: This field may return null, indicating that no valid value was found.
Region String Region where the event occurs.
Note: This field may return null, indicating that no valid value was found.
OccurTime String Time when the event occurs.
Note: This field may return null, indicating that no valid value was found.
UpdateTime String Update time.
Note: This field may return null, indicating that no valid value was found.

DescribeBasicAlarmListAlarms

Alarms returned by DescribeBasicAlarmList

Used by actions: DescribeBasicAlarmList.

Name Type Description
Id Integer Alarm ID.
ProjectId Integer Project ID.
Note: This field may return null, indicating that no valid value was found.
ProjectName String Project name.
Note: This field may return null, indicating that no valid value was found.
Status Integer Alarm status ID.
Note: This field may return null, indicating that no valid value was found.
AlarmStatus String Alarm status.
Note: This field may return null, indicating that no valid value was found.
GroupId Integer Policy group ID.
Note: This field may return null, indicating that no valid value was found.
GroupName String Policy group name.
Note: This field may return null, indicating that no valid value was found.
FirstOccurTime String Occurrence time.
Note: This field may return null, indicating that no valid value was found.
Duration Integer Duration in seconds.
Note: This field may return null, indicating that no valid value was found.
LastOccurTime String End time.
Note: This field may return null, indicating that no valid value was found.
Content String Alarm content.
Note: This field may return null, indicating that no valid value was found.
ObjName String Alarm object.
Note: This field may return null, indicating that no valid value was found.
ObjId String Alarm object ID.
Note: This field may return null, indicating that no valid value was found.
ViewName String Policy type.
Note: This field may return null, indicating that no valid value was found.
Vpc String VPC, which is unique to CVM.
Note: This field may return null, indicating that no valid value was found.
MetricId Integer Metric ID.
Note: This field may return null, indicating that no valid value was found.
MetricName String Metric name.
Note: This field may return null, indicating that no valid value was found.
AlarmType Integer Alarm type. The value 0 indicates metric alarms. The value 2 indicates product event alarms. The value 3 indicates platform event alarms.
Note: This field may return null, indicating that no valid value was found.
Region String Region.
Note: This field may return null, indicating that no valid value was found.
Dimensions String Dimensions of an alarm object.
Note: This field may return null, indicating that no valid value was found.
NotifyWay Array of String Notification method.
Note: This field may return null, indicating that no valid value was found.
InstanceGroup Array of InstanceGroup Instance group information.
Note: This field may return null, indicating that no valid value was found.

DescribeBindingPolicyObjectListDimension

Dimensions of the DescribeBindingPolicyObjectList API

Used by actions: DescribeBindingPolicyObjectList.

Name Type Required Description
RegionId Integer Yes Region ID.
Region String Yes Region abbreviation.
Dimensions String Yes Combined JSON string of dimensions.
EventDimensions String Yes Combined JSON string of event dimensions.

DescribeBindingPolicyObjectListInstance

Object instance information returned by the DescribeBindingPolicyObjectListInstance API.

Used by actions: DescribeBindingPolicyObjectList.

Name Type Description
UniqueId String Unique ID of the object.
Dimensions String Dimension set of an object instance, which is a jsonObj string.
IsShielded Integer Whether the object is shielded. The value 0 indicates that the object is not shielded. The value 1 indicates that the object is shielded.
Region String Region where the object resides.

DescribeBindingPolicyObjectListInstanceGroup

Instance group information returned by the DescribeBindingPolicyObjectList API

Used by actions: DescribeBindingPolicyObjectList.

Name Type Description
InstanceGroupId Integer Instance group ID.
ViewName String Alarm policy type name.
LastEditUin String Uin that was last edited.
GroupName String Instance group name.
InstanceSum Integer Number of instances.
UpdateTime Integer Update time.
InsertTime Integer Creation time.
Regions Array of String Regions where the instances reside.
Note: This field may return null, indicating that no valid value was found.

DescribePolicyConditionListCondition

Policy conditions returned by the DescribePolicyConditionList API

Used by actions: DescribePolicyConditionList.

Name Type Description
PolicyViewName String Policy view name.
EventMetrics Array of DescribePolicyConditionListEventMetric Event alarm conditions.
Note: This field may return null, indicating that no valid value was found.
IsSupportMultiRegion Boolean Whether to support multiple regions.
Metrics Array of DescribePolicyConditionListMetric Metric alarm conditions.
Note: This field may return null, indicating that no valid value was found.
Name String Policy type name.
SortId Integer Sorting ID.
SupportDefault Boolean Whether to support default policies.
SupportRegions Array of String List of regions that support this policy type.
Note: This field may return null, indicating that no valid value was found.

DescribePolicyConditionListConfigManual

DescribePolicyConditionList.ConfigManual

Used by actions: DescribePolicyConditionList.

Name Type Description
CalcType DescribePolicyConditionListConfigManualCalcType Check method.
Note: This field may return null, indicating that no valid value was found.
CalcValue DescribePolicyConditionListConfigManualCalcValue Threshold.
Note: This field may return null, indicating that no valid value was found.
ContinueTime DescribePolicyConditionListConfigManualContinueTime Duration.
Note: This field may return null, indicating that no valid value was found.
Period DescribePolicyConditionListConfigManualPeriod Data period.
Note: This field may return null, indicating that no valid value was found.
PeriodNum DescribePolicyConditionListConfigManualPeriodNum Number of periods.
Note: This field may return null, indicating that no valid value was found.
StatType DescribePolicyConditionListConfigManualStatType Statistics method.
Note: This field may return null, indicating that no valid value was found.

DescribePolicyConditionListConfigManualCalcType

DescribePolicyConditionList.ConfigManual.CalcType

Used by actions: DescribePolicyConditionList.

Name Type Description
Keys Array of Integer Value of CalcType.
Note: This field may return null, indicating that no valid value was found.
Need Boolean Required or not.

DescribePolicyConditionListConfigManualCalcValue

DescribePolicyConditionList.ConfigManual.CalcValue

Used by actions: DescribePolicyConditionList.

Name Type Description
Default String Default value.
Note: This field may return null, indicating that no valid value was found.
Fixed String Fixed value.
Note: This field may return null, indicating that no valid value was found.
Max String Maximum value.
Note: This field may return null, indicating that no valid value was found.
Min String Minimum value.
Note: This field may return null, indicating that no valid value was found.
Need Boolean Required or not.

DescribePolicyConditionListConfigManualContinueTime

DescribePolicyConditionList.ConfigManual.ContinueTime

Used by actions: DescribePolicyConditionList.

Name Type Description
Default Integer Default duration in seconds.
Note: This field may return null, indicating that no valid value was found.
Keys Array of Integer Custom durations in seconds.
Note: This field may return null, indicating that no valid value was found.
Need Boolean Required or not.

DescribePolicyConditionListConfigManualPeriod

DescribePolicyConditionList.ConfigManual.Period

Used by actions: DescribePolicyConditionList.

Name Type Description
Default Integer Default period in seconds.
Note: This field may return null, indicating that no valid value was found.
Keys Array of Integer Custom periods in seconds.
Note: This field may return null, indicating that no valid value was found.
Need Boolean Required or not.

DescribePolicyConditionListConfigManualPeriodNum

DescribePolicyConditionList.ConfigManual.PeriodNum

Used by actions: DescribePolicyConditionList.

Name Type Description
Default Integer Number of default periods.
Note: This field may return null, indicating that no valid value was found.
Keys Array of Integer Number of custom periods.
Note: This field may return null, indicating that no valid value was found.
Need Boolean Required or not.

DescribePolicyConditionListConfigManualStatType

DescribePolicyConditionList.ConfigManual.StatType

Used by actions: DescribePolicyConditionList.

Name Type Description
P5 String Data aggregation method in a period of 5 seconds.
Note: This field may return null, indicating that no valid value was found.
P10 String Data aggregation method in a period of 10 seconds.
Note: This field may return null, indicating that no valid value was found.
P60 String Data aggregation method in a period of 1 minute.
Note: This field may return null, indicating that no valid value was found.
P300 String Data aggregation method in a period of 5 minutes.
Note: This field may return null, indicating that no valid value was found.
P600 String Data aggregation method in a period of 10 minutes.
Note: This field may return null, indicating that no valid value was found.
P1800 String Data aggregation method in a period of 30 minutes.
Note: This field may return null, indicating that no valid value was found.
P3600 String Data aggregation method in a period of 1 hour.
Note: This field may return null, indicating that no valid value was found.
P86400 String Data aggregation method in a period of 1 day.
Note: This field may return null, indicating that no valid value was found.

DescribePolicyConditionListEventMetric

DescribePolicyConditionList.EventMetric

Used by actions: DescribePolicyConditionList.

Name Type Description
EventId Integer Event ID.
EventShowName String Event name.
NeedRecovered Boolean Whether to recover.
Type Integer Event type, which is a reserved field. Currently, it is fixed to 2.

DescribePolicyConditionListMetric

Metric alarm configuration.

Used by actions: DescribePolicyConditionList.

Name Type Description
ConfigManual DescribePolicyConditionListConfigManual Metric configuration.
Note: This field may return null, indicating that no valid value was found.
MetricId Integer Metric ID.
MetricShowName String Metric name.
MetricUnit String Metric unit.

DescribePolicyGroupInfoCallback

User callback information output by the policy query

Used by actions: DescribePolicyGroupInfo.

Name Type Description
CallbackUrl String URL of the user callback API.
ValidFlag Integer Status of the user callback API. The value 0 indicates that the API is not verified. The value 1 indicates that the API is verified. The value 2 indicates that a URL exists but the API fails to be verified.
VerifyCode String Verification code of the user callback API.

DescribePolicyGroupInfoCondition

Alarm threshold conditions output by the policy query.

Used by actions: DescribePolicyGroupInfo、DescribePolicyGroupList.

Name Type Description
MetricShowName String Metric name.
Period Integer Data aggregation period in seconds.
MetricId Integer Metric ID.
RuleId Integer Threshold rule ID.
Unit String Metric unit.
AlarmNotifyType Integer Alarm sending and converging type. The value 0 indicates that alarms are sent consecutively. The value 1 indicates that alarms are sent exponentially.
AlarmNotifyPeriod Integer Alarm sending period in seconds. If the value is less than 0, no alarm will be triggered. If the value is 0, an alarm will be triggered only once. If the value is greater than 0, an alarm will be triggered at the interval of triggerTime.
CalcType Integer Comparative type. The value 1 indicates greater than. The value 2 indicates greater than or equal to. The value 3 indicates smaller than. The value 4 indicates smaller than or equal to. The value 5 indicates equal to. The value 6 indicates not equal to. The value 7 indicates day-on-day increase. The value 8 indicates day-on-day decrease. The value 9 indicates week-on-week increase. The value 10 indicates week-on-week decrease. The value 11 indicates periodical increase. The value 12 indicates periodical decrease.
CalcValue String Threshold.
ContinueTime Integer Duration at which an alarm will be triggered in seconds.
MetricName String Alarm metric name.

DescribePolicyGroupInfoConditionTpl

Template-based policy group information output by the policy query

Used by actions: DescribePolicyGroupInfo、DescribePolicyGroupList.

Name Type Description
GroupId Integer Policy group ID.
GroupName String Policy group name.
ViewName String Policy type.
Remark String Policy group remarks.
LastEditUin String Uin that was last edited.
UpdateTime Integer Update time.
Note: This field may return null, indicating that no valid value was found.
InsertTime Integer Creation time.
Note: This field may return null, indicating that no valid value was found.
IsUnionRule Integer Whether the “AND” rule is used.
Note: This field may return null, indicating that no valid value was found.

DescribePolicyGroupInfoEventCondition

Event alarm conditions output by the policy query

Used by actions: DescribePolicyGroupInfo、DescribePolicyGroupList.

Name Type Description
EventId Integer Event ID.
RuleId Integer Event alarm rule ID.
EventShowName String Event name.
AlarmNotifyPeriod Integer Alarm sending period in seconds. The value <0 indicates that no alarm will be triggered. The value 0 indicates that an alarm is triggered only once. The value >0 indicates that an alarm is triggered at the interval of triggerTime.
AlarmNotifyType Integer Alarm sending and converging type. The value 0 indicates that alarms are sent consecutively. The value 1 indicates that alarms are sent exponentially.

DescribePolicyGroupInfoReceiverInfo

Alarm recipient information output by the policy query

Used by actions: DescribePolicyGroupInfo、DescribePolicyGroupList.

Name Type Description
ReceiverGroupList Array of Integer List of alarm recipient group IDs.
ReceiverUserList Array of Integer List of alarm recipient IDs.
StartTime Integer Start time of the alarm period. Value range: [0,86400). Convert the Unix timestamp to Beijing time and then remove the date. For example, 7200 indicates “10:0:0”.
EndTime Integer End time of the alarm period. The meaning is the same as that of StartTime.
ReceiverType String Recipient type. Valid values: group and user.
NotifyWay Array of String Alarm notification method. Valid values: "SMS", "SITE", "EMAIL", "CALL", and "WECHAT".
UidList Array of Integer Uid of the alarm call recipient.
Note: This field may return null, indicating that no valid value was found.
RoundNumber Integer Number of alarm call rounds.
RoundInterval Integer Intervals of alarm call rounds in seconds.
PersonInterval Integer Alarm call intervals for individuals in seconds.
NeedSendNotice Integer Whether to send an alarm call delivery notice. The value 0 indicates that no notice needs to be sent. The value 1 indicates that a notice needs to be sent.
SendFor Array of String Alarm call notification time. Valid values: OCCUR (indicating that a notice is sent when the alarm is triggered) and RECOVER (indicating that a notice is sent when the alarm is recovered).
RecoverNotify Array of String Notification method when an alarm is recovered. Valid value: SMS.
ReceiveLanguage String Alarm language.
Note: This field may return null, indicating that no valid value was found.

DescribePolicyGroupListGroup

DescribePolicyGroupList.Group

Used by actions: DescribePolicyGroupList.

Name Type Description
GroupId Integer Policy group ID.
GroupName String Policy group name.
IsOpen Boolean Whether it is enabled.
ViewName String Policy view name.
LastEditUin String Uin that was last edited.
UpdateTime Integer Last modified time.
InsertTime Integer Creation time.
UseSum Integer Number of instances that are bound to the policy group.
NoShieldedSum Integer Number of unshielded instances that are bound to the policy group.
IsDefault Integer Whether it is the default policy. The value 0 indicates that it is not the default policy. The value 1 indicates that it is the default policy.
CanSetDefault Boolean Whether the policy can be configured as the default policy.
ParentGroupId Integer Parent policy group ID.
Remark String Remarks of the policy group.
ProjectId Integer ID of the project to which the policy group belongs.
Conditions Array of DescribePolicyGroupInfoCondition Threshold rule list.
Note: This field may return null, indicating that no valid value was found.
EventConditions Array of DescribePolicyGroupInfoEventCondition Product event rule list.
Note: This field may return null, indicating that no valid value was found.
ReceiverInfos Array of DescribePolicyGroupInfoReceiverInfo Recipient list.
Note: This field may return null, indicating that no valid value was found.
ConditionsTemp DescribePolicyGroupInfoConditionTpl Template-based policy group.
Note: This field may return null, indicating that no valid value was found.
InstanceGroup DescribePolicyGroupListGroupInstanceGroup Instance group that is bound to the policy group.
Note: This field may return null, indicating that no valid value was found.
IsUnionRule Integer The “AND” or “OR” rule. The value 0 indicates the “OR” rule (indicating that an alarm will be triggered if any rule meets the threshold condition). The value 1 indicates the “AND” rule (indicating that an alarm will be triggered when all rules meet the threshold conditions).
Note: This field may return null, indicating that no valid value was found.

DescribePolicyGroupListGroupInstanceGroup

Instance group that is bound to a policy group of the DescribePolicyGroupList API

Used by actions: DescribePolicyGroupList.

Name Type Description
InstanceGroupId Integer Instance group name ID.
ViewName String Policy type view name.
LastEditUin String Uin that was last edited.
GroupName String Instance group name.
InstanceSum Integer Number of instances.
UpdateTime Integer Update time.
InsertTime Integer Creation time.

DescribeProductEventListDimensions

Input parameter Dimensions of the DescribeProductEventList API

Used by actions: DescribeProductEventList.

Name Type Required Description
Name String Yes Dimension name.
Value String Yes Dimension value.

DescribeProductEventListEvents

Events returned by the DescribeProductEventList API

Used by actions: DescribeProductEventList.

Name Type Description
EventId Integer Event ID.
Note: This field may return null, indicating that no valid value was found.
EventCName String Event name in Chinese.
Note: This field may return null, indicating that no valid value was found.
EventEName String Event name in English.
Note: This field may return null, indicating that no valid value was found.
EventName String Event name abbreviation.
Note: This field may return null, indicating that no valid value was found.
ProductCName String Product name in Chinese.
Note: This field may return null, indicating that no valid value was found.
ProductEName String Product name in English.
Note: This field may return null, indicating that no valid value was found.
ProductName String Product name abbreviation.
Note: This field may return null, indicating that no valid value was found.
InstanceId String Instance ID.
Note: This field may return null, indicating that no valid value was found.
InstanceName String Instance name.
Note: This field may return null, indicating that no valid value was found.
ProjectId String Project ID.
Note: This field may return null, indicating that no valid value was found.
Region String Region.
Note: This field may return null, indicating that no valid value was found.
Status String Status.
Note: This field may return null, indicating that no valid value was found.
SupportAlarm Integer Whether to support alarms.
Note: This field may return null, indicating that no valid value was found.
Type String Event type.
Note: This field may return null, indicating that no valid value was found.
StartTime Integer Start time.
Note: This field may return null, indicating that no valid value was found.
UpdateTime Integer Update time.
Note: This field may return null, indicating that no valid value was found.
Dimensions Array of DescribeProductEventListEventsDimensions Instance object information.
Note: This field may return null, indicating that no valid value was found.
AdditionMsg Array of DescribeProductEventListEventsDimensions Additional information of the instance object.
Note: This field may return null, indicating that no valid value was found.
IsAlarmConfig Integer Whether to configure alarms.
Note: This field may return null, indicating that no valid value was found.
GroupInfo Array of DescribeProductEventListEventsGroupInfo Policy information.
Note: This field may return null, indicating that no valid value was found.

DescribeProductEventListEventsDimensions

Dimensions of events returned by the DescribeProductEventList API

Used by actions: DescribeProductEventList.

Name Type Description
Key String Dimension name in English.
Note: This field may return null, indicating that no valid value was found.
Name String Dimension name in Chinese.
Note: This field may return null, indicating that no valid value was found.
Value String Dimension value.
Note: This field may return null, indicating that no valid value was found.

DescribeProductEventListEventsGroupInfo

GroupInfo in Events returned by the DescribeProductEventList API

Used by actions: DescribeProductEventList.

Name Type Description
GroupId Integer Policy ID.
Note: This field may return null, indicating that no valid value was found.
GroupName String Policy name.
Note: This field may return null, indicating that no valid value was found.

DescribeProductEventListOverView

OverView object returned by the DescribeProductEventList API

Used by actions: DescribeProductEventList.

Name Type Description
StatusChangeAmount Integer Number of events whose statuses have changed.
Note: This field may return null, indicating that no valid value was found.
UnConfigAlarmAmount Integer Number of events whose alarm statuses are not configured.
Note: This field may return null, indicating that no valid value was found.
UnNormalEventAmount Integer Number of events with exceptions.
Note: This field may return null, indicating that no valid value was found.
UnRecoverAmount Integer Number of events that have not been recovered.
Note: This field may return null, indicating that no valid value was found.

Dimension

Combination of instance object dimensions

Used by actions: GetMonitorData.

Name Type Required Description
Name String Yes Instance dimension name
Value String Yes Instance dimension value

DimensionsDesc

Dimension information

Used by actions: DescribeBaseMetrics.

Name Type Description
Dimensions Array of String Array of dimension names

Instance

Array of instance dimension combinations

Used by actions: GetMonitorData.

Name Type Required Description
Dimensions Array of Dimension Yes Combination of instance dimensions

InstanceGroup

InstanceGroup in Alarms returned by the DescribeBasicAlarmList API

Used by actions: DescribeBasicAlarmList.

Name Type Description
InstanceGroupId Integer Instance group ID.
Note: This field may return null, indicating that no valid value was found.
InstanceGroupName String Instance group name.
Note: This field may return null, indicating that no valid value was found.

MetricDatum

Metric names and values

Used by actions: PutMonitorData.

Name Type Required Description
MetricName String Yes Metric name.
Value Integer Yes Metric value.

MetricObjectMeaning

Meaning of metric data

Used by actions: DescribeBaseMetrics.

Name Type Description
En String Meaning of the metric in English
Zh String Meaning of the metric in Chinese

MetricSet

Description of the unit and supported statistical period of the business metric

Used by actions: DescribeBaseMetrics.

Name Type Description
Namespace String Namespace. Each Tencent Cloud product has a namespace
MetricName String Metric Name
Unit String Unit used by the metric
UnitCname String Unit used by the metric
Period Array of Integer Statistical period in seconds supported by the metric, such as 60 and 300
Periods Array of PeriodsSt Metric method during the statistical period
Meaning MetricObjectMeaning Meaning of the statistical metric
Dimensions Array of DimensionsDesc Dimension description

ModifyPolicyGroupCondition

Modification of the metric threshold condition passed in by the alarm policy group.

Used by actions: ModifyPolicyGroup.

Name Type Required Description
MetricId Integer Yes Metric ID.
CalcType Integer Yes Comparative type. The value 1 indicates greater than. The value 2 indicates greater than or equal to. The value 3 indicates smaller than. The value 4 indicates smaller than or equal to. The value 5 indicates equal to. The value 6 indicates not equal to.
CalcValue String Yes Threshold.
CalcPeriod Integer Yes Data period of the detected metric.
ContinuePeriod Integer Yes Number of consecutive periods.
AlarmNotifyType Integer Yes Alarm sending and convergence type. The value 0 indicates that alarms are sent consecutively. The value 1 indicates that alarms are sent exponentially.
AlarmNotifyPeriod Integer Yes Alarm sending period in seconds. If the value is less than 0, no alarm will be triggered. If the value is 0, an alarm will be triggered only once. If the value is greater than 0, an alarm will be triggered at the interval of triggerTime.
RuleId Integer No Rule ID. No filling means new addition while filling in ruleId means to modify existing rules.

ModifyPolicyGroupEventCondition

Modification of the event alarm condition passed in by the alarm policy group.

Used by actions: ModifyPolicyGroup.

Name Type Required Description
EventId Integer Yes Event ID.
AlarmNotifyType Integer Yes Alarm sending and convergence type. The value 0 indicates that alarms are sent consecutively. The value 1 indicates that alarms are sent exponentially.
AlarmNotifyPeriod Integer Yes Alarm sending period in seconds. If the value is less than 0, no alarm will be triggered. If the value is 0, an alarm will be triggered only once. If the value is greater than 0, an alarm will be triggered at the interval of triggerTime.
RuleId Integer No Rule ID. No filling means new addition while filling in ruleId means to modify existing rules.

PeriodsSt

Statistical method during the period

Used by actions: DescribeBaseMetrics.

Name Type Description
Period String Period
StatType Array of String Statistical method

ReceiverInfo

Recipient information.

Used by actions: ModifyAlarmReceivers.

Name Type Required Description
StartTime Integer Yes Start time of the alarm period. Value range: [0,86400). Convert the Unix timestamp to Beijing time and then remove the date. For example, 7200 indicates “10:0:0”.
EndTime Integer Yes End time of the alarm period. The meaning is the same as that of StartTime.
NotifyWay Array of String Yes Alarm notification method. Valid values: "SMS", "SITE", "EMAIL", "CALL", and "WECHAT".
ReceiverType String Yes Recipient type. Valid values: group and user.
Id Integer No ReceiverId
SendFor Array of String No Alarm call notification time. Valid values: OCCUR (indicating that a notice is sent when the alarm is triggered) and RECOVER (indicating that a notice is sent when the alarm is recovered).
UidList Array of Integer No Uid of the alarm call recipient.
RoundNumber Integer No Number of alarm call rounds.
PersonInterval Integer No Alarm call intervals for individuals in seconds.
RoundInterval Integer No Intervals of alarm call rounds in seconds.
RecoverNotify Array of String No Notification method when an alarm is recovered. Valid value: SMS.
NeedSendNotice Integer No Whether to send an alarm call delivery notice. The value 0 indicates that no notice needs to be sent. The value 1 indicates that a notice needs to be sent.
ReceiverGroupList Array of Integer No Recipient group list. The list of recipient group IDs that is queried by a platform API.
ReceiverUserList Array of Integer No Recipient list. The list of recipient IDs that is queried by a platform API.
ReceiveLanguage String No Language of received alarms. Enumerated values: zh-CN and en-US.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help