Data Types

Last updated: 2021-02-08 11:17:59

AlarmEvent

Alarm event

Used by actions: DescribeAlarmEvents.

Name Type Description
EventName String Event name
Description String Event display name
Namespace String Alarm policy type

AlarmHistory

Alarm record data

Used by actions: DescribeAlarmHistories.

Name Type Description
AlarmId String Alarm record ID
MonitorType String Monitor type
Namespace String Policy type
AlarmObject String Alarm object
Content String Alarm content
FirstOccurTime Integer Timestamp of the first occurrence
LastOccurTime Integer Timestamp of the last occurrence
AlarmStatus String Alarm status. Valid values: ALARM (not resolved), OK (resolved), NO_CONF (expired), NO_DATA (insufficient data)
PolicyId String Alarm policy ID
PolicyName String Policy name
VPC String VPC of alarm object for basic product alarm
ProjectId Integer Project ID
ProjectName String Project name
InstanceGroup Array of InstanceGroups Instance group of alarm object
ReceiverUids Array of Integer Recipient list
ReceiverGroups Array of Integer Recipient group list
NoticeWays Array of String Alarm channel list. Valid values: SMS (SMS), EMAIL (email), CALL (phone), WECHAT (WeChat)
OriginId String Compatible Alarm 1.0 policy group ID
AlarmType String Alarm type
EventId Integer Event ID
Region String Region
PolicyExists Integer Whether the policy exists. Valid values: 0 (no), 1 (yes)

AlarmNotice

Alarm notification template details

Used by actions: DescribeAlarmNotice, DescribeAlarmNotices, DescribeAlarmPolicies, DescribeAlarmPolicy.

Name Type Description
Id String Alarm notification template ID
Note: this field may return null, indicating that no valid values can be obtained.
Name String Alarm notification template name
Note: this field may return null, indicating that no valid values can be obtained.
UpdatedAt String Last modified time
Note: this field may return null, indicating that no valid values can be obtained.
UpdatedBy String Last modified by
Note: this field may return null, indicating that no valid values can be obtained.
NoticeType String Alarm notification type. Valid values: ALARM (for unresolved alarms), OK (for resolved alarms), ALL (for all alarms)
Note: this field may return null, indicating that no valid values can be obtained.
UserNotices Array of UserNotice User notification list
Note: this field may return null, indicating that no valid values can be obtained.
URLNotices Array of URLNotice Callback notification list
Note: this field may return null, indicating that no valid values can be obtained.
IsPreset Integer Whether it is the system default notification template. Valid values: 0 (no), 1 (yes)
Note: this field may return null, indicating that no valid values can be obtained.
NoticeLanguage String Notification language. Valid values: zh-CN (Chinese), en-US (English)
Note: this field may return null, indicating that no valid values can be obtained.
PolicyIds Array of String List of IDs of the alarm policies bound to alarm notification template
Note: this field may return null, indicating that no valid values can be obtained.

AlarmPolicy

Alarm policy details

Used by actions: DescribeAlarmPolicies, DescribeAlarmPolicy.

Name Type Description
PolicyId String Alarm policy ID
Note: this field may return null, indicating that no valid values can be obtained.
PolicyName String Alarm policy name
Note: this field may return null, indicating that no valid values can be obtained.
Remark String Remarks
Note: this field may return null, indicating that no valid values can be obtained.
MonitorType String Monitor type. Valid values: MT_QCE (Tencent Cloud service monitoring)
Note: this field may return null, indicating that no valid values can be obtained.
Enable Integer Status. Valid values: 0 (disabled), 1 (enabled)
Note: this field may return null, indicating that no valid values can be obtained.
UseSum Integer Number of instances bound to policy group
Note: this field may return null, indicating that no valid values can be obtained.
ProjectId Integer Project ID. Valid values: -1 (no project), 0 (default project)
Note: this field may return null, indicating that no valid values can be obtained.
ProjectName String Project name
Note: this field may return null, indicating that no valid values can be obtained.
Namespace String Alarm policy type
Note: this field may return null, indicating that no valid values can be obtained.
ConditionTemplateId String Trigger condition template ID
Note: this field may return null, indicating that no valid values can be obtained.
Condition AlarmPolicyCondition Metric trigger condition
Note: this field may return null, indicating that no valid values can be obtained.
EventCondition AlarmPolicyEventCondition Event trigger condition
Note: this field may return null, indicating that no valid values can be obtained.
NoticeIds Array of String Notification rule ID list
Note: this field may return null, indicating that no valid values can be obtained.
Notices Array of AlarmNotice Notification rule list
Note: this field may return null, indicating that no valid values can be obtained.
TriggerTasks Array of AlarmPolicyTriggerTask Triggered task list
Note: this field may return null, indicating that no valid values can be obtained.
ConditionsTemp ConditionsTemp Template policy group
Note: this field may return null, indicating that no valid values can be obtained.
Note: this field may return null, indicating that no valid values can be obtained.
LastEditUin String Uin of the last modifying user
Note: this field may return null, indicating that no valid values can be obtained.
UpdateTime Integer Update time
Note: this field may return null, indicating that no valid values can be obtained.
Note: this field may return null, indicating that no valid values can be obtained.
InsertTime Integer Creation time
Note: this field may return null, indicating that no valid values can be obtained.
Note: this field may return null, indicating that no valid values can be obtained.
Region Array of String Region
Note: this field may return null, indicating that no valid values can be obtained.
NamespaceShowName String Namespace display name
Note: this field may return null, indicating that no valid values can be obtained.
IsDefault Integer Whether it is the default policy. Valid values: 1 (yes), 0 (no)
Note: this field may return null, indicating that no valid values can be obtained.
CanSetDefault Integer Whether the default policy can be set. Valid values: 1 (yes), 0 (no)
Note: this field may return null, indicating that no valid values can be obtained.
InstanceGroupId Integer Instance group ID
Note: this field may return null, indicating that no valid values can be obtained.
InstanceSum Integer Total number of instances in instance group
Note: this field may return null, indicating that no valid values can be obtained.
InstanceGroupName String Instance group name
Note: this field may return null, indicating that no valid values can be obtained.
RuleType String Trigger condition type. Valid values: STATIC (static threshold), DYNAMIC (dynamic)
Note: this field may return null, indicating that no valid values can be obtained.
OriginId String Policy ID for instance/instance group binding and unbinding APIs (BindingPolicyObject, UnBindingAllPolicyObject, UnBindingPolicyObject)
Note: this field may return null, indicating that no valid values can be obtained.
TagInstances Array of TagInstance Tag
Note: This field may return null, indicating that no valid values can be obtained.

AlarmPolicyCondition

Metric trigger condition of alarm policy

Used by actions: CreateAlarmPolicy, DescribeAlarmPolicies, DescribeAlarmPolicy, ModifyAlarmPolicyCondition.

Name Type Required Description
IsUnionRule Integer Yes Metric trigger condition operator. Valid values: 0 (OR), 1 (AND)
Note: this field may return null, indicating that no valid values can be obtained.
Rules Array of AlarmPolicyRule Yes Alarm trigger condition list
Note: this field may return null, indicating that no valid values can be obtained.

AlarmPolicyEventCondition

Event trigger condition of alarm policy

Used by actions: CreateAlarmPolicy, DescribeAlarmPolicies, DescribeAlarmPolicy, ModifyAlarmPolicyCondition.

Name Type Required Description
Rules Array of AlarmPolicyRule Yes Alarm trigger condition list
Note: this field may return null, indicating that no valid values can be obtained.

AlarmPolicyFilter

Filter condition of alarm policy

Used by actions: CreateAlarmPolicy, DescribeAlarmPolicies, DescribeAlarmPolicy, ModifyAlarmPolicyCondition.

Name Type Required Description
Type String Yes Filter condition type. Valid values: DIMENSION (uses dimensions for filtering)
Note: this field may return null, indicating that no valid values can be obtained.
Dimensions String No JSON string generated by serializing the AlarmPolicyDimension two-dimensional array. The one-dimensional arrays are in OR relationship, and the elements in a one-dimensional array are in AND relationship
Note: this field may return null, indicating that no valid values can be obtained.

AlarmPolicyRule

Trigger condition of alarm policy

Used by actions: CreateAlarmPolicy, DescribeAlarmPolicies, DescribeAlarmPolicy, ModifyAlarmPolicyCondition.

Name Type Required Description
MetricName String No Metric name
Note: this field may return null, indicating that no valid values can be obtained.
Period Integer No Statistical period in seconds
Note: this field may return null, indicating that no valid values can be obtained.
Operator String No Operator
intelligent = intelligent detection without threshold
eq = equal to
ge = greater than or equal to
gt = greater than
le = less than or equal to
lt = less than
ne = not equal to
day_increase = daily increase
day_decrease = daily decrease
day_wave = daily fluctuation
week_increase = weekly increase
week_decrease = weekly decrease
week_wave = weekly fluctuation
cycle_increase = periodical increase
cycle_decrease = periodical decrease
cycle_wave = periodical fluctuation
re = regex match
Note: this field may return null, indicating that no valid values can be obtained.
Value String No Threshold
Note: this field may return null, indicating that no valid values can be obtained.
ContinuePeriod Integer No Number of cycles for continuous notification. Valid values: 1 (1 cycle), 2 (2 cycles), and so on.
Note: this field may return null, indicating that no valid values can be obtained.
NoticeFrequency Integer No Alarm interval in seconds. Valid values: 0 (do not repeat), 300 (alarm once every 5 minutes), 600 (alarm once every 10 minutes), 900 (alarm once every 15 minutes), 1800 (alarm once every 30 minutes), 3600 (alarm once every hour), 7200 (alarm once every 2 hours), 10800 (alarm once every 3 hours), 21600 (alarm once every 6 hours), 43200 (alarm once every 12 hours), 86400 (alarm once every day)
Note: this field may return null, indicating that no valid values can be obtained.
IsPowerNotice Integer No Whether the alarm frequency increases exponentially. Valid values: 0 (no), 1 (yes)
Note: this field may return null, indicating that no valid values can be obtained.
Filter AlarmPolicyFilter No Filter condition for one single trigger rule
Note: this field may return null, indicating that no valid values can be obtained.
Description String No Metric display name, which is used in the output parameter
Note: this field may return null, indicating that no valid values can be obtained.
Unit String No Unit, which is used in the output parameter
Note: this field may return null, indicating that no valid values can be obtained.
RuleType String No Trigger condition type. Valid values: STATIC (static threshold), DYNAMIC (dynamic threshold)
Note: this field may return null, indicating that no valid values can be obtained.

AlarmPolicyTriggerTask

Task triggered by alarm policy

Used by actions: CreateAlarmPolicy, DescribeAlarmPolicies, DescribeAlarmPolicy, ModifyAlarmPolicyTasks.

Name Type Required Description
Type String Yes Triggered task type. Valid value: AS (auto scaling)
Note: this field may return null, indicating that no valid values can be obtained.
TaskConfig String Yes Configuration information in JSON format, such as {"Key1":"Value1","Key2":"Value2"}
Note: this field may return null, indicating that no valid values can be obtained.

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.

CommonNamespace

Unified namespace information

Used by actions: DescribeAllNamespaces.

Name Type Description
Id String Namespace ID
Name String Namespace name
Value String Namespace value
ProductName String Product name
Config String Configuration information
AvailableRegions Array of String List of supported regions
SortId Integer Sort ID
DashboardId String Unique ID in Dashboard

ConditionsTemp

Alarm condition template

Used by actions: DescribeAlarmPolicies, DescribeAlarmPolicy.

Name Type Description
TemplateName String Template name
Note: this field may return null, indicating that no valid values can be obtained.
Condition AlarmPolicyCondition Metric trigger condition
Note: this field may return null, indicating that no valid values can be obtained.
EventCondition AlarmPolicyEventCondition Event trigger condition
Note: this field may return null, indicating that no valid values can be obtained.

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 ind