Data Types

Last updated: 2021-04-20 17:11:54

    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 Alarm policy ID, which can be used when you call APIs (BindingPolicyObject, UnBindingAllPolicyObject, UnBindingPolicyObject) to bind/unbind instances or instance groups to/from an alarm policy
    AlarmType String Alarm type
    EventId Integer Event ID
    Region String Region
    PolicyExists Integer Whether the policy exists. Valid values: 0 (no), 1 (yes)
    MetricsInfo Array of AlarmHistoryMetric Metric information
    Note: this field may return null, indicating that no valid values can be obtained.

    AlarmHistoryMetric

    Metric information of alarm records

    Used by actions: DescribeAlarmHistories.

    Name Type Description
    QceNamespace String Namespace used to query data by Tencent Cloud service monitoring type
    MetricName String Metric name
    Period Integer Statistical period
    Value String Value triggering alarm
    Description String Metric display name

    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 or event name. The supported metrics can be queried via DescribeAlarmMetrics and the supported events via DescribeAlarmEvents.
    Note: this field may return null, indicating that no valid value is obtained.
    Period Integer No Statistical period in seconds. The valid values can be queried via DescribeAlarmMetrics.
    Note: this field may return null, indicating that no valid value is 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 = day-on-day increase
    day_decrease = day-on-day decrease
    day_wave = day-on-day fluctuation
    week_increase = week-on-week increase
    week_decrease = week-on-week decrease
    week_wave = week-on-week fluctuation
    cycle_increase = cyclical increase
    cycle_decrease = cyclical decrease
    cycle_wave = cyclical fluctuation
    re = regex match
    The valid values can be queried via DescribeAlarmMetrics.
    Note: this field may return null, indicating that no valid value is obtained.
    Value String No Threshold. The valid value range can be queried via DescribeAlarmMetrics.
    Note: this field may return null, indicating that no valid value is obtained.
    ContinuePeriod Integer No Number of periods. 1: continue for one period; 2: continue for two periods; and so on. The valid values can be queried via DescribeAlarmMetrics.
    Note: this field may return null, indicating that no valid value is 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. STATIC: static threshold; dynamic: dynamic threshold. If you do not specify this parameter when creating or editing a policy, STATIC is used by default.
    Note: this field may return null, indicating that no valid value is 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 Instance dimension information in the following format:
    {"unInstanceId":"ins-00jvv9mo"}. The dimension information varies by Tencent Cloud services. For more information, please see:
    Dimension List
    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 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. Valid values: 0 (not resolved), 1 (resolved), 2/3/5 (insufficient data), 4 (expired)
    Note: this field may return null, indicating that no valid values can be obtained.
    AlarmStatus String Alarm status. Valid values: ALARM (not resolved), OK (resolved), NO_DATA (insufficient data), NO_CONF (expired)
    Note: this field may return null, indicating that no valid values can be obtained.
    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.
    ViewName String Display name
    Note: This field may return null, indicating that no valid values can be obtained.

    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: DescribeStatisticData, 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.

    InstanceGroups

    Instance group of alarm object

    Used by actions: DescribeAlarmHistories.

    Name Type Description
    Id Integer Instance group ID
    Name String Instance group name

    Metric

    Metric, which can be used to set alarms and query data

    Used by actions: DescribeAlarmMetrics.

    Name Type Description
    Namespace String Alarm policy type
    MetricName String Metric name
    Description String Metric display name
    Min Float Minimum value
    Max Float Maximum value
    Dimensions Array of String Dimension list
    Unit String Unit
    MetricConfig MetricConfig Metric configuration
    Note: this field may return null, indicating that no valid values can be obtained.

    MetricConfig

    Metric configuration

    Used by actions: DescribeAlarmMetrics.

    Name Type Description
    Operator Array of String Allowed operator
    Period Array of Integer Allowed data cycle in seconds
    ContinuePeriod Array of Integer Allowed number of continuous cycles

    MetricData

    DescribeMetricData output parameters

    Used by actions: DescribeStatisticData.

    Name Type Description
    MetricName String Metric name
    Points Array of MetricDataPoint Monitoring data point

    MetricDataPoint

    DescribeMetricData output parameters

    Used by actions: DescribeStatisticData.

    Name Type Description
    Dimensions Array of Dimension Combination of instance object dimensions
    Values Array of Point Data point list

    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

    MidQueryCondition

    DescribeMidDimensionValueList query conditions

    Used by actions: DescribeStatisticData.

    Name Type Required Description
    Key String Yes Dimension
    Operator String Yes Operator. Valid values: eq (equal to), ne (not equal to), in
    Value Array of String Yes Dimension value. If Operator is eq or ne, only the first element will be used

    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.

    MonitorTypeNamespace

    Policy type

    Used by actions: DescribeAlarmHistories.

    Name Type Required Description
    MonitorType String Yes Monitor type
    Namespace String Yes Policy type value

    PeriodsSt

    Statistical method during the period

    Used by actions: DescribeBaseMetrics.

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

    Point

    Monitoring data point

    Used by actions: DescribeStatisticData.

    Name Type Description
    Timestamp Integer Time point when this monitoring data point is generated
    Value Float Monitoring data point value
    Note: this field may return null, indicating that no valid values can be obtained.

    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.

    TagInstance

    Instance tag information of the alarm policy

    Used by actions: DescribeAlarmPolicies, DescribeAlarmPolicy.

    Name Type Description
    Key String Tag key
    Note: This field may return null, indicating that no valid values can be obtained.
    Value String Tag value
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceSum Integer Number of instances
    Note: This field may return null, indicating that no valid values can be obtained.
    ServiceType String Service type, for example, CVM
    Note: This field may return null, indicating that no valid values can be obtained.
    RegionId String Region ID
    Note: This field may return null, indicating that no valid values can be obtained.
    BindingStatus Integer Binding status. 2: bound; 1: binding
    Note: This field may return null, indicating that no valid values can be obtained.
    TagStatus Integer Tag status. 2: existent; 1: nonexistent
    Note: This field may return null, indicating that no valid values can be obtained.

    URLNotice

    Cloud Monitor alarm notification template - callback notification details

    Used by actions: CreateAlarmNotice, DescribeAlarmNotice, DescribeAlarmNoticeCallbacks, DescribeAlarmNotices, DescribeAlarmPolicies, DescribeAlarmPolicy, ModifyAlarmNotice.

    Name Type Required Description
    URL String Yes Callback URL, which can contain up to 256 characters
    Note: this field may return null, indicating that no valid values can be obtained.
    IsValid Integer No Whether verification is passed. Valid values: 0 (no), 1 (yes)
    Note: this field may return null, indicating that no valid values can be obtained.
    ValidationCode String No Verification code
    Note: this field may return null, indicating that no valid values can be obtained.

    UserNotice

    Cloud Monitor alarm notification template - user notification details

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

    Name Type Required Description
    ReceiverType String Yes Recipient type. Valid values: USER (user), GROUP (user group)
    Note: this field may return null, indicating that no valid values can be obtained.
    StartTime Integer Yes Notification start time, which is expressed by the number of seconds since 00:00:00. Value range: 0–86399
    Note: this field may return null, indicating that no valid values can be obtained.
    EndTime Integer Yes Notification end time, which is expressed by the number of seconds since 00:00:00. Value range: 0–86399
    Note: this field may return null, indicating that no valid values can be obtained.
    NoticeWay Array of String Yes Notification channel list. Valid values: EMAIL (email), SMS (SMS), CALL (phone), WECHAT (WeChat)
    Note: this field may return null, indicating that no valid values can be obtained.
    UserIds Array of Integer No User uid list
    Note: this field may return null, indicating that no valid values can be obtained.
    GroupIds Array of Integer No User group ID list
    Note: this field may return null, indicating that no valid values can be obtained.
    PhoneOrder Array of Integer No Phone polling list
    Note: this field may return null, indicating that no valid values can be obtained.
    PhoneCircleTimes Integer No Number of phone pollings. Value range: 1–5
    Note: this field may return null, indicating that no valid values can be obtained.
    PhoneInnerInterval Integer No Call interval in seconds within one polling. Value range: 60–900
    Note: this field may return null, indicating that no valid values can be obtained.
    PhoneCircleInterval Integer No Polling interval in seconds. Value range: 60–900
    Note: this field may return null, indicating that no valid values can be obtained.
    NeedPhoneArriveNotice Integer No Whether receipt notification is required. Valid values: 0 (no), 1 (yes)
    Note: this field may return null, indicating that no valid values can be obtained.

    Was this page helpful?

    Was this page helpful?

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