租户端存储日志服务（CLS）数据结构

数据结构

最近更新时间: 2026-10-10 00:14:50

ConfigurationTemplateInfo

配置模板信息

被如下接口引用：DescribeConfigurationTemplates

名称	必选	允许NULL	类型	描述
TemplateId	是	否	String	配置模板id 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
Version	是	是	Uint64	版本号示例值： 0
Name	是	是	String	配置模板名称示例值： Template_1
Describes	是	是	String	配置模板描述示例值：模板配置1
ShipperTemplateInfos	是	是	Array of ShipperTemplateInfo	投递cos配置模板示例值：查看
CreateTime	是	是	Uint64	创建时间示例值： 1719307168
UpdateTime	是	是	Uint64	更新时间示例值： 1719307168

AlarmTargetInfo

日志告警监控对线

被如下接口引用：DescribeAlarms

名称	必选	允许NULL	类型	描述
LogsetId	是	否	String	日志集ID。示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
LogsetName	是	否	String	日志集名称。示例值： LogsetDemo
TopicId	是	否	String	日志主题ID。示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
TopicName	是	否	String	日志主题名称。示例值： TopicDemo
Query	是	否	String	查询语句。示例值： "mi" OR "CommunicationExcep
Number	是	否	Int64	告警对象序号。示例值： 1
StartTimeOffset	是	否	Int64	查询范围起始时间相对于告警执行时间的偏移，单位为分钟，取值为非正，最大值为0，最小值为-1440。示例值： -240
EndTimeOffset	是	否	Int64	查询范围终止时间相对于告警执行时间的偏移，单位为分钟，取值为非正，须大于StartTimeOffset，最大值为0，最小值为-1440。示例值： 0
SyntaxRule	是	否	Uint64	检索语法规则，默认值为0。 0：Lucene语法，1：CQL语法。详细说明参见检索条件语法规则示例值： 0
QueryInteractiveConfig	否	否	String	查询语句交互模式配置信息。示例值： {"Value":{}}
BizType	否	否	Uint64	主题类型。 0: 日志主题，1: 指标主题示例值： 0

Relabeling

标签重新标记配置。允许动态重写目标、警报、抓取样本和远程写入样本的标签集。

被如下接口引用：CreateMetricConfig、DescribeClusterBaseMetricConfigs、DescribeClusterMetricConfigs、DescribeTopicBaseMetricConfigs、DescribeTopicMetricConfigs、ModifyMetricConfig

名称	必选	允许NULL	类型	描述
Action	否	是	String	基于正则表达式匹配执行的动作。 - replace: Label替换, 必填: SourceLabels, Separator, Regex, TargetLabel, Replacement - labeldrop: 丢弃Label, 必填: Regex - labelkeep: 保留Label, 必填: Regex - lowercase: 小写化, 必填: SourceLabels, Separator, TargetLabel - uppercase: 大写化, 必填: SourceLabels, Separator, TargetLabel - dropequal: 丢弃指标-完全匹配, 必填: SourceLabels, Separator, TargetLabel - keepequal: 保留指标-完全匹配, 必填: SourceLabels, Separator, TargetLabel - drop: 丢弃指标-正则匹配, 必填: SourceLabels, Separator, Regex - keep: 保留指标-正则匹配, 必填: SourceLabels, Separator, Regex - hashmod:哈希取模, 必填: SourceLabels, Separator, TargetLabel, Modulus - labelmap:Label映射, 必填: Regex, Replacement 示例值： replace
SourceLabels	否	是	Array of String	原始label 示例值： ["__meta_kubernetes_pod_label_app"]
Separator	否	是	String	原始label连接符。必填时不能为空串，长度不能超过256 示例值： ;
TargetLabel	否	是	String	目标label。必填时不能为空串，校验格式：`^[a-zA-Z_][a-zA-Z0-9_]*$` ，长度不能超过256 示例值： application
Replacement	否	是	String	替换值。如果正则表达式匹配，则对其执行替换操作。 - 必填时不能为空串，长度不能超过256 - 当action为LabelMap时， Replacement 校验格式：`^(?:(?:[a-zA-Z_]
Regex	否	是	String	正则表达式。提取与之匹配值。必填时不能为空串，校验必须是一个合法的 RE2 示例值： (.*)
Modulus	否	是	Uint64	获取源标签值的哈希值。必填时不能为空,不能为0 示例值： 1

SendDetailItem

单个用户(Uin)的发送情况

被如下接口引用：CheckAlarmChannel

名称	必选	允许NULL	类型	描述
Id	是	否	Uint64	Uin或者Gin 示例值： 906685969
Type	是	否	String	Uin或者Group或者Http或者Wecom 示例值： Uin
SuccessCount	是	否	Int64	成功数示例值： 0

WebCallbackInfo

告警渠道回调配置信息

被如下接口引用：DescribeWebCallbacks

名称	必选	允许NULL	类型	描述
WebCallbackId	否	否	String	告警渠道回调配置id。示例值： webcallback-eqs-sdf-vcd-erq
Name	否	否	String	告警渠道回调配置名称。示例值： name
Type	否	否	String	渠道类型 WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调; 示例值： Http
Webhook	否	否	String	回调地址示例值： http://www.demo.com
Method	否	否	String	请求方式。示例值： POST
Key	否	否	String	秘钥信息。示例值： keyid
Uin	否	否	String	主账号。示例值： 10001
SubUin	否	否	String	子账号。示例值： 1000101
CreateTime	否	否	Uint64	创建时间。秒级时间戳示例值： 1693468888
UpdateTime	否	否	Uint64	更新时间。秒级时间戳示例值： 1693468888

ExceptionInfo

异常问题请求结构

被如下接口引用：DescribeExceptionResources

名称	必选	允许NULL	类型	描述
Enable	否	否	Bool	表示该异常问题是否需要展示。true表示需要展示异常问题，false表示不需要展示异常问题示例值： false
ExceptionId	否	否	Int64	异常资源ID： 1：索引配置异常 2：采集配置异常 3：日志上传异常示例值： 1

FunctionArgument

函数参数描述

被如下接口引用：DescribeFunctions

名称	必选	允许NULL	类型	描述
ArgIndex	是	否	Int64	参数序号，根据参数顺序定义示例值： 1
ArgName	是	否	String	参数名称示例值： field_name
ArgDesc	是	否	String	参数描述示例值：字段名
ArgType	是	否	String	可接受的参数类型列表，包括字面常量、数组、条件表达式、函数表达式等任意一种或多种示例值： string
ArgValueDefault	是	否	String	参数默认值示例值： default_value
ArgValueType	是	否	String	范围、枚举类型示例值： type1
ArgValueScope	是	否	Array of String	参数值域校验范围，这里仅针对常量进行校验，如果arg_value_type是scope类型，则此数组表示前闭后开区间，否则表示枚举的值类型. 如果此值为空，或者空数组，则不进行参数值校验示例值： ["scope"]
IsNecessary	是	否	Bool	是否必须。true表示必须，false代表不必须。示例值： true

ContentInfo

投递日志的内容格式配置

被如下接口引用：CreateShipper、DescribeShipperPreview、DescribeShippers、ModifyShipper

名称	必选	允许NULL	类型	描述
Format	是	否	String	内容格式，支持json、csv 示例值： json
Csv	否	是	CsvInfo	csv格式内容描述示例值：查看
Json	否	是	JsonInfo	json格式内容描述示例值：查看
Parquet	否	是	ParquetInfo	parquet格式内容描述示例值：查看

MultiCondition

多触发条件。

被如下接口引用：CheckAlarmRule、CreateAlarm、DescribeAlarms、ModifyAlarm

名称	必选	允许NULL	类型	描述
Condition	否	否	String	触发条件。示例值： [$1.QUERYCOUNT]> 0
ConditionInteractiveConfig	否	否	String	交互式触发配置信息。示例值： {"Value":{"type":"CONDITION","level":0,"executeQueryIndex":0,"field":"QUERYCOUNT","comparator":">","value":0}}
AlarmLevel	否	否	Uint64	告警级别。0:警告(Warn); 1:提醒(Info); 2:紧急 (Critical)。不填则默认为0。示例值： 0

AnonymousInfo

免鉴权信息

被如下接口引用：CreateTopic、DescribeTopics、ModifyTopic

名称	必选	允许NULL	类型	描述
Operations	否	否	Array of String	操作列表，支持trackLog(JS/HTTP上传日志 )和realtimeProducer(kafka协议上传日志) 示例值： realtimeProducer
Conditions	否	否	Array of ConditionInfo	条件列表示例值：查看

DashboardNoticeMode

仪表盘订阅通知方式

被如下接口引用：CreateDashboardSubscribe、DescribeDashboardSubscribes、ModifyDashboardSubscribe、SearchDashboardSubscribe

名称	必选	允许NULL	类型	描述
ReceiverType	是	否	String	仪表盘通知方式。 Uin：云用户 Group：云用户组 Email：自定义Email WeCom: 企业微信回调示例值： Email
Values	否	否	Array of String	通知方式对应的值。当ReceiverType不是 Wecom 时，Values必填。示例值： ["168053"]
ReceiverChannels	否	是	Array of String	仪表盘通知渠道。支持：["Email","Sms","WeChat","Phone"]。当ReceiverType是 Email 或 Wecom 时，ReceiverChannels不能赋值。示例值： ["Email","Sms","WeChat","Phone"]
Url	否	否	String	回调Url。当ReceiverType是 Wecom 时，Url必填。当ReceiverType不是 Wecom 时，Url不能填写。示例值： https://console.cloud.demo.com

KeyRegexInfo

需要过滤日志的key，及其对应的regex

被如下接口引用：CreateConfig、CreateConfigExtra、CreateCosRecharge、DescribeAgentConfigs、DescribeConfigExtras、DescribeConfigs、DescribeCosRecharges、DescribeMachineGroupConfigs、ModifyConfig、ModifyConfigExtra、ModifyCosRecharge

名称	必选	允许NULL	类型	描述
Key	是	否	String	需要过滤日志的key 示例值： response_code
Regex	是	否	String	key对应的过滤规则regex 示例值： 400

NoticeReceiver

告警通知接收者信息

被如下接口引用：CheckAlarmChannel、CreateAlarmNotice、DescribeAlarmNotices、ModifyAlarmNotice

名称	必选	允许NULL	类型	描述
ReceiverType	是	否	String	接受者类型。可选值： Uin - 用户ID Group - 用户组ID 暂不支持其余接收者类型示例值： Group
ReceiverIds	是	否	Array of Int64	接收者。当ReceiverType为Uin时，ReceiverIds的值为用户uid。子用户信息查询当ReceiverType为Group时，ReceiverIds的值为用户组id。CAM用户组示例值： [1736994580]
ReceiverChannels	是	否	Array of String	通知接收渠道。 Email - 邮件 Sms - 短信 WeChat - 微信 Phone - 电话示例值： ['Sms']
StartTime	是	否	String	允许接收信息的开始时间。格式：15:04:05。必填示例值： 10:04:05
EndTime	是	否	String	允许接收信息的结束时间。格式：15:04:05。必填示例值： 20:04:05
Index	否	否	Int64	位序。入参时无效。出参时有效。示例值： 1
NoticeContentId	否	否	String	通知内容模板ID，使用Default-zh引用默认模板，使用Default-en引用DefaultTemplate(English)。示例值： noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1"

ChannelTestResult

渠道检测结果

被如下接口引用：CheckAlarmChannel

名称	必选	允许NULL	类型	描述
Index	是	否	Int64	序号示例值： 1
ErrorCode	是	否	Int64	错误码，0是正确，-1001表示无效请求。示例值： 0
ErrorMessage	是	是	String	错误信息示例值： err_message
SendTotal	是	是	SendDetail	发送结果示例值：查看

ContainerFileInfo

自建k8s-容器文件路径信息

被如下接口引用：CreateConfigExtra、DescribeConfigExtras、ModifyConfigExtra

名称	必选	允许NULL	类型	描述
Namespace	是	否	String	namespace可以多个，用分隔号分割,例如A,B 示例值： kube-system
Container	是	否	String	容器名称示例值： container1
LogPath	是	否	String	日志文件夹示例值： /var/log/tmep
FilePattern	是	否	String	日志名称示例值： *.log
IncludeLabels	否	是	Array of String	pod标签信息示例值： ["key1=value1"]
WorkLoad	否	否	ContainerWorkLoadInfo	工作负载信息示例值：查看
ExcludeNamespace	否	否	String	需要排除的namespace可以多个，用分隔号分割,例如A,B 示例值： kube-system
ExcludeLabels	否	是	Array of String	需要排除的pod标签信息示例值： ["key1=value1"]
ContainerFlag	否	否	Uint64	容器名称标记。必填字段，不填默认值为0。默认值0，0:选中Container标记。 1:排除Container标记。示例值： 0
FilePaths	否	否	Array of FilePathInfo	日志文件信息示例值：查看
CustomLabels	否	是	Array of String	metadata信息示例值： ["key1=value1","key2=value2"]

DataTransformFailureInfo

数据加工日志失败信息

被如下接口引用：DescribeDataTransformFailLogInfo

名称	必选	允许NULL	类型	描述
LogContent	是	否	String	源日志示例值： content
Reason	是	否	String	加工失败原因示例值： -110

SearchLogInfos

多日志主题检索topic信息

被如下接口引用：DescribeLogHistogram、SearchLog

名称	必选	允许NULL	类型	描述
TopicId	是	否	String	日志主题ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
Period	是	否	Int64	日志存储生命周期示例值： 30
Border	是	否	Int64	冷热边界时间点（ms）示例值： 1671415200000
Context	是	否	String	透传本次接口返回的Context值，可获取后续更多日志，过期时间1小时示例值： Y29udGV4dC04MjMzNWRkMi01YmMxLTQ4NGYtYjQ4MS04MDg0NzAwYjQ1NDUxNjcy

AlarmRuleTestResult

告警策略检测结果

被如下接口引用：CheckAlarmRule

名称	必选	允许NULL	类型	描述
Index	是	否	Int64	位序示例值： 1
ErrorCode	是	否	Int64	错误码。0表示请求正常，-1001表示异常请求示例值： 0
ErrorMessage	是	否	String	错误信息示例值： err_message
AlarmTarget	是	是	CheckAlarmTarget	当前检测的元数据示例值：查看

NetworkInfo

网络打通信息

被如下接口引用：CheckRechargeKafkaServer、CreateKafkaRecharge、DescribeKafkaRecharges、ModifyKafkaRecharge、PreviewKafkaRecharge

名称	必选	允许NULL	类型	描述
NetworkType	是	否	Uint64	网络类型。 0：公网，1：内网示例值： 1
VpcID	否	否	String	私有网络id 示例值： vpc-d18pppxl
AppID	否	否	Uint64	私有网络所属用户app id 示例值： 1250000820
VirtualGatewayType	否	否	Uint64	网络服务类型。0：CVM，3：专线网关，11：云联网，1025：CLB 示例值： 11
VpcGatewayIndex	否	否	String	专线网关id或者云联网id 示例值： ccn-ap4f12qzl
PrivateDomainNames	否	否	Array of PrivateDomainNames	私有域名映射地址示例值：查看

RemoteWriteAuthInfo

Remote Write鉴权信息

被如下接口引用：CheckRemoteWriteTaskConnect、CreateRemoteWriteTask、DescribeRemoteWriteTask、DescribeRemoteWriteTasks、ModifyRemoteWriteTask

名称	必选	允许NULL	类型	描述
Username	否	是	String	basic auth username 示例值： username
Password	否	是	String	basic auth password 示例值： password
Token	否	是	String	basic auth token 示例值： token

AppointLabel

元数据Pod label标签结构体

被如下接口引用：CreateMetricConfig、DescribeClusterBaseMetricConfigs、DescribeClusterMetricConfigs、DescribeTopicBaseMetricConfigs、DescribeTopicMetricConfigs、ModifyMetricConfig

名称	必选	允许NULL	类型	描述
Type	否	是	Uint64	指定标签类型。 - 0：所有Pod label，Keys字段无效 - 1：指定Pod label，Keys字段不能为空示例值： 1
Keys	否	是	Array of String	元数据Pod标签的键。有效标签键有两个部分：可选前缀和名称，以斜杠 (/) 分隔。名称部分是必需的，并且必须不超过 63 个字符，以字母数字字符 ([a-z0-9A-Z]) 开头和结尾，中间有破折号(-)、下划线(_)、点(.) 和字母数字。前缀是可选的。如果指定，前缀必须是 DNS 子域：一系列以点 (.) 分隔的 DNS 标签，总长度不超过 253 个字符，后跟斜杠 ( /)。 - prefix 格式 `[a-z0-9]([-a-z0-9][a-z0-9])?(\.[a-z0-9]([-a-z0-9][a-z0-9])?)` - name 格式 `([A-Za-z0-9][-A-Za-z0-9_.])?[A-Za-z0-9]` - key不能重复示例值： ["k8s-key"]

ExtractRuleInfo

日志提取规则

名称	必选	允许NULL	类型	描述
TimeKey	否	否	String	时间字段的key名字，TikeKey和TimeFormat必须成对出现示例值： time
TimeFormat	否	否	String	时间字段的格式，参考c语言的strftime函数对于时间的格式说明输出参数示例值： YYDDWW
Delimiter	否	否	String	分隔符类型日志的分隔符，只有LogType为delimiter_log时有效示例值： ,
LogRegex	否	否	String	整条日志匹配规则，只有LogType为fullregex_log时有效示例值： \w
BeginRegex	否	否	String	行首匹配规则，只有LogType为multiline_log或fullregex_log时有效示例值： \w
Keys	否	是	Array of String	取的每个字段的key名字，为空的key代表丢弃这个字段，只有LogType为delimiter_log时有效，json_log的日志使用json本身的key。限制100个。示例值： ["name","address"]
FilterKeyRegex	否	否	Array of KeyRegexInfo	日志过滤规则列表（旧版），需要过滤日志的key，及其对应的regex。注意：2.9.3及以上版本LogListener ，建议使用AdvanceFilterRules配置日志过滤规则。示例值：查看
UnMatchUpLoadSwitch	否	是	Bool	解析失败日志是否上传，true表示上传，false表示不上传示例值： true
UnMatchLogKey	否	是	String	失败日志的key，当UnMatchUpLoadSwitch为true时必填示例值： log_key
Backtracking	否	是	Int64	增量采集模式下的回溯数据量，默认：-1（全量采集）；其他非负数表示增量采集（从最新的位置，往前采集${Backtracking}字节（Byte）的日志）最大支持1073741824（1G）。注意： COS导入不支持此字段。示例值： -1
IsGBK	否	否	Int64	是否为Gbk编码。 0：否；1：是。注意目前取0值时，表示UTF-8编码 COS导入不支持此字段。示例值： 0
JsonStandard	否	是	Int64	是否为标准json。 0：否； 1：是。标准json指采集器使用业界标准开源解析器进行json解析，非标json指采集器使用CLS自研json解析器进行解析，两种解析器没有本质区别，建议客户使用标准json进行解析。示例值： 0
Protocol	否	否	String	syslog传输协议，取值为tcp或者udp，只有在LogType为service_syslog时生效，其余类型无需填写。注意：该字段适用于：创建采集规则配置、修改采集规则配置。 COS导入不支持此字段。示例值： tcp
Address	否	否	String	syslog系统日志采集指定采集器监听的地址和端口，形式：[ip]:[port]，只有在LogType为service_syslog时生效，其余类型无需填写。注意：该字段适用于：创建采集规则配置、修改采集规则配置。 COS导入不支持此字段。示例值： 127.0.0.1:9000
ParseProtocol	否	否	String	rfc3164：指定系统日志采集使用RFC3164协议解析日志。 rfc5424：指定系统日志采集使用RFC5424协议解析日志。 auto：自动匹配rfc3164或者rfc5424其中一种协议。只有在LogType为service_syslog时生效，其余类型无需填写。注意：该字段适用于：创建采集规则配置、修改采集规则配置 COS导入不支持此字段。示例值： RFC3164
MetadataType	否	否	Int64	元数据类型。0: 不使用元数据信息；1:使用机器组元数据；2:使用用户自定义元数据；3:使用采集配置路径。注意： COS导入不支持此字段。示例值： 0
PathRegex	否	否	String	采集配置路径正则表达式。请用"()"标识路径中目标字段对应的正则表达式，解析时将"()"视为捕获组，并以__TAG__.{i}:{目标字段}的形式与日志一起上报，其中i为捕获组的序号。若不希望以序号为键名，可以通过命名捕获组"(?<{键名}>{正则})"自定义键名，并以__TAG__.{键名}:{目标字段}的形式与日志一起上报。最多支持5个捕获组注意： MetadataType为3时必填。 COS导入不支持此字段。示例值： /(?.?)/(?.?)/access.log
MetaTags	否	否	Array of MetaTagInfo	用户自定义元数据信息。注意： MetadataType为2时必填。 COS导入不支持此字段。示例值：查看
EventLogRules	否	否	Array of EventLog	Windows事件日志采集规则，只有在LogType为windows_event_log时生效，其余类型无需填写。示例值：查看
AdvanceFilterRules	否	是	Array of AdvanceFilterRuleInfo	日志过滤规则列表（新版）。注意： 2.9.3以下版本LogListener不支持，请使用FilterKeyRegex配置日志过滤规则。自建k8s采集配置（CreateConfigExtra、ModifyConfigExtra）不支持此字段。示例值：查看
RawLogKey	否	否	String	原始日志的键名称(Key)；所有原始日志，均以您指定的键名称（Key），原始日志内容作为值（Value）进行上传，为空时表示不开启原始日志上传。 COS导入不支持此字段。示例值： RawLog

TopicIndexInfo

topic的索引配置明细

被如下接口引用：DescribeIndexs

名称	必选	允许NULL	类型	描述
TopicId	是	否	String	日志主题id 示例值： e8722b2a-ab75-47f8-8530-8ac542133654
Status	是	是	Bool	索引是否生效。true表示索引生效，false表示索引失效。示例值： false
Rule	是	是	RuleInfo	索引配置信息注意：此字段可能返回 null，表示取不到有效值。示例值：查看
ModifyTime	是	否	String	索引修改时间，初始值为索引创建时间。示例值： 2021-01-13 21:00:08
TopicName	是	否	String	日志主题名称示例值： name1
LogsetId	是	否	String	日志集id 示例值： oooo
LogsetName	是	否	String	日志集名称示例值： name2
IncludeInternalFields	是	是	Bool	内置保留字段（FILENAME，HOSTNAME__及__SOURCE）是否包含至全文索引 false:不包含 true:包含示例值： false
MetadataFlag	是	是	Uint64	元数据字段（前缀为__TAG__的字段）是否包含至全文索引 0:仅包含开启键值索引的元数据字段 1:包含所有元数据字段 2:不包含任何元数据字段示例值： 0
CoverageField	是	是	String	自定义日志解析异常存储字段。示例值： RAWLOG

DeliverConfig

投递配置入参

被如下接口引用：CreateAlarmNotice、DescribeAlarmNotices、ModifyAlarmNotice

名称	必选	允许NULL	类型	描述
Region	是	否	String	地域信息。示例值： region
TopicId	是	否	String	日志主题ID。示例值： 57f5808c-4a55-11eb-b378-0242ac130002
Scope	是	否	Uint64	投递数据范围。 0: 全部日志, 包括告警策略日常周期执行的所有日志，也包括告警策略变更产生的日志，默认值 1:仅告警触发及恢复日志示例值： 0

CosFieldsData

COS文件（csv格式）字段信息

被如下接口引用：DescribeExternalDataSourcePreview

名称	必选	允许NULL	类型	描述
RowInfo	是	是	Array of String	COS文件（csv格式）行字段信息示例值： ["name","age"]

ExceptionResources

异常资源信息列表

被如下接口引用：DescribeExceptionResources

名称	必选	允许NULL	类型	描述
TopicId	是	否	String	日志主题Id 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
IndexExceptions	是	否	Array of IndexException	索引配置异常列表示例值：查看
ConfigExceptions	是	否	Array of ConfigException	采集配置异常列表示例值：查看
UploadLogExceptions	是	否	Array of UploadLogException	日志上传异常列表示例值：查看

HighLightItem

日志内容高亮描述信息

被如下接口引用：DescribeLogContext、GetAlarmLog、GetConfigurationTemplateApplyLog、SearchLog

名称	必选	允许NULL	类型	描述
Key	是	否	String	高亮的日志Key 示例值： Message
Values	是	否	Array of String	高亮的语法示例值： [ "finish request"]

ShipperInfo

投递规则

被如下接口引用：DescribeShippers

名称	必选	允许NULL	类型	描述
ShipperId	是	否	String	投递规则ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
TopicId	是	否	String	日志主题ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
Bucket	是	否	String	投递的bucket地址示例值： bucket_name
Prefix	是	否	String	投递的前缀目录示例值： var/log
ShipperName	是	否	String	投递规则的名字示例值： shipper_name
Interval	是	否	Uint64	投递的时间间隔，单位秒示例值： 300
MaxSize	是	否	Uint64	投递的文件的最大值，单位 MB 示例值： 256
Status	是	否	Bool	是否生效。true表示生效，false表示失效。示例值： true
FilterRules	是	否	Array of FilterRuleInfo	投递日志的过滤规则示例值：查看
Partition	是	否	String	投递日志的分区规则，支持strftime的时间格式表示示例值： %Y%m%d
Compress	是	否	CompressInfo	投递日志的压缩配置示例值：查看
Content	是	否	ContentInfo	投递日志的内容格式配置示例值：查看
CreateTime	是	否	String	投递日志的创建时间示例值： 2024-09-19 16:15:35
FilenameMode	是	否	Uint64	投递文件命名配置，0：随机数命名，1：投递时间命名，默认0（随机数命名）示例值： 0
StartTime	是	否	Int64	投递数据范围的开始时间点示例值： 1670642281
EndTime	是	否	Int64	投递数据范围的结束时间点示例值： 1670642281
Progress	是	否	Float	历史数据投递的进度（仅当用户选择的数据内中历史数据时才有效）示例值： 5.6
RemainTime	是	否	Int64	历史数据全部投递完成剩余的时间（仅当用户选择的数据中有历史数据时才有效）示例值： 23
CustomUin	是	否	Uint64	跨账号uin 示例值： 1670641097
HistoryStatus	是	否	Int64	历史任务状态： 0：实时任务 1：任务准备中 2：任务运行中 3：任务运行异常 4：任务运行结束示例值： 1
StorageType	否	否	String	cos桶类型示例值： MAZ_STANDARD
RoleArn	否	否	String	角色访问描述名示例值： qcs::cam::uin/${uin}:roleName/role
ExternalId	否	否	String	外部ID 示例值： external_id
TaskStatus	否	否	Uint64	任务运行状态。支持0,1,2 0: 停止 1: 运行中 2: 异常示例值： 1

ContainerStdoutInfo

自建k8s-容器标准输出信息

被如下接口引用：CreateConfigExtra、DescribeConfigExtras、ModifyConfigExtra

名称	必选	允许NULL	类型	描述
AllContainers	是	否	Bool	是否所有容器。true表示是所有容器，false表示不包含所有容器。示例值： true
Container	否	否	String	container为空表所有的，不为空采集指定的容器示例值： container_name
Namespace	否	否	String	namespace可以多个，用分隔号分割,例如A,B；为空或者没有这个字段，表示所有namespace 示例值： kube-system
IncludeLabels	否	是	Array of String	pod标签信息示例值： ["key1=value1"]
WorkLoads	否	是	Array of ContainerWorkLoadInfo	工作负载信息示例值：查看
ExcludeNamespace	否	否	String	需要排除的namespace可以多个，用分隔号分割,例如A,B 示例值： kube-system
ExcludeLabels	否	是	Array of String	需要排除的pod标签信息示例值： ["key1=value1"]
ContainerFlag	否	否	Uint64	容器名称标记。必填字段，不填默认值为0。默认值0，0:选中Container标记。 1:排除Container标记。示例值： 0
CustomLabels	否	是	String	metadata信息示例值： ["key1=value1","key2=value2"]

RecordingRuleProcessInfo

预聚合任务执行详情

被如下接口引用：DescribeRecordingRuleProcessInfo

名称	必选	允许NULL	类型	描述
TaskId	是	否	String	任务ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
ProcessId	是	否	String	实例ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
TopicId	是	否	String	日志主题id 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
DstTopicId	是	是	String	目标日志主题id。示例值： 57f5808c-4a55-11eb-b378-0242ac130002
Name	是	是	String	任务名称示例值： name
RecordingRuleContent	是	否	String	预聚合语句示例值： sql
ProcessStartTime	是	否	String	执行时间-开始时间示例值： 2024-03-13 12:00:00
ProcessEndTime	是	否	String	执行时间-结束时间示例值： 2024-03-13 12:01:00
ProcessDuration	是	否	Int64	执行时间-耗时示例值： 247
ReadLogCount	是	否	Uint64	处理数据量-输入行数示例值： 1212
WriteLogCount	是	否	Uint64	处理数据量-输出行数示例值： 12
Status	是	否	Int64	调度结果，1:运行中 2:成功 3:失败示例值： 2
StatusFailedMsg	是	否	String	失败原因字段示例值：日志主题不存在
TaskQueryTime	否	否	String	任务查询时间示例值： 2024-03-13 12:01:00

MachineGroupInfo

机器组信息

被如下接口引用：DescribeConfigMachineGroups、DescribeMachineGroups

名称	必选	允许NULL	类型	描述
GroupId	是	否	String	机器组ID 示例值： 559d015f-fac7-43cd-ad6e-3c4523fe8767
GroupName	是	否	String	机器组名称示例值： group_name
MachineGroupType	是	否	MachineGroupTypeInfo	机器组类型示例值：查看
CreateTime	是	否	String	创建时间示例值： 2021-03-05 00:40:22
Tags	是	否	Array of Tag	机器组绑定的标签列表示例值：查看
AutoUpdate	是	否	String	是否开启机器组自动更新。true表示开启自动更新，false表示关闭自动更新。示例值： "true"
UpdateStartTime	是	否	String	升级开始时间，建议业务低峰期升级LogListener 示例值： "12:00:00"
UpdateEndTime	是	否	String	升级结束时间，建议业务低峰期升级LogListener 示例值： "13:00:00"
ServiceLogging	是	否	Bool	是否开启服务日志，用于记录因Loglistener 服务自身产生的log，开启后，会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business，不产生计费。true表示开启服务日志，false表示关闭服务日志。示例值： true
Flag	是	否	String	TKE标志位，默认值为空字符串。空字符串表示日志不是来自于TKE，label_k8s表示日志来自于TKE。示例值： label_k8s
DelayCleanupTime	是	否	Int64	机器组中机器离线定期清理时间示例值： 30
MetaTags	是	否	Array of MetaTagInfo	机器组元数据信息列表示例值：查看
OSType	是	否	Uint64	操作系统类型，0: Linux，1: windows 示例值： 0
DedicatedClusterId	否	否	String	专用集群id 示例值： cluster-262n63ex
ClusterId	否	否	String	集群ID。- 当Flag为 label_tke，表示TKE集群ID- ClusterId 与 ClusterRegion 必须同时填写，或者为空示例值： cluster-crs
ClusterRegion	否	否	String	集群所在地域- 当Flag为 label_tke，表示TKE集群地域- ClusterId 与 ClusterRegion 必须同时填写，或者为空示例值： region

BinlogInitialPoint

mysql binlog文件采集起始位置。

被如下接口引用：CreateBinlogSubscribe、DescribeBinlogSubscribePreview、DescribeBinlogSubscribes、ModifyBinlogSubscribe

名称	必选	允许NULL	类型	描述
Type	是	否	Uint64	起始位置类型。 1:最新位置 2:指定位置 3.指定GTID 示例值： 1
BinlogFileName	否	是	String	Binlog文件名称。当起始位置类型Type=2时，BinlogFileName 必填。示例值： mysql-bin.000001
BinlogPosition	否	是	Uint64	Binlog文件偏移量。当起始位置类型Type=2时， BinlogPosition必填。示例值： 4
GTIDPosition	否	是	String	GTID位置。当起始位置类型Type=3时， GTIDPosition必填。示例值： 3E11FA47-71CA-11E1-9E33-C80AA9429562:23

TopicIdLogStatistic

数据加工日志主题统计数据详情

被如下接口引用：DescribeDataTransformProcessInfo

名称	必选	允许NULL	类型	描述
TopicId	是	否	String	日志主题id 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
ReadLines	是	否	Int64	读取的源日志主题的行数示例值： 1
WriteLines	是	否	Int64	加工后输出到目标日志主题的行数示例值： 1
FailedLines	是	否	Int64	加工失败的行数示例值： 1
FilterLines	是	是	Uint64	加工过滤的行数示例值： 1

ValueInfo

需要开启键值索引的字段的索引描述信息

被如下接口引用：CreateIndex、DescribeIndex、DescribeIndexs、ModifyIndex

名称	必选	允许NULL	类型	描述
Type	是	否	String	字段类型，目前支持的类型有：long、text、double 示例值： long
Tokenizer	否	否	String	字段的分词符，其中的每个字符代表一个分词符；仅支持英文符号、\n\t\r及转义符\； long及double类型字段需为空；注意：\n\t\r本身已被转义，直接使用双引号包裹即可作为入参，无需再次转义。使用API Explorer进行调试时请使用JSON参数输入方式，以避免\n\t\r被重复转义示例值： .*
SqlFlag	否	否	Bool	字段是否开启分析功能。true表示开启分析功能，false表示关闭分析功能。示例值： true
ContainZH	否	否	Bool	是否包含zh，long及double类型字段需为false。true表示包含zh，false表示不包含zh。示例值： false
Alias	否	否	String	索引健值别名示例值： alias_name
OpenIndexForChildOnly	否	否	Bool	只给子节点开启索引示例值： false
ChildNode	否	否	Array of KeyValueInfo	子节点列表示例值：查看

ExportInfo

日志导出信息

被如下接口引用：DescribeExports

名称	必选	允许NULL	类型	描述
TopicId	是	否	String	日志主题ID 示例值： ee20bb16-3025-4048-b81a-dd436373062e
ExportId	是	否	String	日志导出任务ID 示例值： export-57196a6a-7622-47be-bc92-d2ebea959a0f
Query	是	否	String	日志导出查询语句示例值： status:200
FileName	是	否	String	日志导出文件名示例值： log_2075178708_ee20bb16-3025-4048-b81a-dd436373062f_20210107_571
FileSize	是	否	Uint64	日志文件大小示例值： 0
Order	是	否	String	日志导出时间排序。asc表示正序排序，desc表示倒序排序。示例值： desc
Format	是	否	String	日志导出格式。json表示日志导出格式为json。示例值： json
Count	是	否	Uint64	日志导出数量示例值： 100
Status	是	否	String	日志下载状态。Processing:导出正在进行中，Completed:导出完成，Failed:导出失败，Expired:日志导出已过期(三天有效期), Queuing 排队中示例值： Expired
From	是	否	Int64	日志导出起始时间示例值： 1607499207000
To	是	否	Int64	日志导出结束时间示例值： 1607499208000
CosPath	是	否	String	日志导出路径示例值： /region-open-kkk-1730194324/%Y/%m/%d/%H/
CreateTime	是	否	String	日志导出创建时间示例值： 2020-08-08 12:12:12
SyntaxRule	是	否	Uint64	语法规则。默认值为0。 0：Lucene语法，1：CQL语法。示例值： 1
DerivedFields	否	否	Array of String	导出字段示例值： ["timestamp","a","b"]
Separator	否	否	String	分隔符。CSV 文件中各字段间的分隔符，非必填，默认逗号支持： - 空格 - `\t`：制表符 - ` ,`：逗号 - `;`：竖线示例值： ,
EscapeCharacter	否	否	String	转义符。CSV 文件字段值中出现了分隔符的字符，需用转义符包裹该字符，防止读取数据时被错误识别，非必填，默认双引号支持： - `' `：单引号 - `"`：双引号 - 空串示例值： "
FillField	否	否	String	填充字段。csv文件字段不存在(无效)时，使用用户指定的值进行填充。默认空支持：空字符串满足正则表达式示例值： failed
DisplayHeader	否	否	Bool	首行Key是否展示。默认 true 支持： - true：展示 - false：不展示示例值： true

BaseMetricCollectConfig

指标采集配置

被如下接口引用：DescribeClusterBaseMetricConfigs、DescribeTopicBaseMetricConfigs

名称	必选	允许NULL	类型	描述
GroupId	否	是	String	机器组id 示例值： 46ca047e-f015-45c9-9635-444bf4f31602
Configs	否	是	Array of MetricCollectConfig	基础监控采集配置信息示例值：查看

LogsetETL

数据加工自动创建的日志集

被如下接口引用：DescribeDataTransformAutoCreateLogSets

名称	必选	允许NULL	类型	描述
LogsetId	是	否	String	日志集id 示例值： 5ccf2223-5d3e-4877-9524-7a2cf0ce27be
LogsetName	是	否	String	日志集名称示例值： logset_name
TopicCount	是	否	Int64	日志集下日志主题的个数示例值： 0
CreatedAt	是	否	Int64	创建时间（秒级时间戳）示例值： 1696089600

AnalysisDimensional

多维分析的分析维度

被如下接口引用：CreateAlarm、DescribeAlarms、ModifyAlarm

名称	必选	允许NULL	类型	描述
Name	是	是	String	分析名称示例值： status 502 pv
Type	是	是	String	分析类型：query，field ，original 示例值： query
Content	是	是	String	分析内容示例值： *
ConfigInfo	否	否	Array of AlarmAnalysisConfig	多维分析配置。当Analysis的Type字段为query（自定义）时，支持 { "Key": "SyntaxRule", // 语法规则 "Value": "1" //0：Lucene语法，1： CQL语法 } 当Analysis的Type字段为field（top5）时, 支持 { "Key": "QueryIndex", "Value": "-1" // -1：自定义， 1：执行语句1， 2：执行语句2 },{ "Key": "CustomQuery", //检索语句。 QueryIndex为-1时有效且必填 "Value": "*

KafkaConsumerInfo

kafka协议消费主题信息

被如下接口引用：DescribeKafkaConsumerTopics

名称	必选	允许NULL	类型	描述
TopicId	是	是	String	消费主题示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
ToTopicId	是	是	String	kafka的主题id 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
InstanceId	是	是	String	kafka实例id 示例值： ckafka-le45va27
ConsumerGroupList	是	是	Array of ConsumerGroupInfoForMonitor	消费组信息示例值：查看

ConsumerContent

投递任务出入参 Content

被如下接口引用：CreateConsumer、DescribeConsumer、DescribeConsumerPreview、DescribeConsumers、ModifyConsumer

名称	必选	允许NULL	类型	描述
EnableTag	是	是	Bool	是否投递 TAG 信息。当EnableTag为true时，表示投递TAG元信息。示例值： false
MetaFields	是	是	Array of String	需要投递的元数据列表，目前仅支持：SOURCE，FILENAME，TIMESTAMP，HOSTNAME__和__PKGID 示例值： ["__SOURCE__", "__FILENAME__", "__TIMESTAMP__"]
TagJsonNotTiled	否	是	Bool	当EnableTag为true时，必须填写TagJsonNotTiled字段。 TagJsonNotTiled用于标识tag信息是否json平铺。 TagJsonNotTiled为true时不平铺，示例： TAG信息：{"TAG":{"fieldA":200,"fieldB":"text"}} 不平铺：{"TAG":{"fieldA":200,"fieldB":"text"}} TagJsonNotTiled为false时平铺，示例： TAG信息：{"TAG":{"fieldA":200,"fieldB":"text"}} 平铺：{"TAG.fieldA":200,"TAG.fieldB":"text"} 示例值： false
TimestampAccuracy	否	是	Int64	投递时间戳精度，可选项 [1：秒；2：毫秒] ，默认是1。示例值： 1
JsonType	否	是	Int64	投递Json格式。 JsonType为0：和原始日志一致，不转义。示例：日志原文：{"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}} 投递到Ckafka：{"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}} JsonType为1：转义。示例：日志原文：{"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}} 投递到Ckafka：{"a":"aa","b":"{"b1":"b1b1", "c1":"c1c1"}"} 示例值： 0

RecordingRuleYamlTaskInfo

预聚合Yaml任务详情

被如下接口引用：DescribeRecordingRuleYamlTask

名称	必选	允许NULL	类型	描述
YamlId	是	否	String	yaml配置文件id 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
TopicId	是	否	String	源日志主题id 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
DstTopicId	是	否	String	写入描述的日志主题id 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
CreateTime	是	否	String	任务创建时间示例值： 2023-07-28 11:36:00
UpdateTime	是	否	String	任务更新时间示例值： 2023-07-28 11:36:00
Status	是	否	Int64	任务状态，1:运行 2:停止 3:异常-找不到源日志主题 4:异常-找不到目标主题 5: 访问权限问题 6:内部故障 7:其他故障示例值： 2
EnableFlag	是	否	Int64	任务启用状态，1开启, 2关闭示例值： 1
ProcessStartTime	是	否	Uint64	调度开始时间示例值： 4829745892375
ProcessPeriod	是	否	Int64	调度周期(分钟) 示例值： 5
ProcessPeriodUnit	否	是	Uint64	执行周期单位, `0`: Minute, `1`: Second。 - ProcessPeriodUnit:1时，ProcessPeriod 只支持 30（即只支持30秒）。 - ProcessPeriodUnit:0时，ProcessPeriod 支持范围(0,1440]分钟。示例值： 0
ProcessDelay	是	否	Int64	执行延迟(秒) 示例值： 5
HasServicesLog	是	否	Uint64	是否开启投递服务日志。1：关闭，2：开启。示例值： 1
YamlConfigName	是	否	String	yaml配置文件名称示例值： name
YamlContent	是	否	String	yaml配置文件内容示例值： yaml
SubTaskCount	是	否	Int64	yaml文件子任务数量示例值： 0

CustomLabel

自定义标签结构体

被如下接口引用：CreateMetricConfig、DescribeClusterBaseMetricConfigs、DescribeClusterMetricConfigs、DescribeTopicBaseMetricConfigs、DescribeTopicMetricConfigs、ModifyMetricConfig

名称	必选	允许NULL	类型	描述
Key	否	是	String	标签的键。 - 必须以字母或下划线开头，但不可以双下划线（__）开头，后面可以跟任意字母，数字或下划线。 - 最大支持256个字符。 - key不能重复示例值： app
Value	否	是	String	标签的值。 - 最大支持256个字符。示例值： k8s-x

ParquetInfo

Parquet内容

被如下接口引用：CreateShipper、DescribeShipperPreview、DescribeShippers、ModifyShipper

名称	必选	允许NULL	类型	描述
ParquetKeyInfo	是	否	Array of ParquetKeyInfo	ParquetKeyInfo数组示例值：查看

ResourceInfo

需要检索的资源信息

被如下接口引用：DescribeExceptionResources

名称	必选	允许NULL	类型	描述
TopicId	是	否	String	需要检索的topic_id 示例值： 8211a509-fee5-43dd-9ec0-6a6e7bc92552

ContainerWorkLoadInfo

自建k8s-工作负载信息

被如下接口引用：CreateConfigExtra、DescribeConfigExtras、ModifyConfigExtra

名称	必选	允许NULL	类型	描述
Container	否	否	String	容器名示例值： container_name
Kind	是	否	String	工作负载的类型示例值： daemonset
Name	是	否	String	工作负载的名称示例值： tke-log-agent
Namespace	否	否	String	命名空间示例值： kube-system
ContainerFlag	否	否	Uint64	容器名称标记。必填字段，不填默认值为0。 0:选中Container标记。默认值 1:排除Container标记。示例值： 0

DynamicIndex

键值索引自动配置，启用后自动将日志内的字段添加到键值索引中，包括日志中后续新增的字段。

被如下接口引用：CreateIndex、DescribeIndex、DescribeIndexs、ModifyIndex

名称	必选	允许NULL	类型	描述
Status	否	否	Bool	键值索引自动配置开关。true表示开启动态索引，false表示关闭动态索引。示例值： false

LogsetInfo

日志集相关信息

被如下接口引用：DescribeLogsets、DescribeTopics

名称	必选	允许NULL	类型	描述
LogsetId	是	否	String	日志集ID 示例值： 4463e7b0-3ec8-41a1-ae48-5d24b22167c2
LogsetName	是	否	String	日志集名称示例值：业务A日志集
CreateTime	是	否	String	创建时间示例值： 2021-04-01 08:00:00
AssumerUin	是	否	Uint64	若AssumerUin非空，则表示创建该日志集的服务方Uin 示例值： 1000945
AssumerName	是	否	String	若AssumerUin非空，则表示创建该日志集的服务方名称示例值： TCB
LogsetModifyAcl	是	否	Int64	若AssumerUin非空，则表示非改服务方的调用者对于日志集的修改权限示例值： 1
Tags	是	是	Array of Tag	日志集绑定的标签示例值：查看
TopicCount	是	否	Int64	日志集下日志主题的数目示例值： 10
RoleName	是	否	String	若AssumerUin非空，则表示创建该日志集的服务方角色示例值： TCB_QcsRole
Period	是	否	Int64	生命周期，单位为天示例值： 30
LogsetDelACL	是	否	Int64	若AssumerUin非空，则表示非改服务方的调用者对于日志集的删除权限示例值： 1
LogsetShowAcl	是	否	Uint64	若AssumerUin非空，则表示非改服务方的调用者对于日志集的查询权限示例值： 1
MetricTopicCount	是	否	Int64	日志集下指标主题的数目示例值： 10

AlertHistoryNotice

告警历史的通知对象结构

被如下接口引用：DescribeAlertRecordHistory

名称	必选	允许NULL	类型	描述
Name	是	否	String	通知渠道组名称示例值： notice_name
AlarmNoticeId	是	否	String	通知渠道组ID 示例值： alarm-57f5808c-4a55-11eb-b378-0242ac130002

Filter

过滤器

被如下接口引用：DescribeAlarmNotices、DescribeAlarmShields、DescribeAlarms、DescribeAlertRecordHistory、DescribeBinlogSubscribes、DescribeClusterBaseMetricConfigs、DescribeClusterMetricConfigs、DescribeConfigExtras、DescribeConfigs、DescribeConfigurationTemplates、DescribeConsumers、DescribeDashboardSubscribes、DescribeDashboards、DescribeDataTransformAutoCreateLogSets、DescribeDataTransformAutoCreateTopics、DescribeDataTransformInfo、DescribeExternalDataSources、DescribeFolders、DescribeIndexs、DescribeLogsets、DescribeMachineGroups、DescribeMachines、DescribeMetricSubscribes、DescribeNoticeContents、DescribeRecordingRuleTask、DescribeRecordingRuleYamlTask、DescribeRemoteWriteTasks、DescribeScheduledSqlInfo、DescribeShippers、DescribeTemplates、DescribeTopicBaseMetricConfigs、DescribeTopicMetricConfigs、DescribeTopics、DescribeWebCallbacks

名称	必选	允许NULL	类型	描述
Key	是	否	String	需要过滤的字段。示例值： taskId
Values	是	否	Array of String	需要过滤的值。示例值： ["57f5808c-4a55-11eb-b378-0242ac130002"]

KafkaProtocolInfo

Kafka访问协议

被如下接口引用：CheckRechargeKafkaServer、CreateKafkaRecharge、DescribeKafkaRecharges、ModifyKafkaRecharge、PreviewKafkaRecharge

名称	必选	允许NULL	类型	描述
Protocol	否	是	String	协议类型，支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl，此协议会进行连接加密同时需要用户认证。入参必填示例值： sasl_plaintext
Mechanism	否	是	String	加密类型，支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。当Protocol为sasl_plaintext或sasl_ssl时必填示例值： PLAIN
UserName	否	是	String	用户名。当Protocol为sasl_plaintext或sasl_ssl时必填示例值： user_name
Password	否	是	String	用户密码。当Protocol为sasl_plaintext或sasl_ssl时必填示例值： user_password
EnableClientCertificate	否	否	Uint64	是否开启客户端证书验证示例值： 1
EnableServerCertificate	否	否	Uint64	是否开启服务端证书验证示例值： 1
CACertificateId	否	否	String	云托管CA证书id 示例值： K2id
SVRCertificateId	否	否	String	云托管服务端证书id 示例值： K3id

NamespaceCorrectDimension

云监控校准维度信息

被如下接口引用：DescribeMetricCorrectDimension

名称	必选	允许NULL	类型	描述
Namespace	否	是	String	命名空间。示例值： qce/cvm
MetricDimensions	否	是	Array of MetricCorrectDimension	指标维度信息。示例值：查看

MachineGroupMetadataInfo

机器组元数据信息

被如下接口引用：DescribeAgentMachineGroupMetadata

名称	必选	允许NULL	类型	描述
GroupId	是	否	String	机器组ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
MetaTags	是	否	Array of MetaTagInfo	机器组元数据列表示例值：查看

Dimension

云产品实例维度信息

被如下接口引用：DescribeMetricSubscribePreview

名称	必选	允许NULL	类型	描述
Name	否	是	String	实例维度名称,此字段可能返回 null，表示取不到有效值。示例值： demo_name
Value	否	是	String	实例维度值,此字段可能返回 null，表示取不到有效值。示例值： demo_value

NoticeRule

通知规则

被如下接口引用：CreateAlarmNotice、DescribeAlarmNotices、ModifyAlarmNotice

名称	必选	允许NULL	类型	描述
Rule	否	否	String	匹配规则JSON串示例值： jsonstr
NoticeReceivers	否	否	Array of NoticeReceiver	告警通知接收者信息。示例值：查看
WebCallbacks	否	否	Array of WebCallback	告警通知模板回调信息，包括企业微信、钉钉、飞书。示例值：查看
Escalate	否	否	Bool	告警升级开关。true：开启告警升级、false：关闭告警升级，默认：false 示例值： false
Type	否	否	Uint64	告警升级条件。1：无人认领且未恢复、2：未恢复，默认为1 无人认领且未恢复：告警没有恢复并且没有人认领则升级未恢复：当前告警持续未恢复则升级示例值： 1
Interval	否	否	Uint64	告警升级间隔。单位：分钟，范围[1，14400] 示例值： 1
EscalateNotice	否	否	EscalateNoticeInfo	告警升级后下一个环节的通知渠道配置示例值：查看

AlarmAnalysisConfig

告警多维分析一些配置信息

被如下接口引用：CreateAlarm、DescribeAlarms、ModifyAlarm

名称	必选	允许NULL	类型	描述
Key	否	是	String	键。支持以下key： SyntaxRule：语法规则，value支持 0：Lucene语法；1： CQL语法。 QueryIndex：执行语句序号。value支持 -1：自定义； 1：执行语句1； 2：执行语句2。 CustomQuery：检索语句。 QueryIndex为-1时有效且必填，value示例： "*
Value	否	是	String	值。键对应值如下： SyntaxRule：语法规则，value支持 0：Lucene语法；1： CQL语法。 QueryIndex：执行语句序号。value支持 -1：自定义； 1：执行语句1； 2：执行语句2。 CustomQuery：检索语句。 QueryIndex为-1时有效且必填，value示例： "*

LogItem

日志中的KV对

被如下接口引用：GetAlarmLog、GetConfigurationTemplateApplyLog、SearchLog

名称	必选	允许NULL	类型	描述
Key	是	否	String	日志Key 示例值： http_code
Value	是	否	String	日志Value 示例值： 200

UploadLogException

日志上传异常

被如下接口引用：DescribeExceptionResources

名称	必选	允许NULL	类型	描述
EventId	是	否	Int64	异常事件ID 400：参数错误 401：鉴权失败/密钥过期 413：消息格式过大 429：流控-区分超频/超频示例值： 429
Message	是	否	String	异常事件描述示例值： err_message
LatestTime	是	否	Uint64	最近发生时间示例值： 1671182885

BinlogFilterList

binlog 黑名名单过滤配置信息

被如下接口引用：CreateBinlogSubscribe、DescribeBinlogSubscribePreview、DescribeBinlogSubscribes、ModifyBinlogSubscribe

名称	必选	允许NULL	类型	描述
DatabaseName	是	是	String	数据库名称。示例值： databases_name
TableNames	是	是	Array of String	数据表名称。示例值： [table_name1,table_name2]

Tag

创建资源实例时同时绑定的标签对说明

被如下接口引用：CreateAlarm、CreateAlarmNotice、CreateDashboard、CreateLogset、CreateMachineGroup、CreateTopic、DescribeAlarmNotices、DescribeAlarms、DescribeConfigMachineGroups、DescribeDashboards、DescribeLogsets、DescribeMachineGroups、DescribeTopics、ModifyAlarm、ModifyAlarmNotice、ModifyDashboard、ModifyLogset、ModifyMachineGroup、ModifyTopic

名称	必选	允许NULL	类型	描述
Key	是	是	String	标签键示例值： name
Value	是	是	String	标签值示例值：业务A

ConditionInfo

免鉴权条件信息

被如下接口引用：CreateTopic、DescribeTopics、ModifyTopic

名称	必选	允许NULL	类型	描述
Attributes	否	否	String	条件属性，目前只支持VpcID 示例值： VpcID
Rule	否	否	Uint64	条件规则，1:等于，2:不等于示例值： 1
ConditionValue	否	否	String	对应条件属性的值示例值： vpc-6jfhit1t

DashboardTemplateVariable

仪表盘订阅模板变量

被如下接口引用：CreateDashboardSubscribe、DescribeDashboardSubscribes、ModifyDashboardSubscribe、SearchDashboardSubscribe

名称	必选	允许NULL	类型	描述
Key	是	否	String	key的值示例值： TopicId
Values	是	否	Array of String	key对应的values取值values 示例值： ["dd1e5d83-fee5-cd35-ac57-20823c21b8cd"]

DataTransformTaskInfo

数据加工任务基本详情

被如下接口引用：DescribeDataTransformInfo

名称	必选	允许NULL	类型	描述
Name	是	否	String	数据加工任务名称示例值： task_name
TaskId	是	否	String	数据加工任务id 示例值： 96562452-58da-458c-9d2b-0b94e379c917
EnableFlag	是	否	Int64	任务启用状态，默认为1，正常开启, 2关闭示例值： 1
Type	是	否	Int64	加工任务类型，1： DSL， 2：SQL 示例值： 1
SrcTopicId	是	否	String	源日志主题示例值： c6404313-dc28-402c-970d-9654afd08b1f
Status	是	否	Int64	当前加工任务状态（1准备中/2运行中/3停止中/4已停止）示例值： 1
CreateTime	是	否	String	加工任务创建时间示例值： 2022-12-08 21:00:35
UpdateTime	是	否	String	最近修改时间示例值： 2024-03-20 15:51:01
LastEnableTime	是	否	String	最后启用时间，如果需要重建集群，修改该时间示例值： 2024-03-20 15:50:00
SrcTopicName	是	否	String	日志主题名称示例值： topicname
LogsetId	是	否	String	日志集id 示例值： logset-1
DstResources	是	否	Array of DataTransformResouceInfo	加工任务目的topic_id以及别名示例值：查看
EtlContent	是	否	String	加工逻辑函数示例值： fields_set(\"111\",\"111\")
BackupTopicID	是	否	String	兜底topic_id 示例值： 7b40b0cb-034a-4852-9477-9386068cede6
BackupGiveUpData	是	否	Bool	超限之后是否丢弃日志数据示例值： false
InteractiveEtlContent	否	否	String	交互式加工逻辑函数配置。示例值： {"nodes":[],"edges":[]}
HasServicesLog	否	否	Uint64	是否开启投递服务日志。 1关闭,2开启示例值： 1
TaskDstCount	否	否	Uint64	任务目标日志主题数量示例值： 1
DataTransformType	否	否	Uint64	数据加工类型。0：标准加工任务；1：前置加工任务。示例值： 0
KeepFailureLog	否	否	Uint64	保留失败日志状态。 1:不保留，2:保留示例值： 1
FailureLogKey	否	否	String	失败日志的字段名称示例值： ETLParseFailure

TopicExtendInfo

日志主题扩展信息

被如下接口引用：CreateTopic、DescribeTopics、ModifyTopic

名称	必选	允许NULL	类型	描述
AnonymousAccess	否	是	AnonymousInfo	日志主题免鉴权配置信息示例值：查看

ConsumerGroupInfo

消费组信息

被如下接口引用：DescribeConsumerGroups

名称	必选	允许NULL	类型	描述
ConsumerGroup	是	否	String	消费组标识示例值： group21
Timeout	是	否	Uint64	消费者心跳超时时间（秒）示例值： 30
Topics	是	否	Array of String	topic列表示例值： ["57f5808c-4a55-11eb-b378-0242ac130002"]

MachineGroupTypeInfo

机器组类型描述

被如下接口引用：AddMachineGroupInfo、CreateMachineGroup、DeleteMachineGroupInfo、DescribeConfigMachineGroups、DescribeMachineGroups、ModifyMachineGroup

名称	必选	允许NULL	类型	描述
Type	是	否	String	机器组类型。支持 ip 和 label。 ip：表示该机器组Values中存的是采集机器的ip地址 label：表示该机器组Values中存储的是机器的标签示例值： label
Values	否	否	Array of String	机器描述列表。示例值： [10.1.1.1,10.2.2.2]

PartitionOffsetInfo

被如下接口引用：CommitConsumerOffsets、DescribeConsumerOffsets

名称	必选	允许NULL	类型	描述
PartitionId	是	是	Uint64	分区id 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
Offset	否	是	Int64	offset点位示例值： 0

DashboardTopicInfo

仪表盘关联的topic信息

被如下接口引用：DescribeDashboards

名称	必选	允许NULL	类型	描述
TopicId	是	否	String	主题id 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
Region	是	否	String	topic所在的地域示例值： region

TopicIdAndRegion

仪表盘 topic与地域信息

被如下接口引用：DescribeDashboards

名称	必选	允许NULL	类型	描述
TopicId	是	否	String	日志主题id 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
RegionId	是	否	Uint64	日志主题id所在的地域id。示例值： 19

MetricYamlSpec

指标采集yaml格式配置

被如下接口引用：CreateMetricConfig、DescribeClusterBaseMetricConfigs、DescribeClusterMetricConfigs、DescribeTopicBaseMetricConfigs、DescribeTopicMetricConfigs、ModifyMetricConfig

名称	必选	允许NULL	类型	描述
Type	否	是	String	yaml监控类型。支持： - PodMonitor - ServiceMonitor - ScrapeConfig - ScrapeConfig-prometheus `PodMonitor `,`ServiceMonitor `,`ScrapeConfig ` 属于prometheus-operator `ScrapeConfig-prometheus` 属于prometheus 示例值： ServiceMonitor
Spec	否	是	String	配置yaml格式。示例值： yaml

MetaTagInfo

元数据信息

被如下接口引用：CreateConfig、CreateConfigExtra、CreateCosRecharge、CreateMachineGroup、DescribeAgentConfigs、DescribeAgentMachineGroupMetadata、DescribeConfigExtras、DescribeConfigMachineGroups、DescribeConfigs、DescribeCosRecharges、DescribeMachineGroupConfigs、DescribeMachineGroups、ModifyConfig、ModifyConfigExtra、ModifyCosRecharge、ModifyMachineGroup

名称	必选	允许NULL	类型	描述
Key	否	否	String	元数据key 示例值： buss_key
Value	否	否	String	元数据value 示例值： buss_value

RuleInfo

索引规则，FullText、KeyValue、Tag参数必须输入一个有效参数

被如下接口引用：CreateIndex、DescribeIndex、DescribeIndexs、ModifyIndex

名称	必选	允许NULL	类型	描述
FullText	否	是	FullTextInfo	全文索引配置, 为空时代表未开启全文索引示例值：查看
KeyValue	否	是	RuleKeyValueInfo	键值索引配置，为空时代表未开启键值索引示例值：查看
Tag	否	是	RuleTagInfo	元字段索引配置，为空时代表未开启元字段索引示例值：查看
DynamicIndex	否	是	DynamicIndex	键值索引自动配置，为空时代表未开启该功能。启用后自动将日志内的字段添加到键值索引中，包括日志中后续新增的字段。示例值：查看

CheckAlarmTarget

检查告警的告警对象

被如下接口引用：CheckAlarmRule

名称	必选	允许NULL	类型	描述
TopicId	否	是	String	日志主题ID。示例值： dfa4ac24-caa1-4e30-a027-349cb29937c4
Query	否	是	String	查询语句。示例值： code:200
Number	否	是	Int64	告警对象序号；从1开始递增。示例值： 1
StartTimeOffset	否	是	Int64	查询范围起始时间相对于告警执行时间的偏移，单位为分钟，取值为非正，最大值为0，最小值为-1440。示例值： -5
EndTimeOffset	否	是	Int64	查询范围终止时间相对于告警执行时间的偏移，单位为分钟，取值为非正，须大于StartTimeOffset，最大值为0，最小值为-1440。示例值： 0
LogsetId	否	是	String	日志集ID。示例值： dfa4ac24-caa1-4e30-a027-349cb29937c4
SyntaxRule	否	是	Uint64	检索语法规则，默认值为0。 0：Lucene语法，1：CQL语法。详细说明参见检索条件语法规则示例值： 1
Index	否	是	Int64	序号示例值： 0

MetricConfigLabel

指标采集label配置信息

被如下接口引用：CreateMetricConfig、DescribeClusterBaseMetricConfigs、DescribeClusterMetricConfigs、DescribeTopicBaseMetricConfigs、DescribeTopicMetricConfigs、ModifyMetricConfig

名称	必选	允许NULL	类型	描述
Metadata	否	是	Array of String	元数据。支持 - `namespace` - `pod_name` - `pod_ip` - `pod_uid` - `container_name` - `container_id` - `image_name` - `cluster_id` - `node_id` - `node_ip` 示例值： ["namespace","pod_name"]
Label	否	是	AppointLabel	元数据Pod Label信息。示例值：查看
CustomLabels	否	是	Array of CustomLabel	自定义label信息。示例值：查看

CosRechargeInfo

cos导入配置信息

被如下接口引用：DescribeCosRecharges

名称	必选	允许NULL	类型	描述
Id	是	否	String	COS导入配置ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
TopicId	是	否	String	日志主题ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
LogsetId	是	否	String	日志集ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
Name	是	否	String	cos导入任务名称示例值： cos任务导入
Bucket	是	否	String	cos存储桶示例值： bucket1
BucketRegion	是	否	String	cos存储桶地域示例值： region
Prefix	是	否	String	cos存储桶前缀地址示例值： /var/log
LogType	是	否	String	采集的日志类型，json_log代表json格式日志，delimiter_log代表分隔符格式日志，minimalist_log代表单行全文；默认为minimalist_log 示例值： minimalist_log
Status	是	否	Uint64	状态 status 0: 已创建, 1: 运行中, 2: 已停止, 3: 已完成, 4: 运行失败。示例值： 1
Enable	是	否	Uint64	是否启用: 0：未启用， 1：启用示例值： 1
CreateTime	是	否	String	创建时间示例值： 2021-11-08 14:40:22
UpdateTime	是	否	String	更新时间示例值： 2021-11-08 14:40:22
Progress	是	否	Uint64	进度条百分值示例值： 0
Compress	是	否	String	压缩格式，支持 "", "gzip", "lzop", "snappy”; 默认空示例值： gzip
ExtractRuleInfo	是	否	ExtractRuleInfo	见： ExtractRuleInfo 结构描述示例值：查看
TaskType	否	否	Uint64	COS导入任务类型。1：一次性导入任务；2：持续性导入任务。示例值： 1
Metadata	否	否	Array of String	元数据。支持 bucket，object。示例值： ["bucket","object"]

Column

日志分析的列属性

被如下接口引用：GetAlarmLog、GetConfigurationTemplateApplyLog、SearchLog

名称	必选	允许NULL	类型	描述
Name	是	否	String	列的名字示例值： _col0
Type	是	否	String	列的属性示例值： json

PartitionInfo

日志主题分区信息

被如下接口引用：DescribePartitions、MergePartition、SplitPartition

名称	必选	允许NULL	类型	描述
PartitionId	是	否	Int64	分区ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
Status	是	否	String	分区的状态（readwrite或者是readonly）示例值： readonly
InclusiveBeginKey	是	否	String	分区哈希键起始key 示例值： 00000000000000000000000000000000
ExclusiveEndKey	是	否	String	分区哈希键结束key 示例值： ffffffffffffffffffffffffffffffff
CreateTime	是	否	String	分区创建时间示例值： 2024-10-10 16:17:03
LastWriteTime	是	是	String	只读分区数据停止写入时间示例值： 2024-10-10 16:17:03

BinlogDBConfig

数据库配置信息

被如下接口引用：CreateBinlogSubscribe、DescribeBinlogSubscribeConnectivity、DescribeBinlogSubscribePreview、DescribeBinlogSubscribes、ModifyBinlogSubscribe

名称	必选	允许NULL	类型	描述
AccessMode	是	否	Uint64	访问方式。 1: 内网 2: 外网示例值： 1
User	是	是	String	用户名。示例值： root
Password	否	是	String	密码。示例值： root-3306
InstanceId	否	是	String	实例id。数据库类型是云数据库Mysql 或者 TDSQL-C时必填。示例值： xgasg-111
Address	否	是	String	mysql实例地址。自建MySQL，且访问方式为内网访问时必填。示例值： 10.0.0.80
Port	否	是	String	mysql实例端口。自建MySQL，且访问方式为内网访问时必填。示例值： 3306
EndPointServiceId	否	是	String	私有网络服务ID。自建MySQL，且访问方式为内网访问时必填。示例值： vpcwer-23
NetworkServiceType	否	是	Uint64	网络服务类型。 1:负载均衡CLB 2:云服务器CVM 自建MySQL，且访问方式为内网访问时必填。示例值： 1

RegexIndexInfo

获取K-V正则索引信息

被如下接口引用：GenKVRegex

名称	必选	允许NULL	类型	描述
Start	是	否	Int64	起始位置示例值： 0
End	是	否	Int64	结束位置示例值： 50

AlarmTemplateConfig

告警模板配置

被如下接口引用：CreateAlarm、DescribeAlarms、ModifyAlarm

名称	必选	允许NULL	类型	描述
CloudProduct	否	否	String	用产品类型。 TKE：容器服务 CLB：负载均衡示例值： TKE
TemplateId	否	否	String	告警模板 id。示例值： 910d225f-e736-49bd-8e60-89e540fc2053
InstanceId	否	否	String	实例 id。当 CloudProduct 为 TKE 时，InstanceId 为集群 id。示例值： cls-dt97pitw
ExtraData	否	否	String	告警模板额外信息示例值： {"placeholders":[{"key":"ConditionValue","value":"3"}],"instance_info":[{"key":"type","value":"eks"}]}

NoticeContentTemplate

通知内容模板信息

被如下接口引用：DescribeNoticeContents

名称	必选	允许NULL	类型	描述
NoticeContentId	是	否	String	通知内容模板ID。示例值： noticetemplate-0dffefa3-dvee-saef-a1f6-84854de6e908
Name	是	否	String	通知内容模板名称示例值： alarm_name
Type	是	否	Uint64	语言类型。 0： zh 1：英文示例值： 0
NoticeContents	是	否	Array of NoticeContent	通知内容模板信息。示例值：查看
Flag	是	否	Uint64	通知内容模板标记。 0：用户自定义 1：系统内置示例值： 0
Uin	是	否	Uint64	创建者主账号。示例值： 1000010111112
SubUin	否	否	Uint64	创建/修改者子账号。示例值： 10002196demo12
CreateTime	是	否	Int64	创建时间秒级时间戳。示例值： 1705923855
UpdateTime	是	否	Int64	更新时间秒级时间戳。示例值： 1706149043

IndexException

索引配置异常

被如下接口引用：DescribeExceptionResources

名称	必选	允许NULL	类型	描述
TopicId	是	否	String	日志主题ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
Status	是	否	Int64	状态： 1：未开启索引 2：未开启键值索引示例值： 1
TopicName	是	否	String	日志主题名称示例值：主题名称

AdvanceFilterRuleInfo

高级过滤规则

被如下接口引用：CreateConfig、CreateConfigExtra、CreateCosRecharge、CreateKafkaRecharge、DescribeAgentConfigs、DescribeConfigExtras、DescribeConfigs、DescribeCosRecharges、DescribeKafkaRecharges、DescribeMachineGroupConfigs、ModifyConfig、ModifyConfigExtra、ModifyCosRecharge、ModifyKafkaRecharge、PreviewKafkaRecharge

名称	必选	允许NULL	类型	描述
Key	否	否	String	过滤字段示例值： http_code
Rule	否	否	Uint64	过滤规则，0:等于，1:字段存在，2:字段不存在示例值： 0
Value	否	否	String	过滤值示例值： 400

CollectConfig

采集配置信息

被如下接口引用：CreateConfigExtra、DescribeConfigExtras、ModifyConfigExtra

名称	必选	允许NULL	类型	描述
Name	是	否	String	指定采集类型的采集配置名称信息。当CollectInfo中Type为0：表示元数据配置，name为元数据名称。目前支持"container_id"，"container_name"，"image_name"，"namespace"，"pod_uid"，"pod_name"，"pod_ip"。当CollectInfo中Type为1：指定pod label，name为指定pod label名称。示例值： pod_name

DataTransformResouceInfo

数据加工的资源信息

被如下接口引用：CheckFunction、CreateDataTransform、DescribeDataTransformInfo、ModifyDataTransform

名称	必选	允许NULL	类型	描述
TopicId	是	否	String	目标主题id 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
Alias	是	否	String	别名示例值： topicname
LogsetId	否	否	String	日志集id 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
Uin	否	否	String	主账号Uin 示例值： 130000000212

TopicETL

数据加工自动创建topic信息

被如下接口引用：DescribeDataTransformAutoCreateTopics

名称	必选	允许NULL	类型	描述
Uin	是	否	Int64	用户id 示例值： 100001
TaskId	是	否	String	任务id 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
TopicId	是	否	String	日志主题示例值： 57f5808c-4a55-11eb-b378-0242ac130002
LogsetId	是	否	String	日志集示例值： 57f5808c-4a55-11eb-b378-0242ac130002
TopicName	是	否	String	日志主题名称示例值： topic_name
LogsetName	是	否	String	日志集名称示例值： logset_name
Tag	否	是	String	标签示例值： CLS_ETL
CreatedAt	是	是	Int64	创建时间（秒级时间戳）示例值： 1696089600
UpdatedAt	否	否	Int64	更新时间（秒级时间戳）示例值： 1696089600
DeletedAt	否	否	Int64	删除时间（秒级时间戳）示例值： 0

AgentUpdateStatus

Agent自动升级状态信息

被如下接口引用：UpdateAgentStatus

名称	必选	允许NULL	类型	描述
UpdateType	否	否	Int64	升级类型:0-null,1-manual,2-auto,3-force 示例值： 0
UpdateAction	否	否	Int64	升级动作:0-null,1-update,2-revert 示例值： 0
RetryCount	否	否	Int64	重试次数,最大三次示例值： 2
UpdateStatus	否	否	Int64	Agent升级状态:0-querying,1-updating,2-reverting,-1-updatefail,-2-revertfail, -10-notsupport 示例值： 0
ErrCode	是	否	Int64	错误码示例值： 0
ErrMsg	是	否	String	错误信息示例值： "OK"

FieldValueRatioInfos

描述字段值的占比情况

被如下接口引用：DescribeLogFastAnalysis

名称	必选	允许NULL	类型	描述
Value	是	否	String	字段值示例值： 2
Count	是	否	Int64	字段值所占的数量示例值： 23
Ratio	是	否	Float	字段值所占的比例示例值： 0.9

AgentUpdateInfo

Agent自动升级任务信息

被如下接口引用：HeartBeat

名称	必选	允许NULL	类型	描述
NeedUpdate	是	否	Bool	是否需要升级。true表示需要升级，false表示不需要升级。示例值： true
UpdateType	是	是	Int64	升级类型:0-null,1-manual,2-auto,3-force 示例值： 0
UpdateAction	是	是	Int64	升级动作:0-null,1-update,2-revert 示例值： 0
RetryCount	是	是	Int64	重试次数,最大3次示例值： 0
TargetVersion	是	是	String	目标版本示例值： 2.6.5
DownloadUrl	是	是	String	安装包下载链接1 示例值： https://console.cloud.demo.com/loglistener.tar.gz
DownloadUrlSecond	是	是	String	安装包下载链接2 示例值： https://console.cloud.demo.com/loglistener.tar.gz
FileMd5	是	是	String	安装包文件MD5值示例值： f560bf80453db17538aa44e2d5b121a1

FullTextInfo

全文索引配置

被如下接口引用：CreateIndex、DescribeIndex、DescribeIndexs、ModifyIndex

名称	必选	允许NULL	类型	描述
CaseSensitive	是	否	Bool	是否大小写敏感。true表示大小写敏感，false代表大小写不敏感。示例值： false
Tokenizer	是	否	String	全文索引的分词符，其中的每个字符代表一个分词符；仅支持英文符号、\n\t\r及转义符\；注意：\n\t\r本身已被转义，直接使用双引号包裹即可作为入参，无需再次转义。使用API Explorer进行调试时请使用JSON参数输入方式，以避免\n\t\r被重复转义示例值： @&?
ContainZH	否	否	Bool	是否包含zh。true代表包含zh，false代表不包含zh。示例值： false

AgentKeyInfo

需要升级的机器信息

被如下接口引用：UpgradeAgentNormal

名称	必选	允许NULL	类型	描述
IP	是	否	String	agent IP地址示例值： 127.0.0.1
InstanceID	是	否	String	实例ID 示例值： loglistener-1462d334-0fb6-5f36-28d8-209e1b17ea2d

KeyLogInfo

json格式的k-v日志信息

被如下接口引用：DescribeLatestJsonLog、DescribeLatestUserLog

名称	必选	允许NULL	类型	描述
Key	是	否	String	日志key 示例值： logKey
Value	是	否	String	日志内容示例值： logValue

FilterRuleInfo

投递日志的过滤规则

被如下接口引用：CreateConfigurationTemplate、CreateShipper、DescribeConfigurationTemplates、DescribeShippers、ModifyConfigurationTemplate、ModifyShipper

名称	必选	允许NULL	类型	描述
Key	是	否	String	过滤规则Key 示例值： log_key
Regex	是	否	String	过滤规则示例值： /w
Value	是	否	String	过滤规则Value 示例值： log_value

ExternalDataSourceCOSInfo

外部表COS信息

被如下接口引用：CreateExternalDataSource、DescribeExternalDataSourcePreview、DescribeExternalDataSources、ModifyExternalDataSource

名称	必选	允许NULL	类型	描述
Region	是	否	String	COS地域示例值： region
Bucket	是	否	String	COS存储桶示例值： bucket-1
FileAddress	是	否	String	COS文件地址(CSV格式)，仅支持CSV格式文件示例值： /region-open-kkk-1730194324/%Y/%m/%d/%H/
CompressType	否	是	Uint64	压缩方式 0:不压缩;1:gzip; 2:lzop;3:snappy 示例值： 0
FieldsInfo	是	否	Array of FieldInfo	COS文件(CSV格式)内容表头字段与字段类型信息示例值：查看

LogConfigInfo

采集日志配置信息

被如下接口引用：DescribeAgentConfigs

名称	必选	允许NULL	类型	描述
TopicId	是	否	String	日志主题ID 示例值： f6c4fa6f-367a-4f14-8289-1ff6f77ed975
Path	是	否	String	采集日志路径列表示例值： /var/log/message
LogType	是	否	String	日志类型，可选值：minimalist_log代表单行全文；multiline_log代表多行全文；fullregex_log代表单行完全正则；json_log代表JSON日志；multiline_fullregex_log多行完全正则；user_define_log代表组合解析；delimiter_log代表分隔符；示例值： minimalist_log
ExtractRule	是	否	ExtractRuleInfo	提取规则示例值：查看
LogFormat	是	是	String	日志格式化格式，可选值：default代表默认格式；nginx_log代表nginx格式日志；示例值： default
ExcludePaths	是	是	Array of ExcludePathInfo	黑名单path列表示例值：查看
UserDefineRule	是	是	String	用户自定义解析字符串示例值： {"processors":[{"type":"processor_split_delimiter","detail":{"Delimiter":",","ExtractKeys":["time","msg1","msg2"]},"processors":[{"type":"processor_timeformat","detail":{"KeepSource":true,"TimeFormat":"%s","SourceKey":"time"}},{"type":"processor_split_delimiter","detail":{"KeepSource":false,"Delimiter":"
ConfigId	是	是	String	采集配置ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
GroupIds	是	是	Array of String	使用了元数据的机器组ID列表示例值： ["dd1e5d83-fee5-cd35-ac57-20823c21b8cd"]
LogsetId	是	否	String	日志集ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
InputType	否	是	String	日志输入类型，支持linux_file、window_event 、windows_file、syslog、k8s_stdout、k8s_file 示例值： linux_file

MachineInfo

机器状态信息

被如下接口引用：DescribeMachines

名称	必选	允许NULL	类型	描述
Ip	是	否	String	机器的IP 示例值： 10.0.0.1
Status	是	否	Uint64	机器状态，0:异常，1:正常示例值： 0
OfflineTime	是	否	String	机器离线时间，空为正常，异常返回具体时间示例值： 2021-01-12 20:14:10
AutoUpdate	是	否	Int64	机器是否开启自动升级。0:关闭，1:开启示例值： 0
Version	是	否	String	机器当前版本号。示例值： 2.1.0
UpdateStatus	是	否	Int64	机器升级功能状态。 0：升级成功；1：升级中；-1：升级失败。示例值： 0
ErrCode	是	否	Int64	机器升级结果标识。 0：成功；1200：升级成功；其他值表示异常。示例值： 0
ErrMsg	是	否	String	机器升级结果信息。 “ok”：成功；“update success”：升级成功；其他值为失败原因。示例值： OK
InstanceID	否	否	String	机器实例ID 示例值： loglistener-1462d334-0fb6-5f36-28d8-209e1b17ea2d

InstanceData

云产品指标订阅预览结果实例信息

被如下接口引用：DescribeMetricSubscribePreview

名称	必选	允许NULL	类型	描述
MetricName	否	是	String	云监控指标名称示例值： MemUsed
CLSMetricName	否	是	String	CLS指标名称示例值： qce_cvm_memused_60_avg
Namespace	否	是	String	云产品命名空间示例值： QCE/CVM
Dimensions	否	是	Array of Dimension	实例信息示例值：查看
Period	否	是	Uint64	周期,单位：秒示例值： 60
Value	否	是	Float	指标统计值示例值： 90
ErrMsg	否	是	String	错误信息示例值： err_msg

KafkaRechargeInfo

Kafka导入配置信息

被如下接口引用：DescribeKafkaRecharges

名称	必选	允许NULL	类型	描述
Id	是	否	String	Kafka数据订阅配置的ID。示例值： 57f5808c-4a55-11eb-b378-0242ac130002
TopicId	是	否	String	日志主题ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
Name	是	否	String	Kafka导入任务名称示例值： kafka导入任务
KafkaType	是	否	Uint64	导入Kafka类型，0: CKafka，1: 用户自建Kafka 示例值： 0
KafkaInstance	是	否	String	CKafka实例ID，KafkaType为0时必填示例值： ckafka-le45va27
ServerAddr	是	否	String	服务地址示例值： kafkaconsumer-region.cloud.demo.com
IsEncryptionAddr	是	否	Bool	ServerAddr是否为加密连接。true表示是加密连接，false表示不是加密连接。示例值： true
Protocol	是	否	KafkaProtocolInfo	加密访问协议，IsEncryptionAddr参数为true时必填示例值：查看
UserKafkaTopics	是	否	String	用户需要导入的Kafka相关topic列表，多个topic之间使用半角逗号隔开示例值： 57f5808c-4a55-11eb-b378-0242ac130002
ConsumerGroupName	是	否	String	用户Kafka消费组名称示例值： cls_consumergroup_1
Status	是	否	Int64	状态 status 1: 运行中, 2: 暂停示例值： 1
Offset	是	否	Int64	导入数据位置，-2:最早（默认），-1：最晚示例值： 0
CreateTime	是	否	String	创建时间示例值： 2021-11-08 14:40:22
UpdateTime	是	否	String	更新时间示例值： 2021-11-08 14:40:22
LogRechargeRule	是	否	LogRechargeRuleInfo	日志导入规则示例值：查看
NetworkInfo	否	否	NetworkInfo	私有网络信息示例值：查看

CustomMetricSpec

自定义指标采集对象

被如下接口引用：CreateMetricConfig、DescribeClusterBaseMetricConfigs、DescribeClusterMetricConfigs、DescribeTopicBaseMetricConfigs、DescribeTopicMetricConfigs、ModifyMetricConfig

名称	必选	允许NULL	类型	描述
Port	否	是	String	端口。取值范围 [1,65535] 示例值： 80
Path	否	是	String	Metric地址。校验格式：`^/[a-zA-Z0-9-_./]*$` 示例值： /metric
Namespaces	否	是	Array of String	命名空间列表。 - 最大支持100个 - namespace 校验格式 `[a-z0-9]([-a-z0-9]*[a-z0-9])?` ，长度不能超过63 - namespace 不能重复示例值： kube-system
PodLabel	否	是	Array of Label	Pod标签。 - 最大支持100个示例值：查看

RebuildIndexTaskInfo

索引重建任务信息

被如下接口引用：DescribeRebuildIndexTasks

名称	必选	允许NULL	类型	描述
TaskId	是	否	String	索引重建任务ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
Status	是	否	Uint64	索引重建任务当前状态，0:索引重建任务已创建，1:创建索引重建资源，2:索引重建资源创建完成，3:重建中，4:暂停，5:重建索引成功，6:重建成功（可检索），7:重建失败，8:撤销，9:删除元数据和索引示例值： 0
StartTime	是	否	Uint64	重建任务开始时间戳示例值： 1649670501
EndTime	是	否	Uint64	重建任务结束时间戳示例值： 1649670501
RemainTime	是	否	Int64	重投预估剩余时间，单位秒示例值： 10000
CreateTime	是	否	Uint64	重建任务创建时间戳示例值： 1649670501
Progress	是	否	Float	重投完成度，百分比示例值： 0.1
UpdateTime	是	否	Uint64	重建任务更新时间示例值： 0
StatusMessage	是	否	String	附加状态描述信息（目前仅描述失败时失败原因）示例值： message

ConfigExtraInfo

特殊采集规则配置信息

被如下接口引用：DescribeConfigExtras

名称	必选	允许NULL	类型	描述
ConfigExtraId	是	否	String	采集规则扩展配置ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
Name	是	否	String	采集规则名称示例值： config_name
TopicId	是	否	String	日志主题ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
Type	是	否	String	类型：container_stdout、container_file、host_file 示例值： container_stdout
HostFile	是	否	HostFileInfo	节点文件配置信息示例值：查看
ContainerFile	是	否	ContainerFileInfo	容器文件路径信息示例值：查看
ContainerStdout	是	否	ContainerStdoutInfo	容器标准输出信息示例值：查看
LogFormat	是	否	String	日志格式化方式示例值： default
LogType	是	否	String	采集的日志类型，json_log代表json格式日志，delimiter_log代表分隔符格式日志，minimalist_log代表极简日志，multiline_log代表多行日志，fullregex_log代表完整正则，默认为minimalist_log 示例值： minimalist_log
ExtractRule	是	否	ExtractRuleInfo	提取规则，如果设置了ExtractRule，则必须设置LogType 示例值：查看
ExcludePaths	是	是	Array of ExcludePathInfo	采集黑名单路径列表示例值：查看
UpdateTime	是	否	String	更新时间示例值： 2020-02-16 17:01:50
CreateTime	是	否	String	创建时间示例值： 2020-02-16 17:01:50
UserDefineRule	是	否	String	用户自定义解析字符串示例值： {"processors":[{"type":"processor_split_delimiter","detail":{"Delimiter":",","ExtractKeys":["time","msg1","msg2"]},"processors":[{"type":"processor_timeformat","detail":{"KeepSource":true,"TimeFormat":"%s","SourceKey":"time"}},{"type":"processor_split_delimiter","detail":{"KeepSource":false,"Delimiter":"
GroupId	是	否	String	机器组ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
ConfigFlag	是	否	String	自建采集配置标示例值： label_k8s
LogsetId	是	否	String	日志集ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
LogsetName	是	否	String	日志集name 示例值： logset_name
TopicName	是	否	String	日志主题name 示例值： topic_name
CollectInfos	是	否	Array of CollectInfo	采集相关配置信息。详情见 CollectInfo复杂类型配置。示例值：查看
AdvancedConfig	是	否	String	高级采集配置。 Json字符串， Key/Value定义为如下： ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数， 0为不超时 ClsAgentMaxDepth(最大目录深度)，取值范围: 大于等于0的整数 ClsAgentParseFailMerge(合并解析失败日志)，取值范围: true或false 样例：{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true} 示例值： {"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true}

EscalateNoticeInfo

升级通知

被如下接口引用：CreateAlarmNotice、DescribeAlarmNotices、ModifyAlarmNotice

名称	必选	允许NULL	类型	描述
NoticeReceivers	否	否	Array of NoticeReceiver	告警通知模板接收者信息。示例值：查看
WebCallbacks	否	否	Array of WebCallback	告警通知模板回调信息。示例值：查看
Escalate	否	否	Bool	告警升级开关。true：开启告警升级、false：关闭告警升级，默认：false 示例值： false
Interval	否	否	Uint64	告警升级间隔。单位：分钟，范围[1，14400] 示例值： 5
Type	否	否	Uint64	升级条件。1：无人认领且未恢复、2：未恢复，默认为1 无人认领且未恢复：告警没有恢复并且没有人认领则升级未恢复：当前告警持续未恢复则升级示例值： 1
EscalateNotice	否	否	EscalateNoticeInfo	告警升级后下一个环节的通知渠道配置，最多可配置5个环节。示例值：查看

CallBackInfo

回调配置

被如下接口引用：CreateAlarm、DescribeAlarms、ModifyAlarm

名称	必选	允许NULL	类型	描述
Body	是	否	String	回调时的Body。可将各类告警变量放在请求内容中，详见帮助文档。如下示例： {"data":"data"} 示例值： data
Headers	否	是	Array of String	回调时的HTTP请求头部字段。例如：下面请求头部字段来告知服务器请求主体的内容类型为JSON。 "Content-Type: application/json" 示例值： ["Content-Type: application/json"]

KafkaConsumerContent

kafka协议消费内容

被如下接口引用：DescribeKafkaConsumer、DescribeKafkaConsumerPreview、ModifyKafkaConsumer、OpenKafkaConsumer

名称	必选	允许NULL	类型	描述
Format	是	否	Int64	消费数据格式。 0：原始内容；1：JSON。示例值： 1
EnableTag	是	否	Bool	是否投递 TAG 信息 Format为0时，此字段不需要赋值示例值： false
TagTransaction	否	否	Int64	tag数据处理方式：1:不平铺（默认值）；2:平铺。不平铺示例： TAG信息：{"TAG":{"fieldA":200,"fieldB":"text"}} 不平铺：{"TAG":{"fieldA":200,"fieldB":"text"}} 平铺示例： TAG信息：{"TAG":{"fieldA":200,"fieldB":"text"}} 平铺：{"TAG.fieldA":200,"TAG.fieldB":"text"} 示例值： 1
MetaFields	是	否	Array of String	元数据信息列表, 可选值为：SOURCE、FILENAME 、TIMESTAMP、HOSTNAME、PKGID Format为0时，此字段不需要赋值示例值： ["__HOSTNAME__"]
JsonType	否	否	Int64	消费数据Json格式： 1：不转义（默认格式） 2：转义投递Json格式。 JsonType为1：和原始日志一致，不转义。示例：日志原文：{"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}} 投递到Ckafka：{"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}} JsonType为2：转义。示例：日志原文：{"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}} 投递到Ckafka：{"a":"aa","b":"{"b1":"b1b1", "c1":"c1c1"}"} 示例值： 1

ResourcesInfo

地域指标信息

被如下接口引用：DescribeResources

名称	必选	允许NULL	类型	描述
Region	是	否	String	地域示例值： region
Logsets	是	否	Uint64	日志集数示例值： 1
Topics	是	否	Uint64	日志主题数示例值： 1
Partitions	是	否	Uint64	分区数示例值： 1
Machines	是	否	Uint64	机器数示例值： 1
HeartMachines	是	否	Uint64	心跳正常机器数示例值： 1
MetricTopics	是	是	Uint64	指标主题数示例值： 1

MetricSubscribeInfo

指标订阅配置信息

被如下接口引用：DescribeMetricSubscribes

名称	必选	允许NULL	类型	描述
TaskId	否	否	String	订阅任务id。示例值： 57f5808c-4a55-11eb-b378-0242ac130002
TopicId	否	否	String	日志主题id。示例值： 57f5808c-4a55-11eb-b378-0242ac130002
Name	否	否	String	订阅任务名称。示例值： template_name
Namespace	否	否	String	云产品命名空间。示例值： cvm
Metrics	否	否	Array of MetricConfig	指标配置信息。示例值：查看
InstanceInfo	否	否	InstanceConfig	实例配置信息。示例值：查看
Enable	否	否	Uint64	订阅任务开关。1:暂停 2:启用示例值： 2
Status	否	否	Uint64	订阅任务运行状态。0:创建中 1:暂停 2:运行中 3:异常示例值： 0
ErrMsg	否	是	String	订阅任务运行异常时的错误信息。示例值： error
CreateTime	否	是	Int64	创建时间（秒级时间戳）示例值： 1736994580
UpdateTime	否	是	Int64	更新时间（秒级时间戳）示例值： 1736994580

CompressInfo

投递日志的压缩配置

被如下接口引用：CreateConfigurationTemplate、CreateShipper、DescribeConfigurationTemplates、DescribeShippers、ModifyConfigurationTemplate、ModifyShipper

名称	必选	允许NULL	类型	描述
Format	是	否	String	压缩格式，支持gzip、lzop、snappy和none不压缩示例值： gzip

ConfigurationTemplateLogsetInfo

配置模板日志集相关信息

被如下接口引用：ApplyConfigurationTemplate

名称	必选	允许NULL	类型	描述
LogsetIds	是	否	Array of String	日志集id列表示例值： ["dd1e5d83-fee5-cd35-ac57-20823c21b8cd"]
MatchRange	是	否	Array of Uint64	动态配置范围。1:新增日志主题,2:已有日志主题。示例值： [1,2]
Regex	是	否	String	日志主题名称正则匹配表达式。示例值： [a-z]{0,3}
UnMatch	否	否	Bool	该参数控制 Regex参数是否正向匹配。 false：Regex为日志主题名称正则匹配表达式。 true：Regex为日志主题名称正则不匹配表达式。示例值： false

CsvInfo

csv内容描述

被如下接口引用：CreateShipper、DescribeShipperPreview、DescribeShippers、ModifyShipper

名称	必选	允许NULL	类型	描述
PrintKey	是	否	Bool	csv首行是否打印key。true表示首行打印key，false表示首行不打印key 示例值： true
Keys	是	是	Array of String	每列key的名字示例值： ["SOURCE","FILENAME","HOSTNAME"]
Delimiter	是	否	String	各字段间的分隔符示例值： ,
EscapeChar	是	否	String	若字段内容中包含分隔符，则使用该转义符包裹改字段，只能填写单引号、双引号、空字符串示例值： '
NonExistingField	是	否	String	对于上面指定的不存在字段使用该内容填充示例值： not_exist

Label

标签结构体

被如下接口引用：CreateMetricConfig、DescribeClusterBaseMetricConfigs、DescribeClusterMetricConfigs、DescribeTopicBaseMetricConfigs、DescribeTopicMetricConfigs、ModifyMetricConfig

名称	必选	允许NULL	类型	描述
Key	否	是	String	标签的键。有效标签键有两个部分：可选前缀和名称，以斜杠 (/) 分隔。名称部分是必需的，并且必须不超过 63 个字符，以字母数字字符 ([a-z0-9A-Z]) 开头和结尾，中间有破折号(-)、下划线(_)、点(.) 和字母数字。前缀是可选的。如果指定，前缀必须是 DNS 子域：一系列以点 (.) 分隔的 DNS 标签，总长度不超过 253 个字符，后跟斜杠 ( /)。 - prefix 格式 `[a-z0-9]([-a-z0-9][a-z0-9])?(\.[a-z0-9]([-a-z0-9][a-z0-9])?)` - name 格式 `([A-Za-z0-9][-A-Za-z0-9_.])?[A-Za-z0-9]` - key不能重复示例值： app
Operate	否	是	String	标签键值直接的比较关系。不同业务场景支持的比较符不同，具体支持那些参考接口业务描述。例如：`in`、`notin` 示例值： in
Values	否	是	Array of String	标签的值. - 最大支持63个字符。 - 格式：`([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]` 示例值： ["k8s-x"]

ExternalDataSourceInfo

外部数据源信息

被如下接口引用：DescribeExternalDataSources

名称	必选	允许NULL	类型	描述
Id	是	否	String	外部数据源ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
Name	是	是	String	名称示例值： external_data_name
Describes	是	是	String	备注示例值：外部数据源备注
Datasource	是	是	Uint64	数据源类型：1表示Mysql数据源，2表示cos数据源示例值： 1
SubjectionTopicId	是	是	String	隶属日志主题ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
SubjectionTopicName	是	是	String	隶属日志主题名称示例值： demo_topic_name
TopicId	是	是	String	当前请求日志主题ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
LogsetId	是	是	String	日志集示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
SQLInfo	是	是	ExternalDataSourceSQLInfo	mysql配置信息示例值：查看
COSInfo	是	是	ExternalDataSourceCOSInfo	cos配置信息示例值：查看
CreateTime	是	是	Int64	创建时间（秒级时间戳）示例值： 1681990662
UpdateTime	是	是	Int64	更新时间（秒级时间戳）示例值： 1681990662

ScheduledSqlTaskInfo

ScheduledSql任务详情

被如下接口引用：DescribeScheduledSqlInfo

名称	必选	允许NULL	类型	描述
TaskId	是	否	String	ScheduledSql任务id 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
Name	是	否	String	ScheduledSql任务名称示例值： task
SrcTopicId	是	否	String	源日志主题id 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
SrcTopicName	是	否	String	源日志主题名称示例值： topic_name
DstResource	是	否	ScheduledSqlResouceInfo	定时SQL分析目标主题示例值：查看
CreateTime	是	否	String	任务创建时间示例值： 2023-07-28 11:36:00
UpdateTime	是	否	String	任务更新时间示例值： 2023-07-28 11:36:00
Status	是	否	Int64	任务状态，1:运行 2:停止 3:异常-找不到源日志主题 4:异常-找不到目标主题 5: 访问权限问题 6:内部故障 7:其他故障示例值： 2
EnableFlag	是	否	Int64	任务启用状态，1开启, 2关闭示例值： 1
ScheduledSqlContent	是	否	String	查询语句示例值： select count(*)
ProcessStartTime	是	否	String	调度开始时间示例值： 2023-07-28 11:36:00
ProcessType	是	否	Int64	调度类型，1:持续运行 2:指定时间范围示例值： 1
ProcessEndTime	是	否	String	调度结束时间，当process_type=2时为必传字段示例值： 2023-07-28 11:36:00
ProcessPeriod	是	否	Int64	调度周期(分钟) 示例值： 5
ProcessTimeWindow	是	否	String	查询的时间窗口. @m-15m, @m，意为近15分钟示例值： @m-15m, @m
ProcessDelay	是	否	Int64	执行延迟(秒) 示例值： 5
SrcTopicRegion	是	否	String	源topicId的地域信息示例值： region
SyntaxRule	是	否	Uint64	语法规则，0：Lucene语法，1：CQL语法示例值： 0
HasServicesLog	否	否	Uint64	是否开启投递服务日志。1：关闭，2：开启。示例值： 1

PreviewLogStatistic

预览数据详情

被如下接口引用：CreateDataTransform、DescribeDataTransformPreviewDataInfo

名称	必选	允许NULL	类型	描述
DstTopicId	否	否	String	目标日志主题示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
LogContent	是	否	String	日志内容示例值： {"AgentStartTime":"6557160"}
FailReason	否	否	String	失败错误信息，空字符串""表示正常示例值： error
LineNum	是	否	Int64	行号。从0开始示例值： 0
Time	否	否	String	日志时间，格式：2024-05-07 17:13:17.105 入参时无效出参时有效，为日志中的时间格式示例值： 2024-05-07 17:13:17.105
DstTopicName	否	是	String	目标topic-name 示例值： Name
DstLogSetName	否	否	String	目标logsetname 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd

MetricConfig

指标配置信息

被如下接口引用：CreateMetricSubscribe、DescribeMetricSubscribePreview、DescribeMetricSubscribes、ModifyMetricSubscribe

名称	必选	允许NULL	类型	描述
MetricName	是	否	String	指标名称示例值： metric_name
Periods	是	否	Array of Uint64	统计周期,单位:秒（s）示例值： [60,120]
MetricLabels	否	否	Array of MetricLabel	自定义指标标签示例值：查看

ConsumerGroupInfoForMonitor

kafka协议消费消费组监控接口

被如下接口引用：DescribeKafkaConsumerTopics

名称	必选	允许NULL	类型	描述
ConsumerGroupName	是	是	String	消费组名称示例值： cls_consumer_group
PartitionListForMonitor	是	是	Array of PartitionInfoForMonitor	消费组监控信息示例值：查看

RuleTagInfo

标签索引配置信息

被如下接口引用：CreateIndex、DescribeIndex、DescribeIndexs、ModifyIndex

名称	必选	允许NULL	类型	描述
CaseSensitive	是	否	Bool	是否大小写敏感。true表示开启大小写敏感，false表示关闭大小写敏感。示例值： true
KeyValues	是	否	Array of KeyValueInfo	元字段索引配置中的字段信息示例值：查看

PrivateDomainNames

私有域名信息

被如下接口引用：CheckRechargeKafkaServer、CreateKafkaRecharge、DescribeKafkaRecharges、ModifyKafkaRecharge、PreviewKafkaRecharge

名称	必选	允许NULL	类型	描述
DomainName	是	否	String	域名地址示例值： broker.com
IpAddr	是	否	String	ip地址示例值： 10.0.0.1

MetricCollectConfig

指标采集配置

被如下接口引用：DescribeClusterBaseMetricConfigs、DescribeClusterMetricConfigs、DescribeTopicBaseMetricConfigs、DescribeTopicMetricConfigs

名称	必选	允许NULL	类型	描述
ConfigId	否	否	String	采集配置id 示例值： c10ce223-4f2c-4832-a61b-2388a675a230
TopicIds	否	否	Array of String	日志主题id。示例值： ["d7adf66d-88a7-4321-8b4b-6f2c7a9773b8"]
Source	否	否	Uint64	采集配置来源。支持：`0`、`1` - 0:自建k8s - 1:TKE 示例值： 0
GroupIds	否	否	Array of String	机器组id。示例值： ["47532156-1731-4163-84ef-50e96bf7c300"]
Type	否	否	Uint64	监控类型。支持：`0`、`1`，不支持修改 - 0:基础监控 - 1:自定义监控, 示例值： 0
Flag	否	否	Uint64	采集配置方式。支持：`0`、`1`，不支持修改 - 0:普通配置方式，Type字段只能为：`1` - 1:YAML导入方式，Type 可以是：`0`或者`1` 示例值： 0
Name	否	是	String	名称：长度不超过253字符示例值： template-1
Spec	否	是	MetricSpec	采集对象, Flag=0时生效示例值：查看
Relabels	否	是	Array of Relabeling	标签处理, Flag=0时生效示例值：查看
MetricRelabels	否	是	Array of Relabeling	标签处理, Flag=0时生效示例值：查看
MetricLabel	否	是	MetricConfigLabel	自定义元数据, Flag=0时生效示例值：查看
Scheme	否	是	String	通信协议 `http`、`https`；Flag=0时生效示例值： http
ScrapeInterval	否	是	String	采集频率, Flag=0时生效示例值： 60s
ScrapeTimeout	否	是	String	采集超时时间。 Flag=0 && Type=1时生效示例值： 30s
HonorLabels	否	是	Bool	Prometheus如何处理标签之间的冲突。当Flag=0生效，支持`true`,`false` - `false`:配置数据中冲突的标签重命名 - `true`:忽略冲突的服务器端标签示例值： false
EnableCompression	否	是	Bool	压缩, false:关闭, true:开启, Flag=0时生效示例值： false
YamlSpec	否	是	MetricYamlSpec	采集配置yaml格式字符串, Flag=1时必填示例值：查看
Operate	否	否	Uint64	操作状态,0:应用,1:暂停示例值： 0
CreateTime	否	否	Uint64	创建时间戳秒级示例值： 1722945389
UpdateTime	否	否	Uint64	更新时间戳秒级示例值： 1722945399
TopicExtendInfo	否	是	String	日志主题扩展信息示例值： info

MetricLabel

过滤器

被如下接口引用：CreateMetricSubscribe、CreateRecordingRuleTask、CreateScheduledSql、DescribeMetricSubscribePreview、DescribeMetricSubscribes、DescribeRecordingRuleTask、DescribeScheduledSqlInfo、ModifyMetricSubscribe、ModifyRecordingRuleTask、ModifyScheduledSql

名称	必选	允许NULL	类型	描述
Key	否	否	String	指标名称示例值： ErrorMessage
Value	否	否	String	指标内容示例值： Unauthorized

ConfigInfo

采集规则配置信息

被如下接口引用：DescribeConfigs、DescribeMachineGroupConfigs

名称	必选	允许NULL	类型	描述
ConfigId	是	否	String	采集规则配置ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
Name	是	是	String	采集规则配置名称示例值： config_1
LogFormat	是	是	String	日志格式化方式示例值： default
Path	是	是	String	日志采集路径示例值： /var/log/*
LogType	是	是	String	采集的日志类型。 json_log代表：JSON-文件日志（详见使用 JSON 提取模式采集日志）； delimiter_log代表：分隔符-文件日志（详见使用分隔符提取模式采集日志）； minimalist_log代表：单行全文-文件日志（详见使用单行全文提取模式采集日志）； fullregex_log代表：单行完全正则-文件日志（详见使用单行-完全正则提取模式采集日志）； multiline_log代表：多行全文-文件日志（详见使用多行全文提取模式采集日志）； multiline_fullregex_log代表：多行完全正则-文件日志（详见使用多行-完全正则提取模式采集日志）； user_define_log代表：组合解析（适用于多格式嵌套的日志，详见使用组合解析提取模式采集日志）； service_syslog代表：syslog 采集（详见采集 Syslog）； windows_event_log代表：Windows事件日志（详见采集 Windows 事件日志）。示例值： json_log
ExtractRule	是	是	ExtractRuleInfo	提取规则，如果设置了ExtractRule，则必须设置LogType 示例值：查看
ExcludePaths	是	是	Array of ExcludePathInfo	采集黑名单路径列表示例值：查看
Output	是	否	String	采集配置所属日志主题ID即TopicId 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
UpdateTime	是	是	Datetime	更新时间示例值： 2019-01-14 19:19:41
CreateTime	是	否	Datetime	创建时间示例值： 2019-01-14 19:19:41
UserDefineRule	是	是	String	用户自定义解析字符串，详见使用组合解析提取模式采集日志。示例值： {processor:value}
ConfigExtraId	是	是	String	config_extra主键ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
ConfigFlag	是	是	String	采集配置标签示例值： label_k8s
AdvancedConfig	是	是	String	高级采集配置。 Json字符串， Key/Value定义为如下： ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数， 0为不超时 ClsAgentMaxDepth(最大目录深度)，取值范围: 大于等于0的整数 ClsAgentParseFailMerge(合并解析失败日志)，取值范围: true或false 样例： {"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true} 控制台默认占位值：{"ClsAgentDefault":0} 示例值： "{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true}"
Source	是	是	Uint64	采集配置来源，0: 默认来源，1: TKE 示例值： 0
InputType	否	否	String	日志输入类型，支持lfile、window_event、syslog、k8s_stdout、k8s_file 示例值： file
UpdateUnixTime	否	是	String	更新时间戳示例值： 1449455214
CreateUnixTime	否	是	String	创建时间戳示例值： 1449455214

DashboardSubscribeInfo

仪表盘订阅信息

被如下接口引用：DescribeDashboardSubscribes

名称	必选	允许NULL	类型	描述
Id	是	否	Uint64	仪表盘订阅id。示例值： 11
Name	是	否	String	仪表盘订阅名称。示例值：部门日报
DashboardId	是	否	String	仪表盘id。示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
Cron	是	否	String	仪表盘订阅时间。示例值： "0 0 10 L * ?"
SubscribeData	是	否	DashboardSubscribeData	仪表盘订阅数据。示例值：查看
CreateTime	是	否	String	仪表盘订阅记录创建时间。示例值： 2022-03-18 22:47:06
UpdateTime	是	否	String	仪表盘订阅记录更新时间。示例值： 2022-03-18 22:47:06
LastTime	是	否	String	仪表盘订阅记录最后一次发送成功时间。示例值： 2022-03-19 22:47:06
Uin	是	否	Uint64	主账号Id。示例值： 277001
SubUin	是	否	Uint64	主账号下的子账号Id。示例值： 277001
LastStatus	是	否	String	仪表盘订阅记录最后一次发送的状态。success：全部发送成功，fail：未发送， partialSuccess：部分发送成功。示例值： "ok"

TopicInfo

日志主题信息

被如下接口引用：DescribeTopics

名称	必选	允许NULL	类型	描述
LogsetId	是	否	String	日志集ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
TopicId	是	否	String	日志主题ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
TopicName	是	否	String	日志主题名称示例值：业务A
PartitionCount	是	否	Int64	主题分区个数示例值： 1
Index	是	否	Bool	主题是否开启索引（主题类型需为日志主题）。true表示开启索引，false表示关闭索引。示例值： true
AssumerUin	是	否	Uint64	AssumerUin非空则表示创建该日志主题的服务方Uin 示例值： 1736994580
AssumerName	是	否	String	云产品标识，主题由其它云产品创建时，该字段会显示云产品名称，例如CDN、TKE 示例值： CLS_bus
CreateTime	是	否	String	创建时间示例值： 2024-10-10 16:17:03
TopicModifyAcl	是	否	Int64	若AssumerUin非空，则表示除服务方外其余调用者修改日志主题的权限示例值： 1
TopicShowAcl	是	否	Int64	若AssumerUin非空，则表示除服务方外其余调用者展示日志主题的权限示例值： 1
Status	是	否	Bool	主题是否开启采集，true：开启采集；false：关闭采集。创建日志主题时默认开启，可通过SDK调用ModifyTopic修改此字段。控制台目前不支持修改此参数。示例值： true
Tags	是	是	Array of Tag	日志主题绑定的标签信息示例值：查看
RoleName	是	否	String	RoleName非空则表示创建该日志主题的服务方使用的角色示例值： CLB_QcsRole
AutoSplit	是	否	Bool	该主题是否开启自动分裂示例值： true
MaxSplitPartitions	是	否	Int64	若开启自动分裂的话，该主题能够允许的最大分区数示例值： 50
StorageType	是	否	String	主题的存储类型 hot: 标准存储 cold: 低频存储示例值： hot
Period	是	否	Int64	生命周期，单位天，可取值范围1~3600。取值为3640时代表永久保存示例值： 30
SubAssumerName	是	否	String	云产品二级标识，日志主题由其它云产品创建时，该字段会显示云产品名称及其日志类型的二级分类，例如TKE-Audit、TKE-Event。部分云产品仅有云产品标识(AssumerName)，无该字段。示例值： TKE-Audio
LogsetInfo	是	否	LogsetInfo	主题对应的日志集信息示例值：查看
Describes	是	否	String	日志主题描述示例值： demo部门demo业务topic
SubUin	是	否	Uint64	子用户。示例值： 27356
UserSample	是	否	String	用户自定义抽样配置示例值： [{"key":"DEFAULT","rate":10,"rule":""},{"key":"status","rate":20,"rule":"400
UserSampleStatus	是	否	Bool	用户采样率状态。true表示开启用户采样率，false表示关闭用户采样率。示例值： true
WhitelistInfo	是	否	TopicWhitelistInfo	日志主题名名单信息。示例值：查看
HotPeriod	是	否	Uint64	开启日志沉降，标准存储的生命周期， hotPeriod < Period。标准存储为 hotPeriod, 低频存储则为 Period-hotPeriod。（主题类型需为日志主题） HotPeriod=0为没有开启日志沉降。示例值： 0
KeyId	是	否	String	kms-cls服务秘钥id 示例值： ASF-AFAS-JGJISDJG-SDGF
BizType	是	否	Uint64	主题类型。 0: 日志主题 1: 指标主题示例值： 0
IsWebTracking	是	否	Bool	免鉴权开关。 false：关闭； true：开启。开启后将支持指定操作匿名访问该日志主题。详情请参见日志主题。示例值： false
Extends	否	否	TopicExtendInfo	日志主题扩展信息示例值：查看
DedicatedClusterId	否	否	String	专用集群id 示例值： cluster-262n63ex
TopicAsyncTaskID	否	否	String	异步迁移任务ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
MigrationStatus	否	否	Uint64	异步迁移状态示例值： 1
EffectiveDate	否	否	String	异步迁移完成后，预计生效日期示例值： 2024-11-13 14:48:23
NewHotPeriod	否	否	Uint64	异步迁移完成后，新的热存储周期示例值： 7
NewPeriod	否	否	Uint64	异步迁移完成后，新的存储周期示例值： 7
NewStorageType	否	否	String	异步任务迁移完成后，新的存储类型示例值： hot

ConditionTestResult

触发条件测试结果

被如下接口引用：CheckAlarmRule

名称	必选	允许NULL	类型	描述
ErrorCode	是	否	Int64	错误码，可选值：1005代表触发条件表达式语法错误；1006代表触发条件计算错误，请检查参数示例值： 1005
ErrorMessage	是	否	String	错误信息示例值： SyntaxError

DashboardSubscribeData

仪表盘订阅相关数据

被如下接口引用：CreateDashboardSubscribe、DescribeDashboardSubscribes、ModifyDashboardSubscribe、SearchDashboardSubscribe

名称	必选	允许NULL	类型	描述
DashboardTime	否	是	Array of String	仪表盘订阅时间，为空标识取仪表盘默认的时间。示例值： ["now-5m","now"]
StyleLayout	否	否	Uint64	仪表盘样式布局。0：网格布局，1：单列布局。示例值： 0
TemplateVariables	否	是	Array of DashboardTemplateVariable	仪表盘订阅模板变量。示例值：查看
NoticeModes	是	否	Array of DashboardNoticeMode	仪表盘订阅通知方式。示例值：查看
Timezone	否	否	String	时区。参考：https://en.wikipedia.org/wiki/List_of_tz_database_time_zones 示例值： zone
SubscribeLanguage	否	否	String	语言。示例值： zh
JumpDomain	否	否	String	调用链接域名。http:// 或者 https:// 开头，不能/结尾示例值： https://console.cloud.demo.com
JumpUrl	否	否	String	自定义跳转链接。示例值： https://www.demo.com/get4a0d

KafkaInfo

消费kafka相关信息

被如下接口引用：DescribeKafkaConsume、OpenKafkaConsume

名称	必选	允许NULL	类型	描述
TopicName	是	否	String	可消费topic名称示例值： topic_name
UserName	是	否	String	ACL模式用户名示例值： user_name
Password	是	否	String	ACL模式密码示例值： password
InstanceId	是	否	String	可消费kafka实例ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
BootstrapServers	是	否	String	SASL接入点信息示例值： 1.1.1.1

KeyValueInfo

键值或者元字段索引的字段信息

被如下接口引用：CreateIndex、DescribeIndex、DescribeIndexs、ModifyIndex

名称	必选	允许NULL	类型	描述
Key	是	否	String	需要配置键值或者元字段索引的字段名称，仅支持字母、数字、下划线和-./@，且不能以下划线开头注意： 1，元字段（tag）的Key无需额外添加__TAG__.前缀，与上传日志时对应的字段Key一致即可，云控制台展示时将自动添加__TAG__.前缀 2，键值索引（KeyValue）及元字段索引（Tag）中的Key总数不能超过300 3，Key的层级不能超过10层，例如a.b.c.d.e.f.g.h.j.k 4，不允许同时包含json父子级字段，例如a及a.b 示例值： address
Value	是	否	ValueInfo	字段的索引描述信息示例值：查看

RemoteWriteInfo

RemoteWrite配置信息

被如下接口引用：DescribeRemoteWriteTask、DescribeRemoteWriteTasks

名称	必选	允许NULL	类型	描述
TaskId	是	是	String	任务id 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
TopicId	是	是	String	日志主题ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
Name	是	是	String	Remote Write任务名称示例值：测试任务导入
NetType	是	是	Uint64	网络类型 1: 内网 2:外网示例值： 1
VpcId	否	是	String	私有网络id 示例值： vpc-57f5808c
Status	是	是	Int64	任务运行状态 1: 运行中 2:暂停 3: 失败示例值： 1
CreateTime	是	是	String	创建时间示例值： 2021-11-08 14:40:22
UpdateTime	是	是	String	更新时间示例值： 2021-11-08 14:40:22
Target	是	是	String	目标服务名称示例值： service
RemoteWriteURL	是	是	String	目标地址示例值： http://10.0.0.207:9090/api/v1/prom/write
AuthType	否	是	Uint64	鉴权类型 0: 无鉴权 1: basic_auth 2: token 示例值： 1
AuthInfo	否	是	RemoteWriteAuthInfo	鉴权信息示例值：查看
LogsetId	是	是	String	日志集示例值： 57f5808c-4a55-11eb-b378-0242ac130002
Enable	否	是	Uint64	任务状态示例值： 1
SubNet	否	是	String	子网示例值： net
VirtualGatewayType	否	是	Int64	后端服务类型示例值： 1
InstanceId	否	是	String	云时序数据库实例ID 示例值： 1
HasServicesLog	否	是	Uint64	是否开启投递服务日志。1：关闭，2：开启。示例值： 1

HistogramInfo

直方图详细信息

被如下接口引用：DescribeLogHistogram

名称	必选	允许NULL	类型	描述
Count	是	否	Int64	统计周期内的日志条数示例值： 15
BTime	是	否	Int64	按 period 取整后的 unix timestamp：单位毫秒示例值： 2021-04-25 14:25:00.000

LogRechargeRuleInfo

日志导入规则

被如下接口引用：CreateKafkaRecharge、DescribeKafkaRecharges、ModifyKafkaRecharge、PreviewKafkaRecharge

名称	必选	允许NULL	类型	描述
RechargeType	是	否	String	导入类型，支持json_log：json格式日志，minimalist_log: 单行全文，fullregex_log: 单行完全正则示例值： json_log
LogRegex	否	是	String	整条日志匹配规则，只有RechargeType为fullregex_log时有效示例值： (\w+).*
UnMatchLogSwitch	否	否	Bool	解析失败日志是否上传，true表示上传，false表示不上传示例值： true
UnMatchLogKey	否	是	String	解析失败日志的键名称示例值： LogParseFailure
UnMatchLogTimeSrc	否	是	Uint64	解析失败日志时间来源，0: 系统当前时间，1: Kafka消息时间戳示例值： 0
EncodingFormat	是	否	Uint64	解析编码格式，0: UTF-8（默认值），1: GBK 示例值： 0
DefaultTimeSwitch	是	否	Bool	使用默认时间，true：开启（默认值）， flase：关闭示例值： true
DefaultTimeSrc	否	是	Uint64	默认时间来源，0: 系统当前时间，1: Kafka消息时间戳示例值： 0
TimeKey	否	是	String	时间字段示例值： TIMESTAMP
TimeRegex	否	是	String	时间提取正则表达式示例值： (\d{4})-(\d{2})-(\d{2}) (\d{2}):(\d{2}):(\d{2})
TimeFormat	否	是	String	时间字段格式示例值： %Y-%m-%d %H:%M:%S
TimeZone	否	是	String	时间字段时区示例值： UTC+08:00
Metadata	否	是	Array of String	元数据信息，Kafka导入支持kafka_topic,kafka_partition,kafka_offset,kafka_timestamp 示例值： ["kafka_topic","kafka_partition","kafka_offset","kafka_timestamp"]
Keys	否	是	Array of String	日志Key列表，RechargeType为full_regex_log时必填示例值： ["name","address"]
AdvanceFilterRules	否	否	Array of AdvanceFilterRuleInfo	日志过滤规则列表示例值：查看
ParseArray	否	否	Bool	json解析模式，开启首层数据解析示例值： false

WebCallback

回调地址

被如下接口引用：CheckAlarmChannel、CreateAlarmNotice、DescribeAlarmNotices、ModifyAlarmNotice

名称	必选	允许NULL	类型	描述
Url	是	否	String	回调地址，最大支持1024个字节。也可使用WebCallbackId引用集成配置中的URL，此时该字段请填写为空字符串。示例值： https://api.demo.com/cgi-bin/webhook/send?key=4c3cf1e0-a6e7-47f4-b264-5d2kjnbhjgx
Method	否	是	String	回调方法。可选值： POST（默认值） PUT 注意：参数CallbackType为Http时为必选，其它回调方式无需填写。示例值： POST
Headers	否	是	Array of String	该参数已废弃，请使用NoticeContentId。示例值： ["Content-Type: application/json"]
Body	否	是	String	该参数已废弃，请使用NoticeContentId。示例值： htmlBody
CallbackType	是	否	String	回调的类型。可选值：Http WeCom DingTalk Lark 示例值： Http
Index	否	否	Int64	序号。入参无效。出参有效。示例值： 1
StartTime	否	是	String	允许接收信息的开始时间。当做入参时，默认值为00:00:00 示例值： 10:04:05
EndTime	否	是	String	允许接收信息的结束时间。当做入参时，默认值为23:59:59 示例值： 20:04:05
WebCallbackId	否	否	String	集成配置ID。示例值： webcallback
NoticeContentId	否	否	String	通知内容模板ID，使用Default-zh引用默认模板（zh），使用Default-en引用DefaultTemplate(English)。示例值： noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1
RemindType	否	否	Uint64	提醒类型。 0：不提醒；1：指定人；2：所有人示例值： 0
Mobiles	否	否	Array of String	电话列表。示例值： ["15111111111"]
UserIds	否	否	Array of String	用户ID列表。示例值： ["1"]

ScheduledSqlResouceInfo

ScheduledSql的资源信息

被如下接口引用：CreateScheduledSql、DescribeScheduledSqlInfo、ModifyScheduledSql

名称	必选	允许NULL	类型	描述
TopicId	是	否	String	目标主题id 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
LogsetId	否	否	String	日志集id 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
Uin	否	否	Int64	主账号Uin 示例值： 1736994580
Region	否	否	String	主题的地域信息示例值： region
BizType	否	否	Int64	主题类型：0为日志主题，1为指标主题示例值： 0
MetricName	否	否	String	指标名称示例值： cpu_usage
MetricNames	否	否	Array of String	指标名称 BizType为1时，优先使用MetricNames字段多指标只能填充到MetricNames字段，单指标建议填充到MetricName字段示例值： ["cpu_usage","mem_usage"]
MetricLabels	否	否	Array of String	指标维度，不接受时间类型。示例值： ["cluster","ip"]
CustomTime	否	否	String	指标时间戳，默认值为SQL查询时间范围的左侧时间点，您也可以指定其他字段（类型为uinx时间、TimeStamp，精度毫秒）为指标时间戳。示例值： unix_ts,或者TimeStamp 2021-07-15T17:11:56.735+08:00
CustomMetricLabels	否	否	Array of MetricLabel	除了MetricLabels，您还可以使用该参数，为指标补充静态的维度。维度名以字母或下划线开头，后面可以跟字母、数字或下划线，长度小于等于1024 字节示例值：查看

TaskLogStatistic

数据加工任务的统计数据信息

被如下接口引用：DescribeDataTransformProcessInfo

名称	必选	允许NULL	类型	描述
StartTime	是	否	String	开始时间示例值： 2024-11-19 15:26:20
EndTime	是	否	String	结束时间示例值： 2024-11-19 15:26:20
ReadLines	是	是	Int64	读取的源日志主题的行数示例值： 1
WriteLines	是	是	Int64	加工后的行数示例值： 1
FailedLines	是	是	Int64	加工失败的行数示例值： 1
DstTopicLogStatistics	是	是	Array of TopicIdLogStatistic	输出到目标日志主题的总体统计数据示例值：查看
FilterLines	是	是	Uint64	加工过滤的行数示例值： 1

AlarmShieldInfo

告警屏蔽任务配置

被如下接口引用：DescribeAlarmShields

名称	必选	允许NULL	类型	描述
AlarmNoticeId	否	否	String	通知渠道组Id 示例值： notice-ea115e5a-04c4-421e-9ba3-fb177e9025cb
TaskId	否	否	String	屏蔽规则id 示例值： ea115e5a-04c4-421e-9ba3-fb177e9025cb
StartTime	否	否	Uint64	屏蔽开始时间（秒级时间戳）。示例值： 1701933943
EndTime	否	否	Uint64	屏蔽结束时间（秒级时间戳）。示例值： 1701993943
Type	否	否	Uint64	屏蔽类型。1：屏蔽所有通知，2：按照Rule参数屏蔽匹配规则的通知。示例值： 1
Rule	否	否	String	屏蔽规则，当Type为2时必填。规则填写方式详见产品文档。示例值： {"Value":"AND","Type":"Operation","Children":[{"Type":"Condition","Value":"Level","Children":[{"Value":"In","Type":"Compare"},{"Value":"[1]","Type":"Value"}]}]}
Reason	否	否	String	屏蔽原因。示例值：发布，暂时屏蔽
Source	否	否	Uint64	规则创建来源。 1. 控制台，2.api，3.告警通知示例值： 1
Operator	否	否	String	操作者。示例值： 100001（user）
Status	否	否	Uint64	规则状态。 0：暂未生效，1：生效中，2：已失效示例值： 0
CreateTime	否	否	Uint64	规则创建时间。示例值： 1701933943
UpdateTime	否	否	Uint64	规则更新时间。示例值： 1701933943

TopicPartitionOffsetInfo

被如下接口引用：CommitConsumerOffsets、DescribeConsumerOffsets

名称	必选	允许NULL	类型	描述
TopicID	是	是	String	日志主题id 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
PartitionOffsets	否	是	Array of PartitionOffsetInfo	分区点位信息示例值：查看

AlarmNotice

告警通知模板类型

被如下接口引用：DescribeAlarmNotices

名称	必选	允许NULL	类型	描述
Name	是	否	String	告警通知模板名称。示例值： alarm
Type	是	否	String	告警模板的类型。可选值： Trigger - 告警触发 Recovery - 告警恢复 All - 告警触发和告警恢复示例值： All
NoticeReceivers	是	否	Array of NoticeReceiver	告警通知模板接收者信息。示例值：查看
WebCallbacks	是	否	Array of WebCallback	告警通知模板回调信息。示例值：查看
AlarmNoticeId	是	否	String	告警通知模板ID。示例值： notice-dd1e5d83-fee5-cd35-ac57-20823c21b8cd
CreateTime	是	否	String	创建时间。示例值： 2022-11-07 16:30:53
UpdateTime	是	否	String	最近更新时间。示例值： 2022-11-07 16:30:53
Tags	是	否	Array of Tag	告警通知模板绑定的标签信息。示例值：查看
JumpDomain	否	否	String	调用链接域名。http:// 或者 https:// 开头，不能/结尾示例值： https://console.cloud.demo.com
NoticeRules	否	否	Array of NoticeRule	通知规则。示例值：查看
AlarmShieldStatus	否	否	Uint64	免登录操作告警开关。参数值： 1：关闭 2：开启（默认开启）示例值： 2
AlarmNoticeDeliverConfig	否	是	AlarmNoticeDeliverConfig	投递相关信息。示例值：查看
DeliverStatus	否	否	Uint64	投递日志开关。参数值： 1：关闭 2：开启示例值： 2
DeliverFlag	否	否	Uint64	投递日志标识。参数值： 1：未启用 2：已启用 3：投递异常示例值： 3
AlarmShieldCount	否	是	AlarmShieldCount	通知渠道组配置的告警屏蔽统计状态数量信息。示例值：查看

AlertHistoryRecord

告警历史的记录的结构

被如下接口引用：DescribeAlertRecordHistory

名称	必选	允许NULL	类型	描述
RecordId	是	否	String	告警历史ID 示例值： 7cfbe19f-99af-42ca-8f9f-b59d1f9c6157
AlarmId	是	否	String	告警策略ID 示例值： alarm-8211a509-fee5-43dd-9ec0-6a6e7bc92552
AlarmName	是	否	String	告警策略名称示例值：日志错误数超限
TopicId	是	否	String	监控对象ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
TopicName	是	否	String	监控对象名称示例值： Nginx请求日志
Region	是	否	String	监控对象所属地域示例值： region
Trigger	是	否	String	触发条件示例值： $1.d > 300
TriggerCount	是	否	Int64	持续周期，持续满足触发条件TriggerCount个周期后，再进行告警示例值： 1
AlarmPeriod	是	否	Int64	告警通知发送频率，单位为分钟示例值： 15
Notices	是	否	Array of AlertHistoryNotice	通知渠道组示例值：查看
Duration	是	否	Int64	告警持续时间，单位为分钟示例值： 60
Status	是	否	Int64	告警状态，0代表未恢复，1代表已恢复，2代表已失效示例值： 1
CreateTime	是	否	Uint64	告警发生时间，毫秒级Unix时间戳示例值： 1619359718000
GroupTriggerCondition	否	否	Array of GroupTriggerConditionInfo	告警分组触发时对应的分组信息示例值：查看
AlarmLevel	否	否	Uint64	告警级别，0代表警告(Warn)，1代表提醒(Info)，2代表紧急 (Critical) 示例值： 0
MonitorObjectType	否	否	Uint64	监控对象类型。 0:执行语句共用监控对象; 1:每个执行语句单独选择监控对象。示例值： 0
ClaimOperator	否	否	String	告警处理人示例值： zhangsan

HostFileInfo

自建k8s-节点文件配置信息

被如下接口引用：CreateConfigExtra、DescribeConfigExtras、ModifyConfigExtra

名称	必选	允许NULL	类型	描述
LogPath	是	否	String	日志文件夹示例值： /var/log
FilePattern	是	否	String	日志文件名示例值： file.log
CustomLabels	否	是	Array of String	metadata信息示例值： ["key1=value1","key2=value2"]
FilePaths	否	否	Array of FilePathInfo	日志文件路径信息示例值：查看

AlarmInfo

告警策略描述

被如下接口引用：DescribeAlarms

名称	必选	允许NULL	类型	描述
Name	是	否	String	告警策略名称。示例值： p0-业务告警
AlarmTargets	是	否	Array of AlarmTargetInfo	监控对象列表。示例值：查看
MonitorTime	是	否	MonitorTime	监控任务运行时间点。示例值：查看
Condition	是	否	String	触发条件。示例值： $1.cnt>0
TriggerCount	是	否	Int64	持续周期。持续满足触发条件TriggerCount个周期后，再进行告警；最小值为1，最大值为10。示例值： 1
AlarmPeriod	是	否	Int64	告警重复的周期。单位是min。取值范围是0~1440。示例值： 20
AlarmNoticeIds	是	否	Array of String	关联的告警通知模板列表。示例值： ["notice-a808dcfa-6e31-4ef7-bbc3-cbf5396a3ede"]
Status	是	否	Bool	开启状态。true表示开启，false表示关闭。示例值： true
AlarmId	是	否	String	告警策略ID。示例值： alarm-b8a247be-d866-4e00-a875-897435f37d18
CreateTime	是	否	String	创建时间。示例值： 2024-11-06 19:53:37
UpdateTime	是	否	String	最近更新时间。示例值： 2024-11-06 19-53-37
Enable	是	否	Bool	开启状态。true表示开启，false表示关闭。示例值： true
MessageTemplate	是	是	String	自定义通知模板示例值： message tpl TopicName raw result: RawResults
CallBack	是	是	CallBackInfo	自定义回调模板示例值：查看
Analysis	是	是	Array of AnalysisDimensional	多维分析设置示例值：查看
GroupTriggerStatus	是	是	Bool	分组触发状态。1：开启，0：关闭（默认）示例值： 1
GroupTriggerCondition	是	是	Array of String	分组触发条件。示例值： ["$1.conut"]
Tags	是	是	Array of Tag	告警策略绑定的标签信息。示例值：查看
MonitorObjectType	是	是	Uint64	监控对象类型。0:执行语句共用监控对象;1:每个执行语句单独选择监控对象。示例值： 0
AlarmLevel	是	是	Uint64	告警级别。0:警告(Warn);1:提醒(Info);2:紧急 (Critical)。示例值： 0
Classifications	是	是	Array of AlarmClassification	告警附加分类信息列表。示例值：查看
ConditionInteractiveConfig	否	否	String	触发条件交互模式配置信息。示例值： {"Value":{"type":"CONDITION","level":0,"executeQueryIndex":0,"field":"QUERYCOUNT","comparator":">","value":0},"Children":[]}
MultiConditions	否	否	Array of MultiCondition	多触发条件。与 Condition互斥。示例值：查看
AlarmTemplateInfo	否	否	AlarmTemplateConfig	告警模板相关信息示例值：查看

LogInfo

日志结果信息

被如下接口引用：GetAlarmLog、GetConfigurationTemplateApplyLog、SearchLog

名称	必选	允许NULL	类型	描述
Time	是	否	Int64	日志时间，单位ms 示例值： 1619162953000
TopicId	是	否	String	日志主题ID 示例值： 4463e7b0-3ec8-41a1-ae48-5d24b22167c2
TopicName	是	否	String	日志主题名称示例值：业务A日志主题
Source	是	否	String	日志来源IP 示例值： 10.0.0.1
FileName	是	否	String	日志文件名称示例值： /var/access.log
PkgId	是	否	String	日志上报请求包的ID 示例值： 0
PkgLogId	是	否	String	请求包内日志的ID 示例值： 0
Logs	是	是	Array of LogItem	日志内容，由多个LogItem (KV结构）组成示例值：查看
HighLights	是	否	Array of HighLightItem	日志内容的高亮描述信息示例值：查看
LogJson	是	否	String	日志内容的Json序列化字符串示例值： {\"content\":\"log\"}
HostName	是	否	String	日志来源主机名称示例值： hostName-1
RawLog	是	否	String	原始日志(仅在日志创建索引异常时有值) 示例值： {\"content\":\"log\"}
IndexStatus	是	否	String	日志创建索引异常原因(仅在日志创建索引异常时有值) 示例值： IndexAllFail:fields like 'a' and 'a.b' can not appear in the same topic

ShipperTaskInfo

投递任务信息

被如下接口引用：DescribeShipperTasks

名称	必选	允许NULL	类型	描述
TaskId	是	否	String	投递任务ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
ShipperId	是	否	String	投递信息ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
TopicId	是	否	String	日志主题ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
RangeStart	是	否	Int64	本批投递的日志的开始时间戳，毫秒示例值： 978653222
RangeEnd	是	否	Int64	本批投递的日志的结束时间戳，毫秒示例值： 978653222
StartTime	是	否	Int64	本次投递任务的开始时间戳，毫秒示例值： 978653222
EndTime	是	否	Int64	本次投递任务的结束时间戳，毫秒示例值： 978653222
Status	是	否	String	本次投递的结果，"success","running","failed" 示例值： success
Message	是	否	String	结果的详细信息示例值： success

ClbTopicExtendConfig

clb定制化的业务配置

被如下接口引用：CreateTopicExtendConfig、DescribeTopicExtendConfig、ModifyTopicExtendConfig

名称	必选	允许NULL	类型	描述
Vip	否	是	String	LB关键信息，VIP 示例值： 127.0.0.1
VpcId	否	是	Int64	LB关键信息，VpcId 示例值： 23232323
TopicId	否	是	String	clb服务端的公共topic 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
UserTopicId	否	是	String	clb用户的topic 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
UserUin	否	是	Uint64	clb用户的uin信息示例值： 13232323
UserAppId	否	是	Uint64	clb用户的appid信息示例值： 2323232
UserTmpSecretId	否	是	String	临时证书加密密钥ID。最长不超过1024字节。示例值： secretId
UserTmpSecretKey	否	是	String	临时证书加密密钥Key。最长不超过1024字节。示例值： secretKey
UserToken	否	是	String	token, 最长不超过4096字节。示例值： userToken
TmpKeyExpired	否	是	Uint64	临时证书有效的时间，返回 Unix 时间戳，精确到秒示例值： 1547696355
LbKey	否	是	String	唯一标识clb的一种业务示例值： clb_topic
LogSample	否	是	String	公共topic的采样比示例值： [{"key":"key1","rule":"!=200","rate":10},{"key":"DEFAULT","r
UserSample	否	是	String	用户topic的采样比示例值： [{"key":"key1","rule":"!=200","rate":10},{"key":"DEFAULT","r
UserHealthTopicId	否	是	String	LB健康检查日志 Topic ID, 和topicId属于另外一种公共的topic 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
UserSampleStatus	否	是	Bool	topic的采集配置是否生效,true为生效,false为失效示例值： false
UserTopicStatus	否	是	Uint64	1代表用户topic已删除，0代表用户topic未删除。示例值： 0
Collection	否	是	Bool	lbkey是否要采集到公共topic, true为要采集， false为不采集，默认为false 示例值： false
LbID	否	是	String	LB相关业务ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
ShowServerAddr	否	是	Bool	是否展示ServerAddr字段，true 展示，false 不展示示例值： false

FilePathInfo

文件路径信息

被如下接口引用：CreateConfigExtra、DescribeConfigExtras、ModifyConfigExtra

名称	必选	允许NULL	类型	描述
Path	否	否	String	文件路径示例值： /log
File	否	否	String	文件名称示例值： message.log

MetricCorrectDimension

校准后的metric信息

被如下接口引用：DescribeMetricCorrectDimension

名称	必选	允许NULL	类型	描述
MetricName	否	是	String	指标名称。示例值： DiskTotal
Dimensions	否	是	Array of String	指标维度。示例值： ["InstanceId", "diskname"]

Instance

实例信息

被如下接口引用：CreateMetricSubscribe、DescribeMetricSubscribePreview、DescribeMetricSubscribes、ModifyMetricSubscribe

名称	必选	允许NULL	类型	描述
Values	是	否	Array of String	实例信息示例值： ["key1-value","key2-value"]

ConsumerInfo

投递规则

被如下接口引用：DescribeConsumers

名称	必选	允许NULL	类型	描述
ConsumerId	是	否	String	投递规则ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
TopicId	是	否	String	日志主题ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
Effective	是	否	Bool	投递任务是否生效示例值： true
Ckafka	是	否	Ckafka	CKafka的描述示例值：查看
NeedContent	是	否	Bool	是否投递日志的元数据信息示例值： true
Content	是	是	ConsumerContent	如果需要投递元数据信息，元数据信息的描述示例值：查看
Compression	是	是	Int64	压缩方式[0:NONE；2:SNAPPY；3:LZ4] 示例值： 0
CreateTime	是	是	Uint64	投递任务创建毫秒时间戳示例值： 1662034960732
RoleArn	否	是	String	角色访问描述名示例值： qcs::cam::uin/${uin}:roleName/role
ExternalId	否	是	String	外部ID 示例值： external_id_demo
TaskStatus	否	是	Uint64	任务运行状态。支持`0`,`1`,`2` - `0`: 停止 - `1`: 运行中 - `2`: 异常示例值： 1
AdvancedConfig	否	否	AdvancedConsumerConfiguration	高级配置示例值：查看

PartitionInfoForMonitor

kafka协议消费partition监控信息

被如下接口引用：DescribeKafkaConsumerTopics

名称	必选	允许NULL	类型	描述
PartitionId	否	是	Int64	分区id 示例值： 1

Ckafka

CKafka的描述-需要投递到的kafka信息

被如下接口引用：CreateConsumer、DescribeConsumer、DescribeConsumers、ModifyConsumer

名称	必选	允许NULL	类型	描述
Vip	是	是	String	Ckafka 的 Vip 示例值： 10.10.2.42
Vport	是	是	String	Ckafka 的 Vport 示例值： 9092
InstanceId	是	是	String	Ckafka 的 InstanceId 示例值： ckafka-8j4robetb
InstanceName	是	是	String	Ckafka 的 InstanceName 示例值： kafka_name
TopicId	是	是	String	Ckafka 的 TopicId 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
TopicName	是	是	String	Ckafka 的 TopicName 示例值： mrxy-business

ExternalDataSourceSQLInfo

外部表SQL信息

被如下接口引用：CreateExternalDataSource、DescribeExternalDataSourcePreview、DescribeExternalDataSources、ModifyExternalDataSource

名称	必选	允许NULL	类型	描述
AccessMode	否	否	Uint64	访问方式。 1：私有链接(内网访问)；2：外网访问；当DataSource为1时，AccessMode必填示例值： 2
Address	否	是	String	SQL访问IP地址。当DataSource为1且AccessMode为2时，Address必填。示例值： 10.2.3.4
Port	是	否	String	SQL访问端口。当DataSource为1时，Port必填示例值： 3306
EndPointServiceId	否	是	String	私有链接终端节点服务ID。当DataSource为1时，当AccessMode 为1时， EndPointServiceId字段必填。示例值： vpcsvc-f8fth
User	是	否	String	SQL访问用户名示例值： user_00
Password	否	是	String	SQL访问密码示例值： password
DatabaseName	是	否	String	SQL访问数据库名示例值： databases
TableName	是	否	String	SQL访问表名示例值： table
Region	否	是	String	InstanceId所属地域。当DataSource为1且AccessMode为3时，Region必填。当DataSource为3、4时，Region必填。示例值： region
VpcId	否	是	String	所属网络VpcId。当DataSource为1且AccessMode为3时，VpcId必填示例值： vpc-zxcvbnm
VirtualGatewayType	否	是	Uint64	网络服务类型。0：CVM；1025：CLB 当DataSource为1且AccessMode为3时，VirtualGatewayType必填示例值： 0
InstanceId	否	是	String	实例Id。当DataSource为3、4时，InstanceId必填。当DataSource为3时，表示云数据库Mysql 实例id，如：cdb-zxcvbnm 当DataSource为4时，表示云数据库TDSQL-C Mysql 集群id，如：cynosdbmysql-i6bdemo 示例值： cdb-zxcvbnm

SearchLogErrors

多日志主题检索错误信息

被如下接口引用：DescribeLogHistogram、SearchLog

名称	必选	允许NULL	类型	描述
TopicId	是	否	String	日志主题ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
ErrorCode	是	否	Int64	错误码。（已废弃）示例值： -45000
ErrorMsg	是	否	String	错误信息示例值： SyntaxError [field: key, can not search on this field, since it is not indexed]
ErrorCodeStr	是	否	String	错误码示例值： FailedOperation.QueryError

GroupTriggerConditionInfo

分组触发条件

被如下接口引用：DescribeAlertRecordHistory

名称	必选	允许NULL	类型	描述
Key	是	否	String	分组触发字段名称示例值： $1.count
Value	是	否	String	分组触发字段值示例值： 100

InstanceConfig

实例配置信息

被如下接口引用：CreateMetricSubscribe、DescribeMetricSubscribePreview、DescribeMetricSubscribes、ModifyMetricSubscribe

名称	必选	允许NULL	类型	描述
InstanceDimension	是	否	Array of String	实例维度示例值： ["bucket","appid"]
Instances	是	否	Array of Instance	实例值示例值：查看

DashboardInfo

仪表盘信息

被如下接口引用：DescribeDashboards

名称	必选	允许NULL	类型	描述
DashboardId	是	否	String	仪表盘id 示例值： dashboard-57f5808c-4a55-11eb-b378-0242ac130002
DashboardName	是	否	String	仪表盘名字示例值： dashboard_name
Data	是	否	String	仪表盘数据示例值： {"panels":[],"time":["now-h","now"]}
CreateTime	是	否	String	创建仪表盘的时间示例值： 2019-01-14 19:19:41
AssumerUin	是	否	Uint64	AssumerUin非空则表示创建该日志主题的服务方Uin 示例值： 1736994580
RoleName	是	否	String	RoleName非空则表示创建该日志主题的服务方使用的角色示例值： CLB_QcsRole
AssumerName	是	否	String	AssumerName非空则表示创建该日志主题的服务方名称示例值： CLS_business
Tags	是	否	Array of Tag	日志主题绑定的标签信息示例值：查看
DashboardRegion	是	否	String	仪表盘所在地域：为了兼容老的地域。示例值： region
UpdateTime	是	否	String	修改仪表盘的时间示例值： 2021-12-22 16:11:27
DashboardTopicInfos	是	否	Array of DashboardTopicInfo	仪表盘对应的topic相关信息示例值：查看
FolderName	是	否	String	文件夹名称示例值：客户端仪表盘
FolderId	是	否	String	文件夹id 示例值： 10001

RecordingRuleTaskInfo

预聚合任务详情

被如下接口引用：DescribeRecordingRuleTask

名称	必选	允许NULL	类型	描述
TaskId	是	否	String	预聚合任务id 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
TopicId	是	否	String	源日志主题id 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
Name	是	否	String	预聚合任务名称示例值： task
CreateTime	是	否	String	任务创建时间示例值： 2023-07-28 11:36:00
UpdateTime	是	否	String	任务更新时间示例值： 2023-07-28 11:36:00
Status	是	否	Int64	任务状态，1:运行 2:停止 3:异常-找不到源日志主题 4:异常-找不到目标主题 5: 访问权限问题 6:内部故障 7:其他故障示例值： 2
EnableFlag	是	否	Int64	任务启用状态，1开启, 2关闭示例值： 1
ProcessStartTime	是	否	Uint64	调度开始时间示例值： 20304858483
ProcessPeriod	是	否	Int64	调度周期(分钟) 示例值： 5
ProcessPeriodUnit	否	是	Uint64	执行周期单位, `0`: Minute, `1`: Second。 - ProcessPeriodUnit:1时，ProcessPeriod 只支持 30（即只支持30秒）。 - ProcessPeriodUnit:0时，ProcessPeriod 支持范围(0,1440]分钟。示例值： 0
ProcessDelay	是	否	Int64	执行延迟(秒) 示例值： 5
HasServicesLog	是	否	Uint64	是否开启投递服务日志。1：关闭，2：开启。示例值： 1
RecordingRuleContent	是	否	String	预聚合检索语句示例值： sql
MetricName	是	否	String	指标名称示例值： name
CustomMetricLabels	否	否	Array of MetricLabel	自定义指标名称示例值：查看
YamlId	否	否	String	yaml配置文件id 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
YamlConfigName	否	否	String	yaml配置文件名称示例值： name
DstTopicId	是	否	String	目标日志主题id 示例值： 57f5808c-4a55-11eb-b378-0242ac130002

JsonInfo

JSON类型描述

被如下接口引用：CreateConfigurationTemplate、CreateShipper、DescribeConfigurationTemplates、DescribeShipperPreview、DescribeShippers、ModifyConfigurationTemplate、ModifyShipper

名称	必选	允许NULL	类型	描述
EnableTag	是	否	Bool	启用标志。true表示启用TAG标志，false表示关闭TAG标志。示例值： true
MetaFields	是	是	Array of String	元数据信息列表, 可选值为 SOURCE、FILENAME、TIMESTAMP、HOSTNAME。示例值： [SOURCE、FILENAME、TIMESTAMP、HOSTNAME]
JsonType	否	否	Int64	投递Json格式，0：字符串方式投递；1:以结构化方式投递示例值： 1

BinlogConfigInfo

binlog配置信息

被如下接口引用：DescribeBinlogSubscribes

名称	必选	允许NULL	类型	描述
TaskId	否	是	String	配置id。示例值： 115094er-11b0-4aeb-91f5-ee9f46a4a13c
Name	否	是	String	名称：长度不超过64字符，以字母开头，接受0-9,a-z,A-Z, _,-,zh字符。示例值： template_1
TopicId	否	是	String	日志主题id。示例值： 57f5808c-4a55-11eb-b378-0242ac130002
Type	否	是	Uint64	数据库类型。 1:云mysql 2:TDSQL-C 3:自建mysql 示例值： 1
SqlInfo	否	是	BinlogDBConfig	数据库配置信息。示例值：查看
InitialPoint	否	是	BinlogInitialPoint	binlog采集起始点配置信息。示例值：查看
Events	否	是	Array of String	binlog采集事件配置。示例值： [DDL,Insert,Update,Delete]
Metadatas	否	是	Array of String	binlog采集元数据配置。示例值： [position,gtid]
TimestampType	否	是	Uint64	时间戳来源。 1:采集时间 2:事件时间示例值： 1
BlockListStatus	否	是	Uint64	黑名单状态。 1:关闭 2:开启示例值： 1
BlockList	否	是	Array of BinlogFilterList	黑名单配置。示例值：查看
AllowListStatus	否	是	Uint64	白名单状态。 1:关闭 2:开启示例值： 1
AllowList	否	是	Array of BinlogFilterList	白名单配置。示例值：查看
Flatten	否	是	Bool	平铺事件数据标记。默认Flatten为false。 Flatten为false时：会将事件数据以数组+JSON格式集中打包到old_data和data两个字段中。如: 在数据库操作中执行了两次操作，一次更新了a和b字段，一次d和e，日志值为old_data:[{a:a1,b:b1}, {d:d1,e:e1}], data:[{a:a2,b:b2}, {d:d2,e:e2}]。 Flatten为true时：会将不同的事件拆分为多条日志，并在每条日志中对被操作的字段进行平铺。如：在数据库操作中执行了两次操作，一次更新了a和b字段，一次d和e，则会生成两条日志，分别的值为 a:a2, old_a:a1, b:b2, old_b:b1和d:d2, old_d:d1, e:e2, old_e:e1。示例值： false
Status	否	是	Uint64	配置状态。 1: 未启用 2: 启用示例值： 2
StatusFlag	否	是	Uint64	配置状态标记。 1: 未启用 2: 启用 3: 异常示例值： 3
ErrMsg	否	是	String	错误信息。示例值： "connect faild"
CreateTime	否	是	Uint64	创建时间。秒级时间戳示例值： 1699087250
UpdateTime	否	是	Uint64	更新时间。秒级时间戳示例值： 1699087250

RuleKeyValueInfo

键值索引配置

被如下接口引用：CreateIndex、DescribeIndex、DescribeIndexs、ModifyIndex

名称	必选	允许NULL	类型	描述
CaseSensitive	是	否	Bool	是否大小写敏感。true表示大小写敏感，false表示大小写不敏感。示例值： false
KeyValues	否	否	Array of KeyValueInfo	需要建立索引的键值对信息；最大只能配置100个键值对示例值：查看
TemplateType	否	否	String	索引是否开启动态模板；若开启，则会根据上报的键值对配置索引，但是所有字段类型都是text，大小写敏感，不支持分析，采用默认分词符。已废弃示例值： dynamic

ShipperTemplateInfo

投递cos模板配置信息

被如下接口引用：CreateConfigurationTemplate、DescribeConfigurationTemplates、ModifyConfigurationTemplate

名称	必选	允许NULL	类型	描述
ShipperName	是	否	String	投递规则的名字，允许字符0-9、a-z、A-Z、 _、-、zh字符。必须以${TopicName}-${TaskCreateTime} 为前缀；${TopicName} 字符最多200个，如果超出截断topicname，-${TaskCreateTime}14个，用户可添加41个自定义字符，总长度255。受限于CLS产品规格255。示例值： ShipperName
Prefix	是	否	String	创建的投递规则投递目录的前缀,允许字符 a-z、A-Z、0-9、_、-、/，并且以非/开头。${TopicName} 字符最多200个，如果超出截断topicname，${TaskCreateTime}14个，年月日时分秒25个，如果用户使用了默认参数，那么用户可添加17个自定义字符，总长度255。受限于COS产品规格255，COS允许zh路径。示例值： var/log
Partition	否	是	String	投递日志的分区规则，支持strftime的时间格式表示示例值： %Y%m%d
Compress	否	是	CompressInfo	投递日志的压缩配置示例值：查看
MaxSize	否	是	Uint64	投递的文件的最大值，单位 MB，默认256，范围 5-256 示例值： 256
Interval	否	是	Uint64	投递的时间间隔，单位秒，默认300，范围 300-900 示例值： 60
Content	否	是	ConfigurationContentInfo	投递日志的内容格式配置。投递格式：仅支持JSON。示例值：查看
FilterRules	否	是	Array of FilterRuleInfo	投递日志的过滤规则，匹配的日志进行投递，各rule之间是and关系，最多5个，数组为空则表示不过滤而全部投递示例值：查看
StartTime	否	是	Uint64	投递数据范围的开始时间点，不能超出日志主题的生命周期起点。如果用户不填写，默认为用户新建投递任务的时间。示例值： 1732106219
EndTime	否	是	Uint64	投递数据范围的结束时间点，不能填写未来时间。如果用户不填写，默认为持续投递，即无限。示例值： 1732106219

NoticeContentInfo

通知模板内容

被如下接口引用：CreateNoticeContent、DescribeNoticeContents、ModifyNoticeContent

名称	必选	允许NULL	类型	描述
Title	否	否	String	通知内容模板标题信息。部分通知渠道类型不支持“标题”，请参照控制台页面。示例值：这是标题。
Content	否	否	String	通知内容模板正文信息。示例值：这是正文。
Headers	否	否	Array of String	请求头（Request Headers）：在HTTP请求中，请求头包含了客户端向服务器发送的附加信息，如用户代理、授权凭证、期望的响应格式等。仅“自定义回调”支持该配置。示例值： ["Content-Type:application/json"]

SearchLogTopics

多主题检索返回信息

被如下接口引用：DescribeLogHistogram、SearchLog

名称	必选	允许NULL	类型	描述
Errors	是	否	Array of SearchLogErrors	多日志主题检索对应的错误信息示例值：查看
Infos	是	否	Array of SearchLogInfos	多日志主题检索各日志主题信息示例值：查看

ScheduledSqlTaskProcessInfo

ScheduledSql任务执行详情

被如下接口引用：DescribeScheduledSqlProcessInfo

名称	必选	允许NULL	类型	描述
TaskId	是	否	String	任务ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
ProcessId	是	否	String	实例ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
ScheduledSqlContent	是	否	String	加工语句示例值： *
ProcessStartTime	是	否	String	执行时间-开始时间示例值： 2024-03-13 12:00:00
ProcessEndTime	是	否	String	执行时间-结束时间示例值： 2024-03-13 12:01:00
ProcessDuration	是	否	Int64	执行时间-耗时示例值： 247
TimeWindowStartTime	是	否	String	SQL时间窗口-开始时间示例值： 2024-03-13 11:59:00
TimeWindowEndTime	是	否	String	SQL时间窗口-结束时间示例值： 2024-03-13 12:00:00
ReadLogCount	是	否	Uint64	处理数据量-输入行数示例值： 1212
WriteLogCount	是	否	Uint64	处理数据量-输出行数示例值： 12
Status	是	否	Int64	调度结果，1:运行中 2:成功 3:失败示例值： 2
SrcTopicId	是	否	String	源topicid 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
StatusFailedMsg	是	否	String	失败原因字段示例值： fail_reason
Region	否	是	String	目标日志主题所在地域信息。示例值： region
DstTopicId	否	是	String	目标日志主题id。示例值： 57f5808c-4a55-11eb-b378-0242ac130002

ConfigException

采集配置异常

被如下接口引用：DescribeExceptionResources

名称	必选	允许NULL	类型	描述
ConfigId	是	否	String	采集配置Id 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
Status	是	否	Int64	状态： 1：非结构化提取模式示例值： 1
ConfigName	是	否	String	采集配置名称示例值：名称

ConfigurationContentInfo

配置模板投递日志的内容格式配置

被如下接口引用：CreateConfigurationTemplate、DescribeConfigurationTemplates、ModifyConfigurationTemplate

名称	必选	允许NULL	类型	描述
Format	是	否	String	内容格式，只支持json 示例值： json
Json	否	是	JsonInfo	json格式内容描述示例值：查看

FolderInfo

仪表盘文件夹信息

被如下接口引用：DescribeFolders

名称	必选	允许NULL	类型	描述
Id	是	否	String	文件夹Id。示例值： dc01b74a-49e4-11eb-b378-0242ac13000
Name	是	否	String	文件夹名称。示例值：系统监控文件夹

FunctionInfo

数据加工函数基本信息

被如下接口引用：DescribeFunctions

名称	必选	允许NULL	类型	描述
FuncName	是	否	String	函数名称示例值： fields_set
FuncNameDesc	是	否	String	函数描述示例值：函数功能及使用说明
FuncUseDesc	是	否	String	用来说明函数功能示例值：函数语法描述
FuncSyntaxDesc	是	否	String	语法描述示例值：函数使用示例
FuncDemo	是	否	String	demo展示示例值：例1使用逗号作为分隔符，提取日志中的值。
FuncType	是	否	String	函数类型示例值： line_function
IsVariadic	是	否	Bool	true是可变长度参数的加工函数示例值： true
MaxArgumentSize	是	否	Int64	可变参的参数个数最大限制示例值： 10
ReturnType	是	否	String	函数返回结果类型，用来校验嵌套函数中，返回结果是否和函数参数类型匹配。不同的func_type返回的对象类型不同 string/int/bool/condition/func 示例值： string
Arguments	是	否	Array of FunctionArgument	函数参数描述示例值：查看

LogItems

LogItem的数组

被如下接口引用：GetAlarmLog、GetConfigurationTemplateApplyLog、SearchLog

名称	必选	允许NULL	类型	描述
Data	是	否	Array of LogItem	分析结果返回的KV数据对示例值：查看

CollectInfo

采集配置信息

被如下接口引用：CreateConfigExtra、DescribeConfigExtras、ModifyConfigExtra

名称	必选	允许NULL	类型	描述
CollectConfigs	否	否	Array of CollectConfig	指定采集类型的采集配置信息。当Type为0时，CollectConfigs不允许为空。当Type为1时，CollectConfigs为空时，表示选择所有Pod Label；否则CollectConfigs为指定Pod Label。示例值：查看
Type	是	否	Uint64	采集类型，必填字段。 0：元数据配置。 1：指定Pod Label。示例值： 0

AlarmShieldCount

告警屏蔽统计信息

被如下接口引用：DescribeAlarmNotices

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Uint64	符合检索条件的告警屏蔽总数量示例值： 5
InvalidCount	是	否	Uint64	告警屏蔽未生效数量示例值： 1
ValidCount	是	否	Uint64	告警屏蔽生效中数量示例值： 2
ExpireCount	是	否	Uint64	告警屏蔽已过期数量示例值： 2

SendDetail

渠道检测发送详情

被如下接口引用：CheckAlarmChannel

名称	必选	允许NULL	类型	描述
Sms	是	是	Array of SendDetailItem	发送次数示例值：查看
Email	是	是	Array of SendDetailItem	发送次数示例值：查看
WeChat	是	是	Array of SendDetailItem	发送次数示例值：查看
Phone	是	是	Array of SendDetailItem	发送次数示例值：查看
Callback	是	是	Array of SendDetailItem	发送次数示例值：查看

JsonLogInfo

json格式日志内容

被如下接口引用：DescribeLatestJsonLog、DescribeLatestUserLog

名称	必选	允许NULL	类型	描述
Log	是	是	Array of KeyLogInfo	K-V形式日志信息示例值：查看
Tag	是	是	Array of KeyLogInfo	K-V形式标签信息示例值：查看
Time	是	否	Uint64	时间戳示例值： 1732175558

AlarmNoticeDeliverConfig

通知渠道投递日志配置信息

被如下接口引用：DescribeAlarmNotices

名称	必选	允许NULL	类型	描述
DeliverConfig	是	否	DeliverConfig	通知渠道投递日志配置信息。示例值：查看
ErrMsg	否	否	String	投递失败原因。示例值：投递失败，topicId不存在

ExcludePathInfo

黑名单path信息

被如下接口引用：CreateConfig、CreateConfigExtra、DescribeAgentConfigs、DescribeConfigExtras、DescribeConfigs、DescribeMachineGroupConfigs、ModifyConfig、ModifyConfigExtra

名称	必选	允许NULL	类型	描述
Type	是	否	String	类型，选填File或Path 示例值： File
Value	是	否	String	Type对应的具体内容示例值： /data/file.log

MonitorTime

告警策略中监控任务的执行时间点

被如下接口引用：CheckAlarmRule、CreateAlarm、DescribeAlarms、ModifyAlarm

名称	必选	允许NULL	类型	描述
Type	是	否	String	执行周期，可选值：Period、Fixed、Cron。 Period：固定频率 Fixed：固定时间 Cron：Cron表达式示例值： Period
Time	是	否	Int64	执行的周期，或者定制执行的时间节点。单位为分钟，取值范围为1~1440。当type为Period,Fixed时，time字段生效。示例值： 1
CronExpression	否	否	String	执行的周期cron表达式。示例："/1 " 从左到右每个field的含义 Minutes field, Hours field,Day of month field,Month field,Day of week field，不支持秒级别。当type为Cron时，CronExpression字段生效。示例值： /1

UserConfigInfo

附加配置信息

被如下接口引用：DescribeUserConfig、ModifyUserConfig

名称	必选	允许NULL	类型	描述
Key	是	否	String	附加配置key 示例值： key
Value	是	否	String	附加配置内容示例值： value

TopicPartitionInfo

Partitions

被如下接口引用：SendConsumerHeartbeat

名称	必选	允许NULL	类型	描述
TopicID	是	是	String	日志主题ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
Partitions	是	是	Array of Uint64	分区id列表示例值： ["57f5808c-4a55-11eb-b378-0242ac130002"]

TopicWhitelistInfo

日志主题白名单

被如下接口引用：DescribeTopics

名称	必选	允许NULL	类型	描述
CloudQueryLanguage	是	否	Bool	当cql返回不为空时， true:可以使用CQL语法， false:不可以使用CQL语法。字段不存在时，不能使用CQL语法。示例值： false
FlagBit	否	否	Uint64	二进制标记位。前端控制台使用。第一位：是否打免费标签示例值： 0

NoticeContent

通知内容模板详细配置

被如下接口引用：CreateNoticeContent、DescribeNoticeContents、ModifyNoticeContent

名称	必选	允许NULL	类型	描述
Type	是	否	String	渠道类型 Email:邮件;Sms:短信;WeChat:微信;Phone:电话;WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调; 示例值： "Email"
TriggerContent	否	否	NoticeContentInfo	告警触发通知内容模板。示例值：查看
RecoveryContent	否	否	NoticeContentInfo	告警恢复通知内容模板。示例值：查看

ParquetKeyInfo

Parquet内容描述

被如下接口引用：CreateShipper、DescribeShipperPreview、DescribeShippers、ModifyShipper

名称	必选	允许NULL	类型	描述
KeyName	是	否	String	键值名称示例值： content
KeyType	是	否	String	数据类型，目前支持6种类型：string、boolean、int32、int64、float、double 示例值： string
KeyNonExistingField	是	否	String	解析失败赋值信息示例值： key1

PolicyInfo

服务下发策略信息

被如下接口引用：HeartBeat

名称	必选	允许NULL	类型	描述
OP	否	是	Uint64	按位取值标记操作类型。 - 0b0001 标识主动重启命令 - 0b0010 标识强制更新采集配置命令示例值： 0

MultiTopicSearchInformation

多日志主题检索相关信息

被如下接口引用：SearchLog

名称	必选	允许NULL	类型	描述
TopicId	否	否	String	要检索分析的日志主题ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
Context	否	否	String	透传上次接口返回的Context值，可获取后续更多日志，总计最多可获取1万条原始日志，过期时间1小时示例值： Y29udGV4dC04MjMzNWRkMi01YmMxLTQ4NGYtYjQ4MS04MDg0NzAwYjQ1NDUxNjcy

AlarmTarget

告警对象

被如下接口引用：CheckAlarmRule、CreateAlarm、ModifyAlarm

名称	必选	允许NULL	类型	描述
TopicId	是	是	String	日志主题ID。示例值： 8211a509-fee5-43dd-9ec0-6a6e7bc92552
Query	是	是	String	查询语句。示例值： select count(*) as success_counts
Number	是	是	Int64	告警对象序号；从1开始递增。示例值： 1
StartTimeOffset	是	是	Int64	查询范围起始时间相对于告警执行时间的偏移，单位为分钟，取值为非正，最大值为0，最小值为-1440。示例值： -5
EndTimeOffset	是	是	Int64	查询范围终止时间相对于告警执行时间的偏移，单位为分钟，取值为非正，须大于StartTimeOffset，最大值为0，最小值为-1440。示例值： 0
LogsetId	是	是	String	日志集ID。示例值： 8211a509-fee5-43dd-9ec0-6a6e7bc92552
SyntaxRule	否	是	Uint64	检索语法规则，默认值为0。 0：Lucene语法，1：CQL语法。详细说明参见检索条件语法规则示例值： 1
QueryInteractiveConfig	否	是	String	交互模板查询语句配置信息。示例值： {"Value":{}}

ServiceLogConfigInfo

服务日志topic信息

被如下接口引用：DescribeAgentConfigs

名称	必选	允许NULL	类型	描述
LogsetId	是	否	String	服务日志的logset信息示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
TopicId	是	否	String	服务日志的Topic ID 示例值： dd1e5d83-fee5-cd35-ac57-20823c21b8cd
TopicName	是	否	String	服务日志的Topic Name 示例值： demoTopic

LogContextInfo

日志上下文信息

被如下接口引用：DescribeLogContext

名称	必选	允许NULL	类型	描述
Source	是	否	String	日志来源设备示例值： 100.105.60.255
Filename	是	否	String	采集路径示例值： /usr/local/services/cls_cgi_api3-1.0/log/cls_cgi.log.20210425
Content	是	否	String	日志内容示例值： {"CONTENT": "[INFO] [2020-11-23 18:34:14.983] [1da50ffe-4e87-42a6-be05-dc9e200cd284] [LogFilter.java] Query: {}"}
PkgId	是	否	String	日志包序号示例值： 528C1318606EFEB8-1A0
PkgLogId	是	否	Int64	日志包内一条日志的序号示例值： 196609
BTime	是	否	Int64	日志时间戳示例值： 2021-04-25 14:25:00.000
HostName	是	是	String	日志来源主机名称示例值： hostName-1
RawLog	是	是	String	原始日志(仅在日志创建索引异常时有值) 示例值： {"content":"log"}
IndexStatus	是	是	String	日志创建索引异常原因(仅在日志创建索引异常时有值) 示例值： IndexAllFail:fields like 'a' and 'a.b' can not appear in the same topic
HighLights	否	否	Array of HighLightItem	日志内容的高亮描述信息示例值：查看

MetricSpec

采集对象

被如下接口引用：CreateMetricConfig、DescribeClusterBaseMetricConfigs、DescribeClusterMetricConfigs、DescribeTopicBaseMetricConfigs、DescribeTopicMetricConfigs、ModifyMetricConfig

名称	必选	允许NULL	类型	描述
CustomSpecs	否	是	Array of CustomMetricSpec	自定义指标采集配置项示例值：查看

FieldInfo

字段信息

被如下接口引用：CreateExternalDataSource、DescribeExternalDataSourcePreview、DescribeExternalDataSources、ModifyExternalDataSource

名称	必选	允许NULL	类型	描述
FieldName	是	是	String	字段名示例值： name
FieldType	是	是	String	字段类型示例值： string

AlarmClassification

告警分类信息

被如下接口引用：CreateAlarm、DescribeAlarms、ModifyAlarm

名称	必选	允许NULL	类型	描述
Key	是	否	String	分类键示例值： key_sample
Value	是	否	String	分类值示例值： value_sample

AdvancedConsumerConfiguration

投递Ckafka 高级配置

被如下接口引用：CreateConsumer、DescribeConsumer、DescribeConsumers、ModifyConsumer

名称	必选	允许NULL	类型	描述
PartitionHashStatus	否	否	Bool	Ckafka分区hash状态。默认 false true：开启根据字段 Hash 值结果相等的信息投递到统一 ckafka 分区 false：关闭根据字段 Hash 值结果相等的信息投递到统一 ckafka 分区示例值： true
PartitionFields	否	否	Array of String	需要计算 hash 的字段列表。示例值： ["name","address"]

EventLog

Windows事件日志采集配置

名称	必选	允许NULL	类型	描述
EventChannel	是	否	String	事件通道，支持Application，Security，Setup，System，ALL 示例值： Application
TimeType	是	否	Uint64	时间类型，1:用户自定义，2:当前时间示例值： 1
Timestamp	否	否	Uint64	时间，用户选择自定义时间类型时，需要指定时间示例值： 1736994580
EventIDs	否	否	Array of String	事件ID过滤列表选填，为空表示不做过滤支持正向过滤单个值（例：20）或范围（例：0-20），也支持反向过滤单个值(例：-20) 多个过滤项之间可由逗号隔开，例：1-200,-100表示采集1-200范围内除了100以外的事件日志示例值： 1-200,-100