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

数据结构

最近更新时间: 2025-10-20 17:05:57

RegexIndexInfo

获取K-V正则索引信息

被如下接口引用：GenKVRegex

名称 必选 允许NULL 类型 描述
Start 是 否 Int64 起始位置
End 是 否 Int64 结束位置

ContainerStdoutInfo

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

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

名称 必选 允许NULL 类型 描述
AllContainers 是 否 Bool 是否所有容器
Container 否 是 String container为空表所有的，不为空采集指定的容器
Namespace 否 是 String namespace可以多个，用分隔号分割,例如A,B；为空或者没有这个字段，表示所有namespace
IncludeLabels 否 是 Array of String pod标签信息
WorkLoads 否 是 Array of ContainerWorkLoadInfo 工作负载信息
ExcludeNamespace 否 是 String 需要排除的namespace可以多个，用分隔号分割,例如A,B
ExcludeLabels 否 是 Array of String 需要排除的pod标签信息

ShipperTaskInfo

投递任务信息

被如下接口引用：DescribeShipperTasks

名称 必选 允许NULL 类型 描述
TaskId 是 否 String 投递任务ID
ShipperId 是 否 String 投递信息ID
TopicId 是 否 String 日志主题ID
RangeStart 是 否 Int64 本批投递的日志的开始时间戳，毫秒
RangeEnd 是 否 Int64 本批投递的日志的结束时间戳， 毫秒
StartTime 是 否 Int64 本次投递任务的开始时间戳， 毫秒
EndTime 是 否 Int64 本次投递任务的结束时间戳， 毫秒
Status 是 否 String 本次投递的结果，"success","running","failed"
Message 是 否 String 结果的详细信息

AgentUpdateInfo

Agent自动升级任务信息

被如下接口引用：HeartBeat

名称 必选 允许NULL 类型 描述
NeedUpdate 否 否 Bool 是否需要升级
UpdateType 否 是 Int64 升级类型:0-null,1-manual,2-auto,3-force
UpdateAction 否 是 Int64 升级动作:0-null,1-update,2-revert
RetryCount 否 是 Int64 重试次数,最大3次
TargetVersion 否 是 String 目标版本
DownloadUrl 否 是 String 安装包下载链接1
DownloadUrlSecond 否 是 String 安装包下载链接2
FileMd5 否 是 String 安装包文件MD5值

DataTransformFailureInfo

数据加工日志失败信息

被如下接口引用：DescribeDataTransformFailLogInfo

名称 必选 允许NULL 类型 描述
LogContent 是 否 String 源日志
Reason 是 否 String 加工失败原因

FilterRuleInfo

投递日志的过滤规则

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

名称 必选 允许NULL 类型 描述
Key 是 否 String 过滤规则Key
Regex 是 否 String 过滤规则
Value 是 否 String 过滤规则Value

Filter

过滤器

被如下接口引用：DescribeAlarmNotices、DescribeAlarms、DescribeAlertRecordHistory、DescribeAsyncContextTasks、DescribeAsyncSearchTasks、DescribeConfigExtras、DescribeConfigs、DescribeDashboards、DescribeDataTransformInfo、DescribeDemonstrations、DescribeIndexs、DescribeLogsets、DescribeMachineGroups、DescribeShippers、DescribeTemplates、DescribeTopics

名称 必选 允许NULL 类型 描述
Key 是 否 String 需要过滤的字段。
Values 是 否 Array of String 需要过滤的值。

AlarmRuleTestResult

告警策略检测结果

被如下接口引用：CheckAlarmRule

名称 必选 允许NULL 类型 描述
Index 是 否 Int64 位序
ErrorCode 是 否 Int64 错误码
ErrorMessage 是 否 String 错误信息

JsonLogInfo

json格式日志内容

被如下接口引用：DescribeLatestJsonLog

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

TaskLogStatistic

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

被如下接口引用：DescribeDataTransformProcessInfo

名称 必选 允许NULL 类型 描述
StartTime 是 否 String 开始时间
EndTime 是 否 String 结束时间
ReadLines 是 是 Int64 读取的源日志主题的行数
WriteLines 是 是 Int64 加工后的行数
FailedLines 是 是 Int64 加工失败的行数
DstTopicLogStatistics 是 是 Array of TopicIdLogStatistic 输出到目标日志主题的总体统计数据
FilterLines 否 是 Uint64 加工过滤的行数

Column

日志分析的列属性

被如下接口引用：GetAlarmLog、SearchLog

名称 必选 允许NULL 类型 描述
Name 否 否 String 列的名字
Type 否 否 String 列的属性

MachineInfo

机器状态信息

被如下接口引用：DescribeMachines

名称 必选 允许NULL 类型 描述
Ip 是 否 String 机器的IP
Status 是 否 Uint64 机器状态，0:异常，1:正常
OfflineTime 是 否 String 机器离线时间，空为正常，异常返回具体时间
AutoUpdate 是 否 Int64 机器是否开启自动升级。0:关闭，1:开启
Version 是 否 String 机器当前版本号。
UpdateStatus 是 否 Int64 机器升级功能状态。
ErrCode 是 否 Int64 机器升级结果标识。
ErrMsg 是 否 String 机器升级结果信息。

HistogramInfo

直方图详细信息

被如下接口引用：DescribeLogHistogram

名称 必选 允许NULL 类型 描述
Count 是 否 Int64 统计周期内的日志条数
BTime 是 否 Int64 按 period 取整后的 unix timestamp： 单位毫秒

UserConfigInfo

附加配置信息

被如下接口引用：DescribeUserConfig、ModifyUserConfig

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

FunctionArgument

函数参数描述

被如下接口引用：DescribeFunctions

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

PartitionInfo

日志主题分区信息

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

名称 必选 允许NULL 类型 描述
PartitionId 是 否 Int64 分区ID
Status 是 否 String 分区的状态（readwrite或者是readonly）
InclusiveBeginKey 是 否 String 分区哈希键起始key
ExclusiveEndKey 是 否 String 分区哈希键结束key
CreateTime 是 否 String 分区创建时间
LastWriteTime 是 是 String 只读分区数据停止写入时间

QcloudDataInfo

数据信息

被如下接口引用：CreateQcloudHour

名称 必选 允许NULL 类型 描述
DealNames 否 否 Array of String 后付费订单号，每个物品对应一个dealName
FlowId 否 否 String 异步发货产品查询发货状态标识
FlowIds 否 否 Array of String 多物品发货对应的flowId，与dealNames一一对应
ResourceIds 否 否 String 每个订单号对应的发货资源id列表:{"20200929112744":["ins-kjs4jvkj"],"20200929112745":["disk-8ijw00wy"]}
BillId 否 否 String 冻结流水，一次开通一个冻结流水

ContainerFileInfo

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

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

名称 必选 允许NULL 类型 描述
Namespace 是 否 String namespace可以多个，用分隔号分割,例如A,B
Container 是 否 String 容器名称
LogPath 是 否 String 日志文件夹
FilePattern 是 否 String 日志名称
IncludeLabels 否 是 Array of String pod标签信息
WorkLoad 否 是 ContainerWorkLoadInfo 工作负载信息
ExcludeNamespace 否 是 String 需要排除的namespace可以多个，用分隔号分割,例如A,B
ExcludeLabels 否 否 Array of String 需要排除的pod标签信息

SubTypeItem

模版子类型信息

被如下接口引用：DescribeTemplates

名称 必选 允许NULL 类型 描述
SubType 否 否 String 演示示例子类型
Queries 否 否 Array of QueryTemplateItem 检索语句模版
TemplateItems 否 否 Array of TemplateItem 模版项

LogInfo

日志结果信息

被如下接口引用：DescribeAsyncContextResult、DescribeAsyncSearchResult、GetAlarmLog、SearchLog

名称 必选 允许NULL 类型 描述
Time 是 否 Int64 日志时间，单位ms
TopicId 是 否 String 日志主题ID
TopicName 是 否 String 日志主题名称
Source 是 否 String 日志来源IP
FileName 是 否 String 日志文件名称
PkgId 是 否 String 日志上报请求包的ID
PkgLogId 是 否 String 请求包内日志的ID
Logs 是 是 Array of LogItem 日志内容，由多个LogItem (KV结构）组成
HighLights 是 是 Array of HighLightItem 日志内容的高亮描述信息
LogJson 是 是 String 日志内容的Json序列化字符串
HostName 否 是 String 日志来源主机名称

SendDetailItem

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

被如下接口引用：CheckAlarmChannel

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

DashboardInfo

仪表盘信息

被如下接口引用：DescribeDashboards

名称 必选 允许NULL 类型 描述
DashboardId 是 否 String 仪表盘id
DashboardName 是 否 String 仪表盘名字
Data 是 是 String 仪表盘数据
CreateTime 是 否 String 创建仪表盘的时间
AssumerUin 是 是 Uint64 AssumerUin非空则表示创建该日志主题的服务方Uin
RoleName 是 是 String RoleName非空则表示创建该日志主题的服务方使用的角色
AssumerName 是 是 String AssumerName非空则表示创建该日志主题的服务方名称
Tags 是 是 Array of Tag 日志主题绑定的标签信息
DashboardRegion 是 是 String 仪表盘所在地域： 为了兼容老的地域。
UpdateTime 否 是 String 修改仪表盘的时间
DashboardTopicInfos 否 是 Array of DashboardTopicInfo 仪表盘对应的topic相关信息

ConsumerContent

投递任务出入参 Content

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

名称 必选 允许NULL 类型 描述
EnableTag 是 是 Bool 是否投递 TAG 信息
MetaFields 是 是 Array of String 需要投递的元数据列表，目前仅支持：__SOURCE__，__FILENAME__和__TIMESTAMP__
TagJsonNotTiled 否 是 Bool 当EnableTag为true时，必须填写TagJsonNotTiled字段，TagJsonNotTiled用于标识tag信息是否json平铺，TagJsonNotTiled为true时不平铺，false时平铺
TimestampAccuracy 否 是 Int64 投递时间戳精度，可选项 [1:秒；2:毫秒] ，默认是秒

RuleInfo

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

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

名称 必选 允许NULL 类型 描述
FullText 否 是 FullTextInfo 全文索引配置
KeyValue 否 是 RuleKeyValueInfo 键值索引配置
Tag 否 是 RuleTagInfo 元字段索引配置

ServiceLogConfigInfo

服务日志topic信息

被如下接口引用：DescribeAgentConfigs

名称 必选 允许NULL 类型 描述
LogsetId 否 否 String 服务日志的logset信息
TopicId 否 否 String 服务日志的Topic ID
TopicName 否 否 String 服务日志的Topic Name

TopicIdAndRegion

仪表盘 topic与地域信息

被如下接口引用：DescribeDashboards

名称 必选 允许NULL 类型 描述
TopicId 是 否 String 日志主题id
RegionId 是 否 Uint64 日志主题id 所在的地域id 地域ID - 访问链接查看详情：https://iwiki.woa.com/pages/viewpage.action?pageId=780556968#id-地域码表-一.region大区（标准地域）

AlarmTarget

告警对象

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

名称 必选 允许NULL 类型 描述
TopicId 是 否 String 日志主题ID。
Query 是 否 String 查询语句。
Number 是 否 Int64 告警对象序号；从1开始递增。
StartTimeOffset 是 否 Int64 查询范围起始时间相对当前的历史时间，单位非分钟，取值为非正，最大值为0，最小值为-1440。
EndTimeOffset 是 否 Int64 查询范围终止时间相对当前的历史时间，单位非分钟，取值为非正，须大于StartTimeOffset，最大值为0，最小值为-1440。
LogsetId 是 否 String 日志集ID。

KeyValueInfo

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

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

名称 必选 允许NULL 类型 描述
Key 是 否 String 需要配置键值或者元字段索引的字段
Value 是 否 ValueInfo 字段的索引描述信息

DemonstrationResource

演示示例资源

被如下接口引用：DescribeDemonstrations、ModifyDemonstrationResources

名称 必选 允许NULL 类型 描述
ResourceType 是 否 String 资源类型：'LOGSET' | 'TOPIC' | 'DASHBOARD' | 'ALARM' | 'ALARM_NOTICE'
ResourceId 是 否 String 资源ID
Enable 否 否 Bool 是否启用。目前只用于表示Topic是否开启日志自动写入。
Region 是 否 String 资源所在地域
SubType 是 否 String 演示示例子类型
UploadStatus 否 否 String 资源类型为TOPIC的上传状态：'INITIAL' | 'UPLOADING' | 'UPLOAD_FAILED' | 'STOPPED'
TemplateItemId 否 否 String 模版项ID
Creator 否 否 String 创建者：CLS, USER

ConditionTestResult

触发条件测试结果

被如下接口引用：CheckAlarmRule

名称 必选 允许NULL 类型 描述
ErrorCode 是 否 Int64 错误码
ErrorMessage 是 否 String 错误信息

ConfigInfo

采集规则配置信息

被如下接口引用：DescribeConfigs、DescribeMachineGroupConfigs

名称 必选 允许NULL 类型 描述
ConfigId 是 否 String 采集规则配置ID
Name 是 是 String 采集规则配置名称
LogFormat 是 是 String 日志格式化方式
Path 是 是 String 日志采集路径
LogType 是 是 String 采集的日志类型，json_log代表json格式日志，delimiter_log代表分隔符格式日志，minimalist_log代表极简日志，multiline_log代表多行日志，fullregex_log代表完整正则，默认为minimalist_log
ExtractRule 是 是 ExtractRuleInfo 提取规则，如果设置了ExtractRule，则必须设置LogType
ExcludePaths 是 是 Array of ExcludePathInfo 采集黑名单路径列表
Output 是 否 String 采集配置所属日志主题ID即TopicId
UpdateTime 是 是 Datetime 更新时间
CreateTime 是 否 Datetime 创建时间
UserDefineRule 是 是 String 用户自定义解析字符串
ConfigExtraId 是 是 String config_extra主键ID
ConfigFlag 是 是 String 采集配置标签

HostFileInfo

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

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

名称 必选 允许NULL 类型 描述
LogPath 是 否 String 日志文件夹
FilePattern 是 否 String 日志文件名
CustomLabels 否 是 Array of String metadata信息

NoticeReceiver

告警通知接收者信息

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

名称 必选 允许NULL 类型 描述
ReceiverType 是 否 String 接受者类型。可选值：<br><li> Uin - 用户ID<br><li> Group - 用户组ID暂不支持其余接收者类型。
ReceiverIds 是 否 Array of Int64 接收者。
ReceiverChannels 是 否 Array of String 通知接收渠道。<br><li> Email - 邮件<br><li> Sms - 短信<br><li> WeChat - 微信<br><li> Phone - 电话
StartTime 否 否 String 允许接收信息的开始时间。
EndTime 否 否 String 允许接收信息的结束时间。
Index 否 否 Int64 位序

CallBackInfo

回调配置

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

名称 必选 允许NULL 类型 描述
Body 是 否 String 回调时的Body
Headers 否 是 Array of String 回调时的Headers

AlertHistoryRecord

告警历史的记录的结构

被如下接口引用：DescribeAlertRecordHistory

名称 必选 允许NULL 类型 描述
RecordId 是 否 String 记录ID
AlarmId 是 否 String 报警ID
AlarmName 是 否 String 告警名
TopicId 是 否 String topic的id
TopicName 是 否 String topic名
Region 是 否 String 地域
Trigger 是 否 String 触发条件
TriggerCount 是 否 Int64 报警发生阈值
AlarmPeriod 是 否 Int64 连续多少次报警，进行通知
Notices 是 否 Array of AlertHistoryNotice 报警对象
Duration 是 否 Int64 连续报警时间
Status 是 否 Int64 状态
CreateTime 是 否 Uint64 发生时间

ExcludePathInfo

黑名单path信息

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

名称 必选 允许NULL 类型 描述
Type 是 否 String 类型，选填File或Path
Value 是 否 String Type对应的具体内容

RebuildIndexTaskInfo

索引重建任务信息

被如下接口引用：DescribeRebuildIndexTasks

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

PreviewLogStatistic

预览数据详情

被如下接口引用：CreateDataTransform、DescribeDataTransformPreviewDataInfo

名称 必选 允许NULL 类型 描述
DstTopicId 否 否 String 目标日志主题
LogContent 是 否 String 日志内容
FailReason 否 否 String 失败错误码， 空字符串""表示正常
LineNum 是 否 Int64 行号
Time 否 否 String 日志时间戳
DstTopicName 否 是 String 目标topic-name

TopicInfo

日志主题信息

被如下接口引用：DescribeTopics

名称 必选 允许NULL 类型 描述
LogsetId 是 否 String 日志集ID
TopicId 是 否 String 日志主题ID
TopicName 是 否 String 日志主题名称
PartitionCount 是 否 Int64 主题分区个数
Index 是 否 Bool 是否开启索引
AssumerUin 是 是 Uint64 AssumerUin非空则表示创建该日志主题的服务方Uin
AssumerName 是 是 String AssumerName非空则表示创建该日志主题的服务方名称
CreateTime 是 否 String 创建时间
TopicModifyAcl 是 是 Int64 若AssumerUin非空，则表示除服务方外其余调用者修改日志主题的权限
TopicShowAcl 是 是 Int64 若AssumerUin非空，则表示除服务方外其余调用者展示日志主题的权限
Status 是 否 Bool 日主主题是否开启采集
Tags 是 是 Array of Tag 日志主题绑定的标签信息
RoleName 是 是 String RoleName非空则表示创建该日志主题的服务方使用的角色
AutoSplit 是 是 Bool 该主题是否开启自动分裂
MaxSplitPartitions 是 是 Int64 若开启自动分裂的话，该主题能够允许的最大分区数
StorageType 是 是 String 日主题的存储类型
Period 是 是 Int64 生命周期，单位为天
SubAssumerName 是 是 String 二级产品标识
LogsetInfo 否 是 LogsetInfo topic对应的日志集信息
Describes 否 是 String 日志主题描述

LogConfigInfo

采集日志配置信息

被如下接口引用：DescribeAgentConfigs

名称 必选 允许NULL 类型 描述
TopicId 是 否 String 日志主题ID
Path 是 否 String 采集日志路径列表
LogType 是 否 String 日志类型
ExtractRule 是 否 ExtractRuleInfo 提取规则
LogFormat 是 是 String 日志格式化格式
ExcludePaths 是 是 Array of ExcludePathInfo 黑名单path列表
UserDefineRule 否 是 String 用户自定义解析字符串

RuleTagInfo

标签索引配置信息

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

名称 必选 允许NULL 类型 描述
CaseSensitive 是 否 Bool 是否大小写敏感
KeyValues 是 否 Array of KeyValueInfo 标签索引配置中的字段信息

AlarmTargetInfo

日志告警监控对线

被如下接口引用：DescribeAlarms

名称 必选 允许NULL 类型 描述
LogsetId 是 否 String 日志集ID。
LogsetName 是 否 String 日志集名称。
TopicId 是 否 String 日志主题ID。
TopicName 是 否 String 日志主题名称。
Query 是 否 String 查询语句。
Number 是 否 Int64 告警对象序号。
StartTimeOffset 是 否 Int64 查询范围起始时间相对当前的历史时间，取值为非正，最大值为0，最小值为-1440。
EndTimeOffset 是 否 Int64 查询范围终止时间相对当前的历史时间，取值为非正，须大于StartTimeOffset，最大值为0，最小值为-1440。

ParquetKeyInfo

Parquet内容描述

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

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

ConfigExtraInfo

特殊采集规则配置信息

被如下接口引用：DescribeConfigExtras

名称 必选 允许NULL 类型 描述
ConfigExtraId 是 否 String 采集规则扩展配置ID
Name 是 否 String 采集规则名称
TopicId 是 否 String 日志主题ID
Type 是 否 String 类型：container_stdout、container_file、host_file
HostFile 是 是 HostFileInfo 节点文件配置信息
ContainerFile 是 是 ContainerFileInfo 容器文件路径信息
ContainerStdout 是 是 ContainerStdoutInfo 容器标准输出信息
LogFormat 是 是 String 日志格式化方式
LogType 是 是 String 采集的日志类型，json_log代表json格式日志，delimiter_log代表分隔符格式日志，minimalist_log代表极简日志，multiline_log代表多行日志，fullregex_log代表完整正则，默认为minimalist_log
ExtractRule 是 是 ExtractRuleInfo 提取规则，如果设置了ExtractRule，则必须设置LogType
ExcludePaths 是 是 Array of ExcludePathInfo 采集黑名单路径列表
UpdateTime 是 否 String 更新时间
CreateTime 是 否 String 创建时间
UserDefineRule 是 是 String 用户自定义解析字符串
GroupId 是 否 String 机器组ID
ConfigFlag 是 是 String 自建采集配置标
LogsetId 是 是 String 日志集ID
LogsetName 是 是 String 日志集name
TopicName 是 是 String 日志主题name

JsonInfo

JSON类型描述

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

名称 必选 允许NULL 类型 描述
EnableTag 是 否 Bool 启用标志
MetaFields 是 是 Array of String 元数据信息列表

LogsetInfo

日志集相关信息

被如下接口引用：DescribeLogsets、DescribeTopics

名称 必选 允许NULL 类型 描述
LogsetId 是 否 String 日志集ID
LogsetName 是 否 String 日志集名称
CreateTime 是 否 String 创建时间
AssumerUin 是 是 Uint64 若AssumerUin非空，则表示创建该日志集的服务方Uin
AssumerName 是 是 String 若AssumerUin非空，则表示创建该日志集的服务方名称
LogsetModifyAcl 是 是 Int64 若AssumerUin非空，则表示非改服务方的调用者对于日志集的修改权限
Tags 是 是 Array of Tag 日志集绑定的标签
TopicCount 是 否 Int64 日志集下日志主题的数目
RoleName 是 否 String 若AssumerUin非空，则表示创建该日志集的服务方角色
Period 是 是 Int64 生命周期，单位为天
LogsetDelACL 是 是 Int64 若AssumerUin非空，则表示非改服务方的调用者对于日志集的删除权限

MachineGroupTypeInfo

机器组类型描述

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

名称 必选 允许NULL 类型 描述
Type 是 否 String 机器组类型，ip表示该机器组Values中存的是采集机器的IP地址，label表示该机器组Values中存储的是机器的标签
Values 是 否 Array of String 机器描述列表

ResourcesInfo

地域指标信息

被如下接口引用：DescribeResources

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

FieldValueRatioInfos

描述字段值的占比情况

被如下接口引用：DescribeLogFastAnalysis

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

TopicIndexInfo

topic的索引配置明细

被如下接口引用：DescribeIndexs

名称 必选 允许NULL 类型 描述
TopicId 否 否 String 日志主题id
Status 否 是 Bool 索引是否生效
Rule 否 是 RuleInfo 索引配置信息 注意：此字段可能返回 null，表示取不到有效值。
ModifyTime 否 否 String 索引修改时间，初始值为索引创建时间。
TopicName 否 否 String 日志主题名称
LogsetId 否 否 String 日志集id
LogsetName 否 否 String 日志集名称
IncludeInternalFields 否 是 Bool 全文索引系统预置字段标记，默认false。 false:不包含系统预置字段， true:包含系统预置字段
MetadataFlag 否 是 Uint64 元数据相关标志位，默认为0。 0：全文索引包括开启键值索引的元数据字段， 1：全文索引包括所有元数据字段，2：全文索引不包括元数据字段。
CoverageField 否 是 String 自定义日志解析异常存储字段。

CosRechargeInfo

cos导入配置信息

被如下接口引用：DescribeCosRecharges

名称 必选 允许NULL 类型 描述
Id 否 是 String 主键ID
TopicId 否 是 String 日志主题ID
LogsetId 否 是 String 日志集ID
Name 否 是 String cos导入任务名称
Bucket 否 是 String cos存储桶
BucketRegion 否 是 String cos存储桶地域
Prefix 否 是 String cos存储桶前缀地址
LogType 否 是 String 采集的日志类型，json_log代表json格式日志，delimiter_log代表分隔符格式日志，minimalist_log代表极简日志； 默认为minimalist_log
Status 否 是 Uint64 状态 status 0: created, 1: running, 2: pause, 3: finished, 4: failed。
Enable 否 是 Uint64 是否启用: 0： 未启用 ， 1：启用
CreateTime 否 是 String 创建时间
UpdateTime 否 是 String 更新时间
Progress 否 是 Uint64 进度条百分值
Compress 否 是 String supported: "", "gzip", "lzop", "snappy”; 默认空
ExtractRuleInfo 否 是 ExtractRuleInfo 见： ExtractRuleInfo 结构描述

Tag

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

被如下接口引用：CreateDashboard、CreateLogset、CreateMachineGroup、CreateTopic、DescribeConfigMachineGroups、DescribeDashboards、DescribeLogsets、DescribeMachineGroups、DescribeTopics、ModifyDashboard、ModifyLogset、ModifyMachineGroup、ModifyTopic

名称 必选 允许NULL 类型 描述
Key 是 否 String 标签键
Value 是 否 String 标签值

WebCallback

回调地址

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

名称 必选 允许NULL 类型 描述
Url 是 否 String 回调地址。
Method 否 是 String 回调方法。可选值：<br><li> POST<br><li> PUT默认值为POST。CallbackType为Http时为必选。
Headers 否 是 Array of String 请求头。
Body 否 是 String 请求内容。CallbackType为Http时为必选。
CallbackType 是 否 String 回调的类型。可选值：<br><li> WeCom<br><li> Http
Index 否 否 Int64 序号

LogContextInfo

日志上下文信息

被如下接口引用：DescribeLogContext

名称 必选 允许NULL 类型 描述
Source 是 否 String 日志来源设备
Filename 是 否 String 采集路径
Content 是 否 String 日志内容
PkgId 是 否 String 日志包序号
PkgLogId 是 否 Int64 日志包内一条日志的序号
BTime 是 否 Int64 日志时间戳
HostName 否 是 String 日志来源主机名称

KeyLogInfo

json格式的k-v日志信息

被如下接口引用：DescribeLatestJsonLog

名称 必选 允许NULL 类型 描述
Key 是 否 String 日志key
Value 是 否 String 日志内容

DashboardTopicInfo

仪表盘关联的topic信息

被如下接口引用：DescribeDashboards

名称 必选 允许NULL 类型 描述
TopicId 是 否 String 主题id
Region 是 否 String topic所在的地域

AlarmAnalysisConfig

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

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

名称 必选 允许NULL 类型 描述
Key 是 否 String 键
Value 是 否 String 值

TopicIdLogStatistic

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

被如下接口引用：DescribeDataTransformProcessInfo

名称 必选 允许NULL 类型 描述
TopicId 是 否 String 日志主题id
ReadLines 是 否 Int64 读取的源日志主题的行数
WriteLines 是 否 Int64 加工后输出到目标日志主题的行数
FailedLines 是 否 Int64 加工失败的行数
FilterLines 否 是 Uint64 加工过滤的行数

CompressInfo

投递日志的压缩配置

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

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

FullTextInfo

全文索引配置

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

名称 必选 允许NULL 类型 描述
CaseSensitive 是 否 Bool 是否大小写敏感
Tokenizer 是 否 String 全文索引的分词符，字符串中每个字符代表一个分词符
ContainZH 否 是 Bool 是否包含中文

QcloudGoodsDetailInfo

业务参数，用户询价和透传给业务

被如下接口引用：CreateQcloudHour

名称 必选 允许NULL 类型 描述
Pid 是 是 Uint64 价格模型
TimeUnit 是 是 String 商品的时间单位：y:年；m:月；d:日；h:小时；M:分钟；s:秒; p:与计费周期无关,一次性购买的产品传p
TimeSpan 是 是 Uint64 商品的时间大小（一次性售卖固定传1）
SubProductCode 是 是 String 放入goodsDetail内:子产品标签
ProductCode 是 是 String 新增参数: 产品标签
SvClsPartitionCount 是 否 Uint64 相关计费项个数

AsyncSearchTask

异步检索任务

被如下接口引用：DescribeAsyncSearchTasks

名称 必选 允许NULL 类型 描述
LogsetId 是 否 String 日志集ID
TopicId 是 否 String 日志主题ID
CreateTime 是 否 String 创建时间
Status 是 否 Int64 状态，0表示待开始，1表示运行中，2表示已完成，-1表示失败
AsyncSearchTaskId 是 否 String 异步检索任务ID
Query 是 否 String 查询语句
From 是 否 Int64 要查询的日志的起始时间，Unix时间戳，单位ms
To 是 否 Int64 要查询的日志的结束时间，Unix时间戳，单位ms
Sort 是 否 String 日志扫描顺序，可选值：asc(升序)、desc(降序)
ErrorMessage 是 是 String 任务失败的错误信息
LogCount 是 是 Int64 异步检索任务匹配的总日志条数
FinishTime 是 是 String 任务完成时间

LogItem

日志中的KV对

被如下接口引用：DescribeAsyncContextResult、DescribeAsyncSearchResult、GetAlarmLog、SearchLog

名称 必选 允许NULL 类型 描述
Key 是 否 String 日志Key
Value 是 否 String 日志Value

ExportInfo

日志导出信息

被如下接口引用：DescribeExports

名称 必选 允许NULL 类型 描述
TopicId 是 否 String 日志主题ID
ExportId 是 否 String 日志导出任务ID
Query 是 否 String 日志导出查询语句
FileName 是 否 String 日志导出文件名
FileSize 是 否 Uint64 日志文件大小
Order 是 否 String 日志导出时间排序
Format 是 否 String 日志导出格式
Count 是 否 Uint64 日志导出数量
Status 是 否 String 日志下载状态。Processing:导出正在进行中，Complete:导出完成，Failed:导出失败，Expired:日志导出已过期（三天有效期）。
From 是 否 Int64 日志导出起始时间
To 是 否 Int64 日志导出结束时间
CosPath 是 否 String 日志导出路径
CreateTime 是 否 String 日志导出创建时间

SendDetail

渠道检测发送详情

被如下接口引用：CheckAlarmChannel

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

DataTransformResouceInfo

数据加工的资源信息

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

名称 必选 允许NULL 类型 描述
TopicId 是 否 String 目标主题id
Alias 是 否 String 别名
LogsetId 否 否 String 日志集id
Uin 否 否 String 主账号Uin

FunctionInfo

数据加工函数基本信息

被如下接口引用：DescribeFunctions

名称 必选 允许NULL 类型 描述
FuncName 是 否 String 函数名称
FuncNameDesc 是 否 String 函数描述
FuncUseDesc 是 否 String 用来说明函数功能
FuncSyntaxDesc 是 否 String 语法描述
FuncDemo 是 否 String demo展示
FuncType 是 否 String 函数类型
IsVariadic 是 否 Bool true是可变长度参数的加工函数
MaxArgumentSize 是 否 Int64 可变参的参数个数最大限制
ReturnType 是 否 String 函数返回结果类型，用来校验嵌套函数中，返回结果是否和函数参数类型匹配。不同的func_type返回的对象类型不同 string/int/bool/condition/func
Arguments 是 否 Array of FunctionArgument 函数参数描述

AnalysisDimensional

多维分析的分析维度

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

名称 必选 允许NULL 类型 描述
Name 是 否 String 分析名称
Type 是 否 String 分析类型：query，field
Content 是 否 String 分析内容
ConfigInfo 否 否 Array of AlarmAnalysisConfig 配置

ContainerWorkLoadInfo

自建k8s-工作负载信息

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

名称 必选 允许NULL 类型 描述
Container 否 是 String 容器名
Kind 是 否 String 工作负载的类型
Name 是 否 String 工作负载的名称
Namespace 否 是 String 命名空间

ExtractRuleInfo

日志提取规则

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

名称 必选 允许NULL 类型 描述
TimeKey 否 是 String 时间字段的key名字，time_key和time_format必须成对出现
TimeFormat 否 是 String 时间字段的格式，参考c语言的strftime函数对于时间的格式说明输出参数
Delimiter 否 是 String 分隔符类型日志的分隔符，只有log_type为delimiter_log时有效
LogRegex 否 是 String 整条日志匹配规则，只有log_type为fullregex_log时有效
BeginRegex 否 是 String 行首匹配规则，只有log_type为multiline_log或fullregex_log时有效
Keys 否 是 Array of String 取的每个字段的key名字，为空的key代表丢弃这个字段，只有log_type为delimiter_log时有效，json_log的日志使用json本身的key
FilterKeyRegex 否 是 Array of KeyRegexInfo 需要过滤日志的key，及其对应的regex
UnMatchUpLoadSwitch 否 是 Bool 解析失败日志是否上传，true表示上传，false表示不上传
UnMatchLogKey 否 是 String 失败日志的key
Backtracking 否 是 Int64 增量采集模式下的回溯数据量，默认-1（全量采集）
IsGBK 否 是 Int64 是否为Gbk编码. 0: 否, 1: 是
JsonStandard 否 是 Int64 是否为标准json. 0: 否, 1: 是

TemplateItem

模版项

被如下接口引用：DescribeTemplates

名称 必选 允许NULL 类型 描述
TemplateItemId 否 否 String 模版项ID
Name 否 否 String 模版项名称
ResourceType 否 否 String 资源类型：'LOGSET' | 'TOPIC' | 'DASHBOARD' | 'ALARM' | 'ALARM_NOTICE'
Value 否 是 String 模版数据

DataTransformTaskInfo

数据加工任务基本详情

被如下接口引用：DescribeDataTransformInfo

名称 必选 允许NULL 类型 描述
Name 是 否 String 数据加工任务名称
TaskId 是 否 String 数据加工任务id
EnableFlag 是 否 Int64 任务启用状态，默认为1，正常开启, 2关闭
Type 是 否 Int64 加工任务类型，1： DSL， 2：SQL
SrcTopicId 是 否 String 源日志主题
Status 是 否 Int64 当前加工任务状态（1准备中/2运行中/3停止中/4已停止）
CreateTime 是 否 String 加工任务创建时间
UpdateTime 是 否 String 最近修改时间
LastEnableTime 是 否 String 最后启用时间，如果需要重建集群，修改该时间
SrcTopicName 是 否 String 日志主题名称
LogsetId 是 否 String 日志集id
DstResources 是 否 Array of DataTransformResouceInfo 加工任务目的topic_id以及别名
EtlContent 是 否 String 加工逻辑函数

ClbTopicExtendConfig

clb定制化的业务配置

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

名称 必选 允许NULL 类型 描述
Vip 否 是 String LB关键信息，VIP
VpcId 否 是 Int64 LB关键信息，VpcId
TopicId 否 是 String clb服务端的公共topic
UserTopicId 否 是 String clb用户的topic
UserUin 否 是 Uint64 clb用户的uin信息
UserAppId 否 是 Uint64 clb用户的appid信息
UserTmpSecretId 否 是 String 临时证书加密密钥ID。最长不超过1024字节。
UserTmpSecretKey 否 是 String 临时证书加密密钥Key。最长不超过1024字节。
UserToken 否 是 String token, 最长不超过4096字节。
TmpKeyExpired 否 是 Uint64 临时证书有效的时间，返回 Unix 时间戳，精确到秒
LbKey 否 是 String 唯一标识clb的一种业务
LogSample 否 是 String 公共topic的采样比
UserSample 否 是 String 用户topic的采样比
UserHealthTopicId 否 是 String LB健康检查日志 Topic ID, 和topicId属于另外一种公共的topic
UserSampleStatus 否 是 Bool topic的采集配置是否生效,true为生效
UserTopicStatus 否 是 Uint64 1代表用户topic已删除，0代表用户topic未删除。
Collection 否 是 Bool lbkey是否要采集到公共topic, true为要采集， false为不采集，默认为false

AlertHistoryNotice

告警历史的通知对象结构

被如下接口引用：DescribeAlertRecordHistory

名称 必选 允许NULL 类型 描述
Name 是 否 String 通知名
AlarmNoticeId 是 否 String 通知ID

MachineGroupInfo

机器组信息

被如下接口引用：DescribeConfigMachineGroups、DescribeMachineGroups

名称 必选 允许NULL 类型 描述
GroupId 是 否 String 机器组ID
GroupName 是 否 String 机器组名称
MachineGroupType 是 否 MachineGroupTypeInfo 机器组类型
CreateTime 是 否 String 创建时间
Tags 是 是 Array of Tag 机器组绑定的标签列表
AutoUpdate 是 是 String 是否开启机器组自动更新
UpdateStartTime 是 是 String 升级开始时间，建议业务低峰期升级LogListener
UpdateEndTime 是 是 String 升级结束时间，建议业务低峰期升级LogListener
ServiceLogging 是 是 Bool 是否开启服务日志，用于记录因Loglistener 服务自身产生的log，开启后，会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business，不产生计费
Flag 是 是 String 默认值""， "label_k8s"

QueryTemplateItem

检索语句模版

被如下接口引用：DescribeTemplates

名称 必选 允许NULL 类型 描述
Query 否 否 String 检索语句
Name 否 否 String 检索语句名称

AlarmNotice

告警通知模板类型

被如下接口引用：DescribeAlarmNotices

名称 必选 允许NULL 类型 描述
Name 是 否 String 告警通知模板名称。
Type 是 否 String 告警模板的类型。可选值：<br><li> Trigger - 告警触发<br><li> Recovery - 告警恢复<br><li> All - 告警触发和告警恢复
NoticeReceivers 是 是 Array of NoticeReceiver 告警通知模板接收者信息。
WebCallbacks 是 是 Array of WebCallback 告警通知模板回调信息。
AlarmNoticeId 是 是 String 告警通知模板ID。
CreateTime 是 是 String 创建时间。
UpdateTime 是 是 String 最近更新时间。

TopicIdLogFailureInfo

topicid的数据加工失败信息

被如下接口引用：

名称 必选 允许NULL 类型 描述
TopicId 是 否 String 日志主题
LogFailureInfos 是 否 Array of DataTransformFailureInfo 日志失败信息

MonitorTime

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

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

名称 必选 允许NULL 类型 描述
Type 是 否 String 可选值：<br><li> Period - 周期执行<br><li> Fixed - 定期执行
Time 是 否 Int64 执行的周期，或者定制执行的时间节点。单位为分钟，取值范围为1~1440。

CsvInfo

csv内容描述

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

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

KeyRegexInfo

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

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

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

RuleKeyValueInfo

键值索引配置

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

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

ContentInfo

投递日志的内容格式配置

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

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

LogItems

LogItem的数组

被如下接口引用：GetAlarmLog、SearchLog

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

Demonstration

演示示例

被如下接口引用：DescribeDemonstrations

名称 必选 允许NULL 类型 描述
Region 是 否 String 演示示例资源所在地域
Type 是 否 String 演示示例类型
Resources 是 否 Array of DemonstrationResource 演示示例资源
Status 是 否 String 演示示例状态：CREATING, FAILED, SUCCESS, DELETING

Template

模版

被如下接口引用：DescribeTemplates

名称 必选 允许NULL 类型 描述
Type 否 否 String 演示示例类型
SubTypes 否 否 Array of SubTypeItem 模版子类型信息

QcloudGoodsInfoListInfo

物品信息

被如下接口引用：CreateQcloudHour

名称 必选 允许NULL 类型 描述
PayMode 是 否 Uint64 付费模式，0:后付费
Type 是 否 String 业务产品录入的商品码，业务名称，categoryid中的商品码
RegionId 是 否 Uint64 地域ID
ZoneId 是 否 Uint64 区域ID
GoodsNum 是 否 Uint64 商品实例的个数
GoodsDetail 是 否 QcloudGoodsDetailInfo 业务参数，用户询价和透传给业务

ParquetInfo

Parquet内容

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

名称 必选 允许NULL 类型 描述
ParquetKeyInfo 是 否 Array of ParquetKeyInfo ParquetKeyInfo数组

ShipperInfo

投递规则

被如下接口引用：DescribeShippers

名称 必选 允许NULL 类型 描述
ShipperId 是 否 String 投递规则ID
TopicId 是 否 String 日志主题ID
Bucket 是 否 String 投递的bucket地址
Prefix 是 否 String 投递的前缀目录
ShipperName 是 否 String 投递规则的名字
Interval 是 否 Uint64 投递的时间间隔，单位 秒
MaxSize 是 否 Uint64 投递的文件的最大值，单位 MB
Status 是 否 Bool 是否生效
FilterRules 是 是 Array of FilterRuleInfo 投递日志的过滤规则
Partition 是 否 String 投递日志的分区规则，支持strftime的时间格式表示
Compress 是 是 CompressInfo 投递日志的压缩配置
Content 是 是 ContentInfo 投递日志的内容格式配置
CreateTime 是 否 String 投递日志的创建时间

ValueInfo

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

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

名称 必选 允许NULL 类型 描述
Type 是 否 String 字段类型，目前支持的类型有：long、text、double
Tokenizer 否 否 String 字段的分词符，只有当字段类型为text时才有意义；输入字符串中的每个字符代表一个分词符
SqlFlag 否 否 Bool 字段是否开启分析功能
ContainZH 否 是 Bool 是否包含中文

AgentUpdateStatus

Agent自动升级状态信息

被如下接口引用：UpdateAgentStatus

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

Ckafka

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

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

名称 必选 允许NULL 类型 描述
Vip 是 否 String Ckafka 的 Vip
Vport 是 否 String Ckafka 的 Vport
InstanceId 是 否 String Ckafka 的 InstanceId
InstanceName 是 否 String Ckafka 的 InstanceName
TopicId 是 否 String Ckafka 的 TopicId
TopicName 是 否 String Ckafka 的 TopicName

HighLightItem

日志内容高亮描述信息

被如下接口引用：DescribeAsyncContextResult、DescribeAsyncSearchResult、GetAlarmLog、SearchLog

名称 必选 允许NULL 类型 描述
Key 是 否 String 高亮的日志Key
Values 是 否 Array of String 高亮的语法

AlarmInfo

告警策略描述

被如下接口引用：DescribeAlarms

名称 必选 允许NULL 类型 描述
Name 是 否 String 告警策略名称。
AlarmTargets 是 否 Array of AlarmTargetInfo 监控对象列表。
MonitorTime 是 否 MonitorTime 监控任务运行时间点。
Condition 是 否 String 触发条件。
TriggerCount 是 否 Int64 持续周期。持续满足触发条件TriggerCount个周期后，再进行告警；最小值为1，最大值为10。
AlarmPeriod 是 否 Int64 告警重复的周期。单位是min。取值范围是0~1440。
AlarmNoticeIds 是 否 Array of String 关联的告警通知模板列表。
Status 是 否 Bool 开启状态。
AlarmId 是 否 String 告警策略ID。
CreateTime 是 否 String 创建时间。
UpdateTime 是 否 String 最近更新时间。
Enable 是 否 Bool 开启状态
MessageTemplate 是 是 String 自定义通知模板
CallBack 是 是 CallBackInfo 自定义回调模板
Analysis 是 是 Array of AnalysisDimensional 多维分析设置

ChannelTestResult

渠道检测结果

被如下接口引用：CheckAlarmChannel

名称 必选 允许NULL 类型 描述
Index 是 否 Int64 序号
ErrorCode 是 否 Int64 错误码，0是正确
ErrorMessage 是 是 String 错误信息
SendTotal 是 是 SendDetail 发送结果

KafkaInfo

消费kafka相关信息

被如下接口引用：DescribeKafkaConsume、OpenKafkaConsume

名称 必选 允许NULL 类型 描述
TopicName 是 否 String 可消费topic名称
UserName 是 否 String ACL模式用户名
Password 是 否 String ACL模式密码
InstanceId 是 否 String 可消费kafka实例ID
BootstrapServers 是 否 String SASL接入点信息

QcloudInterfacePara

物品信息

被如下接口引用：CreateQcloudHour

名称 必选 允许NULL 类型 描述
Multi 是 否 Uint64 恒传1，该字段若传值表示是否开通多个物品，需把开通各项物品传入goodsInfoList
GoodsInfoList 是 否 Array of QcloudGoodsInfoListInfo 开通的物品列表，以下参数为每个物品相关的参数

AsyncContextTask

异步上下文任务

被如下接口引用：DescribeAsyncContextTasks

名称 必选 允许NULL 类型 描述
LogsetId 是 否 String 日志集ID
TopicId 是 否 String 日志主题ID
CreateTime 是 否 Int64 创建时间，时间戳，精确到毫秒
Status 是 否 Int64 状态，0表示待开始，1表示运行中，2表示已完成，-1表示失败
AsyncContextTaskId 是 否 String 异步上下文任务ID
ErrorMessage 是 是 String 任务失败的错误信息
PkgId 是 是 String 日志包序号
PkgLogId 是 是 String 日志包内一条日志的序号
Time 是 是 Int64 日志时间
FinishTime 是 是 Int64 任务完成时间，时间戳，精确到毫秒
AsyncSearchTaskId 是 是 String 相关联的异步检索ID
Query 是 是 String 相关联的异步检索任务的查询语句
From 是 是 Int64 相关联的异步检索任务的查询起始时间
To 是 是 Int64 相关联的异步检索任务的查询结束时间