tencent cloud

All product documents
APIs
DocumentationAPIsTencent Cloud Observability PlatformData Types
Data Types
Last updated: 2024-07-08 17:35:43
Data Types
Last updated: 2024-07-08 17:35:43

AlarmEvent

Alarm event

Used by actions: DescribeAlarmEvents.

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

AlarmHierarchicalNotice

Notification template ID and the list of alarm notification levels. The values Remind and Serious indicate that the notification template only sends alarms at the Remind and Serious levels.

Used by actions: CreateAlarmPolicy, ModifyAlarmPolicyNotice.

Name Type Required Description
NoticeId String No Notification template ID
Note: This field may return null, indicating that no valid values can be obtained.
Classification Array of String No The list of alarm notification levels. The values Remind and Serious indicate that the notification template only sends alarms at the Remind and Serious levels.
Note: This field may return null, indicating that no valid values can be obtained.

AlarmHierarchicalValue

The configuration of alarm level threshold

Used by actions: CreateAlarmPolicy, ModifyAlarmPolicyCondition.

Name Type Required Description
Remind String No Threshold for the Remind level
Note: This field may return null, indicating that no valid values can be obtained.
Warn String No Threshold for the Warn level
Note: This field may return null, indicating that no valid values can be obtained.
Serious String No Threshold for the Serious level
Note: This field may return null, indicating that no valid values can be obtained.

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.
Dimensions String Dimension information of an instance that triggered alarms.
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 Required Description
Id String Yes Alarm notification template ID
Note: this field may return null, indicating that no valid values can be obtained.
Name String Yes Alarm notification template name
Note: this field may return null, indicating that no valid values can be obtained.
UpdatedAt String Yes Last modified time
Note: this field may return null, indicating that no valid values can be obtained.
UpdatedBy String Yes Last modified by
Note: this field may return null, indicating that no valid values can be obtained.
NoticeType String Yes 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 Yes User notification list
Note: this field may return null, indicating that no valid values can be obtained.
URLNotices Array of URLNotice Yes Callback notification list
Note: this field may return null, indicating that no valid values can be obtained.
IsPreset Integer Yes 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 Yes 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 Yes 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.
AMPConsumerId String Yes Backend AMP consumer ID.
Note: This field may return null, indicating that no valid values can be obtained.
CLSNotices Array of CLSNotice Yes Channel to push alarm notifications to CLS.
Note: This field may return null, indicating that no valid values can be obtained.
Tags Array of Tag Yes Tags bound to a 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.
FilterDimensionsParam String Information on the filter dimension associated with a policy.
Note: This field may return null, indicating that no valid values can be obtained.
IsOneClick Integer Whether it is a quick alarm policy.
Note: This field may return null, indicating that no valid values can be obtained.
OneClickStatus Integer Whether the quick alarm policy is enabled.
Note: This field may return null, indicating that no valid values can be obtained.
AdvancedMetricNumber Integer The number of advanced metrics.
Note: This field may return null, indicating that no valid values can be obtained.
IsBindAll Integer Whether the policy is associated with all objects
Note: This field may return null, indicating that no valid values can be obtained.
Tags Array of Tag Policy 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 Judgment condition of an alarm trigger condition (0: Any; 1: All; 2: Composite). When the value is set to 2 (i.e., composite trigger conditions), this parameter should be used together with ComplexExpression.
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.
ComplexExpression String No The judgment expression of composite alarm trigger conditions, which is valid when the value of IsUnionRule is 2. This parameter is used to determine that an alarm condition is met only when the expression values are True for multiple trigger conditions.
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, 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, 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.
IsAdvanced Integer No Whether it is an advanced metric. 0: No; 1: Yes.
Note: This field may return null, indicating that no valid values can be obtained.
IsOpen Integer No Whether the advanced metric feature is enabled. 0: No; 1: Yes.
Note: This field may return null, indicating that no valid values can be obtained.
ProductId String No Integration center product ID.
Note: This field may return null, indicating that no valid values can be obtained.
ValueMax Float No Maximum value
Note: This field may return null, indicating that no valid values can be obtained.
ValueMin Float No Minimum value
Note: This field may return null, indicating that no valid values can be obtained.
HierarchicalValue AlarmHierarchicalValue No The configuration of alarm level 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 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.

CLSNotice

The operation of pushing alarm notifications to CLS

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

Name Type Required Description
Region String Yes Region.
LogSetId String Yes Logset ID.
TopicId String Yes Topic ID.
Enable Integer No Status. Valid values: 0 (disabled), 1 (enabled). Default value: 1 (enabled). This parameter can be left empty.

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

CommonNamespaceNew

Policy type information

Used by actions: DescribeAllNamespaces.

Name Type Description
Id String Namespace ID
Name String Namespace name
MonitorType String Monitoring type
Dimensions Array of DimensionNew Dimension information

Condition

Alarm condition

Used by actions: DescribeConditionsTemplateList.

Name Type Description
AlarmNotifyPeriod Integer Alarm notification frequency.
AlarmNotifyType Integer Predefined repeated notification policy. 0: One-time alarm; 1: exponential alarm; 2: consecutive alarm.
CalcType String Detection method.
Note: This field may return null, indicating that no valid values can be obtained.
CalcValue String Detection value.
Note: This field may return null, indicating that no valid values can be obtained.
ContinueTime String Duration in seconds.
Note: This field may return null, indicating that no valid values can be obtained.
MetricID Integer Metric ID.
MetricDisplayName String Displayed metric name.
Period Integer Statistical period.
RuleID Integer Rule ID.
Unit String Metric unit.
IsAdvanced Integer Whether it is an advanced metric. Valid values: 0 (no), 1 (yes).
IsOpen Integer Whether the advance metric feature is enabled. Valid values: 0 (no), 1 (yes).
ProductId String Product ID.
Note: This field may return null, indicating that no valid values can be obtained.

ConditionsTemp

Alarm trigger 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.
DeprecatingInfo DescribePolicyConditionListResponseDeprecatingInfo Deprecated information
Note: This field may return null, indicating that no valid values can be obtained.

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.

DescribePolicyConditionListResponseDeprecatingInfo

DescribePolicyConditionListResponseDeprecatingInfo

Used by actions: DescribePolicyConditionList.

Name Type Description
Hidden Boolean Whether to hide
Note: This field may return null, indicating that no valid values can be obtained.
NewViewNames Array of String Names of new views
Note: This field may return null, indicating that no valid values can be obtained.
Description String Description
Note: This field may return null, indicating that no valid values can be obtained.

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

DimensionNew

Dimension information of the policy type

Used by actions: DescribeAllNamespaces.

Name Type Description
Key String Dimension key ID displayed on the backend
Name String Dimension key name displayed on the frontend
IsRequired Boolean Whether it is required
Operators Array of Operator List of supported operators
IsMultiple Boolean Whether multiple items can be selected
IsMutable Boolean Whether it can be modified after creation
IsVisible Boolean Whether it is displayed to users
CanFilterPolicy Boolean Whether it can be used to filter policies
CanFilterHistory Boolean Whether it can be used to filter historical alarms
CanGroupBy Boolean Whether it can be used as an aggregate dimension
MustGroupBy Boolean Whether it must be used as an aggregate dimension
ShowValueReplace String The key to be replaced on the frontend
Note: This field may return null, indicating that no valid values can be obtained.

DimensionsDesc

Dimension information

Used by actions: DescribeBaseMetrics.

Name Type Description
Dimensions Array of String Array of dimension names

EventCondition

Event alarm conditions

Used by actions: DescribeConditionsTemplateList.

Name Type Description
AlarmNotifyPeriod String Alarm notification frequency.
Note: This field may return null, indicating that no valid values can be obtained.
AlarmNotifyType String Predefined repeated notification policy. 0: One-time alarm; 1: exponential alarm; 2: consecutive alarm
Note: This field may return null, indicating that no valid values can be obtained.
EventID String Event ID.
EventDisplayName String Displayed event name.
RuleID String Rule ID.

Filter

Query filter

Used by actions: DescribePrometheusAlertPolicy, DescribePrometheusInstancesOverview, DescribePrometheusRecordRuleYaml, DescribePrometheusRecordRules, DescribePrometheusTargetsTMP, DescribePrometheusTemp.

Name Type Required Description
Type String No Filter method. Valid values: =, !=, in.
Key String No Filter dimension name
Value String No Filter value. For the in filter method, separate multiple values by comma.
Name String No Filter name
Values Array of String No Filter value range

GrafanaAccountInfo

TCMG authorized account information

Used by actions: DescribeSSOAccount.

Name Type Description
UserId String User account ID
Role Array of GrafanaAccountRole User permission
Notes String Remarks
CreateAt Timestamp ISO8601 Creation time
InstanceId String Instance ID
Note: This field may return null, indicating that no valid values can be obtained.
Uin String User’s root account UIN

GrafanaAccountRole

TCMG account permission

Used by actions: CreateSSOAccount, DescribeSSOAccount, UpdateSSOAccount.

Name Type Required Description
Organization String No Organization
Role String No Permission

GrafanaChannel

Grafana alert channel

Used by actions: DescribeGrafanaChannels.

Name Type Description
ChannelId String Channel ID
ChannelName String Channel name
Receivers Array of String Array of alert channel template IDs
CreatedAt Timestamp ISO8601 Creation time
UpdatedAt Timestamp ISO8601 Update time
OrganizationIds Array of String All valid organizations in an alert channel
Note: This field may return null, indicating that no valid values can be obtained.

GrafanaInstanceInfo

Instance type when the Grafana instance is queried

Used by actions: DescribeGrafanaInstances.

Name Type Description
InstanceName String Instance name
InstanceId String Instance ID
Region String Region
VpcId String VPC ID
SubnetIds Array of String Array of subnet IDs
InternetUrl String Grafana private network address
InternalUrl String Grafana public network address
CreatedAt Timestamp Creation time
InstanceStatus Integer Status. Valid values: 1 (creating), 2 (running), 3 (abnormal), 4 (restarting), 5 (stopping), 6 (stopped), 7 (deleted).
TagSpecification Array of PrometheusTag Instance tag
Note: This field may return null, indicating that no valid values can be obtained.
Zone String Instance AZ
InstanceChargeType Integer Billing mode. Valid value: 1 (monthly subscription).
VpcName String VPC name
SubnetName String Subnet name
RegionId Integer Region ID
RootUrl String The full URL used to access this instance
EnableSSO Boolean Whether to enable SSO
Version String Version number
EnableSSOCamCheck Boolean Whether to enable CAM authentication during SSO

GrafanaIntegrationConfig

Grafana instance configuration

Used by actions: DescribeGrafanaIntegrations.

Name Type Description
IntegrationId String Integration ID
Kind String Integration type
Content String Integration content
Description String Integration description
GrafanaURL String Grafana redirection address
Note: This field may return null, indicating that no valid values can be obtained.

GrafanaNotificationChannel

Grafana notification channel

Used by actions: DescribeGrafanaNotificationChannels.

Name Type Description
ChannelId String Channel ID
ChannelName String Channel name
Receivers Array of String Array of notification channel template IDs
CreatedAt Timestamp ISO8601 Creation time
UpdatedAt Date Update time
OrgId String Default valid organization. This parameter has been deprecated. Please use OrganizationIds instead.
ExtraOrgIds Array of String Extra valid organization. This parameter has been deprecated. Please use OrganizationIds instead.
Note: This field may return null, indicating that no valid values can be obtained.
OrgIds String Valid organization. This parameter has been deprecated. Please use OrganizationIds instead.
Note: This field may return null, indicating that no valid values can be obtained.
OrganizationIds String All valid organizations in an alert channel
Note: This field may return null, indicating that no valid values can be obtained.

GrafanaPlugin

Grafana plugin

Used by actions: DescribeInstalledPlugins, InstallPlugins.

Name Type Required Description
PluginId String Yes Grafana plugin ID
Version String Yes Grafana plugin version
Note: This field may return null, indicating that no valid values can be obtained.

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

IntegrationConfiguration

Export integration configuration

Used by actions: DescribeExporterIntegrations.

Name Type Description
Name String Name
Kind String Type
Content String Content
Status Integer Status
Category String Instance type
InstanceDesc String Instance description
GrafanaDashboardURL String Dashboard URL

Label

Tags in K8s, which generally exist in the form of an array.

Used by actions: CreatePrometheusAlertPolicy, CreatePrometheusClusterAgent, DescribePrometheusAlertPolicy, DescribePrometheusClusterAgents, ModifyPrometheusAgentExternalLabels, ModifyPrometheusAlertPolicy, ModifyPrometheusTemp.

Name Type Required Description
Name String Yes Label name
Value String Yes Label value

LogAlarmReq

Log alarm request information

Used by actions: CreateAlarmPolicy, ModifyAlarmPolicyCondition.

Name Type Required Description
InstanceId String Yes APM instance ID
Filter Array of LogFilterInfo Yes Search condition
AlarmMerge String Yes The switch to enable/disable alarm merging
AlarmMergeTime String Yes Alarm merging time

LogFilterInfo

Log alarm search condition structure

Used by actions: CreateAlarmPolicy, ModifyAlarmPolicyCondition.

Name Type Required Description
Key String Yes Field name
Operator String Yes Comparison operator
Value String Yes Field value

ManagementCommand

Prometheus agent management command line

Used by actions: GetPrometheusAgentManagementCommand.

Name Type Description
Install String Agent installation command
Note: This field may return null, indicating that no valid values can be obtained.
Restart String Agent restart command
Note: This field may return null, indicating that no valid values can be obtained.
Stop String Agent stop command
Note: This field may return null, indicating that no valid values can be obtained.
StatusCheck String Agent status detection command
Note: This field may return null, indicating that no valid values can be obtained.
LogCheck String Agent log detection command
Note: This field may return null, indicating that no valid values can be obtained.

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.
IsAdvanced Integer Whether it is an advanced metric. 1: Yes; 0: No.
Note: This field may return null, indicating that no valid values can be obtained.
IsOpen Integer Whether the advanced metric feature is enabled. 1: Yes; 0: No.
Note: This field may return null, indicating that no valid values can be obtained.
ProductId Integer Integration center product ID.
Note: This field may return null, indicating that no valid values can be obtained.
Operators Array of Operator Matching operator
Note: This field may return null, indicating that no valid values can be obtained.
Periods Array of Integer Metric monitoring granularity
Note: This field may return null, indicating that no valid values can be obtained.
IsLatenessMetric Integer

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

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
MetricCName String Metric name (in Chinese).
Note: this field may return null, indicating that no valid values can be obtained.
MetricEName String Metric name (in English).
Note: this field may return null, indicating that no valid values can be obtained.

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.

MonitorTypeInfo

Monitoring type details

Used by actions: DescribeMonitorTypes.

Name Type Description
Id String Monitoring type ID
Name String Monitoring type
SortId Integer Sort order

MonitorTypeNamespace

Policy type

Used by actions: DescribeAlarmHistories.

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

NoticeBindPolicys

Binding between a notification template and a policy

Used by actions: DeleteAlarmNotices.

Name Type Required Description
NoticeId String No Alert notification template ID
PolicyIds Array of String No List of IDs of the alerting rules bound to an alarm notification template

Operator

Operators supported by the instance

Used by actions: DescribeAlarmMetrics, DescribeAllNamespaces.

Name Type Description
Id String Operator ID
Name String Operator name

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.

PolicyGroup

Policy group information

Used by actions: DescribeConditionsTemplateList.

Name Type Description
CanSetDefault Boolean Whether the alarm policy can be set to default.
GroupID Integer Alarm policy group ID.
GroupName String Alarm policy group name.
InsertTime Integer Creation time.
IsDefault Integer Whether the alarm policy is set to default.
Enable Boolean Whether the alarm policy is enabled.
LastEditUin Integer UIN of the last modifier.
NoShieldedInstanceCount Integer Number of unshielded instances.
ParentGroupID Integer Parent policy group ID.
ProjectID Integer Project ID.
ReceiverInfos Array of PolicyGroupReceiverInfo Alarm recipient information.
Note: This field may return null, indicating that no valid values can be obtained.
Remark String Remarks.
UpdateTime Integer Modification time.
TotalInstanceCount Integer The total number of associated instances.
ViewName String View.
IsUnionRule Integer Whether the logical relationship between rules is AND.

PolicyGroupReceiverInfo

Information on recipients in the policy template list (API v2018)

Used by actions: DescribeConditionsTemplateList.

Name Type Description
EndTime Integer End time of a valid time period.
NeedSendNotice Integer Whether it is required to send notifications.
NotifyWay Array of String Alarm receiving channel.
Note: This field may return null, indicating that no valid values can be obtained.
PersonInterval Integer Alarm call intervals for individuals in seconds.
ReceiverGroupList Array of Integer Message recipient group list.
Note: This field may return null, indicating that no valid values can be obtained.
ReceiverType String Recipient type.
ReceiverUserList Array of Integer Recipient list. The list of recipient IDs that is queried by a platform API.
Note: This field may return null, indicating that no valid values can be obtained.
RecoverNotify Array of String Alarm resolution notification method.
Note: This field may return null, indicating that no valid values can be obtained.
RoundInterval Integer Alarm call interval per round in seconds.
RoundNumber Integer Number of alarm call rounds.
SendFor Array of String Alarm call notification time. Valid values: OCCUR (indicating that a notification is sent when the alarm is triggered) and RECOVER (indicating that a notification is sent when the alarm is resolved).
Note: This field may return null, indicating that no valid values can be obtained.
StartTime Integer Start time of a valid time period.
UIDList Array of Integer UID of the alarm call recipient.
Note: This field may return null, indicating that no valid values can be obtained.

PrometheusAgent

prometheus agent

Used by actions: DescribePrometheusAgents.

Name Type Description
Name String Agent name
Note: This field may return null, indicating that no valid values can be obtained.
AgentId String Agent ID
InstanceId String Instance ID
Ipv4 String Agent IP
Note: This field may return null, indicating that no valid values can be obtained.
HeartbeatTime String Heartbeat time
Note: This field may return null, indicating that no valid values can be obtained.
LastError String Last error
Note: This field may return null, indicating that no valid values can be obtained.
AgentVersion String Agent version
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer Agent status

PrometheusAgentInfo

Information of managed Prometheus agent

Used by actions: DeletePrometheusClusterAgent.

Name Type Required Description
ClusterType String Yes Cluster type
ClusterId String Yes Cluster ID
Describe String No Remarks

PrometheusAgentOverview

Overview of managed Prometheus agent

Used by actions: DescribePrometheusClusterAgents.

Name Type Description
ClusterType String Cluster type
ClusterId String Cluster ID
Status String Agent status. Valid values:
normal
abnormal
ClusterName String Cluster name
ExternalLabels Array of Label External labels
External labels, which will be attached to all metrics in this cluster
Note: This field may return null, indicating that no valid values can be obtained.
Region String Cluster region
Note: This field may return null, indicating that no valid values can be obtained.
VpcId String ID of the VPC where the cluster resides
Note: This field may return null, indicating that no valid values can be obtained.
FailedReason String Recorded information of failed operations, such as association.
Note: This field may return null, indicating that no valid values can be obtained.
Name String Agent name
Note: This field may return null, indicating that no valid values can be obtained.

PrometheusAlertManagerConfig

Self-built AlertManager configuration used by the alert channel

Used by actions: CreatePrometheusAlertPolicy, CreatePrometheusGlobalNotification, DescribePrometheusAlertPolicy, DescribePrometheusGlobalNotification, ModifyPrometheusAlertPolicy, ModifyPrometheusGlobalNotification, ModifyPrometheusTemp.

Name Type Required Description
Url String Yes AlertManager URL
ClusterType String No Type of the cluster where AlertManager is deployed
Note: This field may return null, indicating that no valid values can be obtained.
ClusterId String No ID of the cluster where AlertManager is deployed
Note: This field may return null, indicating that no valid values can be obtained.

PrometheusAlertPolicyItem

TMP alerting rule instance

Used by actions: CreatePrometheusAlertPolicy, CreatePrometheusTemp, DescribePrometheusAlertPolicy, DescribePrometheusTemp, ModifyPrometheusAlertPolicy, ModifyPrometheusTemp.

Name Type Required Description
Name String Yes Rule name
Rules Array of PrometheusAlertRule Yes List of rules
Id String No Alerting rule ID
Note: This field may return null, indicating that no valid values can be obtained.
TemplateId String No If the alert comes from a template, TemplateId is the template ID.
Note: This field may return null, indicating that no valid values can be obtained.
Notification PrometheusNotificationItem No Alert channel, which may be returned as null if used in a template.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedAt String No Last modification time
Note: This field may return null, indicating that no valid values can be obtained.
ClusterId String No If the alerting rule comes from the user cluster CRD resource definition, ClusterId is the cluster ID.
Note: This field may return null, indicating that no valid values can be obtained.

PrometheusAlertRule

Prometheus alerting rule

Used by actions: CreatePrometheusAlertPolicy, DescribePrometheusAlertPolicy, ModifyPrometheusAlertPolicy, ModifyPrometheusTemp.

Name Type Required Description
Name String Yes Rule name
Rule String Yes Prometheus statement
Labels Array of Label Yes Additional tags
Template String Yes Alert sending template
For String Yes Duration
Describe String No Rule description
Note: This field may return null, indicating that no valid values can be obtained.
Annotations Array of Label No See annotations in the Prometheus rule
Note: This field may return null, indicating that no valid values can be obtained.
RuleState Integer No Alerting rule status
Note: This field may return null, indicating that no valid values can be obtained.

PrometheusClusterAgentBasic

Basic information of the cluster associated with a Tencent Cloud Observability Platform (TCOP)-integrated TMP instance.

Used by actions: CreatePrometheusClusterAgent.

Name Type Required Description
Region String Yes Cluster ID
ClusterType String Yes Cluster type
ClusterId String Yes Cluster ID
EnableExternal Boolean Yes Whether to enable public network CLB
InClusterPodConfig PrometheusClusterAgentPodConfig No Pod configurations of components deployed in the cluster
ExternalLabels Array of Label No External labels, which will be attached to all metrics collected by this cluster
NotInstallBasicScrape Boolean No Whether to install the default collection configuration.
NotScrape Boolean No Whether to collect metrics (true: Drop all metrics; false: Collect default metrics)
OpenDefaultRecord Boolean No Whether to enable the default recording rule

PrometheusClusterAgentPodConfig

Additional pod configurations of the components deployed in the cluster when a cluster is associated

Used by actions: CreatePrometheusClusterAgent.

Name Type Required Description
HostNet Boolean No Whether to use HostNetWork
NodeSelector Array of Label No A parameter used to specify the running nodes for a pod
Tolerations Array of Toleration No Tolerable taints

PrometheusConfigItem

Prometheus configuration

Used by actions: CreatePrometheusConfig, CreatePrometheusTemp, DescribePrometheusConfig, DescribePrometheusGlobalConfig, DescribePrometheusTemp, ModifyPrometheusConfig, ModifyPrometheusTemp.

Name Type Required Description
Name String Yes Name
Config String Yes Configuration content
TemplateId String No If the configuration comes from a template, this parameter is the template ID, which is used as an output parameter.
Note: This field may return null, indicating that no valid values can be obtained.
Targets Targets No Number of targets
Note: This field may return null, indicating that no valid values can be obtained.

PrometheusInstanceGrantInfo

Instance authorization information

Used by actions: DescribePrometheusInstances.

Name Type Description
HasChargeOperation Integer Whether there is permission to operate on the billing information. Valid values: 1 (yes), 2 (no).
HasVpcDisplay Integer Whether there is permission to display the VPC information. Valid values: 1 (yes), 2 (no).
HasGrafanaStatusChange Integer Whether there is permission to change the Grafana status. Valid values: 1 (yes), 2 (no).
HasAgentManage Integer Whether there is permission to manage agents. Valid values: 1 (yes), 2 (no).
HasTkeManage Integer Whether there is permission to manage TKE integrations. Valid values: 1 (yes), 2 (no).
HasApiOperation Integer Whether there is permission to display the API information. Valid values: 1 (yes), 2 (no).

PrometheusInstanceTenantUsage

TMP usage information

Used by actions: DescribePrometheusInstanceUsage.

Name Type Description
InstanceId String Instance ID
Note: This field may return null, indicating that no valid values can be obtained.
CalcDate String Billing cycle
Note: This field may return null, indicating that no valid values can be obtained.
Total Float Total usage
Note: This field may return null, indicating that no valid values can be obtained.
Basic Float Usage of basic (free) metrics
Note: This field may return null, indicating that no valid values can be obtained.
Fee Float Usage of paid metrics
Note: This field may return null, indicating that no valid values can be obtained.

PrometheusInstancesItem

Prometheus service response body

Used by actions: DescribePrometheusInstances.

Name Type Description
InstanceId String Instance ID.
InstanceName String Instance name.
InstanceChargeType Integer Instance billing mode. Valid values:

  • 2: Monthly subscription
  • 3: Pay-as-you-go
RegionId Integer Region ID
Zone String AZ
VpcId String VPC ID
SubnetId String Subnet ID
DataRetentionTime Integer Storage period
Note: This field may return null, indicating that no valid values can be obtained.
InstanceStatus Integer Instance status. Valid values:

  • 1: Creating
  • 2: Running
  • 3: Abnormal
  • 4: Rebooting
  • 5: Terminating
  • 6: Service suspended
  • 8: Suspending service for overdue payment
  • 9: Service suspended for overdue payment
GrafanaURL String Grafana dashboard URL
Note: This field may return null, indicating that no valid values can be obtained.
CreatedAt String Creation time
EnableGrafana Integer Whether Grafana is enabled
  • 0: Disabled
  • 1: Enabled
    		•
    IPv4Address String Instance IPv4 address
    Note: This field may return null, indicating that no valid values can be obtained.
    TagSpecification Array of PrometheusTag List of tags associated with the instance.
    Note: This field may return null, indicating that no valid values can be obtained.
    ExpireTime String Expiration time of the purchased instance
    Note: This field may return null, indicating that no valid values can be obtained.
    ChargeStatus Integer Billing status

    • 1: Normal
    • 2: Expired
    • 3: Terminated
    • 4: Assigning
    • 5: Assignment failed


    Note: This field may return null, indicating that no valid values can be obtained.
    SpecName String Specification name
    Note: This field may return null, indicating that no valid values can be obtained.
    AutoRenewFlag Integer Auto-renewal flag

    • 0: Auto-renewal not enabled
    • 1: Auto-renewal enabled
    • 2: Auto-renewal prohibited
    • -1: Invalid

    Note: This field may return null, indicating that no valid values can be obtained.
    IsNearExpire Integer Expiring soon

    • 0: No
    • 1: Yes


    Note: This field may return null, indicating that no valid values can be obtained.
    AuthToken String The token required for data writing
    Note: This field may return null, indicating that no valid values can be obtained.
    RemoteWrite String Prometheus remote write address
    Note: This field may return null, indicating that no valid values can be obtained.
    ApiRootPath String Prometheus HTTP API root address
    Note: This field may return null, indicating that no valid values can be obtained.
    ProxyAddress String Proxy address
    Note: This field may return null, indicating that no valid values can be obtained.
    GrafanaStatus Integer Grafana status

    • 1: Creating
    • 2: Running
    • 3: Abnormal
    • 4: Restarting
    • 5: Terminating
    • 6: Service suspended
    • 7: Deleted


    Note: This field may return null, indicating that no valid values can be obtained.
    GrafanaIpWhiteList String Grafana IP allowlist, where IPs are separated by comma.
    Note: This field may return null, indicating that no valid values can be obtained.
    Grant PrometheusInstanceGrantInfo Instance authorization information
    Note: This field may return null, indicating that no valid values can be obtained.
    GrafanaInstanceId String ID of the bound Grafana instance
    Note: This field may return null, indicating that no valid values can be obtained.
    AlertRuleLimit Integer The alert rule limit
    Note: This field may return null, indicating that no valid values can be obtained.
    RecordingRuleLimit Integer The recording rule limit
    Note: This field may return null, indicating that no valid values can be obtained.
    MigrationType Integer Migration status. 0: Not migrating; 1: Migrating from source instance; 2: Migrating to target instance.
    Note: This field may return null, indicating that no valid values can be obtained.

    PrometheusInstancesOverview

    TMP v2 instance overview

    Used by actions: DescribePrometheusInstancesOverview.

    Name Type Description
    InstanceId String Instance ID
    InstanceName String Instance name
    VpcId String VPC ID
    SubnetId String Subnet ID
    InstanceStatus Integer Running status. Valid values: 1 (creating); 2 (running); 3 (abnormal); 4 (restarting); 5 (terminating); 6 (stopped); 7 (deleted).
    ChargeStatus Integer Billing status. Valid values: 1 (normal); 2 (expired); 3 (terminated); 4 (assigning); 5 (failed to assign)
    Note: This field may return null, indicating that no valid values can be obtained.
    EnableGrafana Integer Whether Grafana is enabled. Valid values: 0 (no); 1 (yes).
    GrafanaURL String Grafana dashboard URL
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceChargeType Integer Instance payment type. Valid values: 1 (trial edition); 2 (prepaid)
    SpecName String Specification name
    Note: This field may return null, indicating that no valid values can be obtained.
    DataRetentionTime Integer Storage period
    Note: This field may return null, indicating that no valid values can be obtained.
    ExpireTime String Expiration time of the purchased instance
    Note: This field may return null, indicating that no valid values can be obtained.
    AutoRenewFlag Integer Auto-renewal flag. Valid values: 0 (auto-renewal not enabled); 1 (auto-renewal enabled); 2 (auto-renewal prohibited); -1 (invalid).
    Note: This field may return null, indicating that no valid values can be obtained.
    BoundTotal Integer Total number of bound clusters
    BoundNormal Integer Total number of bound clusters in the normal status
    ResourcePackageStatus Integer Resource pack status (0: Unavailable; 1: Available)
    Note: This field may return null, indicating that no valid values can be obtained.
    ResourcePackageSpecName String Resource pack specification name
    Note: This field may return null, indicating that no valid values can be obtained.

    PrometheusJobTargets

    Targets of a Prometheus job

    Used by actions: DescribePrometheusTargetsTMP.

    Name Type Description

    PrometheusNotificationItem

    Alert notification channel configuration

    Used by actions: CreatePrometheusAlertPolicy, CreatePrometheusGlobalNotification, DescribePrometheusAlertPolicy, DescribePrometheusGlobalNotification, ModifyPrometheusAlertPolicy, ModifyPrometheusGlobalNotification, ModifyPrometheusTemp.

    Name Type Required Description
    Enabled Boolean Yes Whether it is enabled
    Type String Yes Channel type. Default value: amp. Valid values:
    amp
    webhook
    alertmanager
    WebHook String No If Type is webhook, this field is required.
    Note: This field may return null, indicating that no valid values can be obtained.
    AlertManager PrometheusAlertManagerConfig No If Type is alertmanager, this field is required.
    Note: This field may return null, indicating that no valid values can be obtained.
    RepeatInterval String No Convergence time
    TimeRangeStart String No Effect start time
    TimeRangeEnd String No Effect end time
    NotifyWay Array of String No Alert notification channel. Valid values: SMS, EMAIL, CALL, WECHAT.
    Note: This field may return null, indicating that no valid values can be obtained.
    ReceiverGroups Array of String No Alert recipient group (user group)
    Note: This field may return null, indicating that no valid values can be obtained.
    PhoneNotifyOrder Array of Integer No Alert call sequence.
    Note: If NotifyWay is CALL, this parameter will be used.
    Note: This field may return null, indicating that no valid values can be obtained.
    PhoneCircleTimes Integer No Number of alert calls.
    Note: If NotifyWay is CALL, this parameter will be used.
    Note: This field may return null, indicating that no valid values can be obtained.
    PhoneInnerInterval Integer No Alert call interval within a cycle in seconds.
    Note: If NotifyWay is CALL, this parameter will be used.
    Note: This field may return null, indicating that no valid values can be obtained.
    PhoneCircleInterval Integer No Alert call cycle interval in seconds.
    Note: If NotifyWay is CALL, this parameter will be used.
    Note: This field may return null, indicating that no valid values can be obtained.
    PhoneArriveNotice Boolean No Alert call receipt notification
    Note: If NotifyWay is CALL, this parameter will be used.
    Note: This field may return null, indicating that no valid values can be obtained.

    PrometheusRecordRuleYamlItem

    Details of the Prometheus recording rule instance, including the cluster ID.

    Used by actions: DescribePrometheusRecordRules.

    Name Type Description
    Name String Instance name
    UpdateTime String Last update time
    TemplateId String YAML content
    Content String If the recording rule comes from a template, TemplateId is the template ID.
    Note: This field may return null, indicating that no valid values can be obtained.
    ClusterId String If the recording rule comes from the user cluster CRD resource definition, ClusterId is the cluster ID.
    Note: This field may return null, indicating that no valid values can be obtained.
    Status Integer Status
    Note: This field may return null, indicating that no valid values can be obtained.
    Id String id
    Note: This field may return null, indicating that no valid values can be obtained.
    Count Integer Number of rules
    Note: This field may return null, indicating that no valid values can be obtained.

    PrometheusRuleKV

    KV parameter of the Prometheus alerting rule

    Used by actions: CreateAlertRule, DescribeAlertRules, UpdateAlertRule.

    Name Type Required Description
    Key String Yes Key
    Value String Yes Value

    PrometheusRuleSet

    Set of Prometheus alerting rules

    Used by actions: DescribeAlertRules.

    Name Type Description
    RuleId String Rule ID
    RuleName String Rule name
    RuleState Integer Rule status code
    Type String Rule category
    Note: This field may return null, indicating that no valid values can be obtained.
    Labels Array of PrometheusRuleKV List of rule tags
    Note: This field may return null, indicating that no valid values can be obtained.
    Annotations Array of PrometheusRuleKV List of rule annotations
    Note: This field may return null, indicating that no valid values can be obtained.
    Expr String Rule expression
    Note: This field may return null, indicating that no valid values can be obtained.
    Duration String Rule alert duration
    Note: This field may return null, indicating that no valid values can be obtained.
    Receivers Array of String List of alert recipient groups
    Note: This field may return null, indicating that no valid values can be obtained.
    Health String Rule status. Valid values:
  • unknown: Unknown
  • pending: Loading
  • ok: Running
  • err: Error
    		•
    CreatedAt String Rule creation time
    Note: This field may return null, indicating that no valid values can be obtained.
    UpdatedAt String Rule update time
    Note: This field may return null, indicating that no valid values can be obtained.

    PrometheusScrapeJob

    Prometheus scrape task

    Used by actions: DescribePrometheusScrapeJobs.

    Name Type Description
    Name String Task name
    Note: This field may return null, indicating that no valid values can be obtained.
    AgentId String Agent ID
    JobId String Task ID
    Config String Configuration
    Note: This field may return null, indicating that no valid values can be obtained.

    PrometheusTag

    TMP tag

    Used by actions: CreateGrafanaInstance, CreatePrometheusMultiTenantInstancePostPayMode, DescribeGrafanaInstances, DescribePrometheusInstances.

    Name Type Required Description
    Key String Yes Tag key
    Value String Yes Tag value
    Note: This field may return null, indicating that no valid values can be obtained.

    PrometheusTemp

    Template instance

    Used by actions: CreatePrometheusTemp, DescribePrometheusTemp.

    Name Type Required Description
    Name String Yes Template name
    Level String Yes Template dimension. Valid values:
    instance
    cluster
    Describe String No Template description
    Note: This field may return null, indicating that no valid values can be obtained.
    RecordRules Array of PrometheusConfigItem No This parameter is valid if Level is instance.
    List of recording rules in the template
    Note: This field may return null, indicating that no valid values can be obtained.
    ServiceMonitors Array of PrometheusConfigItem No This parameter is valid if Level is cluster.
    List of ServiceMonitor rules in the template.
    Note: This field may return null, indicating that no valid values can be obtained.
    PodMonitors Array of PrometheusConfigItem No This parameter is valid if Level is cluster.
    List of PodMonitor rules in the template.
    Note: This field may return null, indicating that no valid values can be obtained.
    RawJobs Array of PrometheusConfigItem No This parameter is valid if Level is cluster.
    List of RawJob rules in the template.
    Note: This field may return null, indicating that no valid values can be obtained.
    TemplateId String No Template ID, which is used as an output parameter.
    Note: This field may return null, indicating that no valid values can be obtained.
    UpdateTime String No Last update time, which is used as an output parameter.
    Note: This field may return null, indicating that no valid values can be obtained.
    Version String No The current version, which is used as an output parameter.
    Note: This field may return null, indicating that no valid values can be obtained.
    IsDefault Boolean No Whether it is the default template provided by the system, which is used as an output parameter.
    Note: This field may return null, indicating that no valid values can be obtained.
    AlertDetailRules Array of PrometheusAlertPolicyItem No This parameter is valid if Level is instance.
    List of alert configurations in the template
    Note: This field may return null, indicating that no valid values can be obtained.
    TargetsTotal Integer No Number of associated instances
    Note: This field may return null, indicating that no valid values can be obtained.

    PrometheusTempModify

    Modifiable items in the TMP template

    Used by actions: ModifyPrometheusTemp.

    Name Type Required Description
    Name String No Name
    Describe String No Description
    Note: This field may return null, indicating that no valid values can be obtained.
    ServiceMonitors Array of PrometheusConfigItem No This parameter is valid if Level is cluster.
    List of ServiceMonitor rules in the template.
    Note: This field may return null, indicating that no valid values can be obtained.
    PodMonitors Array of PrometheusConfigItem No This parameter is valid if Level is cluster.
    List of PodMonitor rules in the template.
    Note: This field may return null, indicating that no valid values can be obtained.
    RawJobs Array of PrometheusConfigItem No This parameter is valid if Level is cluster.
    List of RawJob rules in the template.
    Note: This field may return null, indicating that no valid values can be obtained.
    RecordRules Array of PrometheusConfigItem No This parameter is valid if Level is instance.
    List of recording rules in the template
    Note: This field may return null, indicating that no valid values can be obtained.
    AlertDetailRules Array of PrometheusAlertPolicyItem No Modification content, which is valid only if template type is Alert.
    Note: This field may return null, indicating that no valid values can be obtained.

    PrometheusTemplateSyncTarget

    Sync target of the TMP template

    Used by actions: DeletePrometheusTempSync, DescribePrometheusTempSync, SyncPrometheusTemp.

    Name Type Required Description
    Region String Yes Target region
    InstanceId String Yes Target instance
    ClusterId String No Cluster ID, which is required only if the Level of the collection template is cluster.
    Note: This field may return null, indicating that no valid values can be obtained.
    SyncTime String No Last sync time, which is used as an output parameter.
    Note: This field may return null, indicating that no valid values can be obtained.
    Version String No The currently used template version, which is used as an output parameter.
    Note: This field may return null, indicating that no valid values can be obtained.
    ClusterType String No Cluster type, which is required only if the Level of the collection template is cluster.
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceName String No Instance name, which is used as an output parameter.
    Note: This field may return null, indicating that no valid values can be obtained.
    ClusterName String No Cluster name, which is used as an output parameter.
    Note: This field may return null, indicating that no valid values can be obtained.

    PrometheusZoneItem

    Region information returned by PrometheusZoneItem

    Used by actions: DescribePrometheusZones.

    Name Type Description
    Zone String AZ
    ZoneId Integer AZ ID
    ZoneState Integer AZ status. Valid values: 0(Unavailable), 1 (Available).
    RegionId Integer Region ID
    ZoneName String AZ name

    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 phone call alarm.
    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 API.
    ReceiverUserList Array of Integer No Recipient list. The list of recipient IDs that is queried by API.
    ReceiveLanguage String No Language of received alarms. Enumerated values: zh-CN and en-US.

    RecordingRuleSet

    Response structure information of the Prometheus recording rule

    Used by actions: DescribeRecordingRules.

    Name Type Description
    RuleId String Rule ID
    RuleState Integer Rule status code
    Name String Group name
    Group String Rule group
    Total Integer Number of rules
    CreatedAt String Rule creation time
    UpdatedAt String Rule update time
    RuleName String Rule name
    Note: This field may return null, indicating that no valid values can be obtained.

    ServiceDiscoveryItem

    Prometheus scrape configuration information

    Used by actions: CreateServiceDiscovery, DescribeServiceDiscovery.

    Name Type Description
    Name String Scrape configuration name
    Namespace String Namespace of the scrape configuration
    Kind String Scrape configuration type: ServiceMonitor/PodMonitor
    NamespaceSelector String Namespace selection method
    Note: This field may return null, indicating that no valid values can be obtained.
    Selector String Label selection method
    Note: This field may return null, indicating that no valid values can be obtained.
    Endpoints String Endpoints information (PodMonitor does not have this parameter)
    Yaml String Scrape configuration information
    Note: This field may return null, indicating that no valid values can be obtained.

    Tag

    Tag

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

    Name Type Required Description
    Key String Yes Tag key
    Value String Yes Tag value

    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.

    Targets

    Number of scrape targets

    Used by actions: CreatePrometheusConfig, DescribePrometheusConfig, DescribePrometheusGlobalConfig, ModifyPrometheusConfig, ModifyPrometheusTemp.

    Name Type Required Description
    Total Integer No The total count
    Note: This field may return null, indicating that no valid values can be obtained.
    Up Integer No Number of online targets
    Note: This field may return null, indicating that no valid values can be obtained.
    Down Integer No Number of offline targets
    Note: This field may return null, indicating that no valid values can be obtained.
    Unknown Integer No Number of unknown status
    Note: This field may return null, indicating that no valid values can be obtained.

    TaskStepInfo

    Task step information

    Used by actions: DescribePrometheusInstanceInitStatus.

    Name Type Description
    Step String Step name
    LifeState String Lifecycle
    pending
    running
    success
    failed
    StartAt String Step start time
    Note: This field may return null, indicating that no valid values can be obtained.
    EndAt String Step end time
    Note: This field may return null, indicating that no valid values can be obtained.
    FailedMsg String If LifeState is failed, this field displays the error message.
    Note: This field may return null, indicating that no valid values can be obtained.

    TemplateGroup

    Template list

    Used by actions: DescribeConditionsTemplateList.

    Name Type Description
    Conditions Array of Condition Metric alarm rules.
    Note: This field may return null, indicating that no valid values can be obtained.
    EventConditions Array of EventCondition Event alarm rules.
    Note: This field may return null, indicating that no valid values can be obtained.
    PolicyGroups Array of PolicyGroup The associated alarm policy groups.
    Note: This field may return null, indicating that no valid values can be obtained.
    GroupID Integer Template-based policy group ID.
    GroupName String Template-based policy group name.
    InsertTime Integer Creation time.
    LastEditUin Integer UIN of the last modifier.
    Remark String Remarks.
    UpdateTime Integer Update time.
    ViewName String View.
    IsUnionRule Integer Whether the logical relationship between rules is AND.

    Toleration

    Kubernetes taint

    Used by actions: CreatePrometheusClusterAgent.

    Name Type Required Description
    Key String No Key of the taint to which the toleration is applied
    Operator String No The key-value relationship
    Effect String No The taint effect to be matched

    URLNotice

    Alarm notification template – callback notification details

    Used by actions: CreateAlarmNotice, DescribeAlarmNotice, DescribeAlarmNoticeCallbacks, DescribeAlarmNotices, 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.
    StartTime Integer No Start time of the notification in seconds, which is calculated from 00:00:00.
    Note: this field may return null, indicating that no valid values can be obtained.
    EndTime Integer No End time of the notification in seconds, which is calculated from 00:00:00.
    Note: this field may return null, indicating that no valid values can be obtained.
    Weekday Array of Integer No Notification cycle. The values 1-7 indicate Monday to Sunday.
    Note: This field may return null, indicating that no valid values can be obtained.

    UserNotice

    Alarm notification template - user notification details

    Used by actions: CreateAlarmNotice, DescribeAlarmNotice, DescribeAlarmNotices, 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), RTX (WeCom)
    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.
    PhoneCallType String No Dial type. SYNC (simultaneous dial), CIRCLE (polled dial). Default value: CIRCLE.
    Note: This field may return null, indicating that no valid values can be obtained.
    Weekday Array of Integer No Notification cycle. The values 1-7 indicate Monday to Sunday.
    Note: This field may return null, indicating that no valid values can be obtained.
    OnCallFormIDs Array of String No List of schedule IDs
    Note: This field may return null, indicating that no valid values can be obtained.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback

    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support