Tenant Cloud Monitor and Operation Cloud Monitor Data structure

Data structure

Last Updated At: 2026-08-02 00:06:15

DescribePolicyQuotaV3ResponseDataQuotaList

Referenced by the following interfaces: DescribePolicyQuota

name	required	NULL allowed	type	description
Used	yes	no	Int64	User. Example: 10
Total	yes	no	Int64	Total number. Example: 10
ProjectID	yes	no	Int64	Project ID. Example: 10

BindingPolicyObjectDimension

Dimensions of instances bound to a policy

Referenced by the following interfaces: BindingPolicyObject, CreateInstanceGroup, DescribeInstanceGroup, ModifyInstanceGroup, ShieldPolicyAlarm

name	required	NULL allowed	type	description
RegionId	no	no	Int64	Region ID. Example: 1
Region	yes	no	String	Region name. Example: gz
Dimensions	no	no	String	Dimension information Example: {"unInstanceId":"ins-00jvv9mo"}
EventDimensions	no	no	String	Event dimension information. Example: {"uuid":"c734cd0d-d050-44bd-8d17-f6381039b4b6"}

CustomAlarmList

Referenced by the following interfaces: DescribeCustomAlarmList

name	required	NULL allowed	type	description
LocalIP	yes	no	String	IP Example: 127.0.0.1
Msg	yes	no	String	Message. Example: ok
OccurTime	yes	no	String	Event time. Example: 1735041205
Caller	yes	no	String	Caller. Example: remote

MetricTooltip

Rich text prompt for the metric.

Referenced by the following interfaces: DescribeAlarmEvents, DescribeAlarmHistories, DescribeAlarmMetrics, DescribeMiniDashboardAlarmInfo

name	required	NULL allowed	type	description
Message	yes	no	String	Text command. Example: This metric indicates the CPU utilization of this instance.
URL	yes	no	String	Details link. Example: https://convergecloud.com/
UrlName	yes	no	String	Link name. Example: View Details

DescribeAlarmCallbackHistory

Historical callback information.

Referenced by the following interfaces: DescribeAlarmCallbackHistory

name	required	NULL allowed	type	description
Url	yes	no	String	Callback address Example: http://test.com
ValidFlag	yes	no	Int64	Whether the callback is validated. Example: 1
VerifyCode	yes	no	String	Callback address verification code. Example: 1131ad

DescribePolicyGroupListGroupInstanceGroup

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

Referenced by the following interfaces: DescribePolicyGroupList

name	required	NULL allowed	type	description
InstanceGroupId	yes	no	Int64	Instance group name ID. Example: 1234
ViewName	yes	no	String	Policy type view name. Example: cvm_device
LastEditUin	yes	no	String	UIN of the last editor. Example: 123456
GroupName	yes	no	String	Instance group name. Example: Testing
InstanceSum	yes	no	Int64	Number of instances. Example: 10
UpdateTime	yes	no	Int64	Update time. Example: 1735095122
InsertTime	yes	no	Int64	Creation time. Example: 1735095122

DescribeAbnormalObjectsThresholdObject

Metric alarm exception object returned by the DescribeAbnormalObjects API.

Referenced by the following interfaces: DescribeAbnormalObjects

name	required	NULL allowed	type	description
Id	yes	no	Int64	Alarm ID. Example: 1
RuleId	yes	no	Int64	Alarm rule ID. Example: 10
GroupId	yes	no	Int64	Policy group ID. Example: 1234
GroupName	yes	no	String	Policy group name. Example: Testing
ProjectId	yes	yes	Int64	Project ID. Example: 1
Status	yes	no	Int64	Alarm status. Example: 1
Content	yes	no	String	The alarm content. Example: qwer
FirstOccurTime	yes	no	String	Time of first occurrence. Example: 1735041205
LastOccurTime	yes	no	String	Time of last occurrence. Example: 1735041205
Dimensions	yes	no	String	Dimension combination. JSON string. Example: {"unInstanceId":"ins-xxx"}
UniqueId	yes	no	String	Dimension combination md5. Example: eqeq-czda
AbnormalStatus	yes	no	String	Alarm status: "abnormal" indicates that the alarm has not been recovered, and "warning" indicates that the alarm has been recovered. Example: abnormal
InstanceId	yes	no	String	Object ID. Example: ins-00jvv9mo

DescribePolicyConditionListConfigManualPeriod

DescribePolicyConditionList.ConfigManual.Period

Referenced by the following interfaces: DescribePolicyConditionList

name	required	NULL allowed	type	description
Default	yes	yes	Int64	Default period in seconds. Example: 10
Keys	yes	yes	Array of Int64	Custom period in seconds. Example: 10
Need	yes	no	Bool	Whether required. Example: true

DescribeBaseMetricsDataPeriod

Referenced by the following interfaces: DescribeBaseMetricsForConsoleFontEnd

name	required	NULL allowed	type	description
Period	yes	no	Uint64	Interval. Example: 60
StatType	yes	yes	Array of String	Statistical method. Example: ["avg"]

AttributeInfoInput

Attribute information.

Referenced by the following interfaces: CreateAttributes

name	required	NULL allowed	type	description
AttributeName	yes	no	String	Attribute name. Example: Testing
AttributeTypeId	no	no	Uint64	The type. Example: 1
DataType	yes	no	Int64	Attribute data type. Example: 1
AttributeLevel	no	no	Int64	Attribute level. Example: 1
Unit	no	no	Int64	Attribute unit. Example: 1
StatisticalPeriod	no	no	Int64	Statistical period. Example: 60
OwnerId	no	no	Array of Uint64	Owner list ID. The sub_uin of the logged in user is used by default. Example: 1234
Description	no	no	String	Description. Example: Testing
AttributeUniqueName	yes	no	String	Unique name of the attribute. It consists of letters, digits, hyphens or underscores. Example: qwer_123

CgrpModuleNode

Group leaf node data structure.

Referenced by the following interfaces: CreateModule, DeleteModule, DescribeModule, ModifyModule

name	required	NULL allowed	type	description
AppId	no	yes	Int64	AppId Example: 1234
High	no	yes	Int64	Grouping tree height. Example: 1
Id	yes	no	Int64	Leaf group ID. Example: 1
L1Id	no	yes	Int64	Level-1 group ID. Example: 1
L1Name	no	yes	String	Level-1 group name. Example: Testing
L2Id	no	yes	Int64	Level-2 group ID. Example: 1
L2Name	no	yes	String	Level-2 group name. Example: Testing
L3Id	no	yes	Int64	Level-3 group ID. Example: 1
L3Name	no	yes	String	Level-3 group name. Example: Testing
Name	no	yes	String	Leaf group name. Example: Testing
OwnerBack	no	yes	String	Backup owner. Example: qwer123
OwnerMain	no	yes	String	Major owner. Example: qwer123
ParentId	yes	no	Int64	Parent group ID. Example: 1
SubUin	no	yes	String	SubUin Example: 123456
TypeId	yes	no	String	Type of the instance that is allowed to be added to the leaf group. Example: cvm_device
Uin	no	yes	String	Uin Example: 123456

DimensionsDesc

Dimension information

Referenced by the following interfaces: DescribeBaseMetrics

name	required	NULL allowed	type	description
Dimensions	yes	no	Array of String	Array of dimension names. Example: ["vm_uuid"]

GroupIdTag

1.0 policy ID, tag.

Referenced by the following interfaces: DescribeGroupIDByTags

name	required	NULL allowed	type	description
GroupIDList	yes	no	Array of String	1.0 policy ID. Example: ["123456"]
Key	yes	no	String	Tag key. Example: qwer
Value	yes	no	String	Tag value. Example: qwer

DescribeBindingPolicyObjectListInstance

Object instance information returned by the DescribeBindingPolicyObjectListInstance API.

Referenced by the following interfaces: DescribeBindingPolicyObjectList

name	required	NULL allowed	type	description
UniqueId	yes	no	String	Unique ID of the object. Example: eqeq-czda
Dimensions	yes	no	String	Dimension set of an object instance, which is a jsonObj string. Example: {"unInstanceId":"ins-xxx"}
IsShielded	yes	no	Int64	Whether the object is shielded. The value 0 indicates that the object is not shielded. The value 1 indicates that the object is shielded. Example: 1
Region	yes	no	String	Region where the object resides. Example: gz

Contact

Recipient information returned by the DescribeContactList API.

Referenced by the following interfaces: DescribeContactList

name	required	NULL allowed	type	description
Uid	yes	no	Int64	uid Example: 1
Uin	yes	no	String	uin Example: 123456
Name	yes	no	String	Recipient name. Example: Testing
CanLogin	yes	no	Int64	Whether you can log in. 0: you can't log in. 1: you can log in. Example: 1
PhoneFlag	yes	no	Int64	Whether the mobile phone number is verified. Example: 1
PhoneNum	yes	no	String	The mobile phone. Example: 10
EmailFlag	yes	no	Int64	Whether the email is verified. Example: 1
Email	yes	no	String	Email. Example: 123@com
IsReceiverOwner	yes	no	Int64	Whether it is the person in charge of receiving. Example: 123456
OwnerUid	yes	no	Int64	ownerUid Example: 123456

ClmMetricAnalysisBasicMetric

Basic metric parameters in CLM metric analysis.

Referenced by the following interfaces: DescribeMetricAnalysisData

name	required	NULL allowed	type	description
Operator	yes	no	String	Operator. Example: =
Name	yes	no	String	Metric name. Example: Testing

DescribePolicyConditionListMetric

Metric alarm configuration.

Referenced by the following interfaces: DescribePolicyConditionList

name	required	NULL allowed	type	description
ConfigManual	yes	yes	DescribePolicyConditionListConfigManual	Metric configuration Example:View
MetricId	yes	no	Int64	Metric ID. Example: 10
MetricShowName	yes	no	String	Metric name. Example: cvm_device
MetricUnit	yes	no	String	Metric unit. Example: %

CvmAgentStatus

Agent status returned by the DescribeCvmAgentStatus API.

Referenced by the following interfaces: DescribeCvmAgentStatus

name	required	NULL allowed	type	description
InstanceId	yes	no	String	Instance ID. Example: ins-00jvv9mo
AgentInstalled	yes	no	Bool	Whether the agent is installed. Example: false

DescribeBindingPolicyObjectListDimension

Dimensions of the DescribeBindingPolicyObjectList API

Referenced by the following interfaces: DescribeBindingPolicyObjectList

name	required	NULL allowed	type	description
RegionId	yes	no	Int64	Region ID. Example: 1
Region	yes	no	String	Region name abbreviation. Example: gz
Dimensions	yes	no	String	Combined JSON string of dimensions. Example: {"unInstanceId":"ins-xxx"}
EventDimensions	yes	no	String	Combined JSON string of event dimensions. Example: {"unInstanceId":"ins-xxx"}

CgrpInstanceGroupNode

Group array in which the instance is located.

Referenced by the following interfaces: CreateInstances, DeleteInstances, DescribeInstance

name	required	NULL allowed	type	description
Id	no	yes	Int64	The group ID. Example: 1
Name	no	yes	String	Group name. Example: test

AttributeUnitInfoOutputData

Referenced by the following interfaces: DescribeAttributeUnits

name	required	NULL allowed	type	description
Data	yes	no	Array of AttributeUnitInfoOutput	Attribute unit data list. Example:View
TotalCount	yes	no	Int64	Number of attribute unit data lists. Example: 10

DescribeMonitorDataByAlarmIDDataPoint

Referenced by the following interfaces: DescribeMonitorDataByAlarmID

name	required	NULL allowed	type	description
IsNull	yes	no	Bool	Whether it is empty. Example: true
Value	yes	no	Float	Value. Example: 10

ServerInfoData

Referenced by the following interfaces: DescribeServers

name	required	NULL allowed	type	description
Data	yes	no	Array of ServerInfo	Return data. Example:View
TotalCount	yes	no	Int64	Total number. Example: 10

ModifyConditionsTemplateRequestEventCondition

Referenced by the following interfaces: CreateConditionsTemplate, ModifyConditionsTemplate

name	required	NULL allowed	type	description
AlarmNotifyPeriod	yes	no	String	Alarm notification cycle. Example: 5
AlarmNotifyType	yes	no	String	Alarm notification method. Example: sms
EventID	yes	no	String	Event ID. Example: 10
RuleID	no	no	Int64	Rule ID. Example: 10

DescribeAgentStatusHistoryData

Referenced by the following interfaces: DescribeAgentStatusHistory

name	required	NULL allowed	type	description
UnInstanceID	yes	no	String	Instance ID. Example: ins-00jvv9mo
Status	yes	no	Int64	CVM status. Example: 1
Histories	yes	no	Array of DescribeAgentStatusHistory	Historical data. Example:View

NoticeContentTmplItem

Elements in the notification content template.

Referenced by the following interfaces: CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl

name	required	NULL allowed	type	description
CustomCallback	no	no	Array of CustomCallbackTmplMatcher	Custom notification channel configuration. Example:View

MetricConfig

Metric configuration

Referenced by the following interfaces: DescribeAlarmMetrics

name	required	NULL allowed	type	description
Operator	yes	no	Array of String	Allowed operator. Example: =
Period	yes	no	Array of Int64	Allowed data cycle in seconds. Example: 5
ContinuePeriod	yes	no	Array of Int64	Allowed number of consecutive periods. Example: 5

PCLMDimension

Metric set dimension object for log monitoring.

Referenced by the following interfaces: CLMDescribeMetricSets

name	required	NULL allowed	type	description
Field	yes	no	String	Field name. Example: timeField
CreatedAt	no	no	String	Creation time (only for output parameter; leave it empty for input parameter) Example: qwer
UpdatedAt	no	no	String	Update time (only for output parameter; leave it empty for input parameter) Example: qwer
MetricSetCID	no	no	String	Metric set CID (only for output parameter; leave it empty for input parameter). Example: cid-xxx

TemplateGroup

Template list

Referenced by the following interfaces: DescribeConditionsTemplateList

name	required	NULL allowed	type	description
Conditions	yes	yes	Array of Condition	Metric alarm rule. Example:View
EventConditions	yes	yes	Array of EventCondition	Event alarm rule. Example:View
PolicyGroups	yes	yes	Array of PolicyGroup	Associated alarm policy group. Example:View
GroupID	yes	no	Int64	Template-based policy group ID. Example: 1
GroupName	yes	no	String	Template-based policy group name. Example: test
InsertTime	yes	no	Int64	Creation time. Example: 11
LastEditUin	yes	no	Int64	UIN of the last user who modified it. Example: 1
Remark	yes	no	String	Description. Example: test
UpdateTime	yes	no	Int64	Update time. Example: 1
ViewName	yes	no	String	View. Example: cvm_device
IsUnionRule	yes	no	Int64	Whether the AND rule is used. Example: 1

NoticeContentTmplBindPolicyCount

Number of alarm policies bound to the notification content template.

Referenced by the following interfaces: DescribeNoticeContentTmpl

name	required	NULL allowed	type	description
NoticeContentTmplID	no	no	String	Notification template ID Example: tmpl-xxx
BindCount	no	no	Uint64	Number of bound alarm policies. Example: 1

MonitorSelectedDimension

Dimension selected.

Referenced by the following interfaces: DescribeDashboardDimensionValues

name	required	NULL allowed	type	description
DimensionName	no	no	String	Dimension name. Example: Testing
DimensionValue	no	no	String	The value of the dimension. Example: 100

ClmMetricCustomItem

Compound metric configurations for the log monitoring metric set.

Referenced by the following interfaces: CreateMetricSet, DescribeMetricSet, DescribeMetricSets, ModifyMetricSet

name	required	NULL allowed	type	description
Formula	yes	no	String	Expression. Example: {"cluster_name":"es-dnxsssss"}
Name	yes	no	String	Metric name. Example: Testing
Desc	yes	no	String	Metric description name. Example: Testing
Id	no	no	Int64	Item ID (only for output parameter; leave it empty for input parameter) Example: 1
MetricSetId	no	no	Int64	Metric set ID (only for output parameter; leave it empty for input parameter) Example: 12
CreatedAt	no	no	String	Creation time (only for output parameter; leave it empty for input parameter) Example: eqeadfrqc
UpdatedAt	no	no	String	Update time (only for output parameter; leave it empty for input parameter) Example: eqeadfrqc

ServiceInfo

Referenced by the following interfaces: CreateService, DescribeService

name	required	NULL allowed	type	description
ServiceId	yes	yes	Int64	Service ID. Example: 1
IsOpen	yes	yes	Int64	Whether to enable the service. Example: 1
ViewId	yes	yes	Int64	Default view ID. Example: 10

ModifyPolicyGroupEventCondition

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

Referenced by the following interfaces: ModifyPolicyGroup

name	required	NULL allowed	type	description
RuleId	no	no	Int64	Rule ID. No filling means new addition while filling in ruleId means to modify existing rules. Example: 12
EventId	yes	no	Int64	Event ID. Example: 12
AlarmNotifyType	yes	no	Int64	Alarm sending and converging type. The value 0 indicates that alarms are sent consecutively. The value 1 indicates that alarms are sent exponentially. Example: 1
AlarmNotifyPeriod	yes	no	Int64	Alarm sending period in seconds. The value u003c0 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. Example: 5

DescribeProductEventListEvents

Events returned by the DescribeProductEventList API

Referenced by the following interfaces: DescribeProductEventList

name	required	NULL allowed	type	description
EventId	yes	yes	Int64	Event ID. Example: 111
EventCName	yes	yes	String	The name of an event. Example: Unreachable by ping
EventEName	yes	yes	String	English name of an event. Example: ping_unreachable
EventName	yes	yes	String	Abbreviated name of an event. Example: ping_unreachable
ProductCName	yes	yes	String	The name of the product. Example: cvm
ProductEName	yes	yes	String	The product name. Example: cvm
ProductName	yes	yes	String	Product Name Abbreviation Example: cvm
InstanceId	yes	yes	String	Instance ID. Example: ins-3xdfd90
InstanceName	yes	yes	String	Instance name. Example: ins-3xdfd90
ProjectId	yes	yes	String	Project ID. Example: 123
Region	yes	yes	String	Region. Example: gz
Status	yes	yes	String	State. Example: 1
SupportAlarm	yes	yes	Int64	Specifies whether to support alarm notifications. Example: 1
Type	yes	yes	String	Event type. Example: 21
StartTime	yes	yes	Int64	Start time. Example: 1611560738
UpdateTime	yes	yes	Int64	Update time. Example: 1611560790
Dimensions	yes	yes	Array of DescribeProductEventListEventsDimensions	Information about an instance object. Example:View
AdditionMsg	yes	yes	Array of DescribeProductEventListEventsDimensions	Additional information about an instance object. Example:View
IsAlarmConfig	yes	yes	Int64	Specifies whether to configure alarms. Example: 1
GroupInfo	yes	yes	Array of DescribeProductEventListEventsGroupInfo	Policy information Example:View

StrategyChannelInfo

Referenced by the following interfaces: ModifyStrategyChannels

name	required	NULL allowed	type	description
StrategyId	yes	no	Uint64	The ID of the alarm policy. Example: 10
AlarmChannel	no	no	Array of String	Alarm channel list. Example: sms

TransLogItem

Changelog returned by DescribeTransLog.

Referenced by the following interfaces: DescribeTransLog

name	required	NULL allowed	type	description
Id	yes	yes	Int64	Changelog ID. Example: 1
ModuleId	yes	yes	Int64	Module ID. Example: 1
LogData	yes	yes	String	Log information. JSON string. Example: qwer
CreateTime	yes	yes	Int64	Creation time. Example: 1735179378
LastEditUin	yes	yes	String	UIN of the last user who modified it. Example: 123456

ClmAlertFilterRule

Expired.

Referenced by the following interfaces: CreateAlertPolicy, DescribeAlertPolicies, DescribeAlertPolicy, ModifyAlertPolicy

name	required	NULL allowed	type	description
AlertPolicyId	yes	yes	Int64	Associated alarm policy ID. Example: 1234
Key	yes	yes	String	Filtered keywords. Example: qwer
Operating	yes	yes	String	Operator. Example: =
Value	yes	yes	String	Filter value (multiple values are separated by commas). Example: 1234
Id	no	yes	Int64	Filter condition ID. Example: 1
CreatedAt	no	yes	String	Creation time. Example: eqeadfrqc
UpdatedAt	no	yes	String	Update time. Example: eqeadfrqc

DescribeAccidentConfigAccidentTypeInfo

Event type of the DescribeAccidentConfig API.

Referenced by the following interfaces: DescribeAccidentConfig

name	required	NULL allowed	type	description
AccidentId	yes	no	Int64	Platform event ID. Example: 1
AccidentName	yes	no	String	Platform event name. Example: qwer
AccidentEnName	yes	no	String	Platform event name in English. Example: qwer

AttributeValueInfoOutput

Referenced by the following interfaces: DescribeServerData, DescribeViewData

name	required	NULL allowed	type	description
Values	yes	no	Array of AttributeTimestampValueOutput	Attribute value list. Example:View
StartTime	yes	no	String	Start time. Example: 1734950008
EndTime	yes	no	String	End time. Example: 1734953808
StartPosition	yes	no	Int64	Start position. Example: 1
EndPosition	yes	no	Int64	End position. Example: 1

ReceiverInfo

Recipient information.

Referenced by the following interfaces: ModifyAlarmReceivers

name	required	NULL allowed	type	description
Id	no	no	Int64	The ID. Example: 1234
StartTime	yes	no	Int64	Alarm period start time. Range: [0,86400). Remove the date after converting the time from UNIX timestamp to UTC+8 time. For example, 7200 means "10:0:0". Example: 1734953008
EndTime	yes	no	Int64	End time of the alarm period. The meaning is the same as that of StartTime. Example: 1734953808
NotifyWay	yes	no	Array of String	Alarm notification method. Valid values: "SMS", "SITE", "EMAIL", "CALL", and "WECHAT". Example: sms
SendFor	no	no	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). Example: qwer
UidList	no	no	Array of Int64	UID of the alarm call recipient. Example: 1234
RoundNumber	no	no	Int64	Number of alarm call rounds. Example: 1
PersonInterval	no	no	Int64	Alarm call intervals for individuals in seconds. Example: 1
RoundInterval	no	no	Int64	Intervals of alarm call rounds in seconds. Example: 1
RecoverNotify	no	no	Array of String	Notification method when an alarm is recovered. Valid value: SMS. Example: sms
NeedSendNotice	no	no	Int64	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. Example: 1
ReceiverType	yes	no	Array of String	Recipient type. Valid values: user, group. Example: group
ReceiverGroupList	no	no	Array of Int64	Recipient group list. The list of recipient group IDs that is queried by API. Example: [1234]
ReceiverUserList	no	no	Array of Int64	Recipient list. The list of recipient IDs that is queried by API. Example: [1234]

URLNotice

Cloud Monitor alarm notification template - callback notification details

Referenced by the following interfaces: CreateAlarmNotice, DescribeAlarmNotice, DescribeAlarmNoticeCallbacks, DescribeAlarmNotices, DescribeAlarmPolicies, DescribeAlarmPolicy, ModifyAlarmNotice

name	required	NULL allowed	type	description
URL	yes	yes	String	Callback URL, which can contain up to 256 characters. Example: http://www.123.com
IsValid	no	yes	Int64	Whether verification is passed. Valid values: 0 (no), 1 (yes). Example: 1
ValidationCode	no	yes	String	Verification code. Example: 82hf8t

StrategyStatesInfo

Referenced by the following interfaces: ModifyStrategyStates

name	required	NULL allowed	type	description
StrategyId	yes	no	Int64	The ID of the alarm policy. Example: 1
IsStart	yes	no	Int64	Enablement status. Default value: 1. 0: stopping. 1: starting. Example: 1

MetricData

DescribeMetricData output parameters

Referenced by the following interfaces: DescribeDataForMiniProgram, DescribeStatisticData

name	required	NULL allowed	type	description
MetricName	yes	no	String	None. Example: CpuUsage
Points	yes	no	String	None. Example: qwer

AlarmPolicyRule

Alarm policy trigger condition (shared by metrics and events and example values are separated by /).

Referenced by the following interfaces: CreateAlarmPolicy, DescribeAlarmPolicies, DescribeAlarmPolicy, ModifyAlarmPolicyCondition

name	required	NULL allowed	type	description
MetricName	no	no	String	Metric name. Example: CpuUsage/disk_readonly
AggregationDimensions	no	yes	Array of String	Aggregation dimension list (not passed for events). Example: ["sum"]
Period	no	no	Int64	Seconds. Statistical period (not passed for events). Example: 60
AggregateType	no	no	String	Data aggregation type. Multiple metrics may be involved due to compound conditions. Metrics are indicated in JSON format, such as {"report_metric_gauge":"last"} (not passed for events). Example: last
Operator	no	no	String	English operators intelligent = No intelligent detection for the 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 growth day_decrease = Day-on-day decline day_wave = Day-on-day fluctuation week_increase = Week-on-week growth week_decrease = Week-on-week decline week_wave = Week-on-week fluctuation cycle_increase = Month-on-month growth cycle_decrease = Month-on-month decline cycle_wave = Month-on-month fluctuation re = Regular expression matching (not passed for events) Example: gt
Value	no	no	String	Threshold (not passed for events). Example: 100
ContinuePeriod	no	no	Int64	Number of cycles. Continuous notification cycle. 1 = last for 1 cycle; 2 = last for 2 cycles... (not passed for events). Example: 1
NoticeFrequency	no	no	Int64	Seconds. Alarm interval: 0 = non-repeating; 300 = every 5 minutes; 600 = every 10 minutes; 900 = every 15 minutes; 1800 = every 30 minutes; 3600 = every 1 hour; 7200 = every 2 hours; 10800 = every 3 hours; 21600 = every 6 hours; 43200 = every 12 hours; 86400 = every day (not passed for events). Example: 300
IsPowerNotice	no	no	Int64	Whether the alarm frequency increases exponentially. 0 = no; 1 = yes (not passed for events). Example: 0
Filter	no	yes	AlarmPolicyFilter	Filter condition for a single trigger rule (not passed for events). Example:View
Description	no	no	String	Metric display name, which is used in the output parameter. Example: CPU utilization/read-only disks
Unit	no	no	String	Unit, which is used for output parameters (not passed for events). Example: %
RuleType	no	no	String	Trigger condition type. STATIC = static threshold; DYNAMIC = dynamic threshold (not passed for events). Example: STATIC
ValueMax	no	yes	String	ValueMax (not passed for events). Example: 0
ValueMin	no	yes	String	ValueMin (not passed for events). Example: 0

MonitorTypeInfo

Detailed Information of Monitoring Type

Referenced by the following interfaces: DescribeMonitorTypes

name	required	NULL allowed	type	description
Id	yes	no	String	Monitoring Type ID Example: 19023
Name	yes	no	String	Monitoring type. Example: MT_QCE
SortId	yes	no	Int64	Arrangement Order Example: 1

DescribePolicySituationAlarmSituation

Referenced by the following interfaces: DescribePolicySituation

name	required	NULL allowed	type	description
AlarmRuleCount	yes	no	Int64	Number of alarm rules. Example: 10
AlarmTouchCount	yes	no	Int64	Number of alarm deliveries. Example: 10

CCMInstanceAttributeDataOutput

Referenced by the following interfaces: DescribeCCMInstanceDatas

name	required	NULL allowed	type	description
AttributeId	yes	no	Uint64	Metric ID. Example: 1
ServerId	yes	no	Uint64	Server ID. Example: 1
Values	yes	no	Array of AttributeTimestampValueOutput	Metric report data. Example:View
InstanceName	yes	no	String	Instance name. Example: ins-qwer

PCLMLogProfileItem

Log monitoring metric set - log data structure description.

Referenced by the following interfaces: CLMDescribeMetricSets

name	required	NULL allowed	type	description
MetricSetCID	no	no	String	Associated metric set CID (only for output parameter; leave it empty for input parameter). Example: cid-xxx
Field	yes	no	String	Field name. Example: timeField
Type	yes	no	String	Field type. Valid values: string, long, double. Example: string
CreatedAt	no	no	String	Creation time (only for output parameter; leave it empty for input parameter). Example: qwer
UpdatedAt	no	no	String	Update time (only for output parameter; leave it empty for input parameter). Example: qwer

PCLMMetricSet

Log monitoring metric set.

Referenced by the following interfaces: CLMDescribeMetricSets

name	required	NULL allowed	type	description
LogsetId	yes	yes	String	CLS logset ID. Example: d5f10b84-def8-4e58-bab0-16ef567b1f22
LogsetName	yes	yes	String	CLS log set name. Example: Testing
LogtopicId	yes	yes	String	CLS log topic ID. Example: d4253323-7dfc-4b1b-8889-d82cef77375a
LogtopicName	yes	yes	String	CLS log topic name. Example: Testing
Name	yes	yes	String	Metric set name. Example: Testing
StatisticCycle	yes	yes	Int64	Statistical period. Valid values: 60, 300. Example: 1
TimeField	yes	yes	String	Time field. Example: 1314141
LogFilterRules	yes	yes	Array of PCLMLogFilterRule	Log filtering rule. Example:View
MetricBasicItems	yes	yes	Array of PCLMMetricBasicItem	Basic metric rule. Example:View
MetricCustomItems	yes	yes	Array of PCLMMetricCustomItem	Compound metric rule. Example:View
Dimensions	yes	yes	Array of PCLMDimension	Dimension rule. Example:View
CID	no	yes	String	CID (only for output parameter; leave it empty for input parameter). Example: cid-xxx
CreatedAt	no	yes	String	Creation time (only for output parameter; leave it empty for input parameter) Example: qwer
UpdatedAt	no	yes	String	Update time (only for output parameter; leave it empty for input parameter) Example: qwer
AppId	no	yes	Int64	App ID (only for output parameter; leave it empty for input parameter). Example: 1234
Uin	no	yes	String	UIN (only for output parameter; leave it empty for input parameter). Example: 123456
Region	no	yes	String	Region (only for output parameter; leave it empty for input parameter). Example: gz
LogProfileItems	yes	yes	Array of PCLMLogProfileItem	Log data structure description. Example:View
SubAccountUin	no	yes	String	SubAccountUin (only for output parameter; leave it empty for input parameter). Example: 123456

CgrpInstance

Creates a new instance ID.

Referenced by the following interfaces: CreateInstances, DeleteInstances

name	required	NULL allowed	type	description
InstanceId	yes	no	String	Instance ID. Example: ins-00jvv9mo
InstanceName	no	no	String	Instance name. Example: test
TypeId	no	no	String	Type Example: cvm_device
Region	no	no	String	Region. Example: gz
ModuleId	yes	no	Int64	Leaf group node. Example: 1

CommonNamespace

Unified namespace information

Referenced by the following interfaces: DescribeAllNamespaces

name	required	NULL allowed	type	description
Id	yes	no	String	Namespace identifier. Example: performance_metric
Name	yes	no	String	The name of the namespace. Example: Performance metrics
Value	yes	no	String	Namespace value. Example: qwer
ProductName	yes	no	String	Product name. Example: cvm_device
Config	yes	no	String	Configuration information. Example: qwer
AvailableRegions	yes	no	Array of String	List of supported regions. Example: ["bj","bjjr"]
SortId	yes	no	Int64	Sort ID. Example: 251
DashboardId	yes	no	String	Unique identifier in Dashboard. Example: eipv6

DescribeProductEventListDimensions

Input parameter Dimensions of the DescribeProductEventList API

Referenced by the following interfaces: DescribeProductEventList

name	required	NULL allowed	type	description
Name	yes	no	String	Dimension name. Example: Testing
Value	yes	no	String	The value of the dimension. Example: XXXX

PCLMStatisticFilterRule

Metric filter condition in log monitoring metric set configurations.

Referenced by the following interfaces: CLMDescribeMetricSets

name	required	NULL allowed	type	description
MetricItemId	no	yes	Int64	Associated metric item ID (only for output parameter; leave it empty for input parameter). Example: 1
CreatedAt	no	yes	String	Creation time (only for output parameter; leave it empty for input parameter). Example: qwer
UpdatedAt	no	yes	String	Update time (only for output parameter; leave it empty for input parameter). Example: qwer
Relation	yes	no	Int64	Relationship. 1: AND. 2: OR. Example: 1
Field	yes	no	String	Field name. Example: timeField
Operator	yes	no	String	Filter operator: Numeric fields supoort: gt lt ge le eq ne in. Character fields support: eq ne in contains. Example: =
Value	yes	no	String	Filter operation value. Example: 10

ClmStatisticFilterRule

Metric filter condition in log monitoring metric set configurations.

Referenced by the following interfaces: CreateMetricSet, DescribeMetricSet, DescribeMetricSets, ModifyMetricSet

name	required	NULL allowed	type	description
Id	no	no	Int64	Item ID (only for output parameter; leave it empty for input parameter). Example: 1
MetricItemId	no	no	Int64	Associated metric item ID (only for output parameter; leave it empty for input parameter). Example: 1
CreatedAt	no	no	String	Creation time (only for output parameter; leave it empty for input parameter). Example: eqeadfrqc
UpdatedAt	no	no	String	Update time (only for output parameter; leave it empty for input parameter). Example: eqeadfrqc
Relation	yes	no	Int64	Relationship. 1: AND. 2: OR. Example: 12
Field	yes	no	String	Field name. Example: timeField
Operator	yes	no	String	Filter operator: Numeric fields supoort: gt lt ge le eq ne in. Character fields support: eq ne in contains. Example: =
Value	no	no	String	Filter operation value. Example: 50

AlarmPolicyTriggerTask

Task triggered by alarm policy

Referenced by the following interfaces: CreateAlarmPolicy, DescribeAlarmPolicies, DescribeAlarmPolicy, ModifyAlarmPolicyTasks

name	required	NULL allowed	type	description
Type	yes	no	String	Triggered task type. Valid value: AS (auto scaling). Example: AS
TaskConfig	yes	no	String	Configuration information in JSON format, such as {"Key1":"Value1","Key2":"Value2"}. Example: {"Key1":"Value1","Key2":"Value2"}

DescribeAppFlowConverterResponseDataPoint

Referenced by the following interfaces: DescribeAppFlow

name	required	NULL allowed	type	description
Value	yes	yes	Float	Value. Example: 100

UserNotice

Cloud Monitor alarm notification template - user notification details

Referenced by the following interfaces: CreateAlarmNotice, DescribeAlarmNotice, DescribeAlarmNotices, DescribeAlarmPolicies, DescribeAlarmPolicy, ModifyAlarmNotice

name	required	NULL allowed	type	description
ReceiverType	yes	no	String	Recipient type. Valid values: USER (user), GROUP (user group). Example: USER
UserIds	no	yes	Array of Int64	User uid list. Example: [100001,100002]
GroupIds	no	yes	Array of Int64	User group ID list. Example: [10001,10002]
StartTime	yes	no	Int64	Number of seconds since notification start time 00:00:00 (Value range: 0-86399). Example: 0
EndTime	yes	no	Int64	Number of seconds since notification end time 00:00:00 (Value range: 0-86399). Example: 86399
NoticeWay	yes	no	Array of String	Notification channel list. Valid values: EMAIL (email), SMS (SMS), CALL (phone), WECHAT (WeChat). Example: ["SMS", "CALL"]
PhoneOrder	no	yes	Array of Int64	Phone polling list. Example: [100001,100002]
PhoneCircleTimes	no	no	Int64	Number of phone pollings. Value range: 1–5. Example: 1
PhoneInnerInterval	no	no	Int64	Call interval in seconds within one polling. Value range: 60–900. Example: 60
PhoneCircleInterval	no	no	Int64	Polling interval in seconds. Value range: 60–900. Example: 60
NeedPhoneArriveNotice	no	no	Int64	Whether receipt notification is required. Valid values: 0 (no), 1 (yes). Example: 1

DescribePolicyGroupInfoCallback

User callback information output by the policy query

Referenced by the following interfaces: DescribePolicyGroupInfo

name	required	NULL allowed	type	description
CallbackUrl	yes	no	String	URL of the user callback API. Example: http://test.com
ValidFlag	yes	no	Int64	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. Example: 1
VerifyCode	yes	no	String	Verification code of the user callback API. Example: 13eq

PCLMMetricBasicItem

Basic metric configurations for the log monitoring metric set.

Referenced by the following interfaces: CLMDescribeMetricSets

name	required	NULL allowed	type	description
Field	yes	yes	String	Field name. Example: timeField
Operator	yes	yes	String	Metric statistics method: sum, count, min, max. Example: =
Name	yes	yes	String	Metric name. Example: Testing
Desc	yes	yes	String	Metric description name. Example: Testing
StatisticFilterRules	no	yes	Array of PCLMStatisticFilterRule	Metric filtering rule. Example:View
MetricSetCID	no	yes	String	Metric set CID (only for output parameter; leave it empty for input parameter). Example: cid-xxx
CreatedAt	no	yes	String	Creation time (only for output parameter; leave it empty for input parameter) Example: qwer
UpdatedAt	no	yes	String	Update time (only for output parameter; leave it empty for input parameter) Example: qwer

DescribePolicyQuotaV3ResponseDataQuota

Referenced by the following interfaces: DescribePolicyQuota

name	required	NULL allowed	type	description
Used	yes	no	Int64	User. Example: 10
Total	yes	no	Int64	Total number. Example: 10

AttributeIdOutput

Referenced by the following interfaces: ModifyAttribute

name	required	NULL allowed	type	description
AttributeId	yes	yes	Uint64	Attribute ID. Example: 10

DescribeBaseMetricsDataMeaning

Referenced by the following interfaces: DescribeBaseMetricsForConsoleFontEnd

name	required	NULL allowed	type	description
Language	yes	no	String	Language. Example: zh
Meaning	yes	no	String	Meaning. Example: qwer

ClmMetricAnalysisCustomMetric

Compound metric parameters in CLM metric analysis.

Referenced by the following interfaces: DescribeMetricAnalysisData

name	required	NULL allowed	type	description
Name	no	no	String	Compound metric name. Example: Testing
Formula	yes	no	String	Operation expression. Example: {"cluster_name":"es-dnxsssss"}

AttributeValueInfoOutputData

Referenced by the following interfaces: DescribeServerData, DescribeViewData

name	required	NULL allowed	type	description
Data	yes	no	Array of AttributeValueInfoOutput	Attribute report data list. Example:View
TotalCount	yes	no	Int64	Number of attribute data lists. Example: 10

ClmDescribeAlertPoliciesData

CLM alarm policy list return structure.

Referenced by the following interfaces: DescribeAlertPolicies

name	required	NULL allowed	type	description
TotalCount	yes	yes	Int64	Total number. Example: 10
AlertPolicies	yes	yes	Array of ClmAlertPolicy	List element. Example:View

Dimension

Combination of instance object dimensions

Referenced by the following interfaces: DescribeDashboardMetricData, DescribePolicyGroupCount, GetMonitorData, GetTkeData

name	required	NULL allowed	type	description
Name	yes	no	String	Instance dimension name. Example: InstanceId
Value	yes	no	String	Instance dimension value. Example: ins-c282wnl0

Condition

Alarm condition

Referenced by the following interfaces: DescribeConditionsTemplateList, DescribePolicyInfoByInstance, DescribeRecommendedTemplate

name	required	NULL allowed	type	description
AlarmNotifyPeriod	yes	no	Int64	Alarm notification frequency. Example: 7200
AlarmNotifyType	yes	no	Int64	Predefined repeated notification policy. 0: One-time alarm; 1: exponential alarm; 2: consecutive alarm. Example: 0
CalcType	yes	yes	String	Test method. Example: "1"
CalcValue	yes	yes	String	Test value. Example: "95"
ContinueTime	yes	yes	String	Duration. Example: "300"
MetricID	yes	no	Int64	Metric ID. Example: 33
MetricDisplayName	yes	no	String	Displayed metric name. Example: "CPU utilization"
Period	yes	no	Int64	Interval. Example: 60
RuleID	yes	no	Int64	Rule ID. Example: 623123
Unit	yes	no	String	Metric unit. Example: "%"

CreatePolicyGroupCondition

Alarm threshold condition passed in when a policy is created.

Referenced by the following interfaces: CreatePolicyGroup

name	required	NULL allowed	type	description
MetricId	yes	no	Int64	Metric ID. Example: 1234
CalcType	no	no	Int64	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. Example: 1
CalcValue	no	no	Float	Comparative value. This parameter is optional if the metric has no requirement. Example: 1.13
CalcPeriod	no	no	Int64	Data aggregation period in seconds. This parameter is optional if the metric has a default value. Example: 1
ContinuePeriod	no	no	Int64	Number of consecutive periods after which an alarm will be triggered. Example: 5
AlarmNotifyType	yes	no	Int64	Alarm sending and converging type. The value 0 indicates that alarms are sent consecutively. The value 1 indicates that alarms are sent exponentially. Example: 0
AlarmNotifyPeriod	yes	no	Int64	Alarm sending period in seconds. The value u003c0 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. Example: 0
RuleId	no	no	Int64	If a metric is created based on a template, the RuleId of the metric in the template must be passed in. Example: 1

DescribeMsgPolicyListVoiceConfig

Referenced by the following interfaces: DescribeMsgPolicyInfo, DescribeMsgPolicyList

name	required	NULL allowed	type	description
RoundNumber	yes	no	Int64	Number of calls. Example: 10
UIDList	yes	yes	Array of Int64	UIN list. Example: 10
RoundInterval	yes	no	Int64	Interval between each round. Example: 10
PersonInterval	yes	no	Int64	Interval. Example: 10
NeedSendNotice	yes	no	Int64	Whether to send a reminder. Example: 10

ClmAnalysisFilter

Filter condition in CLM multidimensional analysis.

Referenced by the following interfaces: DescribeDimensionAnalysisData, DescribeMetricAnalysisData

name	required	NULL allowed	type	description
Field	yes	no	String	Field name. Example: timeField
Operator	yes	no	String	Operator. Only = is supported (when the value array contains multiple values, it is an "in" relationship). Example: =
Value	yes	no	Array of String	Value. Example: 50

TemplateTag

Output parameter of DescribeTemplateTags: list of tags for template variables.

Referenced by the following interfaces: DescribeTemplateTags

name	required	NULL allowed	type	description
Tag	yes	no	String	Tag name. Example: qwer
TagType	yes	no	String	Tag type. Example: qwer
ProductId	yes	no	String	Associated product ID (basic monitoring). Example: qwer

AttributeTimestampValueOutput

Referenced by the following interfaces: DescribeAttributeAggregateData, DescribeCCMInstanceDatas, DescribeServerData, DescribeServerDatas, DescribeViewData

name	required	NULL allowed	type	description
Timestamp	yes	no	Int64	Timestamp. Example: 1735041205
Value	yes	yes	Int64	Attribute value. Example: 10

DashboardDataSource

Dashboard2.0 data source information.

Referenced by the following interfaces: DescribeDashboardDataSources

name	required	NULL allowed	type	description
UUID	yes	no	String	DataSource unique identifier. Example: u78haeoyaq8w8wbr
Name	yes	no	String	Data source name. Example: Testing
Type	yes	no	String	Data source type, such as MySQL, Prometheus. Example: MySQL
TypeLogoUrl	yes	yes	String	Data source icon. Example: http://test.com
Access	yes	yes	String	Access mode. Example: mode
Url	yes	yes	String	Data source access address Example: http://test.com
Password	yes	no	String	Password. It can be an empty string. Example: 123456
User	yes	no	String	Username. It can be an empty string. Example: qwer
Database	yes	no	String	Database. Example: mysql
BasicAuth	yes	no	Bool	It is "false" by default. Example: false
IsDefault	yes	no	Bool	Whether it is the default data source. Example: false
JsonData	yes	yes	String	Additional information of the storage data source, such as ES link information "{ "esVersion": 5, "logLevelField": "","logMessageField": " ", "maxConcurrentShardRequests": 256, "timeField": "@timestamp"}". Example: { "esVersion": 5, "logLevelField": "","logMessageField": "", "maxConcurrentShardRequests": 256, "timeField": "@timestamp"}
ReadOnly	yes	no	Bool	Whether the data source data is read-only. Example: false

ModifyNotifyBatchNotifyInfo

Alarm notification method of the ModifyNotifyBatch API.

Referenced by the following interfaces: ModifyNotifyBatch

name	required	NULL allowed	type	description
GroupId	yes	no	Int64	Policy group ID. Example: 1234
NotifyWay	yes	no	Array of String	List of alarm methods. Example: sms

NoticeContentTmplBindInfo

Information on binding of the notification template and content template.

Referenced by the following interfaces: DescribeAlarmPolicies, DescribeAlarmPolicy, ModifyAlarmPolicyNotice

name	required	NULL allowed	type	description
ContentTmplID	no	no	String	Content template ID. Example: tmpl-xxx
NoticeID	no	no	String	Notification template ID. Example: notice-xxx

AttributeInfoOutput

Attribute information.

Referenced by the following interfaces: DescribeAttributes, DescribeCCMGroupViewAttribute

name	required	NULL allowed	type	description
AttributeId	yes	no	Uint64	Attribute ID. Example: 1
AttributeName	yes	no	String	Attribute name. Example: Testing
AttributeLevel	yes	no	Int64	Attribute level. Example: 1
Description	yes	no	String	Description. Example: test
AttributeType	yes	yes	String	The type. Example: cpu_usage
DataType	yes	no	Int64	Attribute data type. Example: 1
CreateTime	yes	no	String	Creation time. Example: 1735041205
OwnerName	yes	no	String	Attribute owner. Example: test
UnitId	yes	no	Int64	Unit ID. Example: 1
UnitName	yes	no	String	The unit. Example: test
StatisticalPeriod	yes	no	Int64	Statistical period. Example: 60
AttributeUniqueName	yes	no	String	Unique string of the attribute. It consists of letters, digits, hyphens or underscores. Example: qwer_123

IdcInfoData

Referenced by the following interfaces: DescribeIdcServerCount

name	required	NULL allowed	type	description
Data	yes	no	Array of IdcInfo	Return data. Example:View
TotalCount	yes	no	Int64	Total number. Example: 10

DescribePolicyGroupListGroup

DescribePolicyGroupList.Group

Referenced by the following interfaces: DescribePolicyGroupList

name	required	NULL allowed	type	description
GroupId	yes	no	Int64	Policy group ID. Example: 1234
GroupName	yes	no	String	Policy group name. Example: test
IsOpen	yes	no	Bool	Indicates whether self-healing notifications are enabled. Example: true
ViewName	yes	no	String	Policy view name. Example: cvm_device
LastEditUin	yes	no	String	UIN of the last editor. Example: 123456
UpdateTime	yes	no	Int64	Last modification time. Example: 12314155251
InsertTime	yes	no	Int64	Creation time. Example: 12314155251
UseSum	yes	no	Int64	Number of instances bound to the policy group. Example: 10
NoShieldedSum	yes	no	Int64	Number of unshielded instances that are bound to the policy group. Example: 10
IsDefault	yes	no	Int64	Whether it is a default policy. 0: non-default policy. 1: default policy. Example: 1
CanSetDefault	yes	no	Bool	Whether it can be set as the default policy. Example: true
ParentGroupId	yes	no	Int64	Parent policy group ID. Example: 1234
Remark	yes	no	String	Remarks of the policy group. Example: test
ProjectId	yes	no	Int64	ID of the project to which the policy group belongs. Example: 0
Conditions	yes	yes	Array of DescribePolicyGroupInfoCondition	Threshold rules list. Example:View
EventConditions	yes	yes	Array of DescribePolicyGroupInfoEventCondition	List of product event rules. Example:View
ReceiverInfos	yes	yes	Array of DescribePolicyGroupInfoReceiverInfo	User recipient list. Example:View
ConditionsTemp	yes	yes	DescribePolicyGroupInfoConditionTpl	Template-based policy group. Example:View
InstanceGroup	yes	yes	DescribePolicyGroupListGroupInstanceGroup	Instance group that is bound to the policy group. Example:View
IsUnionRule	yes	yes	Int64	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). Example: 1

PolicyGroup

Policy group information

Referenced by the following interfaces: DescribeConditionsTemplateList

name	required	NULL allowed	type	description
CanSetDefault	yes	no	Bool	Whether the policy can be set as the default policy. Example: false
GroupID	yes	no	Int64	Alarm policy group ID. Example: 1234
GroupName	yes	no	String	Alarm policy group name. Example: Testing
InsertTime	yes	no	Int64	Creation time. Example: 1735179378
IsDefault	yes	no	Int64	Whether it is a default alarm policy. Example: 1
Enable	yes	no	Bool	Enablement status of the alarm policy. Example: false
LastEditUin	yes	no	Int64	UIN of the last user who modified it. Example: 123456
NoShieldedInstanceCount	yes	no	Int64	Number of unshielded instances. Example: 10
ParentGroupID	yes	no	Int64	Parent policy group ID. Example: 1234
ProjectID	yes	no	Int64	Project ID. Example: 1
ReceiverInfos	yes	yes	Array of PolicyGroupReceiverInfo	Information about the alarm recipient. Example:View
Remark	yes	no	String	Remarks. Example: Testing
UpdateTime	yes	no	Int64	Modification time. Example: 1735179378
TotalInstanceCount	yes	no	Int64	Total number of bound instances. Example: 10
ViewName	yes	no	String	View. Example: cvm_device
IsUnionRule	yes	no	Int64	Whether the AND rule is used. Example: 1

ClmMetricSet

Log monitoring metric set.

Referenced by the following interfaces: CreateMetricSet, DescribeMetricSet, DescribeMetricSets, ModifyMetricSet

name	required	NULL allowed	type	description
LogsetId	yes	no	String	CLS logset ID. Example: d5f10b84-def8-4e58-bab0-16ef567b1f22
LogsetName	yes	no	String	CLS log set name. Example: Testing
LogtopicId	yes	no	String	CLS log topic ID. Example: d4253323-7dfc-4b1b-8889-d82cef77375a
LogtopicName	yes	no	String	CLS log topic name. Example: Testing
Name	yes	no	String	Metric set name. Example: Testing
StatisticCycle	yes	no	Int64	Statistical period. Valid values: 60, 300. Example: 1
TimeField	yes	no	String	Time field. Example: 3131431
LogFilterRules	yes	yes	Array of ClmLogFilterRule	Log filtering rule. Example:View
MetricBasicItems	yes	yes	Array of ClmMetricBasicItem	Basic metric rule. Example:View
MetricCustomItems	yes	yes	Array of ClmMetricCustomItem	Compound metric rule. Example:View
Dimensions	yes	yes	Array of ClmDimension	Dimension rule. Example:View
Id	no	no	Int64	Item ID (only for output parameter; leave it empty for input parameter) Example: 1
CreatedAt	no	no	String	Creation time (only for output parameter; leave it empty for input parameter) Example: eqeadfrqc
UpdatedAt	no	no	String	Update time (only for output parameter; leave it empty for input parameter) Example: eqeadfrqc
AppId	no	no	Int64	App ID (only for output parameter; leave it empty for input parameter). Example: 1234
Uin	no	no	String	UIN (only for output parameter; leave it empty for input parameter). Example: 123456
Region	no	no	String	Region (only for output parameter; leave it empty for input parameter). Example: gz
LogProfileItems	yes	yes	Array of ClmLogProfileItem	Log data structure description. Example:View

DashboardMetricData

Reported data returned by Dashboard2.0 query metrics.

Referenced by the following interfaces: DescribeDashboardMetricData

name	required	NULL allowed	type	description
MetricName	yes	no	String	Metric name. Example: CpuUsage
Aggregate	yes	no	String	The aggregation method. Example: avg
GroupBy	yes	no	Array of Dimension	Query condition array. Example:View
Timestamps	yes	no	Array of Uint64	Returns the Timestamp array. Example: [1604303550]
Value	yes	no	String	Metric report data. JSON serialized strings are returned in array form. Example: [1,0.8]
StartTime	yes	no	Datetime_iso	Returns the start time of the query period in ISO format, such as: 2018-04-10T10:15:58.858Z. Example: 2019-11-29T12:30:13+08:00
EndTime	yes	no	Datetime_iso	Returns the start time of the query period in ISO format, such as: 2018-04-10T10:15:58.858Z. Example: 2019-03-24T20:50:00+08:00
Period	yes	no	Int64	Statistical period in seconds. Example: 60
Conditions	yes	no	Array of DashboardMetricCondition	Filter condition. Example:View
Namespace	yes	no	String	Namespace. Example: QCE/CVM
Error	yes	no	String	Error message. Example: error
Code	yes	no	String	Error code. Example: 11001
SeriesId	yes	no	String	Query flag. Example: 1a6deff1-7991-4d82-a8c1-44b66e1c33f6
ConfigId	yes	yes	String	Product configuration ID. Example: qwer
Dimensions	yes	no	Array of Dimension	Dimension combination of an instance. Example:View
OrderTag	yes	yes	Float	Field for sorting. Example: 1234
Type	no	yes	String	Type Example: qwer

MetricObjectMeaning

Meaning of metric data

Referenced by the following interfaces: DescribeBaseMetrics

name	required	NULL allowed	type	description
En	yes	no	String	Meaning of metric data (English). Example: qwer
Zh	yes	no	String	Meaning of metric data. Example: qwer

PCLMMetricAnalysisData

CLM metric analysis data structure.

Referenced by the following interfaces: DescribeMetricAnalysisData

name	required	NULL allowed	type	description
Compare	yes	yes	Array of PCLMMetricAnalysisPoint	Comparison data. Example:View
Current	yes	yes	Array of PCLMMetricAnalysisPoint	Current data. Example:View
Granularity	yes	yes	Int64	Time granularity (seconds). Example: 1

AlarmHistory

Alarm record data

Referenced by the following interfaces: DescribeAlarmHistories, DescribeMiniDashboardAlarmInfo

name	required	NULL allowed	type	description
AlarmId	yes	no	String	Alarm history ID. Example: 01e1f33f-b4ec-43db-8fd0-6f7e163e6ca5
MonitorType	yes	no	String	Monitoring type. Example: MT_QCE
Namespace	yes	no	String	Policy type Example: cvm_device
AlarmObject	yes	no	String	Alarm object. Example: ins-abcdef
Content	yes	no	String	The alarm content. Example: CPU utilization > 80%
FirstOccurTime	yes	no	Int64	Timestamp of the first occurrence time. Example: 1611700000
LastOccurTime	yes	no	Int64	Timestamp of the final occurrence time. Example: 1611734567
AlarmStatus	yes	no	String	Alarm status. ALARM=not recovered. OK=recovered. NO_CONF=expired. NO_DATA=insufficient data. Example: ALARM
PolicyId	yes	no	String	Alarm policy ID. Example: policy-abcdef
PolicyName	yes	no	String	Policy name. Example: CVM alarm policy
VPC	yes	no	String	VPC of the alarm object for the basic product alarm. Example: 0
ProjectId	yes	no	Int64	Project ID. Example: 0
ProjectName	yes	no	String	Project name. Example: Default project
InstanceGroup	yes	yes	Array of InstanceGroups	Instance group of alarm object Example:View
ReceiverUids	yes	no	Array of Int64	Recipient list. Example: [1234]
ReceiverGroups	yes	no	Array of Int64	Recipient group list. Example: [1234]
NoticeWays	yes	no	Array of String	Alarm channel list. Valid values: SMS (SMS), EMAIL (email), CALL (phone), WECHAT (WeChat). Example: ["SMS"]
OriginId	yes	no	String	Compatibility alarm v1.0 policy group ID. Example: 12345
AlarmType	yes	no	String	Alarm type. Example: METRIC
EventId	yes	no	Int64	Event ID. Example: 0
Region	yes	no	String	Region. Example: region1
PolicyExists	yes	no	Int64	Whether the policy exists. 0: no. 1: yes. Example: 1
ExtraTags	yes	yes	String	Extra information. JSON string. Example: {"cluster_name":"es-dnxsssss"}
MetricsInfo	yes	yes	Array of AlarmHistoryMetric	Metric information. Example:View
Dimensions	no	yes	String	Dimensions Example: {"cluster_name":"es-dnxsssss"}
AlarmLevel	no	no	String	Alarm Level Example: Remind

AlarmPolicyCondition

Metric trigger condition of alarm policy

Referenced by the following interfaces: CreateAlarmPolicy, DescribeAlarmPolicies, DescribeAlarmPolicy, ModifyAlarmPolicyCondition

name	required	NULL allowed	type	description
IsUnionRule	yes	no	String	The 'AND' or 'OR' rule of the metric. The value 0 indicates the 'OR' rule. The value 1 indicates the 'AND' rule. Example: 1
Rules	yes	no	Array of AlarmPolicyRule	Alarm trigger condition list. Example:View

DescribePolicyGroupInfoCondition

Alarm threshold conditions output by the policy query.

Referenced by the following interfaces: DescribePolicyGroupInfo, DescribePolicyGroupList

name	required	NULL allowed	type	description
MetricShowName	yes	no	String	Metric name. Example: CpuUsage
Period	yes	no	Int64	Data aggregation period in seconds. Example: 60
MetricId	yes	no	Int64	Metric ID. Example: 10
RuleId	yes	no	Int64	Threshold rule ID. Example: 10
Unit	yes	no	String	Metric unit. Example: %
AlarmNotifyType	yes	no	Int64	Alarm sending and converging type. The value 0 indicates that alarms are sent consecutively. The value 1 indicates that alarms are sent exponentially. Example: 10
AlarmNotifyPeriod	yes	no	Int64	Alarm sending period in seconds. The value u003c0 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. Example: 10
CalcType	yes	no	Int64	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. Example: 10
CalcValue	yes	no	String	Detection threshold. Example: 100
ContinueTime	yes	no	Int64	Duration at which an alarm will be triggered in seconds. Example: 50

PolicyGroupReceiverInfo

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

Referenced by the following interfaces: DescribeConditionsTemplateList

name	required	NULL allowed	type	description
EndTime	yes	no	Int64	End time of a valid time period. Example: 1734957911
NeedSendNotice	yes	no	Int64	Whether it is required to send notifications. Example: 1
NotifyWay	yes	yes	Array of String	The channel for sending alarms. Example: sms
PersonInterval	yes	no	Int64	Alarm call intervals for individuals in seconds. Example: 1
ReceiverGroupList	yes	yes	Array of Int64	Message recipient group list. Example: 10
ReceiverType	yes	no	String	Recipient type. Example: sms
ReceiverUserList	yes	yes	Array of Int64	Recipient list. The list of recipient IDs that is queried by API. Example: [1234]
RecoverNotify	yes	yes	Array of String	Notification method when an alarm is recovered. Example: sms
RoundInterval	yes	no	Int64	Intervals of alarm call rounds in seconds. Example: 1
RoundNumber	yes	no	Int64	Number of alarm call rounds. Example: 1
SendFor	yes	yes	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). Example: qwer
StartTime	yes	no	Int64	Start time of a valid time period. Example: 1734953808
UIDList	yes	yes	Array of Int64	UID of the alarm call recipient. Example: 1234

AlarmEvent

Alarm event

Referenced by the following interfaces: DescribeAlarmEvents

name	required	NULL allowed	type	description
EventName	yes	no	String	Event name. Example: Testing
Description	yes	no	String	Displayed event name. Example: Testing
Namespace	yes	no	String	Alarm policy type. Example: cvm_device
Tooltip	yes	yes	MetricTooltip	Prompt information that can be displayed. Example:View

UnifyDashboardMeta

Dashboard list element information.

Referenced by the following interfaces: DescribeUnifyDashboards

name	required	NULL allowed	type	description
UUID	yes	no	String	dashboard uuid Example: 1234
IsStarred	yes	no	Bool	Whether to add to "Favorite". Example: false
Title	yes	no	String	Dashboard name. Example: 1735179378
IsDefault	yes	no	Bool	Default Example: false
Type	yes	no	String	Dashboard type. Example: qwer
LastVisitTime	yes	no	String	Last access time. Example: 1735179378
CreatedAt	yes	no	String	Creation time. Example: qwer
UpdatedAt	yes	no	String	Update time. Example: qwer
FolderUUID	no	no	String	The folder UUID. Example: f-ikxn2fzkagqrdijo
IsFolder	no	no	Bool	Whether it is a folder. Example: false
Order	no	no	String	Order. Example: desc

RegionPolicyObjectCount

Region statistics returned by the DescribePolicyObjectCount API.

Referenced by the following interfaces: DescribePolicyObjectCount

name	required	NULL allowed	type	description
Region	yes	no	String	Region. Example: gz
Count	yes	no	Int64	Number of instances bound. Example: 10

ClmDimension

Metric set dimension object for log monitoring.

Referenced by the following interfaces: CreateMetricSet, DescribeMetricSet, DescribeMetricSets, ModifyMetricSet

name	required	NULL allowed	type	description
Field	yes	no	String	Field name. Example: timeField
Id	no	no	Int64	Item ID (only for output parameter; leave it empty for input parameter) Example: 1
CreatedAt	no	no	String	Creation time (only for output parameter; leave it empty for input parameter) Example: eqeadfrqc
UpdatedAt	no	no	String	Update time (only for output parameter; leave it empty for input parameter) Example: eqeadfrqc
MetricSetId	no	no	Int64	Metric set ID (only for output parameter; leave it empty for input parameter) Example: 1

ServerAttributeDataOutput

Referenced by the following interfaces: DescribeServerDatas

name	required	NULL allowed	type	description
AttributeId	yes	no	Uint64	Metric ID. Example: 1
ServerId	yes	no	Uint64	Server ID. Example: 1
Values	yes	no	Array of AttributeTimestampValueOutput	Reported value of the metric. Example:View

MetricDatum

Metric names and values

Referenced by the following interfaces: PutMonitorData

name	required	NULL allowed	type	description
MetricName	yes	no	String	Metric name. Example: CpuUsage
Value	yes	no	Uint64	Metric value. Example: 10

DescribePolicyConditionListConfigManual

DescribePolicyConditionList.ConfigManual

Referenced by the following interfaces: DescribePolicyConditionList

name	required	NULL allowed	type	description
CalcType	yes	yes	DescribePolicyConditionListConfigManualCalcType	Test method. Example:View
CalcValue	yes	yes	DescribePolicyConditionListConfigManualCalcValue	Detection threshold. Example:View
ContinueTime	yes	yes	DescribePolicyConditionListConfigManualContinueTime	Duration. Example:View
Period	yes	yes	DescribePolicyConditionListConfigManualPeriod	Data cycle. Example:View
PeriodNum	yes	yes	DescribePolicyConditionListConfigManualPeriodNum	Number of consecutive periods. Example:View
StatType	yes	yes	DescribePolicyConditionListConfigManualStatType	The aggregation method. Example:View

AttributeAggrValueInfoOutputData

Referenced by the following interfaces: DescribeAttributeAggregateData

name	required	NULL allowed	type	description
Data	yes	no	Array of AttributeTimestampValueOutput	Returns a list of aggregation data. Example:View
TotalCount	yes	no	Int64	Returns the number of aggregation data lists. Example: 10

DescribePolicyConditionListConfigManualContinueTime

DescribePolicyConditionList.ConfigManual.ContinueTime

Referenced by the following interfaces: DescribePolicyConditionList

name	required	NULL allowed	type	description
Default	yes	yes	Int64	Default duration in seconds. Example: 10
Keys	yes	yes	Array of Int64	Custom duration in seconds. Example: 10
Need	yes	no	Bool	Whether required. Example: true

DescribePolicyConditionListConfigManualCalcValue

DescribePolicyConditionList.ConfigManual.CalcValue

Referenced by the following interfaces: DescribePolicyConditionList

name	required	NULL allowed	type	description
Default	yes	yes	String	Default value. Example: test
Fixed	yes	yes	String	Fixed value. Example: qwer
Max	yes	yes	String	Maximum value. Example: 100
Min	yes	yes	String	Minimum value. Example: 10
Need	yes	no	Bool	Whether required. Example: true

MessagePolicy

Referenced by the following interfaces: DescribeMsgPolicyList

name	required	NULL allowed	type	description
PolicyID	yes	no	String	Policy ID. Example: policy-abc123
PolicyName	yes	no	String	Policy name. Example: Testing
ReceiverGroupIds	yes	yes	Array of Int64	Recipient group list. Example: [1234]
NotifyWay	yes	yes	Array of String	Notification method. Example: sms
VoiceConfig	yes	yes	DescribeMsgPolicyListVoiceConfig	Voice configurations. Example:View
IsDefault	yes	no	Bool	Whether it is a default policy. Example: true
AlarmCount	yes	no	Int64	Number of alarms. Example: 1

HistoryAlarmInfo

Return parameters of the DescribeAlarmHistoryByAlarmId API.

Referenced by the following interfaces: DescribeAlarmHistoryByAlarmId

name	required	NULL allowed	type	description
Id	yes	no	Int64	Alarm ID. Example: 1
GroupId	yes	no	Int64	Policy group ID. Example: 1234
AlarmStatus	yes	yes	String	Alarm status. Example: 1
AlarmType	yes	yes	Int64	Alarm type. 0 (metric alarm), 2 (product event alarm), 3 (platform event alarm). Example: 1
Content	yes	no	String	The alarm content. Example: qwer
CurrentValue	yes	yes	String	Current value. Example: 10
FirstOccurTime	yes	yes	String	Initial triggered time. Example: 1735129241
LastOccurTime	yes	yes	String	Final triggered time. Example: 1735129241
Duration	yes	yes	Int64	Duration. Example: 10
ObjId	yes	yes	String	Object ID. Example: 0a523bfb-dd09-47e2-a85c-0b23455b0949
ObjName	yes	yes	String	Object name. Example: 172.16.0.15#75904
ProjectId	yes	yes	Int64	Project ID. Example: 10
ProjectName	yes	yes	String	Project name. Example: Default
Region	yes	yes	String	Region. Example: gz
Status	yes	yes	Int64	Status. Valid values: 0, 1, 2, 3, 4, 5. 0: not recovered. 1: recovered. 4: expired. 2/3/5: insufficient data. Example: 1
ViewName	yes	yes	String	View name. Example: cvm_device

ModifyConditionsTemplateRequestCondition

Referenced by the following interfaces: CreateConditionsTemplate, ModifyConditionsTemplate

name	required	NULL allowed	type	description
AlarmNotifyPeriod	no	no	String	Alarm notification cycle. Example: 86400
AlarmNotifyType	no	no	Int64	Alarm notification method. Example: 0
CalcPeriod	yes	no	String	Statistical period. Example: 60
CalcType	yes	no	String	Statistical method. Example: 1
CalcValue	yes	no	String	Statistics value. Example: 0
ContinuePeriod	yes	no	String	Consecutive period. Example: 1
MetricId	yes	no	Int64	Metric ID. Example: 10
RuleID	no	no	Int64	Rule ID. Example: 1

PCLMDescribeMetricSetsData

CLMDescribeMetricSets return data.

Referenced by the following interfaces: CLMDescribeMetricSets

name	required	NULL allowed	type	description
MetricSets	yes	yes	Array of PCLMMetricSet	Metric set list data. Example:View
TotalCount	yes	yes	Int64	Total number. Example: 10

CgrpGroupNode

Referenced by the following interfaces: CreateGroup, DeleteGroup, DescribeGroup, InitGroup, ModifyGroup

name	required	NULL allowed	type	description
AppId	no	yes	Int64	Group ID. Example: 1234
High	no	no	Int64	Group depth. Example: 1
Id	yes	no	Int64	Group ID. Example: 1
IsLeaf	no	no	Bool	Whether it is a leaf node. Example: true
Level	no	no	Int64	Current level in the tree. Example: 1
Name	no	no	String	Tree node. Example: Testing
ParentId	no	no	Int64	Parent node ID. Example: 1
SubUin	no	yes	String	SubUin Example: 1234
TypeId	no	no	String	Type of the instance that is allowed to be stored in the leaf node. Example: cvm_device
Uin	no	yes	String	Uin Example: 123456

ClmAlertPolicy

Expired.

Referenced by the following interfaces: CreateAlertPolicy, DescribeAlertPolicies, DescribeAlertPolicy, ModifyAlertPolicy

name	required	NULL allowed	type	description
Name	yes	yes	String	Policy name. Example: test
MetricSetId	yes	yes	Int64	Metric set ID (invalid parameter). Example: 1
Status	yes	yes	Int64	Status. 1: enabled. 2: not enabled. Example: 1
AlertGroupId	yes	yes	String	Alarm recipient group ID. Multiple IDs are separated by commas. Example: 1234
AlertChannel	yes	yes	String	Channels for receiving alarms: "SMS", "EMAIL", "WECHAT", "CALL". Multiple values are separated by commas. Example: sms
NoticePeriodBegin	yes	yes	Int64	Start time of the time range to send notifications (number of seconds since 00:00:00). Example: 100
NoticePeriodEnd	yes	yes	Int64	End time of the time range to send notifications (number of seconds since 00:00:00). Example: 200
UrlScheme	no	yes	String	Scheme of the callback URL. Example: http
CallbackUrl	no	yes	String	Callback URL, excluding the scheme part. Example: http://test.com
AlertFilterRules	no	yes	Array of ClmAlertFilterRule	List of alarm filter conditions. Example:View
AlertTriggerRules	yes	yes	Array of ClmAlertTriggerRule	Alarm trigger condition list. Example:View
Id	no	yes	Int64	Alarm policy ID (output parameter). Example: 1
CreatedAt	no	yes	String	Creation time (output parameter). Example: eqeadfrqc
UpdatedAt	no	yes	String	Update time (output parameter). Example: eqeadfrqc
AlertUserId	no	yes	String	Alarm recipient ID. Multiple IDs are separated by commas. Example: 1234
LatestAlertTime	no	yes	String	Last alarm time (output parameter). Example: 1735041205
FilterRelation	no	yes	Int64	Relationship between filter conditions. 1: AND. 2: OR. Example: 1
TriggerRelation	yes	yes	Int64	Relationship between trigger conditions. 1: AND. 2: OR. Example: 1
MetricSetCID	no	no	Float	Metric set CID. Example: 123455

Metric

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

Referenced by the following interfaces: DescribeAlarmMetrics

name	required	NULL allowed	type	description
Namespace	yes	no	String	Alarm policy type. Example: cvm_device
QceNamespace	yes	no	String	It is only valid for cloud product monitoring and is used by certain APIs to query data. Example: QCE/CVM
MetricName	yes	no	String	Metric name. Example: CpuUsage
Description	yes	no	String	Displayed metric name. Example: CPU Utilization
Aggregations	yes	no	Array of MetricAggregation	The aggregation method. Example:View
Min	yes	no	Float	Minimum value. Example: 0
Max	yes	no	Float	Maximum value. Example: 100
Dimensions	yes	no	Array of String	The dimensions. Example: vm_uuid
Unit	yes	no	String	Unit. Example: %
Tooltip	yes	yes	MetricTooltip	Rich text prompt. Example:View
MetricConfig	yes	yes	MetricConfig	Metric configuration Example:View
Operators	no	no	Array of String	Operators Example: {"Id":"eq","Name":"="}
Periods	no	no	Array of Int64	Periods Example: 5

CustomCallbackNoticeTmpl

Elements in the custom notification content template.

Referenced by the following interfaces: CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl

name	required	NULL allowed	type	description
ContentTmpl	yes	no	String	Alarm notification content template. Example: Alarm notification template
TitleTmpl	no	no	String	Alarm notification topic template. Example: Title

AlarmPolicyBasic

Basic information of a v2.0 alarm policy.

Referenced by the following interfaces: DescribeAlarmPoliciesBasic

name	required	NULL allowed	type	description
MonitorType	yes	yes	String	Monitoring type. Example: MT_QCE
OriginId	yes	yes	String	V1.0 alarm policy ID. Example: 1234
PolicyId	no	yes	String	V2.0 alarm policy ID. Example: policy-abc123
PolicyName	no	yes	String	The name of the alarm policy. Example: Testing

StrategyIdInfo

Referenced by the following interfaces: CreateStrategy

name	required	NULL allowed	type	description
StrategyId	yes	no	Int64	The ID of the alarm policy. Example: 1

ModifyMsgPolicyVoiceConfig

Custom message voice alarm configuration.

Referenced by the following interfaces: CreateMsgPolicy, ModifyMsgPolicy

name	required	NULL allowed	type	description
UidList	no	no	Array of Int64	List of UIDs. Example: [1234]
RoundNumber	no	no	Int64	Number of alarm rounds. Valid values: 1-5. Example: 10
RoundInterval	no	no	Int64	Intervals of alarm rounds in seconds. Example: 10
PersonInterval	no	no	Int64	Alarm intervals for individuals in seconds. Example: 10
NeedSendNotice	no	no	Int64	Whether notification is required. 1: yes. 0: no. Example: 10

ProjectInfo

Output parameter of the DescribeProjectsList API.

Referenced by the following interfaces: DescribeProjectsList

name	required	NULL allowed	type	description
AppId	yes	no	Int64	AppId Example: 1234
CreatorUin	yes	no	Int64	The UIN of the creator. Example: 123456
Name	yes	no	String	Project name. Example: Testing
Info	yes	no	String	Project information. Example: qwer
IsDefault	yes	no	Int64	Indicates whether to use your default value. Example: 1
ProjectId	yes	no	Int64	Project ID. Example: 1
OwnerUin	yes	no	Int64	The UIN of the root account. Example: 123456
SrcAppId	yes	no	Int64	Source App ID. Example: 1234
SrcPlat	yes	no	String	Source platform. Example: qwer
Status	yes	no	Int64	State. Example: 1
CreateTime	yes	no	String	Creation time. Example: 1735179378

ConditionsTemp

Alarm condition template

Referenced by the following interfaces: DescribeAlarmPolicies, DescribeAlarmPolicy

name	required	NULL allowed	type	description
ConditionId	yes	yes	Int64	Alarm condition ID. Example: 1234
TemplateName	yes	yes	String	Template name. Example: test
Condition	yes	yes	AlarmPolicyCondition	Metric trigger condition. Example:View
EventCondition	yes	yes	AlarmPolicyEventCondition	Event trigger condition. Example:View

PeriodsSt

Statistical method during the period

Referenced by the following interfaces: DescribeBaseMetrics

name	required	NULL allowed	type	description
Period	yes	no	String	Interval. Example: 60
StatType	yes	no	Array of String	Statistical method. Example: avg

WebStorageInfos

Dashboard pop-up information management.

Referenced by the following interfaces: DescribeWebStorage

name	required	NULL allowed	type	description
CreatedAt	yes	no	String	Creation time. Example: qwer
SubUin	yes	no	String	Sub-user. Example: 123456
Uin	yes	no	String	Primary user. Example: 123456
UpdatedAt	yes	no	String	Update time. Example: qwer
WebStorageInfo	yes	no	String	Pop-up information. Example: qwer

DescribeAccidentEventListAlarms

Output parameter type of the DescribeAccidentEventList API

Referenced by the following interfaces: DescribeAccidentEventList

name	required	NULL allowed	type	description
BusinessTypeDesc	yes	yes	String	Event category. Example: qwer
AccidentTypeDesc	yes	yes	String	Event type. Example: qwer
BusinessID	yes	yes	Int64	ID of the event category. The value 1 indicates service issues. The value 2 indicates other subscriptions. Example: 1
EventStatus	yes	yes	Int64	Event status ID. The value 0 indicates that the event has been recovered. The value 1 indicates that the event has not been recovered. Example: 1
AffectResource	yes	yes	String	Affected object. Example: qwer
Region	yes	yes	String	Region where the event occurs. Example: gz
OccurTime	yes	yes	String	Time when the event occurs. Example: 1735041205
UpdateTime	yes	yes	String	Update time. Example: 1735041205

PolicyTag

Policy tag.

Referenced by the following interfaces: BindingPolicyTag, DescribeGroupIDByTags, UnbindingPolicyTag

name	required	NULL allowed	type	description
Key	yes	no	String	Tag key. Example: qwer
Value	yes	no	String	Tag value. Example: qwer

MetricSet

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

Referenced by the following interfaces: DescribeBaseMetrics

name	required	NULL allowed	type	description
Namespace	yes	no	String	Namespace. Each cloud product has a namespace. Example: QCE/CVM
MetricName	yes	no	String	Metric name. Example: AccOuttraffic
Unit	yes	no	String	Unit used by the metric. Example: MB
UnitCname	yes	no	String	Unit used by the metric. Example: ""
Period	yes	no	Array of Int64	Statistical period in seconds supported by the metric, such as 60 and 300. Example: [10,60]
Periods	yes	no	Array of PeriodsSt	Metric in a statistical period. Example:View
Meaning	yes	no	MetricObjectMeaning	The meaning of the statistical metric. Example:View
Dimensions	yes	no	Array of DimensionsDesc	The description of the dimension. Example:View

ModifyPolicyGroupCondition

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

Referenced by the following interfaces: ModifyPolicyGroup

name	required	NULL allowed	type	description
RuleId	no	no	Int64	Rule ID. No filling means new addition while filling in ruleId means to modify existing rules. Example: 1
MetricId	yes	no	Int64	Metric ID. Example: 10
CalcType	yes	no	Int64	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. Example: 10
CalcValue	yes	no	String	Detection threshold. Example: 10
CalcPeriod	yes	no	Int64	Data period of the detected metric. Example: 5
ContinuePeriod	yes	no	Int64	Number of consecutive periods. Example: 5
AlarmNotifyType	yes	no	Int64	Alarm sending and converging type. The value 0 indicates that alarms are sent consecutively. The value 1 indicates that alarms are sent exponentially. Example: 1
AlarmNotifyPeriod	yes	no	Int64	Alarm sending period in seconds. The value u003c0 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. Example: 5

MonitorProductInfo

Product information returned by the DescribeMonitorProductByIds API.

Referenced by the following interfaces: DescribeMonitorProductByIds

name	required	NULL allowed	type	description
Id	yes	yes	String	The product code. Example: 10
ProductName	yes	yes	String	Product name. Example: cvm_device
PolicyViewName	yes	yes	String	Product view name. Example: cvm_device
AvaliableRegions	yes	yes	Array of String	Region supported. Example: ["gz"]
IsShowInDashboard	yes	yes	Bool	Whether the Dashboard is visible. Example: false
Meta	yes	yes	String	Product details. JSON string. Example: qwer
Namespace	yes	yes	String	Namespace of the product. Example: QCE/CVM

ProductHealthStatus

HealthStatus returned by the DescribeProductHealthStatusList API.

Referenced by the following interfaces: DescribeProductHealthStatusList

name	required	NULL allowed	type	description
ViewName	yes	yes	String	View name. Example: cvm_device
HealthStatus	yes	yes	Int64	Health status. 1: not recovered. Example: 1
WarningCount	yes	yes	Int64	Number of reminders. Example: 1
AbnormalCount	yes	yes	Int64	Number of exceptions. Example: 1
AlarmRegions	yes	yes	Array of String	List of regions that receive alarms. Example: ["gz"]

DescribePolicyUseList

Object returned by the DescribePolicyUseList API.

Referenced by the following interfaces: DescribePolicyUseList

name	required	NULL allowed	type	description
UniqueId	yes	no	String	Unique ID of the alarm object. Example: eqeq-czda
Dimensions	yes	no	String	Dimension string. Example: {"unInstanceId":"ins-xxx"}

DescribeEventPolicyConfigDimension

Referenced by the following interfaces: DescribeEventPolicyConfig

name	required	NULL allowed	type	description
Name	yes	no	String	The name of the dimension. Example: Testing
Key	yes	no	String	Dimension key value. Example: qwer

AlarmBindingInstance

Referenced by the following interfaces: DescribeAlarmBindingInstanceList

name	required	NULL allowed	type	description
UUID	yes	no	String	Instance UUID. Example: u78haeoyaq8w8wbr
Information	yes	no	String	Information about instance dimension combinations. Example: {"appid":1251000011,"projectid":10,"vm_uuid":"9566dd15-fb0a-4515-9b87-09ad16d87884"}

AttributeUnitInfoOutput

Referenced by the following interfaces: DescribeAttributeUnits

name	required	NULL allowed	type	description
UnitId	yes	no	Uint64	Metric unit ID. Example: 1
UnitName	yes	no	String	Metric unit name. Example: test

DescribeBindingPolicyObjectListInstanceGroup

Instance group information returned by the DescribeBindingPolicyObjectList API

Referenced by the following interfaces: DescribeBindingPolicyObjectList

name	required	NULL allowed	type	description
InstanceGroupId	yes	no	Int64	Instance group ID. Example: 1234
ViewName	yes	no	String	Name of the alarm policy type. Example: cvm_device
LastEditUin	yes	no	String	Uin that was last edited. Example: 123456
GroupName	yes	no	String	Instance group name. Example: Testing
InstanceSum	yes	no	Int64	Number of instances. Example: 10
UpdateTime	yes	no	Int64	Update time. Example: 1735095122
InsertTime	yes	no	Int64	Creation time. Example: 1735095122
Regions	yes	yes	Array of String	Regions where the instances reside. Example: ["gz"]

AlarmPolicyEventCondition

Event trigger condition of alarm policy

Referenced by the following interfaces: CreateAlarmPolicy, DescribeAlarmPolicies, DescribeAlarmPolicy, ModifyAlarmPolicyCondition

name	required	NULL allowed	type	description
Rules	yes	yes	Array of AlarmPolicyRule	Alarm trigger condition list. Example:View

CCMChartData

Referenced by the following interfaces: DescribeCCMCharts

name	required	NULL allowed	type	description
Data	yes	no	Array of CCMChartEntry	Returns the data list. Example:View
TotalCount	yes	no	Int64	Queries the total amount of data. Example: 10

CreatePolicyGroupEventCondition

Event alarm condition passed in when a policy is created.

Referenced by the following interfaces: CreatePolicyGroup

name	required	NULL allowed	type	description
RuleId	no	no	Int64	If a metric is created based on a template, the RuleId of the metric in the template must be passed in. Example: 1
EventId	yes	no	Int64	Alarm event ID. Example: 1
AlarmNotifyType	yes	no	Int64	Alarm sending and converging type. The value 0 indicates that alarms are sent consecutively. The value 1 indicates that alarms are sent exponentially. Example: 1
AlarmNotifyPeriod	yes	no	Int64	Alarm sending period in seconds. The value u003c0 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. Example: 5

DescribePolicyConditionListConfigManualStatType

DescribePolicyConditionList.ConfigManual.StatType

Referenced by the following interfaces: DescribePolicyConditionList

name	required	NULL allowed	type	description
P5	yes	yes	String	Data aggregation method in a period of 5 seconds. Example: 5
P10	yes	yes	String	Data aggregation method in a period of 10 seconds. Example: 10
P60	yes	yes	String	Data aggregation method in a period of 1 minute. Example: 60
P300	yes	yes	String	Data aggregation method in a period of 5 minute. Example: 300
P600	yes	yes	String	Data aggregation method in a period of 10 minute. Example: 600
P1800	yes	yes	String	Data aggregation method in a period of 30 minute. Example: 1800
P3600	yes	yes	String	Data aggregation method in a period of 1 hour. Example: 3600
P86400	yes	yes	String	Data aggregation method in a period of 1 day. Example: 86400

MetricAggregation

Metric aggregation method.

Referenced by the following interfaces: DescribeAlarmMetrics

name	required	NULL allowed	type	description
NameCn	yes	no	String	Name. Example: test
NameEn	yes	no	String	The name. Example: Testing
Id	no	yes	String	The ID. Example: 1
Name	no	yes	String	Name Example: Testing

DescribeAccidentConfigAccident

Platform event of the DescribeAccidentConfig API.

Referenced by the following interfaces: DescribeAccidentConfig

name	required	NULL allowed	type	description
BusinessId	yes	no	Int64	Business ID. Example: 10
BusinessName	yes	no	String	Business name. Example: qwer
BusinessEnName	yes	no	String	Business name. Example: qwer
PolicyShowName	yes	no	String	Displayed strategy name. Example: qwer
PolicyShowEnName	yes	no	String	Displayed strategy name in English. Example: qwer
PolicyViewName	yes	no	String	Policy type name. Example: cvm_device
AccidentTypeInfo	yes	no	Array of DescribeAccidentConfigAccidentTypeInfo	List of platform event types. Example:View

IdcInfo

Referenced by the following interfaces: DescribeIdcServerCount

name	required	NULL allowed	type	description
IdcId	yes	no	Int64	Region ID. Example: 12345
ServerCount	yes	no	Int64	Number of instances. Example: 10
IdcName	yes	no	String	The region name. Example: Testing

DashboardMetricQuery

Dashboard 2.0 metric query input parameter structure.

Referenced by the following interfaces: DescribeDashboardMetricData

name	required	NULL allowed	type	description
StartTime	yes	no	Datetime_iso	Start time of the query period in ISO format, such as: 2018-04-10T10:15:58.858Z. Example: 2019-11-29T12:30:13+08:00
EndTime	yes	no	Datetime_iso	End time of the query period in ISO format, such as: 2018-04-10T10:15:58.858Z. Example: 2019-03-24T20:50:00+08:00
Datasource	yes	no	String	Data source. Example: DS_QCEMetric
Namespace	yes	no	String	The name of the namespace. Example: QCE/CVM
MetricName	yes	no	String	Name of the query metric. Example: LanOuttraffic
Period	no	no	Int64	Statistical period in seconds. The default value is 60 seconds. Example: 60
GroupBy	yes	no	Array of String	Group. Fill in the metric dimension. Example: LanOuttraffic
Aggregate	no	no	String	Aggregation method. Fill in the aggregation method according to the metric type. Example: min
Conditions	yes	no	Array of DashboardMetricCondition	Filter condition. Example:View
SeriesId	no	no	String	Query flag. Example: 1a6deff1-7991-4d82-a8c1-44b66e1c33f6
DataSourceRegion	no	no	String	Name of the data source region. Example: gz
ConfigId	no	no	String	Product configuration ID. Example: cvm
QueryVersion	no	no	String	Queries the version number. Leave it empty for the old version. For the new version, pass in "2020-10-21". Example: 2020-10-21
OrderBy	no	no	String	Calculation method of sort value. Valid values: avg, sum, min, max. Example: desc
AscDesc	no	no	String	Sort order. Valid values: asc, desc. Example: desc
Limit	no	no	Uint64	Number of items to be sorted. Example: 10

ClmMetricBasicItem

Basic metric configurations for the log monitoring metric set.

Referenced by the following interfaces: CreateMetricSet, DescribeMetricSet, DescribeMetricSets, ModifyMetricSet

name	required	NULL allowed	type	description
Field	yes	yes	String	Field name. Example: timeField
Operator	yes	yes	String	Metric statistics method: sum, count, min, max. Example: =
Name	yes	yes	String	Metric name. Example: Testing
Desc	yes	yes	String	Metric description name. Example: Testing
StatisticFilterRules	no	yes	Array of ClmStatisticFilterRule	Metric filtering rule. Example:View
Id	no	yes	Int64	Item ID (only for output parameter; leave it empty for input parameter) Example: 1
MetricSetId	no	yes	Int64	Metric set ID (only for output parameter; leave it empty for input parameter) Example: 1
CreatedAt	no	yes	String	Creation time (only for output parameter; leave it empty for input parameter) Example: eqeadfrqc
UpdatedAt	no	yes	String	Update time (only for output parameter; leave it empty for input parameter) Example: eqeadfrqc

AttributeInfoOutputData

Attribute data list.

Referenced by the following interfaces: DescribeAttributes

name	required	NULL allowed	type	description
Data	yes	no	Array of AttributeInfoOutput	Attribute data list. Example:View
TotalCount	yes	no	Int64	Number of attribute data lists. Example: 10

DashboardDimensionSource

Dashboard2.0 dimension list.

Referenced by the following interfaces: DescribeDashboardDimensionKeys

name	required	NULL allowed	type	description
DataSource	yes	no	String	Data source. Example: DS_QCEMetric
Namespace	yes	no	String	Namespace. Example: cvm_device
DimensionName	yes	no	String	Dimension name. Example: Testing
MetricName	yes	no	String	Metric name. Example: cpu_usage

DescribePolicyInfoByInstanceInstanceGroup

Referenced by the following interfaces: DescribePolicyInfoByInstance

name	required	NULL allowed	type	description
InstanceGroupID	yes	yes	Int64	Instance group ID. Example: 1234
ViewName	yes	no	String	View. Example: cvm_device
LastEditUin	yes	yes	Int64	UIN of the last editor. Example: 123456
GroupName	yes	no	String	Instance group name. Example: Testing
InstanceSum	yes	yes	Int64	Number of instances. Example: 10
UpdateTime	yes	yes	Int64	Update time. Example: 1735095122
InsertTime	yes	yes	Int64	Creation time. Example: 1735095122

ClmLogFilterRule

Metric set filtering rule for log monitoring.

Referenced by the following interfaces: CreateMetricSet, DescribeMetricSet, DescribeMetricSets, ModifyMetricSet

name	required	NULL allowed	type	description
Relation	yes	no	Int64	Relationship. 1: AND. 2: OR. Example: 1
Field	yes	no	String	Field name. Example: timeField
Operator	yes	no	String	Filter operator: Numeric fields supoort: gt lt ge le eq ne in. Character fields support: eq ne in contains. Example: =
Value	yes	no	String	Filter operation value. Example: 50
Id	no	no	Int64	Item ID (only for output parameter; leave it empty for input parameter) Example: 1
MetricSetId	no	no	Int64	Metric set ID (only for output parameter; leave it empty for input parameter) Example: 12
CreatedAt	no	no	String	Creation time (only for output parameter; leave it empty for input parameter) Example: eqeadfrqc
UpdatedAt	no	no	String	Update time (only for output parameter; leave it empty for input parameter) Example: eqeadfrqc

IdcData

Referenced by the following interfaces: DescribeIdcTree

name	required	NULL allowed	type	description
Id	yes	no	Int64	idc id, which represents zoneId on the cloud platform. Example: 1
Name	yes	no	String	idc id, which represents zone name on the cloud platform. Example: Testing

SubscribeInfoReceiver

Output parameter of DescribeSubscribeInfo.

Referenced by the following interfaces: DescribeSubscribeInfo

name	required	NULL allowed	type	description
Username	yes	yes	String	User name. Example: test
Uin	yes	yes	String	User UIN. Example: 123456
Uid	yes	yes	String	User UID. Example: 1234

AlarmPolicyQuota

Specific v2.0 alarm policy quota.

Referenced by the following interfaces: DescribeAlarmObjectQuota, DescribeAlarmPolicyQuota

name	required	NULL allowed	type	description
AppId	yes	no	Int64	The account ID. Example: 1234
Namespace	yes	no	String	Policy type. "": no policy type. Example: cvm_device
ProjectId	yes	no	Int64	Project ID. -1: no project. Example: 1
Total	yes	no	Int64	Total amount of quotas. Example: 10
Used	yes	no	Int64	Number of used resources. Example: 10

DescribeAlarmSmsQuotaQuota

Quota information of the DescribeAlarmSmsQuota API.

Referenced by the following interfaces: DescribeAlarmSmsQuota

name	required	NULL allowed	type	description
Type	yes	no	String	The quota type. Example: cloud_test
Name	yes	no	String	Quota name. Example: Cloud Automated Testing alarm
FreeLeft	yes	no	Int64	Remaining free quota. Example: 100
PurchaseLeft	yes	no	Int64	Remaining paid quota. Example: 200
Used	yes	no	Int64	Number of used resources. Example: 100

DescribePolicyConditionListEventMetric

DescribePolicyConditionList.EventMetric

Referenced by the following interfaces: DescribePolicyConditionList

name	required	NULL allowed	type	description
EventId	yes	no	Int64	Event ID. Example: 10
EventShowName	yes	no	String	Event name. Example: ReadOnly
NeedRecovered	yes	no	Bool	Whether to recover. Example: true
Type	yes	no	Int64	Event type, which is a reserved field. Currently, it is fixed to 2. Example: 1

DashboardMetricEntry

Dashboard2.0 metric information.

Referenced by the following interfaces: DescribeDashboardMetrics

name	required	NULL allowed	type	description
Namespace	yes	no	String	Namespace value. Example: QCE/CVM
MetricName	yes	no	String	Metric name. Example: WanIntraffic
MetricType	yes	no	String	The metric type. Example: QCEMetric
Aggregations	yes	no	Array of String	Aggregation method of the metric. Example: Max
Description	yes	no	String	Displayed metric name. Example: Public Network Inbound Bandwidth
Unit	yes	no	String	Metric data unit. Example: Mbps
Min	yes	no	Float	Minimum value. Example: 0
Max	yes	no	Float	Maximum value. Example: 0
Dimensions	yes	no	Array of String	The dimensions. Example: {"unInstanceId":"ins-xxx"}

NoticeContentTmpl

Information on the queried custom content templates.

Referenced by the following interfaces: DescribeNoticeContentTmpl

name	required	NULL allowed	type	description
TmplID	no	no	String	Template ID Example: tmpl-xxx
TmplName	no	no	String	Template name. Example: tmplName
MonitorType	no	no	String	Monitoring type. Example: MT_QCE
TmplContents	no	no	NoticeContentTmplItem	Content template details. Example:View
TmplLanguage	no	no	String	Template language. Valid values: en and zh. Example: zh
CreateTime	no	no	Int64	Creation time. It is a Unix timestamp in second. Example: 1729655205
UpdateTime	no	no	Int64	Modification time. It is a Unix timestamp in second. Example: 1729655205
LastModifier	no	no	String	Last Modified By Example: tester-b
Creator	no	no	String	Creator. Example: tester-a
IsPreset	no	no	Int64	Whether the template content is the default content. 0: no; 1: yes. Example: 0

DashboardNamespace

Namespace information under Dashboard2.0 data source.

Referenced by the following interfaces: DescribeAllNamespaces, DescribeDashboardNamespaces

name	required	NULL allowed	type	description
Id	yes	no	String	Namespace identifier. Example: dcchannel
Name	yes	no	String	The name of the namespace. Example: Direct Connect—Dedicated tunnel
Value	yes	no	String	Namespace value. Example: QCE/DCX
ProductName	yes	yes	String	Product name. Example: Direct Connect—Dedicated tunnel
Config	yes	yes	String	Configuration information. Example: {}
AvailableRegions	yes	yes	Array of String	List of supported regions. Example: ["gz"]
SortId	yes	yes	Int64	Sort ID. Example: 301
Type	no	yes	String	Namespace type. Example: BUSINESS
DashboardId	no	no	String	DashboardId Example: eipv6

ClmLogProfileItem

Log monitoring metric set - log data structure description.

Referenced by the following interfaces: CreateMetricSet, DescribeMetricSet, DescribeMetricSets, ModifyMetricSet

name	required	NULL allowed	type	description
Id	no	no	Int64	ID (only for output parameter; leave it empty for input parameter) Example: 1
MetricSetId	no	no	Int64	Associated metric set ID (only for output parameter; leave it empty for input parameter) Example: 12
Field	yes	no	String	Field name. Example: timeField
Type	yes	no	String	Field type. Valid values: string, long, double. Example: string
CreatedAt	no	no	String	Creation time (only for output parameter; leave it empty for input parameter). Example: eqeadfrqc
UpdatedAt	no	no	String	Update time (only for output parameter; leave it empty for input parameter). Example: eqeadfrqc

DescribeBasicAlarmListAlarms

Alarms returned by DescribeBasicAlarmList

Referenced by the following interfaces: DescribeBasicAlarmList

name	required	NULL allowed	type	description
Id	yes	no	Uint64	ID of the alarm. Example: 1
ProjectId	yes	yes	Int64	Project ID. Example: 1
ProjectName	yes	yes	String	Project Name Example: Testing
Status	yes	yes	Int64	Alarm status ID. Example: 1
AlarmStatus	yes	yes	String	Alarm status. Example: ALARM
GroupId	yes	yes	Int64	Policy group ID. Example: 1234
GroupName	yes	yes	String	Policy group name. Example: Testing
FirstOccurTime	yes	yes	String	Event time. Example: 1735095122
Duration	yes	yes	Int64	Duration in seconds. Example: 10
LastOccurTime	yes	yes	String	End time. Example: 1735095122
Content	yes	yes	String	The alarm content. Example: qwer
ObjName	yes	yes	String	Alarm object. Example: 172.16.0.15#75904
ObjId	yes	yes	String	Alarm object ID. Example: 0a523bfb-dd09-47e2-a85c-0b23455b0949
ViewName	yes	yes	String	Policy type Example: cvm_device
Vpc	yes	yes	String	VPC, which is unique to CVM. Example: qwer
MetricId	yes	yes	Int64	Metric ID. Example: 10
MetricName	yes	yes	String	Metric name. Example: CpuUsage
AlarmType	yes	yes	Int64	Alarm type. The value 0 indicates metric alarms. The value 2 indicates product event alarms. The value 3 indicates platform event alarms. Example: 1
Region	yes	yes	String	Region. Example: gz
Dimensions	yes	yes	String	Dimension information of an alarm object. Example: {"unInstanceId":"ins-xxx"}
NotifyWay	yes	yes	Array of String	Notification method. Example: sms
InstanceGroup	yes	yes	Array of InstanceGroup	Instance group information. Example:View

MoveFailReason

Reasons why the dashboard failed to be moved.

Referenced by the following interfaces: MoveUnifyDashboards

name	required	NULL allowed	type	description
UUID	yes	no	String	UUID of the dashboard. Example: daaeqe
Msg	yes	no	String	Reasons why the movement failed. Example: ok

DashboardMetricCondition

Query condition for the Dashboard2.0 metric query.

Referenced by the following interfaces: DescribeDashboardMetricData

name	required	NULL allowed	type	description
Dimension	yes	no	Array of String	Array elements are JSON serialized strings. Example: {"unInstanceId":"ins-00jvv9mo"}
Region	yes	no	String	Domain name Example: gz

MonitorDimensionSource

Dimensio Key Sources.

Referenced by the following interfaces: DescribeDashboardDimensionKeys

name	required	NULL allowed	type	description
Namespace	yes	no	String	Namespace. Example: QCE/CVM
Metric	yes	no	String	List of metrics. Example: CpuUsage
SearchValue	yes	no	String	The values. Example: qwer

Instance

Array of instance dimension combinations

Referenced by the following interfaces: DescribePolicyGroupCount, GetMonitorData

name	required	NULL allowed	type	description
Dimensions	yes	no	Array of Dimension	Dimension combination of an instance. Example:View

AlarmPolicyFilter

Filter condition of alarm policy

Referenced by the following interfaces: CreateAlarmPolicy, DescribeAlarmPolicies, DescribeAlarmPolicy, ModifyAlarmPolicyCondition

name	required	NULL allowed	type	description
Type	yes	no	String	Filter condition type. Valid values: DIMENSION (uses dimensions for filtering). Example: =
Expression	no	no	String	Bare write filter expression. Example: test
Dimensions	no	no	String	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. Example: test

DashboardPanel

Dashboard panel.

Referenced by the following interfaces: AddDashboardPanels, TopDashboardPanel

name	required	NULL allowed	type	description
Type	no	no	String	copy
DashboardUUID	no	no	String	UUID of the dashboard. Example: u78haeoyaq8w8wbr
PanelID	no	no	Int64	Panel ID. Example: 1234
Panel	no	no	String	Panel data. Example: qwer

DescribeDashboardViewList

Referenced by the following interfaces: DescribeDashboardViews

name	required	NULL allowed	type	description
ViewID	yes	no	Int64	View ID. Example: 1
DescName	yes	no	String	Description name. Example: Testing
Namespace	yes	no	String	Namespace. Example: QCE/CVM
MetricName	yes	yes	Array of String	List of metric names. Example: CpuUsage
Meta	yes	no	String	Metadata JSON. Example: {"aggregateType":"detail","aggregations":["Avg","Max","Min"],"chartTypes":["column"],"configId":"cvm","layout":{"h":"5","h2":"0","w":"4","x":"0","y":"0"},"timeAggregate":"last"}
Instances	yes	yes	Array of String	Instance list. Example: ["ins-xxx"]

AlarmPolicy

Alarm policy details

Referenced by the following interfaces: DescribeAlarmPolicies, DescribeAlarmPolicy

name	required	NULL allowed	type	description
PolicyId	yes	yes	String	Alarm policy ID. Example: policy-abc123
PolicyName	yes	yes	String	The name of the alarm policy. Example: Testing
Remark	yes	yes	String	Remarks. Example: Testing
MonitorType	yes	yes	String	Monitor type. Valid values: MT_QCE (Cloud Platform service monitoring) Example: MT_QCE
Enable	yes	yes	Int64	Enabled or disabled status. 1: enabled. 0: disabled. Example: 1
UseSum	yes	yes	Int64	Number of instances bound to the policy group. Example: 10
ProjectId	yes	yes	Int64	Project ID. -1: no project. 0: default project. Example: 1
ProjectName	yes	yes	String	Project name. Example: Testing
Namespace	yes	yes	String	Alarm policy type. Example: cvm_device
Measurement	yes	yes	String	That is, viewName / View. Cloud Platform service monitoring: cvm_device, etc. Custom monitoring: Measurement under Namespace. Example: test
PolicyExpression	yes	yes	String	Writes alarm rules including trigger rules, filter conditions, etc. It is suitable for prometheus monitoring. Example: Testing
ConditionTemplateId	yes	yes	String	Trigger condition template ID. Example: 1234
Condition	yes	yes	AlarmPolicyCondition	Metric trigger condition. Example:View
EventCondition	yes	yes	AlarmPolicyEventCondition	Event trigger condition. Example:View
NoticeIds	yes	yes	Array of String	List of notification rule IDs. Example: ["1234"]
Notices	yes	yes	Array of AlarmNotice	Notification rule list. Example:View
TriggerTasks	yes	yes	Array of AlarmPolicyTriggerTask	List of trigger tasks. Example:View
OriginID	no	yes	String	Obsolete field. Policy ID for APIs for binding and unbinding instances or instance groups (BindingPolicyObject, UnBindingAllPolicyObject, UnBindingPolicyObject). Example: 1234
ConditionsTemp	yes	yes	ConditionsTemp	Template-based policy group. Note: This field may return null, indicating that no valid value was found. Example:View
LastEditUin	yes	yes	String	UIN of the last user who modified it. Example: 5678
UpdateTime	yes	yes	Int64	Update time. Note: This field may return null, indicating that no valid value was found. Example: 1735022702
InsertTime	yes	yes	Int64	Creation time. Note: This field may return null, indicating that no valid value was found. Example: 1735002702
Region	yes	yes	Array of String	Region. Example: gz
NamespaceShowName	yes	no	String	Namespace display name. Example: cvm_device
IsDefault	yes	no	Int64	Whether it is the default policy. Valid values: 1 (yes), 0 (no). Example: 1
CanSetDefault	yes	no	Int64	Whether the default policy can be set. Valid values: 1 (yes), 0 (no). Example: 1
InstanceGroupId	yes	no	Int64	Instance group ID. Example: 1234
InstanceSum	yes	no	Int64	Total number of instances in instance group. Example: 10
InstanceGroupName	yes	no	String	Instance group name. Example: test
JsConfig	yes	no	String	JsConfig foreground configuration. Example: {"cluster_name":"es-dnxsssss"}
RuleType	yes	no	String	Trigger condition type. Valid values: STATIC (static threshold), DYNAMIC (dynamic). Example: STATIC
OriginId	yes	no	String	Policy ID for APIs for binding and unbinding instances or instance groups (BindingPolicyObject, UnBindingAllPolicyObject, UnBindingPolicyObject). Example: 1234
TagInstances	yes	yes	Array of TagInstance	Tag. Example:View
Filter	no	yes	String	Filter Example: {"Dimensions":"","Expression":"","Type":""}
GroupBy	no	yes	String	GroupBy Example: {"Id":"","Name":""}
NoticeContentTmplBindInfos	no	no	NoticeContentTmplBindInfo	Information on the notification template and content template. Example:View
AlarmLevel	no	no	String	Alarm Level Example: Remind

DescribeProductEventListEventsDimensions

Dimensions of events returned by the DescribeProductEventList API

Referenced by the following interfaces: DescribeProductEventList

name	required	NULL allowed	type	description
Key	yes	yes	String	Dimension name (English). Example: readOnly
Name	yes	yes	String	Dimension name. Example: Disk read-only
Value	yes	yes	String	The value of the dimension. Example: qwer

DescribeDashboardsList

Referenced by the following interfaces: DescribeDashboards

name	required	NULL allowed	type	description
DashboardID	yes	no	String	DashboardID Example: eipv6
DescName	yes	no	String	Description name. Example: test
Meta	yes	no	String	Metadata. Example: {"aggregateType":"detail","aggregations":["Avg","Max","Min"],"chartTypes":["column"],"configId":"cvm","layout":{"h":"5","h2":"0","w":"4","x":"0","y":"0"},"timeAggregate":"last"}

ClmAlertTriggerRule

Deprecated parameter.

Referenced by the following interfaces: CreateAlertPolicy, DescribeAlertPolicies, DescribeAlertPolicy, ModifyAlertPolicy

name	required	NULL allowed	type	description
Id	no	yes	Int64	Trigger condition ID (output parameter). Example: 1
CreatedAt	no	yes	String	Creation time (output parameter). Example: eqeadfrqc
UpdatedAt	no	yes	String	Update time (output parameter). Example: eqeadfrqc
AlertPolicyId	yes	yes	Int64	Primary key ID of the associated alarm policy. Example: 1234
MetricName	yes	yes	String	Metric name (English). Example: cpu_usage
MetricType	yes	yes	Int64	Metric type. 1: common metric. 2: compound metric. Example: 1
Operating	yes	yes	String	Operator. Example: =
Value	yes	yes	Float	Metric threshold. Example: 50
ContinuousCycleCount	yes	yes	Int64	Number of consecutive periods. Example: 10
NoticeFrequencySec	yes	yes	Int64	Notification frequency (interval between notifications in seconds). Example: 10
MetricFormula	no	yes	String	Compound index expression (leave it empty for basic indexes). Example: {"cluster_name":"es-dnxsssss"}

DescribeGraphDataPartition

Referenced by the following interfaces: DescribeGraphData

name	required	NULL allowed	type	description
Name	yes	no	Array of String	Partition name. Example: Testing
Usage	yes	no	Float	Usage. Example: 1234
Total	yes	no	Float	Total. Example: 10

ProductSimple

Brief information on products supported by Cloud Monitor.

Referenced by the following interfaces: DescribeProductList

name	required	NULL allowed	type	description
Namespace	yes	no	String	Namespace. Example: QCE/CVM
ProductName	yes	no	String	The name of the product. Example: cvm_device
ProductEnName	yes	no	String	English name of the product. Example: test

DescribePolicyConditionListConfigManualPeriodNum

DescribePolicyConditionList.ConfigManual.PeriodNum

Referenced by the following interfaces: DescribePolicyConditionList

name	required	NULL allowed	type	description
Default	yes	yes	Int64	Number of default periods. Example: 10
Keys	yes	yes	Array of Int64	Number of custom periods. Example: 10
Need	yes	no	Bool	Whether required. Example: true

DescribeInstanceGroupListInstanceGroup

Instance group information returned by the DescribeInstanceGroupList API.

Referenced by the following interfaces: DescribeInstanceGroupList

name	required	NULL allowed	type	description
InstanceGroupId	yes	no	Int64	Instance group ID. Example: 1234
ViewName	yes	no	String	Instance group policy type name. Example: cvm_device
LastEditUin	yes	no	String	UIN of the latest update. Example: 123456
GroupName	yes	no	String	Instance group name. Example: Testing
InstanceSum	yes	no	Int64	Number of instances in the group. Example: 10
UpdateTime	yes	no	Int64	Update time in the format of Unix timestamp. Example: 1735095122
InsertTime	yes	no	Int64	Creation time in the format of Unix timestamp. Example: 1735095122
PolicyGroups	yes	yes	Array of DescribeInstanceGroupListPolicyGroup	List of bound alarm policy groups. Example:View

ModifyRecoverNotifyBatchNotifyInfo

ModifyRecoverNotifyBatch recovery method information.

Referenced by the following interfaces: ModifyRecoverNotifyBatch

name	required	NULL allowed	type	description
GroupId	yes	no	Int64	Policy group ID. Example: 1234
RecoverNotify	yes	no	Array of String	List of alarm recovery notification methods. Example: sms

StrategyEntryAlarm

Referenced by the following interfaces: CreateStrategy, DescribeCCMGroupViewStrategy, DescribeStrategys, ModifyStrategy

name	required	NULL allowed	type	description
AlarmType	yes	no	Uint64	Alarm rule type for the policy. 100: Maximum value (i.e. >), 101: Maximum value (i.e. >=), 102: Minimum value alarm (i.e. <), 103: Minimum value alarm (i.e. <=), 104: Fluctuation value alarm. Example: 1
AttributeId	yes	no	Uint64	Alarm rule attribute ID of the policy. Example: 1
Threshold	yes	no	Int64	Alarm rule threshold of the policy. Example: 1
DetectCount	yes	no	Int64	Policy's alarm rule: the number of alarms in DetectPeriod minutes. Example: 1
DetectPeriod	yes	no	Int64	Alarm period of the policy. Example: 1
TriggerPeriod	yes	no	Int64	Policy's alarm rule: alarm interval period. Example: 1
Description	yes	no	String	Description. Example: Testing
AttributeName	no	yes	String	Metric description. Example: Testing
AttributeUniqueName	no	yes	String	Metric description in English. Unique name. Example: qwer_123

SubscribeInfo

Output parameter of DescribeSubscribeInfo.

Referenced by the following interfaces: DescribeSubscribeInfo

name	required	NULL allowed	type	description
BusinessId	yes	yes	Int64	Event type ID. Example: 1
BusinessName	yes	yes	String	Event name. Example: qwer
AccidentId	yes	yes	Int64	Question type ID. Example: 1
AccidentName	yes	yes	String	Question name. Example: XXXX
NotifyWay	yes	yes	Array of Int64	Notification method. Example: 1
Receivers	yes	yes	Array of SubscribeInfoReceiver	Recipient list. Example:View
Tips	yes	yes	String	Prompt. Example: qwer
UserConfig	yes	yes	String	User configuration. JSON string. Example: {"qwer":"1234"}

DescribeInstanceGroupListPolicyGroup

Policy group information returned by the DescribeInstanceGroupList API.

Referenced by the following interfaces: DescribeInstanceGroupList

name	required	NULL allowed	type	description
GroupId	yes	no	Int64	Policy group ID. Example: 1234
GroupName	yes	no	String	Policy group name. Example: Testing

GroupTemplateList

GetRecommendedTemplateResponse.GroupTemplateList

Referenced by the following interfaces: DescribeRecommendedTemplate

name	required	NULL allowed	type	description
GroupID	yes	no	Int64	Template policy group ID. Example: 1234
GroupName	yes	no	String	Template-based policy group name. Example: Testing
IsDefault	yes	no	Int64	Whether it is a default policy. Example: 1
Enable	yes	no	Bool	Enablement status of the alarm policy. Example: true
LastEditUin	yes	no	Int64	UIN of the last user who modified it. Example: 123456
NoShieldedInstanceCount	yes	no	Int64	Number of unshielded instances. Example: 10
TotalInstanceCount	yes	no	Int64	Total number of bound instances. Example: 10
ParentGroupID	yes	no	Int64	Parent policy group ID. Example: 1234
Remark	yes	no	String	Remarks. Example: Marker
ViewName	yes	no	String	View. Example: cvm_device
Conditions	yes	no	Array of Condition	Metric alarm trigger condition. Example:View
EventConditions	yes	no	Array of EventCondition	Event alarm trigger condition. Example:View
CanSetDefault	yes	no	Bool	Whether the policy can be set as the default policy. Example: true
InsertTime	yes	no	Int64	Creation time. Example: 1735129241
UpdateTime	yes	no	Int64	Modification time. Example: 1735129241

ClmDescribeMetricSetsData

DescribeMetricSets return data.

Referenced by the following interfaces: DescribeMetricSets

name	required	NULL allowed	type	description
MetricSets	yes	yes	Array of ClmMetricSet	Metric set list data. Example:View
TotalCount	yes	no	Int64	Total number. Example: 10

AttributeServerInfoOutputData

Referenced by the following interfaces: DescribeAttributeAllServer, DescribeIdcServer

name	required	NULL allowed	type	description
Data	yes	no	Array of AttributeServerInfoOutput	Returns a list of servers reporting this attribute. Example:View
TotalCount	yes	no	Int64	Returns the number of server lists reporting this attribute. Example: 10

DescribePolicyGroupInfoConditionTpl

Template-based policy group information output by the policy query

Referenced by the following interfaces: DescribePolicyGroupInfo, DescribePolicyGroupList

name	required	NULL allowed	type	description
GroupId	yes	no	Int64	Policy group ID. Example: 1234
GroupName	yes	no	String	Policy group name. Example: Testing
ViewName	yes	no	String	Policy type Example: cvm_device
Remark	yes	no	String	Policy group remarks. Example: test
LastEditUin	yes	no	String	UIN of the last user who modified it. Example: 123456
UpdateTime	yes	yes	Int64	Update time. Example: 1735095122
InsertTime	yes	yes	Int64	Creation time. Example: 1735095122
IsUnionRule	yes	yes	Int64	Whether it is an AND rule. Example: 1

StrategyData

Referenced by the following interfaces: DescribeCCMGroupViewStrategy, DescribeStrategys

name	required	NULL allowed	type	description
Data	yes	no	Array of StrategyEntry	Return data. Example:View
TotalCount	yes	no	Int64	Queries the total number of data lists. Example: 10

PCLMMetricAnalysisPoint

CLM metric analysis data point.

Referenced by the following interfaces: DescribeMetricAnalysisData

name	required	NULL allowed	type	description
Timestamp	yes	no	Int64	Timestamp (seconds). Example: 1735129241
Value	yes	yes	Float	Value. Example: 10
Name	yes	no	String	Metric name. Example: Testing

DescribePolicyConditionListConfigManualCalcType

DescribePolicyConditionList.ConfigManual.CalcType

Referenced by the following interfaces: DescribePolicyConditionList

name	required	NULL allowed	type	description
Keys	yes	yes	Array of Int64	Value of CalcType. Example: 1
Need	yes	no	Bool	Whether required. Example: true

DescribePolicyInfoByInstanceGroupList

Referenced by the following interfaces: DescribePolicyInfoByInstance

name	required	NULL allowed	type	description
GroupID	yes	no	Int64	Policy group ID. Example: 1234
GroupName	yes	no	String	Policy name. Example: Testing
IsOpen	yes	no	Bool	Indicates whether self-healing notifications are enabled. Example: true
ViewName	yes	no	String	View name. Example: cvm_device
LastEditUin	yes	no	Int64	UIN of the last editor. Example: 123456
IsDefault	yes	no	Int64	Whether it is a default policy. Example: 1
CanSetDefault	yes	no	Bool	Whether it can be set as the default policy. Example: true
ParentGroupID	yes	no	Int64	Parent policy group ID. Example: 1234
Remark	yes	no	String	Description. Example: Testing
IsUnionRule	yes	no	Int64	Whether it is an AND relationship policy. Example: 1
ProjectID	yes	no	Int64	Project ID. Example: 1
Conditions	yes	yes	Array of Condition	Alarm rule. Example:View
ConditionsTemp	yes	yes	DescribePolicyInfoByInstanceConditionsTemp	Rule template information. Example:View
InstanceGroup	yes	yes	DescribePolicyInfoByInstanceInstanceGroup	Instance group. Example:View
NoShieldedSum	yes	no	Int64	Number of unshielded instances. Example: 10
UseSum	yes	no	Int64	The total number of instances. Example: 10
UpdateTime	yes	no	Int64	Update time. Example: 1735095122
InsertTime	yes	no	Int64	Creation time. Example: 1735095122

CCMChartEntry

Referenced by the following interfaces: DescribeCCMCharts

name	required	NULL allowed	type	description
ChartId	yes	no	Int64	Monitoring chart ID. Example: 1
ViewId	yes	no	Int64	Group view ID. Example: 1
ChartName	yes	no	String	Name of the monitoring chart. Example: test
ChartType	yes	no	Int64	Type of the monitoring chart. 1 Detail view, 2 Aggregate view. Example: 1
ProductType	yes	no	Int64	Product type. 1 Basic monitoring, 2 Custom monitoring. Example: cvm
AttributeId	yes	no	Int64	Metric ID. Example: 1
Aggregation	yes	no	Int64	Aggregation method. 0 SUM, 1 AVG, 2 MAX, 3 MIN Example: 1
Description	yes	no	String	Description. Example: test
CreatorId	yes	no	Uint64	Creator ID. Example: 1
CreateTime	yes	no	String	Creation time. Example: 1735041205
UpdaterId	yes	no	Uint64	Updater ID. Example: 1
UpdateTime	yes	no	String	Update time. Example: 1735041205
AttributeName	yes	yes	String	Metric name. Example: Testing
AttributeUniqueName	yes	yes	String	Unique English name of the metric. Example: qwer_123
UnitName	yes	yes	String	Metric unit name. Example: test

MidQueryCondition

DescribeMidDimensionValueList query conditions

Referenced by the following interfaces: DescribeMidDimensionValueList, DescribeStatisticData

name	required	NULL allowed	type	description
Key	yes	no	String	Dimension. Example: qwer
Operator	yes	no	String	Operator. Valid values: eq (equal to), ne (not equal to), in. Example: =
Value	yes	no	Array of String	Dimension value. If Operator is eq or ne, only the first element will be used. Example: 10

MiniDashboardAlarmInfo

MiniDashboard AlarmInfo

Referenced by the following interfaces: DescribeMiniDashboardAlarmInfo

name	required	NULL allowed	type	description
Dimension	no	no	String	Dimension information Example: {"name":"instanceId","value":"1"}
NoPolicy	no	no	Bool	No Alarm Policy Example: true
DefaultPolicyWithoutNotice	no	no	String	Default Policy without Notification Rule Example: policy-abcdef

MonitorTypeNamespace

Policy type

Referenced by the following interfaces: DescribeAlarmHistories

name	required	NULL allowed	type	description
MonitorType	yes	no	String	Monitoring type. Example: MT_QCE
Namespace	yes	no	String	Policy type value. Example: cvm_device

AlarmHistoryMetric

Metric information of alarm records

Referenced by the following interfaces: DescribeAlarmHistories, DescribeMiniDashboardAlarmInfo

name	required	NULL allowed	type	description
QceNamespace	yes	no	String	Queries the namespace used by the data. Example: qce/cvm
MetricName	yes	no	String	Metric name. Example: CpuUsage
Period	yes	no	Int64	Statistical period. Example: 60
Value	yes	no	String	Value that triggers the alarm. Example: 10
Tooltip	yes	yes	MetricTooltip	Explanation of the metric. Example:View
Description	yes	no	String	Display name of the metric. Example: CPU Utilization

StrategyEntry

Referenced by the following interfaces: DescribeCCMGroupViewStrategy, DescribeStrategys

name	required	NULL allowed	type	description
StrategyId	yes	no	Int64	The ID of the alarm policy. Example: 10
StrategyName	yes	no	String	The name of the alarm policy. Example: qwer
ReceiverType	yes	no	Int64	Alarm reception type. Example: 1
ReceiverId	yes	no	Array of Uint64	List of IDs of alarm recipient users or user groups. Example: 1234
EffectiveStartTime	yes	no	String	The start time of the validity period. Example: 1734953008
EffectiveEndTime	yes	no	String	The end time of the validity period. Example: 1734953808
AlarmChannel	yes	no	Array of String	Alarm channel list. Valid values: "SMS", "SITE", "EMAIL", "CALL", and "WECHAT". Example: sms
CallbackUrl	yes	no	String	Alarm callback address. Example: http://test.com
Description	yes	no	String	Description. Example: Testing
CreatorId	yes	no	Uint64	Creator ID. Example: 1
CreateTime	yes	no	String	Creation time. Example: 1735179378
UpdaterId	yes	no	Uint64	ID of the user who updated it. Example: 10
UpdateTime	yes	no	String	Update time. Example: 1735179378
IsStart	yes	no	Int64	Whether to start it. 0: stopping. 1: starting. Example: 1
MixType	yes	no	Uint64	Type of alarm objects, 1: server. 2: view. Example: 1
MixSubType	yes	no	Int64	Alarm object subtype. When MixType is 2, then MixId is a list of view IDs. When MixId is an empty array [], then the background will automatically query the default view ID. When MixType is 1 (server), if MixSubType is 1, MixId can be left empty. If MixSubType is 2, then MixId is a list of server Ids, which can contain more than one server ID. Example: 10
Alarm	yes	no	Array of StrategyEntryAlarm	Alarm rule list. Example:View
MixId	yes	no	Array of Int64	List of alarm object type IDs. Example: 1
Ip	yes	no	Array of String	If MixType is the server type and the subtype is the specified server ID, then the Ip list exists. Example: 127.0.0.1

DescribeEventPolicyConfig

Referenced by the following interfaces: DescribeEventPolicyConfig

name	required	NULL allowed	type	description
EventID	yes	no	String	Event ID. Example: 1234
ProductName	yes	no	String	Product name. Example: cvm
ProductEName	yes	no	String	The product name. Example: cvm
ProductCName	yes	no	String	The name of the product. Example: CVM instance
EventName	yes	no	String	Event name. Example: ReadOnly
EventEName	yes	no	String	English name of an event. Example: ReadOnly
EventCName	yes	no	String	The name of an event. Example: Disk read-only
Dimensions	yes	yes	Array of DescribeEventPolicyConfigDimension	Dimension. Example:View

CCMGroupViewEntry

Referenced by the following interfaces: DescribeCCMGroupView

name	required	NULL allowed	type	description
ViewId	yes	yes	Int64	Group view ID. Example: 1
ViewName	yes	yes	String	Group view name. Example: cvm_device
IsAuto	yes	yes	Int64	Whether the group view automatically binds the metric. 0: no. 1: yes. Example: 1

DescribePolicyInfoByInstanceConditionsTemp

Referenced by the following interfaces: DescribePolicyInfoByInstance

name	required	NULL allowed	type	description
GroupID	yes	yes	Int64	Group ID. Example: 1234
GroupName	yes	no	String	Group name. Example: Testing
ViewName	yes	no	String	View name. Example: cvm_device
Remark	yes	no	String	Description. Example: Testing
LastEditUin	yes	yes	Int64	UIN of the last editor. Example: 123456
IsUnionRule	yes	yes	Int64	Whether the AND rule is used. Example: 1
InsertTime	yes	yes	Int64	Creation time. Example: 1735095122
UpdateTime	yes	yes	Int64	Update time. Example: 1735095122

CustomCallbackTmplMatcher

Matcher for custom notification content templates.

Referenced by the following interfaces: CreateNoticeContentTmpl, DescribeNoticeContentTmpl, ModifyNoticeContentTmpl

name	required	NULL allowed	type	description
MatchingStatus	yes	no	Array of String	Matching status. Valid values: Invalid, Trigger, and Recovery. Example: Trigger
Template	yes	no	CustomCallbackNoticeTmpl	Template configuration Example:View

TransLogInstance

List of instances returned by DescribeTransLog.

Referenced by the following interfaces: DescribeInstanceGroup

name	required	NULL allowed	type	description
Dimensions	yes	yes	String	Dimension of the instance. Example: qwer
UniqueId	yes	yes	String	Unique ID of the instance. Example: eqeq-czda
IsShielded	yes	yes	Int64	Shielding status. 1: shielding enabled. 0: no shielding. Example: 1
Region	yes	yes	String	Region. Example: gz

DescribeSortObjectListDimension

Dimension of the DescribeSortObjectList API. It refers to a dimension, including the dimension name and dimension value.

Referenced by the following interfaces: DescribeSortObjectList

name	required	NULL allowed	type	description
Name	yes	no	String	Dimension name. Example: appid
Value	yes	no	String	The value of the dimension. Example: 1

AttributeIdDeleteOutput

Referenced by the following interfaces: DeleteAttribute, DeleteAttributes

name	required	NULL allowed	type	description
DeleteCount	yes	no	Int64	Number of deletions. Example: 1
AttributeId	yes	no	Array of Uint64	Attribute ID. Example: 10

DescribePolicyConditionListCondition

Policy conditions returned by the DescribePolicyConditionList API

Referenced by the following interfaces: DescribePolicyConditionList

name	required	NULL allowed	type	description
PolicyViewName	yes	no	String	Policy view name. Example: cvm_device
EventMetrics	yes	yes	Array of DescribePolicyConditionListEventMetric	Event alarm conditions Example:View
IsSupportMultiRegion	yes	no	Bool	Whether multiple regions are supported. Example: true
Metrics	yes	yes	Array of DescribePolicyConditionListMetric	Metric alarm conditions. Example:View
Name	yes	no	String	Policy type name. Example: test
SortId	yes	no	Int64	Sorting ID. Example: 1
SupportDefault	yes	no	Bool	Whether the default policy is supported. Example: true
SupportRegions	yes	yes	Array of String	List of regions that support this policy type. Example: ["gz"]
DeprecatingInfo	no	yes	String	Expiration Information Example: qwer

DescribeProductEventListEventsGroupInfo

GroupInfo in Events returned by the DescribeProductEventList API

Referenced by the following interfaces: DescribeProductEventList

name	required	NULL allowed	type	description
GroupId	yes	yes	Int64	Policy ID. Example: 1234
GroupName	yes	yes	String	Policy name. Example: Testing

TagInstance

Instance tag information of the alarm policy

Referenced by the following interfaces: DescribeAlarmPolicies, DescribeAlarmPolicy

name	required	NULL allowed	type	description
Key	yes	yes	String	Tag key. Example: tag
Value	yes	yes	String	Tag value. Example: value
InstanceSum	yes	yes	Int64	Number of instances. Example: 1
ServiceType	yes	yes	String	Product type. For example, cvm. Example: cvm
RegionId	yes	yes	String	Region ID. Example: 1
BindingStatus	yes	yes	Int64	Binding status. 2: bound; 1: binding. Example: 2
TagStatus	yes	yes	Int64	Tag status. 2: existent; 1: nonexistent. Example: 2

DescribePolicyGroupInfoEventCondition

Event alarm conditions output by the policy query

Referenced by the following interfaces: DescribePolicyGroupInfo, DescribePolicyGroupList

name	required	NULL allowed	type	description
EventId	yes	no	Int64	Event ID. Example: 10
RuleId	yes	no	Int64	Event alarm rule ID. Example: 10
EventShowName	yes	no	String	Event name. Example: ReadOnly
AlarmNotifyPeriod	yes	no	Int64	Alarm sending period in seconds. The value u003c0 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. Example: 5
AlarmNotifyType	yes	no	Int64	Alarm sending and converging type. The value 0 indicates that alarms are sent consecutively. The value 1 indicates that alarms are sent exponentially. Example: 1

PCLMDimensionAnalysisResultData

Dimension analysis results data.

Referenced by the following interfaces: DescribeDimensionAnalysisData

name	required	NULL allowed	type	description
Current	yes	no	String	Dimension data. Example: qwer
Granularity	yes	no	Int64	Granularity. Example: 1

PCLMMetricCustomItem

Compound metric configurations for the log monitoring metric set.

Referenced by the following interfaces: CLMDescribeMetricSets

name	required	NULL allowed	type	description
Formula	yes	no	String	Expression. Example: {"cluster_name":"es-dnxsssss"}
Name	yes	no	String	Metric name. Example: Testing
Desc	yes	no	String	Metric description name. Example: Testing
MetricSetCID	no	no	String	Metric set CID (only for output parameter; leave it empty for input parameter). Example: cid-xxx
CreatedAt	no	no	String	Creation time (only for output parameter; leave it empty for input parameter) Example: qwer
UpdatedAt	no	no	String	Update time (only for output parameter; leave it empty for input parameter) Example: qwer

DescribeAgentStatusHistory

Referenced by the following interfaces: DescribeAgentStatusHistory

name	required	NULL allowed	type	description
Timestamp	yes	no	Datetime_iso	Timestamp. Example: 2019-11-29T12:30:13+08:00
Status	yes	no	Int64	State. Example: 1

ServerInfo

Referenced by the following interfaces: DescribeServers

name	required	NULL allowed	type	description
ServerId	yes	no	Uint64	Server ID. Example: 1
ServerName	yes	no	String	Server name. Example: qwer
Ip	yes	no	String	Server private IP address. Example: 127.0.0.1
IdcId	yes	no	Int64	Region ID. Example: 10
IdcName	yes	no	String	The region name. Example: qwer

DescribeBaseMetricsForConsoleFontEndData

Referenced by the following interfaces: DescribeBaseMetricsForConsoleFontEnd

name	required	NULL allowed	type	description
NameSpace	yes	no	String	Namespace. Example: QCE/CVM
MetricName	yes	no	String	Metric name. Example: CpuUsage
MetricCNName	yes	no	String	Metric name. Example: CPU Usage
MetricENName	yes	no	String	English name of metrics. Example: CpuUsage
Dimensions	yes	no	String	Dimension. Example: {"unInstanceId":"ins-xxx"}
Unit	yes	no	String	Unit. Example: %
UnitCNName	yes	no	String	Unit name. Example: Percentage
PeriodAndStatTypes	yes	yes	Array of DescribeBaseMetricsDataPeriod	Period and statistical method. Example:View
Meaning	yes	yes	Array of DescribeBaseMetricsDataMeaning	Metric description. Example:View

AttributeServerInfoOutput

Referenced by the following interfaces: DescribeAttributeAllServer, DescribeIdcServer

name	required	NULL allowed	type	description
ServerId	yes	yes	Uint64	Server ID. Example: 1
ServerName	yes	yes	String	Server name. Example: test
Ip	yes	yes	String	Server IP address. Example: 127.0.0.1
IdcId	yes	yes	Int64	Region ID. Example: 1
IdcName	yes	yes	String	The region name. Example: test

PolicyGroupItem

PolicyGroups returned by the DescribeInstanceGroup API.

Referenced by the following interfaces: DescribeInstanceGroup

name	required	NULL allowed	type	description
GroupId	yes	yes	Int64	Policy ID. Example: 1234
GroupName	yes	yes	String	Policy name. Example: Testing

PCLMLogFilterRule

Metric set filtering rule for log monitoring.

Referenced by the following interfaces: CLMDescribeMetricSets

name	required	NULL allowed	type	description
Relation	yes	no	Int64	Relationship. 1: AND. 2: OR. Example: 10
Field	yes	no	String	Field name. Example: timeField
Operator	yes	no	String	Filter operator: Numeric fields supoort: gt lt ge le eq ne in. Character fields support: eq ne in contains. Example: =
Value	yes	no	String	Filter operation value. Example: 10
MetricSetCID	no	no	String	Metric set CID (only for output parameter; leave it empty for input parameter). Example: cid-xxx
CreatedAt	no	no	String	Creation time (only for output parameter; leave it empty for input parameter) Example: qwer
UpdatedAt	no	no	String	Update time (only for output parameter; leave it empty for input parameter) Example: qwer

DescribeProductEventListOverView

OverView object returned by the DescribeProductEventList API

Referenced by the following interfaces: DescribeProductEventList

name	required	NULL allowed	type	description
StatusChangeAmount	yes	yes	Int64	Number of state change events. Example: 1
UnConfigAlarmAmount	yes	yes	Int64	Number of events corresponding to which alarm states are not configured. Example: 1
UnNormalEventAmount	yes	yes	Int64	Number of abnormal events. Example: 1
UnRecoverAmount	yes	yes	Int64	Number of unrecovered events. Example: 1

AlarmNotice

Alarm notification template details

Referenced by the following interfaces: DescribeAlarmNotice, DescribeAlarmNotices, DescribeAlarmPolicies, DescribeAlarmPolicy

name	required	NULL allowed	type	description
Id	yes	yes	String	ID of the alarm notification template. Example: 12345
Name	yes	yes	String	Name of the alarm notification template. Example: Default notification
UpdatedAt	yes	yes	String	Last modification time. Example: 2020-11-16 13:56:56
UpdatedBy	yes	yes	String	Last editor. Example: 1500000688
NoticeType	yes	yes	String	Alarm notification type. ALARM=Notification not recovered. OK=Notification recovered. ALL=All notifications. Example: ALL
UserNotices	yes	yes	Array of UserNotice	User notification list. Example:View
URLNotices	yes	yes	Array of URLNotice	Callback notification list. Example:View
IsPreset	yes	yes	Int64	Whether it is the system default notification template. 0: no. 1: Yes. Example: 1
NoticeLanguage	yes	yes	String	Notification language Example: zh-CN
PolicyIds	no	yes	Array of String	List of alarm policy IDs bound to the alarm notification template. Example: ["policy-abc123"]
AMPConsumerId	no	yes	String	Background amp consumer ID. Example: Consumer-asfafasf
ExtraChannels	yes	yes	Array of String	Other non-public notification channels. Example: ["TSS"]
BigCustomerNotices	no	yes	Array of BigCustomerNotice	BigCustomerNotices Example:View

CgrpInstanceNode

Group instance details.

Referenced by the following interfaces: CreateInstances, DeleteInstances, DescribeInstance

name	required	NULL allowed	type	description
Id	no	yes	String	Auto increment ID. Example: 1234
InstanceId	yes	no	String	Instance ID. Example: ins-00jvv9mo
InstanceName	yes	no	String	Instance name. Example: test
TypeId	yes	no	String	The instance type. Example: cvm_device
Region	yes	no	String	Region. Example: gz
ModuleId	yes	no	Int64	Leaf group ID. Example: 1
ModuleName	yes	no	String	Leaf group name. Example: qwer
L1Id	no	yes	Int64	Level-1 group ID. Example: 1
L2Id	no	yes	Int64	Level-2 group ID. Example: 1
L3Id	no	yes	Int64	Level-3 group ID. Example: 1
AppId	no	yes	Int64	appId Example: 1234
Uin	no	yes	String	Uin Example: 123456
SubUin	no	yes	String	SubUin Example: 123456
Group	no	yes	Array of CgrpInstanceGroupNode	Group array. Example:View

DescribeStorageDurationData

Referenced by the following interfaces: DescribeStorageDuration

name	required	NULL allowed	type	description
Period	yes	no	Int64	Interval. Example: 5
Duration	yes	no	Int64	Duration. Example: 10

InstanceGroupInfo

InstanceGroupInfo API returned by the DescribeInstanceGroup API.

Referenced by the following interfaces: DescribeInstanceGroup

name	required	NULL allowed	type	description
GroupName	yes	yes	String	Instance group name. Example: Testing
InstanceGroupId	yes	yes	Int64	Instance group ID. Example: 1234
InstanceSum	yes	yes	Int64	Number of instances. Example: 10
ViewName	yes	yes	String	View name/strategy type. Example: cvm_device
InsertTime	yes	yes	Int64	Creation time. Example: 1735129241
UpdateTime	yes	yes	Int64	Update time. Example: 1735129241
LastEditUin	yes	yes	String	UIN of the last user who updated it. Example: 123456

DescribePolicyQuotaV3ResponseData

Referenced by the following interfaces: DescribePolicyQuota

name	required	NULL allowed	type	description
ViewName	yes	no	String	View. Example: cvm_device
IsQuotaByProject	yes	no	Bool	Whether it is a project quota. Example: true
QuotaList	yes	yes	Array of DescribePolicyQuotaV3ResponseDataQuotaList	List of quotas. Example:View
Quota	yes	yes	DescribePolicyQuotaV3ResponseDataQuota	The quota. Example:View

InstanceGroup

InstanceGroup in Alarms returned by the DescribeBasicAlarmList API

Referenced by the following interfaces: DescribeBasicAlarmList

name	required	NULL allowed	type	description
InstanceGroupId	yes	yes	Int64	Instance group ID. Example: 1234
InstanceGroupName	yes	yes	String	Instance group name. Example: Testing

EventCondition

Event alarm conditions

Referenced by the following interfaces: DescribeConditionsTemplateList, DescribeRecommendedTemplate

name	required	NULL allowed	type	description
AlarmNotifyPeriod	yes	no	String	Alarm notification frequency. Example: 5
AlarmNotifyType	yes	no	String	Predefined repeated notification policy. 0: One-time alarm; 1: exponential alarm; 2: consecutive alarm. Example: 0
EventID	yes	no	String	Event ID. Example: qwer
EventDisplayName	yes	no	String	Displayed event name. Example: test
RuleID	yes	no	String	Rule ID. Example: qwer

DescribePolicyGroupInfoReceiverInfo

Alarm recipient information output by the policy query

Referenced by the following interfaces: DescribePolicyGroupInfo, DescribePolicyGroupList

name	required	NULL allowed	type	description
ReceiverGroupList	yes	no	Array of Int64	List of alarm recipient group IDs. Example: [1234]
ReceiverUserList	yes	no	Array of Int64	List of alarm recipient IDs. Example: [1234]
StartTime	yes	no	Int64	Alarm period start time. Range: [0,86400). Remove the date after converting the time from UNIX timestamp to UTC+8 time. For example, 7200 means "10:0:0". Example: 1734953008
EndTime	yes	no	Int64	End time of the alarm period. The meaning is the same as that of StartTime. Example: 1734953808
ReceiverType	yes	no	String	Recipient type. Valid values: group (recipient group) and user (recipient). Example: group
NotifyWay	yes	no	Array of String	Alarm notification method. Valid values: "SMS", "SITE", "EMAIL", "CALL", and "WECHAT". Example: sms
UidList	yes	yes	Array of Int64	UID of the alarm call recipient. Example: [1234]
RoundNumber	yes	no	Int64	Number of alarm call rounds. Example: [1234]
RoundInterval	yes	no	Int64	Intervals of alarm call rounds in seconds. Example: 60
PersonInterval	yes	no	Int64	Alarm call intervals for individuals in seconds. Example: 60
NeedSendNotice	yes	no	Int64	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. Example: 0
SendFor	yes	no	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). Example: OCCUR
RecoverNotify	yes	no	Array of String	Notification method when an alarm is recovered. Valid value: SMS. Example: SMS

DataPoint

Monitoring data point

Referenced by the following interfaces: GetMonitorData

name	required	NULL allowed	type	description
Dimensions	yes	no	Array of Dimension	Combination of instance object dimensions. Example:View
Timestamps	yes	no	Array of Float	Timestamp array that indicates the points in time that have data. A missing timestamp has no data points. Example: 31415513
Values	yes	no	Array of Float	Metric value array, which corresponds to the values returned for Timestamps. Example: 31314

BigCustomerNotice

Major client notification.

Referenced by the following interfaces: CreateAlarmNotice, DescribeAlarmNotice, DescribeAlarmNotices, DescribeAlarmPolicies, DescribeAlarmPolicy

name	required	NULL allowed	type	description
NeedPushChatGroup	yes	no	Int64	Whether to push to the after-sales group of major clients. 0: no. 1: yes. Example: 1
StartTime	yes	no	Int64	Number of seconds since notification start time 00:00:00 (Value range: 0-86399). Example: 0
EndTime	yes	no	String	Number of seconds since notification end time 00:00:00 (Value range: 0-86399). Example: 3600

DescribeAbnormalObjectsEventObject

Product event alarm exception object returned by the DescribeAbnormalObjects API.

Referenced by the following interfaces: DescribeAbnormalObjects

name	required	NULL allowed	type	description
Status	yes	no	Int64	Alarm status. Example: 1
Content	yes	no	String	The alarm content. Example: qewrrq
InstanceId	yes	no	String	Instance ID. Example: ins-00jvv9mo
Dimensions	yes	no	String	Dimension combination. JSON string. Example: {"unInstanceId":"ins-xxx"}
AbnormalStatus	yes	no	String	Alarm status: "abnormal" indicates that the alarm has not been recovered, and "warning" indicates that the alarm has been recovered. Example: abnormal
FirstOccurTime	yes	no	String	Time of first occurrence. Example: 1735041205
LastOccurTime	yes	no	String	Time of last occurrence. Example: 1735041205
UniqueId	yes	no	String	Dimension combination md5. Example: 1314edae41314
GroupId	yes	yes	Int64	Policy group ID. Example: 1234
GroupName	yes	yes	String	Policy group name. Example: Testing
ProjectId	yes	yes	Int64	Project ID. Example: 1
ProductCName	yes	no	String	The name of the product. Example: Cloud Virtual Machine
ProductEName	yes	no	String	English name of the product. Example: cvm
EventEName	yes	no	String	Event name. Example: ReadOnly
EventCName	yes	no	String	The name of the event. Example: Disk read-only
EventId	yes	no	Int64	Product event ID. Example: 1
Region	yes	no	String	Region. Example: gz
EventUniqueId	yes	no	String	Product dimension combination md5. Example: eqeq-czda

InstanceGroups

Instance group of alarm object

Referenced by the following interfaces: DescribeAlarmHistories, DescribeMiniDashboardAlarmInfo

name	required	NULL allowed	type	description
Id	yes	no	Int64	Instance group ID. Example: 1
Name	yes	no	String	Instance group name. Example: Testing