数据结构

最近更新时间:2024-11-28 01:12:34

我的收藏

AdvanceFilterRuleInfo

高级过滤规则

被如下接口引用:CreateConfig, CreateConfigExtra, CreateCosRecharge, DescribeCosRecharges, ModifyConfig, ModifyConfigExtra, ModifyCosRecharge。

名称 类型 必选 描述
Key String 过滤字段
注意:此字段可能返回 null,表示取不到有效值。
Rule Integer 过滤规则,0:等于,1:字段存在,2:字段不存在
注意:此字段可能返回 null,表示取不到有效值。
Value String 过滤值
注意:此字段可能返回 null,表示取不到有效值。

AlarmAnalysisConfig

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

被如下接口引用:CreateAlarm, ModifyAlarm。

名称 类型 必选 描述
Key String 键。支持以下key:
SyntaxRule:语法规则,value支持 0:Lucene语法;1: CQL语法。
QueryIndex:执行语句序号。value支持 -1:自定义; 1:执行语句1; 2:执行语句2。
CustomQuery:检索语句。 QueryIndex为-1时有效且必填,value示例: "* | select count(*) as count"。
Fields:字段。value支持 SOURCEFILENAMEHOSTNAMETIMESTAMPINDEX_STATUSPKG_LOGIDTOPIC
Format:显示形式。value支持 1:每条日志一行;2:每条日志每个字段一行。
Limit:最大日志条数。 value示例: 5。
注意:此字段可能返回 null,表示取不到有效值。
示例值:k
Value String 值。
键对应值如下:
SyntaxRule:语法规则,value支持 0:Lucene语法;1: CQL语法。
QueryIndex:执行语句序号。value支持 -1:自定义; 1:执行语句1; 2:执行语句2。
CustomQuery:检索语句。 QueryIndex为-1时有效且必填,value示例: "* | select count(*) as count"。
Fields:字段。value支持 SOURCEFILENAMEHOSTNAMETIMESTAMPINDEX_STATUSPKG_LOGIDTOPIC
Format:显示形式。value支持 1:每条日志一行;2:每条日志每个字段一行。
Limit:最大日志条数。 value示例: 5。
注意:此字段可能返回 null,表示取不到有效值。
示例值:v

AlarmClassification

告警分类信息

被如下接口引用:CreateAlarm, ModifyAlarm。

名称 类型 必选 描述
Key String 分类键
示例值:key_sample
Value String 分类值
示例值:value_sample

AlarmInfo

告警策略描述

被如下接口引用:DescribeAlarms。

名称 类型 描述
Name String 告警策略名称。
示例值:test
AlarmTargets Array of AlarmTargetInfo 监控对象列表。
MonitorTime MonitorTime 监控任务运行时间点。
Condition String 单触发条件。与MultiConditions参数互斥。
TriggerCount Integer 持续周期。持续满足触发条件TriggerCount个周期后,再进行告警;最小值为1,最大值为10。
示例值:1
AlarmPeriod Integer 告警重复的周期。单位是min。取值范围是0~1440。
示例值:20
AlarmNoticeIds Array of String 关联的告警通知模板列表。
Status Boolean 开启状态。
示例值:true
AlarmId String 告警策略ID。
示例值:57f5808c-4a55-11eb-b378-0242ac130002
CreateTime String 创建时间。
UpdateTime String 最近更新时间。
MessageTemplate String 自定义通知模板
注意:此字段可能返回 null,表示取不到有效值。
示例值:message tpl test {{.TopicName}}, raw result: {{.RawResults}}
CallBack CallBackInfo 自定义回调模板
注意:此字段可能返回 null,表示取不到有效值。
Analysis Array of AnalysisDimensional 多维分析设置
注意:此字段可能返回 null,表示取不到有效值。
GroupTriggerStatus Boolean 分组触发状态。1:开启,0:关闭(默认)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
GroupTriggerCondition Array of String 分组触发条件。
注意:此字段可能返回 null,表示取不到有效值。
示例值:["$1.conut"]
MonitorObjectType Integer 监控对象类型。0:执行语句共用监控对象;1:每个执行语句单独选择监控对象。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
AlarmLevel Integer 告警级别。0:警告(Warn);1:提醒(Info);2:紧急 (Critical)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
MultiConditions Array of MultiCondition 多触发条件。与
Condition互斥。
注意:此字段可能返回 null,表示取不到有效值。

AlarmNotice

告警通知渠道组详细配置

被如下接口引用:DescribeAlarmNotices。

名称 类型 描述
Name String 告警通知渠道组名称。
示例值:alarm
Tags Array of Tag 告警通知渠道组绑定的标签信息。
注意:此字段可能返回 null,表示取不到有效值。
Type String 告警模板的类型。可选值:

  • Trigger - 告警触发


  • Recovery - 告警恢复


  • All - 告警触发和告警恢复

  • 示例值:All
    NoticeReceivers Array of NoticeReceiver 告警通知模板接收者信息。
    注意:此字段可能返回 null,表示取不到有效值。
    WebCallbacks Array of WebCallback 告警通知模板回调信息。
    注意:此字段可能返回 null,表示取不到有效值。
    AlarmNoticeId String 告警通知模板ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:notice-xxx-xxx-xx-xx
    NoticeRules Array of NoticeRule 通知规则。
    注意:此字段可能返回 null,表示取不到有效值。
    AlarmShieldStatus Integer 免登录操作告警开关。
    参数值: 1:关闭 2:开启(默认开启)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2
    JumpDomain String 调用链接域名。http:// 或者 https:// 开头,不能/结尾
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:https://console.cloud.tencent.com
    AlarmNoticeDeliverConfig AlarmNoticeDeliverConfig 投递相关信息。
    注意:此字段可能返回 null,表示取不到有效值。
    CreateTime String 创建时间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2022-11-07 16:30:53
    UpdateTime String 最近更新时间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2022-11-07 16:30:53

    AlarmNoticeDeliverConfig

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

    被如下接口引用:DescribeAlarmNotices。

    名称 类型 描述
    DeliverConfig DeliverConfig 通知渠道投递日志配置信息。
    ErrMsg String 投递失败原因。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:投递失败,topicId不存在

    AlarmShieldInfo

    告警屏蔽任务配置

    被如下接口引用:DescribeAlarmShields。

    名称 类型 描述
    AlarmNoticeId String 通知渠道组Id
    示例值:notice-ea115e5a-04c4-421e-9ba3-fb177e9025cb
    TaskId String 屏蔽规则id
    示例值:ea115e5a-04c4-421e-9ba3-fb177e9025cb
    StartTime Integer 屏蔽开始时间(秒级时间戳)。
    示例值:1701933943
    EndTime Integer 屏蔽结束时间(秒级时间戳)。
    示例值:1701993943
    Type Integer 屏蔽类型。1:屏蔽所有通知,2:按照Rule参数屏蔽匹配规则的通知。
    示例值:1
    Rule String 屏蔽规则,当Type为2时必填。规则填写方式详见产品文档
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:{"Value":"AND","Type":"Operation","Children":[{"Type":"Condition","Value":"Level","Children":[{"Value":"In","Type":"Compare"},{"Value":"[1]","Type":"Value"}]},{"Type":"Condition","Value":"AlarmID","Children":[{"Value":"In","Type":"Compare"},{"Value":"["alarm-57105ec6-xxxx-xxxx-xxxx-892f3b8d143a"]","Type":"Value"}]}]}
    Reason String 屏蔽原因。
    示例值:发布,暂时屏蔽
    Source Integer 规则创建来源。
    1. 控制台,2.api,3.告警通知
    示例值:1
    Operator String 操作者。
    示例值:100001(张三)
    Status Integer 规则状态。
    0:暂未生效,1:生效中,2:已失效
    示例值:0
    CreateTime Integer 规则创建时间。
    示例值:1701933943
    UpdateTime Integer 规则更新时间。
    示例值:1701933943

    AlarmTarget

    告警对象

    被如下接口引用:CreateAlarm, ModifyAlarm。

    名称 类型 必选 描述
    TopicId String 日志主题ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:380fe1f1-0c7b-4b0d-xxxx-d514959db1bb
    Query String 查询语句。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:code:200 | select count(*) as success_counts
    Number Integer 告警对象序号;从1开始递增。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    StartTimeOffset Integer 查询范围起始时间相对于告警执行时间的偏移,单位为分钟,取值为非正,最大值为0,最小值为-1440。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:-5
    EndTimeOffset Integer 查询范围终止时间相对于告警执行时间的偏移,单位为分钟,取值为非正,须大于StartTimeOffset,最大值为0,最小值为-1440。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    LogsetId String 日志集ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1c012db7-2cfd-4418-xxxx-7342c7a42516
    SyntaxRule Integer 检索语法规则,默认值为0。
    0:Lucene语法,1:CQL语法。
    详细说明参见检索条件语法规则
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1

    AlarmTargetInfo

    告警对象

    被如下接口引用:DescribeAlarms。

    名称 类型 描述
    LogsetId String 日志集ID。
    示例值:eff86344-6a51-479a-xxxx-779aabd40a3e
    LogsetName String 日志集名称。
    示例值:LogsetDemo
    TopicId String 日志主题ID。
    示例值:016f6eac-4c21-4857-xxxx-4adf3be7d56c
    TopicName String 日志主题名称。
    示例值:TopicDemo
    Query String 查询语句。
    示例值:"mi" OR "CommunicationExcep
    Number Integer 告警对象序号。
    示例值:1
    StartTimeOffset Integer 查询范围起始时间相对于告警执行时间的偏移,单位为分钟,取值为非正,最大值为0,最小值为-1440。
    示例值:-240
    EndTimeOffset Integer 查询范围终止时间相对于告警执行时间的偏移,单位为分钟,取值为非正,须大于StartTimeOffset,最大值为0,最小值为-1440。
    示例值:0
    SyntaxRule Integer 检索语法规则,默认值为0。
    0:Lucene语法,1:CQL语法。
    详细说明参见检索条件语法规则
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    BizType Integer 主题类型。
    0: 日志主题,1: 指标主题
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0

    AlertHistoryNotice

    告警通知渠道组详情

    被如下接口引用:DescribeAlertRecordHistory。

    名称 类型 描述
    Name String 通知渠道组名称
    示例值:shicao_test
    AlarmNoticeId String 通知渠道组ID

    AlertHistoryRecord

    告警历史详情

    被如下接口引用:DescribeAlertRecordHistory。

    名称 类型 必选 描述
    RecordId String 告警历史ID
    示例值:7cfbe19f-99af-42ca-8f9f-b59d1f9c6157
    AlarmId String 告警策略ID
    示例值:alarm-8211a509-xxxx-43dd-9ec0-6a6e7bc92552
    AlarmName String 告警策略名称
    示例值:日志错误数超限
    TopicId String 监控对象ID
    示例值:0bf009c5-53f3-4f60-xxxx-341d732ed5b9
    TopicName String 监控对象名称
    示例值:Nginx请求日志
    Region String 监控对象所属地域
    示例值:ap-guangzhou
    Trigger String 触发条件
    示例值:$1.d > 300
    TriggerCount Integer 持续周期,持续满足触发条件TriggerCount个周期后,再进行告警
    示例值:1
    AlarmPeriod Integer 告警通知发送频率,单位为分钟
    示例值:15
    Notices Array of AlertHistoryNotice 通知渠道组
    Duration Integer 告警持续时间,单位为分钟
    示例值:60
    Status Integer 告警状态,0代表未恢复,1代表已恢复,2代表已失效
    示例值:1
    CreateTime Integer 告警发生时间,毫秒级Unix时间戳
    示例值:1619359718000
    GroupTriggerCondition Array of GroupTriggerConditionInfo 告警分组触发时对应的分组信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[{"Key":"$1.count","Value":"100"}]
    AlarmLevel Integer 告警级别,0代表警告(Warn),1代表提醒(Info),2代表紧急 (Critical)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    MonitorObjectType Integer 监控对象类型。
    0:执行语句共用监控对象; 1:每个执行语句单独选择监控对象。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0

    AnalysisDimensional

    多维分析的分析维度

    被如下接口引用:CreateAlarm, DescribeAlarms, ModifyAlarm。

    名称 类型 必选 描述
    Name String 分析名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:status 502 pv
    Type String 分析类型:query,field ,original
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:query
    Content String 分析内容
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:*|select count(1) as pv where status = 502
    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": "* | select count() as count"
    },{
    "Key": "SyntaxRule", // 查不到这个字段也是老语法(Lucene)
    "Value": "0"//0:Lucene, 1:CQL
    }

    当Analysis的Type字段为original(原始日志)时, 支持
    {
    "Key": "Fields",
    "Value": "SOURCE,HOSTNAME,TIMESTAMP,PKG_LOGID,TAG.pod_ip"
    }, {
    "Key": "QueryIndex",
    "Value": "-1" // -1:自定义, 1:执行语句1, 2:执行语句2
    },{
    "Key": "CustomQuery", // //检索语句。 QueryIndex为-1时有效且必填
    "Value": "
    | select count(*) as count"
    },{
    "Key": "Format", //显示形式。1:每条日志一行,2:每条日志每个字段一行
    "Value": "2"
    },
    {
    "Key": "Limit", //最大日志条数
    "Value": "5"
    },{
    "Key": "SyntaxRule", // 查不到这个字段也是老语法
    "Value": "0"//0:Lucene, 1:CQL
    }
    注意:此字段可能返回 null,表示取不到有效值。

    AnonymousInfo

    免鉴权信息

    被如下接口引用:CreateTopic, ModifyTopic。

    名称 类型 必选 描述
    Operations Array of String 操作列表,支持trackLog(JS/HTTP上传日志 )和realtimeProducer(kafka协议上传日志)
    Conditions Array of ConditionInfo 条件列表

    CallBackInfo

    回调配置

    被如下接口引用:CreateAlarm, DescribeAlarms, ModifyAlarm。

    名称 类型 必选 描述
    Body String 回调时的Body。
    可将各类告警变量放在请求内容中,详见帮助文档
    如下示例:

    <br/>{<br/>"TopicId": "{{ .QueryLog[0][0].topicId }}",<br/>"key": "{{.Alarm}}",<br/>"time": "{{ .QueryLog[0][0].time }}",<br/>"log": "{{ .QueryLog[0][0].content.__CONTENT__ }}",<br/>"namespace": "{{ .QueryLog[0][0].content.__TAG__.namespace }}"<br/>}<br/>

    Headers Array of String 回调时的HTTP请求头部字段。
    例如:下面请求头部字段来告知服务器请求主体的内容类型为JSON。

    <br/>"Content-Type: application/json"<br/>

    注意:此字段可能返回 null,表示取不到有效值。

    Ckafka

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

    被如下接口引用:CreateConsumer, DescribeConsumer, ModifyConsumer。

    名称 类型 必选 描述
    InstanceId String Ckafka 的 InstanceId
    示例值:ckafka-8j4rotest
    TopicName String Ckafka 的 TopicName
    示例值:mrxy-business
    Vip String Ckafka 的 Vip
    示例值:10.10.2.42
    Vport String Ckafka 的 Vport
    示例值:9092
    InstanceName String Ckafka 的 InstanceName
    示例值:kafka协议消费监控用
    TopicId String Ckafka 的 TopicId
    示例值:1254011820-24a0d67e-748b-4e30-9502-78779bcc5test

    CloudProductLogTaskInfo

    云产品日志投递任务信息

    被如下接口引用:DescribeCloudProductLogTasks。

    名称 类型 描述
    ClsRegion String 日志服务地域
    示例值:ap-guangzhou
    InstanceId String 实例ID
    示例值:ins-r8hr2upy
    LogsetId String 日志集ID
    示例值:92cdd6d4-da98-4a6e-9494-175b44338680
    TopicId String 日志主题ID
    示例值:92cdd6d4-da98-4a6e-9494-175b44338680
    Extend String 日志配置拓展信息, 一般用于存储额外的日志投递配置
    注意:此字段可能返回 null,表示取不到有效值。
    LogType String 日志类型,支持枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:CDB-AUDIT

    CollectConfig

    采集配置信息

    被如下接口引用:CreateConfigExtra。

    名称 类型 必选 描述
    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

    CollectInfo

    采集配置信息

    被如下接口引用:CreateConfigExtra, DescribeConfigExtras。

    名称 类型 必选 描述
    Type Integer 采集类型,必填字段。
  • 0:元数据配置。
  • 1:指定Pod Label。

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    CollectConfigs Array of CollectConfig 指定采集类型的采集配置信息。
  • 当Type为0时,CollectConfigs不允许为空。
  • 当Type为1时,CollectConfigs为空时,表示选择所有Pod Label;否则CollectConfigs为指定Pod Label。

  • 注意:此字段可能返回 null,表示取不到有效值。

    Column

    日志分析的列属性

    被如下接口引用:GetAlarmLog, SearchLog。

    名称 类型 描述
    Name String 列的名字
    示例值:_col0
    Type String 列的属性
    示例值:json

    CompressInfo

    投递日志的压缩配置

    被如下接口引用:CreateShipper, DescribeShippers, ModifyShipper。

    名称 类型 必选 描述
    Format String 压缩格式,支持gzip、lzop、snappy和none不压缩
    示例值:none

    ConditionInfo

    免鉴权条件信息

    被如下接口引用:CreateTopic, ModifyTopic。

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

    ConfigExtraInfo

    特殊采集规则配置信息

    被如下接口引用:DescribeConfigExtras。

    名称 类型 描述
    ConfigExtraId String 采集规则扩展配置ID
    示例值:xxx-xxx-xxx-xxx
    Name String 采集规则名称
    示例值:tb-xxx1
    TopicId String 日志主题ID
    示例值:xxx-xxx-xxx-xxx
    Type String 类型:container_stdout、container_file、host_file
    示例值:container_stdout
    HostFile HostFileInfo 节点文件配置信息
    注意:此字段可能返回 null,表示取不到有效值。
    ContainerFile ContainerFileInfo 容器文件路径信息
    注意:此字段可能返回 null,表示取不到有效值。
    ContainerStdout ContainerStdoutInfo 容器标准输出信息
    注意:此字段可能返回 null,表示取不到有效值。
    LogFormat String 日志格式化方式
    注意:此字段可能返回 null,表示取不到有效值。
    LogType String 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表极简日志,multiline_log代表多行日志,fullregex_log代表完整正则,默认为minimalist_log
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:minimalist_log
    ExtractRule ExtractRuleInfo 提取规则,如果设置了ExtractRule,则必须设置LogType
    注意:此字段可能返回 null,表示取不到有效值。
    ExcludePaths Array of ExcludePathInfo 采集黑名单路径列表
    注意:此字段可能返回 null,表示取不到有效值。
    UpdateTime String 更新时间
    示例值:2020-02-16 17:01:50
    CreateTime String 创建时间
    示例值:2020-02-16 17:01:50
    UserDefineRule String 用户自定义解析字符串
    注意:此字段可能返回 null,表示取不到有效值。
    GroupId String 机器组ID
    示例值:xxx-xxx-xxx-xxx
    ConfigFlag String 自建采集配置标
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:label_k8s
    LogsetId String 日志集ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:xxx-xxx-xxx-xxx
    LogsetName String 日志集name
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:xxx-xxx-xxx-xxx
    TopicName String 日志主题name
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:xxx-xxx-xxx-xxx
    CollectInfos Array of CollectInfo 采集相关配置信息。详情见 CollectInfo复杂类型配置。
    注意:此字段可能返回 null,表示取不到有效值。
    AdvancedConfig String 高级采集配置。 Json字符串, Key/Value定义为如下:
    - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时
    - ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数
    - ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false
    样例:{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true}
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true}

    ConfigInfo

    采集规则配置信息

    被如下接口引用:DescribeConfigs, DescribeMachineGroupConfigs。

    名称 类型 描述
    ConfigId String 采集规则配置ID
    示例值:57f5808c-4a55-11eb-b378-0242ac130002
    Name String 采集规则配置名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:test
    LogFormat String 日志格式化方式
    注意:此字段可能返回 null,表示取不到有效值。
    Path String 日志采集路径
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:/test/log.test
    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 事件日志)。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:json_log
    ExtractRule ExtractRuleInfo 提取规则,如果设置了ExtractRule,则必须设置LogType
    注意:此字段可能返回 null,表示取不到有效值。
    ExcludePaths Array of ExcludePathInfo 采集黑名单路径列表
    注意:此字段可能返回 null,表示取不到有效值。
    Output String 采集配置所属日志主题ID即TopicId
    示例值:57f5808c-4a55-11eb-b378-0242ac130002
    UpdateTime Timestamp 更新时间
    注意:此字段可能返回 null,表示取不到有效值。
    CreateTime Timestamp 创建时间
    UserDefineRule String 用户自定义解析字符串,详见使用组合解析提取模式采集日志
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"{"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":"|","SourceKey":"msg1","ExtractKeys":["submsg1","submsg2","submsg3"]},"processors":[]},{"type":"processor_split_key_value","detail":{"KeepSource":false,"Delimiter":":","SourceKey":"msg2"}}]}]}"
    AdvancedConfig String 高级采集配置。 Json字符串, Key/Value定义为如下:
    - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时
    - ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数
    - ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false
    样例:
    {\"ClsAgentFileTimeout\":0,\"ClsAgentMaxDepth\":10,\"ClsAgentParseFailMerge\":true}

    控制台默认占位值:{\"ClsAgentDefault\":0}
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true}"

    ConsoleSharingConfig

    控制台分享配置

    被如下接口引用:CreateConsoleSharing。

    名称 类型 必选 描述
    Name String 分享链接名称
    示例值:my-sharing
    Type Integer 仪表盘: 1; 检索页:2
    示例值:1
    DurationMilliseconds Integer 分享链接有效期,单位:毫秒,最长支持30天
    示例值:1800000
    Resources Array of String 允许访问的资源列表,目前仅支持一个Resource
    示例值:当Type为1时:['qcs::cls::uin/100001127589:dashboard/dashboard-1223fa03--44f9-f118-69a8-21aa33ea5aa1']; 当Type为2时:['qcs::cls:ap-guangzhou:uin/10000000001:topic/c1306921-2180-3e45-9azb-31d12217871e6']
    Domain String 分享链接域名,可选范围
    - 公网匿名分享:填写clsshare.com
    - datasight内网匿名分享(若开启):datasight内网域名
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:clsshare.com
    VerifyCode String 验证码
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:lEC0V0
    StartTime String 默认查询范围的开始时间点,支持绝对时间(13位Unix时间戳)或相对时间表达式
    示例值:'1706781017413'或now-7d
    EndTime String 默认查询范围的结束时间点,支持绝对时间(13位Unix时间戳)或相对时间表达式。注意,结束时间点要大于开始时间点
    示例值:'1706791017413'或now
    NowTime Integer 仅当StartTime/EndTime为相对时间时使用,基于NowTime计算绝对时间,默认为创建时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1706797306086
    Params Array of ConsoleSharingParam 默认的检索分析语句,仅当Type为2时使用
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[ { "Name":"query", "Values":[ "* | select *" ] } ]
    IsLockTimeRange Boolean 是否允许访问者自行修改检索分析时间范围。默认不锁定(false)
    示例值:false
    IsLockQuery Boolean 是否允许访问者自行修改日志检索语句。在检索页分享中表示检索语句锁定状态;在仪表盘中表示过滤变量锁定状态。默认不锁定(false)
    示例值:false
    IsSupportLogExport Boolean 检索页分享是否允许访问者下载日志,默认不允许(false)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:false

    ConsoleSharingParam

    控制台分享链接params参数

    被如下接口引用:CreateConsoleSharing。

    名称 类型 必选 描述
    Name String 名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:query
    Value String
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:test

    ConsumerContent

    投递任务出入参 Content

    被如下接口引用:CreateConsumer, DescribeConsumer, ModifyConsumer。

    名称 类型 必选 描述
    EnableTag Boolean 是否投递 TAG 信息。
    当EnableTag为true时,表示投递TAG元信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:false
    MetaFields Array of String 需要投递的元数据列表,目前仅支持:__SOURCE__,__FILENAME__,__TIMESTAMP__,__HOSTNAME__和__PKGID__
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["__SOURCE__", "__FILENAME__", "__TIMESTAMP__"]
    TagJsonNotTiled Boolean 当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"}
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:false
    TimestampAccuracy Integer 投递时间戳精度,可选项 [1:秒;2:毫秒] ,默认是1。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    JsonType Integer 投递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\"}"}
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0

    ContainerFileInfo

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

    被如下接口引用:CreateConfigExtra, DescribeConfigExtras, ModifyConfigExtra。

    名称 类型 必选 描述
    Namespace String namespace可以多个,用分隔号分割,例如A,B
    示例值:kube-system
    Container String 容器名称
    示例值:container1
    LogPath String 日志文件夹
    示例值:/var/log/tmep
    FilePattern String 日志名称
    示例值:*.log
    FilePaths Array of FilePathInfo 日志文件信息
    IncludeLabels Array of String pod标签信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["key1=value1"]
    WorkLoad ContainerWorkLoadInfo 工作负载信息
    注意:此字段可能返回 null,表示取不到有效值。
    ExcludeNamespace String 需要排除的namespace可以多个,用分隔号分割,例如A,B
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:kube-system
    ExcludeLabels Array of String 需要排除的pod标签信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["key1=value1"]
    CustomLabels Array of String metadata信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["key1=value1","key2=value2"]

    ContainerStdoutInfo

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

    被如下接口引用:CreateConfigExtra, DescribeConfigExtras, ModifyConfigExtra。

    名称 类型 必选 描述
    AllContainers Boolean 是否所有容器
    示例值:true / false
    Container String container为空表所有的,不为空采集指定的容器
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    Namespace String namespace可以多个,用分隔号分割,例如A,B;为空或者没有这个字段,表示所有namespace
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:kube-system
    IncludeLabels Array of String pod标签信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["key1=value1"]
    WorkLoads Array of ContainerWorkLoadInfo 工作负载信息
    注意:此字段可能返回 null,表示取不到有效值。
    ExcludeNamespace String 需要排除的namespace可以多个,用分隔号分割,例如A,B
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:kube-system
    ExcludeLabels Array of String 需要排除的pod标签信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["key1=value1"]
    CustomLabels Array of String metadata信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["key1=value1","key2=value2"]

    ContainerWorkLoadInfo

    自建k8s-工作负载信息

    被如下接口引用:CreateConfigExtra, ModifyConfigExtra。

    名称 类型 必选 描述
    Kind String 工作负载的类型
    示例值:daemonset
    Name String 工作负载的名称
    示例值:tke-log-agent
    Container String 容器名
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    Namespace String 命名空间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:kube-system

    ContentInfo

    投递日志的内容格式配置

    被如下接口引用:CreateShipper, DescribeShippers, ModifyShipper。

    名称 类型 必选 描述
    Format String 内容格式,支持json、csv
    示例值:json
    Csv CsvInfo csv格式内容描述
    注意:此字段可能返回 null,表示取不到有效值。
    Json JsonInfo json格式内容描述
    注意:此字段可能返回 null,表示取不到有效值。
    Parquet ParquetInfo parquet格式内容描述
    注意:此字段可能返回 null,表示取不到有效值。

    CosRechargeInfo

    cos导入配置信息

    被如下接口引用:DescribeCosRecharges。

    名称 类型 描述
    Id String COS导入配置ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:03efb75a-0f89-41b0-8cc6-90xxxxxxxxx
    TopicId String 日志主题ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:03efb75a-0f89-41b0-8cc6-90xxxxxxxxx
    LogsetId String 日志集ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:03efb75a-0f89-41b0-8cc6-90xxxxxxxxx
    Name String COS导入任务名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:xxx任务导入
    Bucket String COS存储桶
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:bucket1
    BucketRegion String COS存储桶所在地域
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ap-guangzhou
    Prefix String COS文件所在文件夹的前缀
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:/var/test
    LogType String 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表单行全文;
    默认为minimalist_log
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:minimalist_log
    Status Integer 状态 status 0: 已创建, 1: 运行中, 2: 已停止, 3: 已完成, 4: 运行失败。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    Enable Integer 是否启用: 0: 未启用 , 1:启用
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    CreateTime String 创建时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2021-11-08 14:40:22
    UpdateTime String 更新时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2021-11-08 14:40:22
    Progress Integer 进度条百分值
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Compress String supported: "", "gzip", "lzop", "snappy”; 默认空
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:gzip
    ExtractRuleInfo ExtractRuleInfo 见: ExtractRuleInfo 结构描述
    注意:此字段可能返回 null,表示取不到有效值。
    TaskType Integer COS导入任务类型。1:一次性导入任务;2:持续性导入任务。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    Metadata Array of String 元数据。支持 bucket,object。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["bucket","object"]

    CsvInfo

    csv内容描述

    被如下接口引用:CreateShipper, DescribeShippers, ModifyShipper。

    名称 类型 必选 描述
    PrintKey Boolean csv首行是否打印key
    示例值:true
    Keys Array of String 每列key的名字
    注意:此字段可能返回 null,表示取不到有效值。
    Delimiter String 各字段间的分隔符
    EscapeChar String 若字段内容中包含分隔符,则使用该转义符包裹改字段,只能填写单引号、双引号、空字符串
    NonExistingField String 对于上面指定的不存在字段使用该内容填充

    DashboardInfo

    仪表盘信息

    被如下接口引用:DescribeDashboards。

    名称 类型 描述
    DashboardId String 仪表盘id
    示例值:xxxxx--xxx
    DashboardName String 仪表盘名字
    示例值:testname
    Data String 仪表盘数据
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:testdata
    CreateTime String 创建仪表盘的时间
    AssumerUin Integer AssumerUin非空则表示创建该日志主题的服务方Uin
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:123456
    RoleName String RoleName非空则表示创建该日志主题的服务方使用的角色
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:CLB_QcsRole
    AssumerName String AssumerName非空则表示创建该日志主题的服务方名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:test
    Tags Array of Tag 日志主题绑定的标签信息
    注意:此字段可能返回 null,表示取不到有效值。
    DashboardRegion String 仪表盘所在地域: 为了兼容老的地域。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ap-beijing
    UpdateTime String 修改仪表盘的时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2021-12-22 16:11:27
    DashboardTopicInfos Array of DashboardTopicInfo 仪表盘对应的topic相关信息
    注意:此字段可能返回 null,表示取不到有效值。

    DashboardNoticeMode

    仪表盘订阅通知方式

    被如下接口引用:CreateDashboardSubscribe, ModifyDashboardSubscribe, SearchDashboardSubscribe。

    名称 类型 必选 描述
    ReceiverType String 仪表盘通知方式。

  • Uin:腾讯云用户

  • Group:腾讯云用户组

  • Email:自定义Email

  • WeCom: 企业微信回调
    示例值:Email
  • Values Array of String 知方式对应的值。

  • 当ReceiverType不是 Wecom 时,Values必填。
    示例值:["168053","12345"]
  • ReceiverChannels Array of String 仪表盘通知渠道。

  • 支持:["Email","Sms","WeChat","Phone"]。

  • 当ReceiverType是 Email 或 Wecom 时,ReceiverChannels不能赋值。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["Email","Sms","WeChat","Phone"]
  • Url String 回调Url。

  • 当ReceiverType是 Wecom 时,Url必填。

  • 当ReceiverType不是 Wecom 时,Url不能填写。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:http://xxx
  • DashboardSubscribeData

    仪表盘订阅相关数据

    被如下接口引用:CreateDashboardSubscribe, ModifyDashboardSubscribe, SearchDashboardSubscribe。

    名称 类型 必选 描述
    NoticeModes Array of DashboardNoticeMode 仪表盘订阅通知方式。
    DashboardTime Array of String 仪表盘订阅时间,为空标识取仪表盘默认的时间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["now-5m","now"]
    TemplateVariables Array of DashboardTemplateVariable 仪表盘订阅模板变量。
    注意:此字段可能返回 null,表示取不到有效值。
    Timezone String 时区。参考:https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#SHANGHAI
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:Asia/Shanghai
    SubscribeLanguage String 语言。 zh 中文、en`英文。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:zh
    JumpDomain String 调用链接域名。http:// 或者 https:// 开头,不能/结尾
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:https://console.cloud.tencent.com
    JumpUrl String 自定义跳转链接。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:https://www.xxx.com/getxxx

    DashboardTemplateVariable

    仪表盘订阅模板变量

    被如下接口引用:CreateDashboardSubscribe, ModifyDashboardSubscribe, SearchDashboardSubscribe。

    名称 类型 必选 描述
    Key String key的值
    示例值:TopicId
    Values Array of String key对应的values取值values
    示例值:["xxxx-xxxx-xxxx-xxxx","123414-12341234-12345-3456"]

    DashboardTopicInfo

    仪表盘关联的topic信息

    被如下接口引用:DescribeDashboards。

    名称 类型 必选 描述
    TopicId String 主题id
    示例值:xxxx
    Region String topic所在的地域
    示例值:ap-guangzhou

    DataTransformResouceInfo

    数据加工的资源信息

    被如下接口引用:CheckFunction, CreateDataTransform, DescribeDataTransformInfo, ModifyDataTransform。

    名称 类型 必选 描述
    TopicId String 目标主题id
    示例值:topic-xx
    Alias String 别名
    示例值:topicname

    DataTransformTaskInfo

    数据加工任务基本详情

    被如下接口引用:DescribeDataTransformInfo。

    名称 类型 描述
    Name String 数据加工任务名称
    示例值:test_name
    TaskId String 数据加工任务id
    示例值:96562452-58da-458c-9d2b-0b94e379c917
    EnableFlag Integer 任务启用状态,默认为1,正常开启, 2关闭
    示例值:1
    Type Integer 加工任务类型,1: DSL, 2:SQL
    示例值:1
    SrcTopicId String 源日志主题
    示例值:c6404313-dc28-402c-970d-9654afd08b1f
    Status Integer 当前加工任务状态(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以及别名
    示例值:{"dst_topics":[{"topic_id":"xxx", "alias":"topic"}]}
    EtlContent String 加工逻辑函数。
    示例值:fields_set(\"111\",\"111\")
    DataTransformType Integer 数据加工类型。0:标准加工任务;1:前置加工任务。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    KeepFailureLog Integer 保留失败日志状态。 1:不保留,2:保留
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    FailureLogKey String 失败日志的字段名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ETLParseFailure

    DeliverConfig

    投递配置入参

    被如下接口引用:CreateAlarmNotice, DescribeAlarmNotices, ModifyAlarmNotice。

    名称 类型 必选 描述
    Region String 地域信息。

    示例:
    ap-guangzhou 广州地域;
    ap-nanjing 南京地域。

    详细信息请查看官网:

    https://cloud.tencent.com/document/product/614/18940
    示例值:ap-guangzhou
    TopicId String 日志主题ID。
    示例值:12312324-asdfa-13513-66254
    Scope Integer 投递数据范围。

    0: 全部日志, 包括告警策略日常周期执行的所有日志,也包括告警策略变更产生的日志,默认值

    1:仅告警触发及恢复日志
    示例值:0

    DynamicIndex

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

    被如下接口引用:CreateIndex, DescribeIndex, ModifyIndex。

    名称 类型 必选 描述
    Status Boolean 键值索引自动配置开关
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:false

    EscalateNoticeInfo

    升级通知

    被如下接口引用:CreateAlarmNotice, ModifyAlarmNotice。

    名称 类型 必选 描述
    NoticeReceivers Array of NoticeReceiver 告警通知模板接收者信息。
    WebCallbacks Array of WebCallback 告警通知模板回调信息。
    Escalate Boolean 告警升级开关。true:开启告警升级、false:关闭告警升级,默认:false
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:false
    Interval Integer 告警升级间隔。单位:分钟,范围[1,14400]
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:5
    Type Integer 升级条件。1:无人认领且未恢复、2:未恢复,默认为1
    - 无人认领且未恢复:告警没有恢复并且没有人认领则升级
    - 未恢复:当前告警持续未恢复则升级

    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    EscalateNotice EscalateNoticeInfo 告警升级后下一个环节的通知渠道配置,最多可配置5个环节。
    注意:此字段可能返回 null,表示取不到有效值。

    EventLog

    Windows事件日志采集配置

    被如下接口引用:CreateConfig, CreateConfigExtra, CreateCosRecharge, DescribeCosRecharges, ModifyConfig, ModifyConfigExtra, ModifyCosRecharge。

    名称 类型 必选 描述
    EventChannel String 事件通道,支持Application,Security,Setup,System,ALL

    示例值:Application
    TimeType Integer 时间类型,1:用户自定义,2:当前时间
    示例值:1
    Timestamp Integer 时间,用户选择自定义时间类型时,需要指定时间
    示例值:12345675
    EventIDs Array of String 事件ID过滤列表

    ExcludePathInfo

    黑名单path信息

    被如下接口引用:CreateConfig, CreateConfigExtra, DescribeConfigExtras, DescribeConfigs, DescribeMachineGroupConfigs, ModifyConfig, ModifyConfigExtra。

    名称 类型 必选 描述
    Type String 类型,选填File或Path
    Value String Type对应的具体内容

    ExportInfo

    日志导出信息

    被如下接口引用:DescribeExports。

    名称 类型 描述
    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 Integer 日志文件大小
    示例值:0
    Order String 日志导出时间排序
    示例值:desc
    Format String 日志导出格式
    示例值:json
    Count Integer 日志导出数量
    示例值:100
    Status String 日志下载状态。Processing:导出正在进行中,Completed:导出完成,Failed:导出失败,Expired:日志导出已过期(三天有效期), Queuing 排队中
    示例值:Expired
    From Integer 日志导出起始时间
    示例值:1607499207000
    To Integer 日志导出结束时间
    示例值:1607499208000
    CosPath String 日志导出路径,有效期一个小时,请尽快使用该路径下载。
    示例值:""
    CreateTime String 日志导出创建时间
    示例值:2020-08-08 12:12:12
    SyntaxRule Integer 语法规则。 默认值为0。
    0:Lucene语法,1:CQL语法。
    示例值:1
    DerivedFields Array of String 导出字段
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["timestamp","a","b"]

    ExtractRuleInfo

    日志提取规则

    被如下接口引用:CreateConfig, CreateConfigExtra, CreateCosRecharge, DescribeConfigExtras, DescribeConfigs, DescribeCosRecharges, DescribeMachineGroupConfigs, ModifyConfig, ModifyConfigExtra, ModifyCosRecharge。

    名称 类型 必选 描述
    TimeKey String 时间字段的key名字,TikeKey和TimeFormat必须成对出现
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:test
    TimeFormat String 时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:YYDDWW
    Delimiter String 分隔符类型日志的分隔符,只有LogType为delimiter_log时有效
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:,
    LogRegex String 整条日志匹配规则,只有LogType为fullregex_log时有效
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:\w
    BeginRegex String 行首匹配规则,只有LogType为multiline_log或fullregex_log时有效
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:\w
    Keys Array of String 取的每个字段的key名字,为空的key代表丢弃这个字段,只有LogType为delimiter_log时有效,json_log的日志使用json本身的key。限制100个。
    注意:此字段可能返回 null,表示取不到有效值。
    FilterKeyRegex Array of KeyRegexInfo 日志过滤规则列表(旧版),需要过滤日志的key,及其对应的regex。
    注意:2.9.3及以上版本LogListener ,建议使用AdvanceFilterRules配置日志过滤规则。

    注意:此字段可能返回 null,表示取不到有效值。
    UnMatchUpLoadSwitch Boolean 解析失败日志是否上传,true表示上传,false表示不上传
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
    UnMatchLogKey String 失败日志的key,当UnMatchUpLoadSwitch为true时必填
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:testlog
    Backtracking Integer 增量采集模式下的回溯数据量,默认:-1(全量采集);其他非负数表示增量采集(从最新的位置,往前采集${Backtracking}字节(Byte)的日志)最大支持1073741824(1G)。
    注意:
    - COS导入不支持此字段。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:-1
    IsGBK Integer 是否为Gbk编码。 0:否;1:是。
    注意
    - 目前取0值时,表示UTF-8编码
    - COS导入不支持此字段。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    JsonStandard Integer 是否为标准json。 0:否; 1:是。
    - 标准json指采集器使用业界标准开源解析器进行json解析,非标json指采集器使用CLS自研json解析器进行解析,两种解析器没有本质区别,建议客户使用标准json进行解析。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Protocol String syslog传输协议,取值为tcp或者udp,只有在LogType为service_syslog时生效,其余类型无需填写。
    注意:
    - 该字段适用于:创建采集规则配置、修改采集规则配置。
    - COS导入不支持此字段。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:tcp
    Address String syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port],只有在LogType为service_syslog时生效,其余类型无需填写。
    注意:
    - 该字段适用于:创建采集规则配置、修改采集规则配置。
    - COS导入不支持此字段。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:127.0.0.1:9000
    ParseProtocol String rfc3164:指定系统日志采集使用RFC3164协议解析日志。
    rfc5424:指定系统日志采集使用RFC5424协议解析日志。
    auto:自动匹配rfc3164或者rfc5424其中一种协议。
    只有在LogType为service_syslog时生效,其余类型无需填写。
    注意:
    - 该字段适用于:创建采集规则配置、修改采集规则配置
    - COS导入不支持此字段。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:RFC3164
    MetadataType Integer 元数据类型。0: 不使用元数据信息;1:使用机器组元数据;2:使用用户自定义元数据;3:使用采集配置路径。
    注意:
    - COS导入不支持此字段。
    示例值:0
    PathRegex String 采集配置路径正则表达式。
    注意:
    - MetadataType为3时必填。
    - COS导入不支持此字段。
    注意:此字段可能返回 null,表示取不到有效值。
    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)不支持此字段。
    注意:此字段可能返回 null,表示取不到有效值。

    FilePathInfo

    文件路径信息

    被如下接口引用:CreateConfigExtra, ModifyConfigExtra。

    名称 类型 必选 描述
    Path String 文件路径
    示例值:/log
    File String 文件名称
    示例值:test.log

    Filter

    过滤器

    被如下接口引用:DescribeAlarmNotices, DescribeAlarmShields, DescribeAlarms, DescribeAlertRecordHistory, DescribeCloudProductLogTasks, DescribeConfigExtras, DescribeConfigs, DescribeDashboardSubscribes, DescribeDashboards, DescribeDataTransformInfo, DescribeLogsets, DescribeMachineGroups, DescribeMachines, DescribeNoticeContents, DescribeScheduledSqlInfo, DescribeShippers, DescribeTopics。

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

    FilterRuleInfo

    投递日志的过滤规则

    被如下接口引用:CreateShipper, DescribeShippers, ModifyShipper。

    名称 类型 必选 描述
    Key String 过滤规则Key
    示例值:testKey
    Regex String 过滤规则
    示例值:/w
    Value String 过滤规则Value
    示例值:testValue

    FullTextInfo

    全文索引配置

    被如下接口引用:CreateIndex, DescribeIndex, ModifyIndex。

    名称 类型 必选 描述
    CaseSensitive Boolean 是否大小写敏感
    示例值:false
    Tokenizer String 全文索引的分词符,其中的每个字符代表一个分词符;
    仅支持英文符号、\n\t\r及转义符\;
    注意:\n\t\r本身已被转义,直接使用双引号包裹即可作为入参,无需再次转义。使用API Explorer进行调试时请使用JSON参数输入方式,以避免\n\t\r被重复转义
    示例值:@&?|#()='",;:<>[]{}/ \n\t\r\
    ContainZH Boolean 是否包含中文
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:false

    GroupTriggerConditionInfo

    分组触发条件

    被如下接口引用:DescribeAlertRecordHistory。

    名称 类型 描述
    Key String 分组触发字段名称
    示例值:$1.count
    Value String 分组触发字段值
    示例值:100

    HighLightItem

    日志内容高亮描述信息

    被如下接口引用:DescribeLogContext。

    名称 类型 描述
    Key String 高亮的日志Key
    Values Array of String 高亮的语法

    HistogramInfo

    直方图详细信息

    被如下接口引用:DescribeLogHistogram。

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

    HostFileInfo

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

    被如下接口引用:CreateConfigExtra, DescribeConfigExtras, ModifyConfigExtra。

    名称 类型 必选 描述
    LogPath String 日志文件夹
    示例值:/xxx/xxx
    FilePattern String 日志文件名
    示例值:**.log
    CustomLabels Array of String metadata信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["key1=value1","key2=value2"]

    JsonInfo

    JSON类型描述

    被如下接口引用:CreateShipper, DescribeShippers, ModifyShipper。

    名称 类型 必选 描述
    EnableTag Boolean 启用标志
    示例值:true
    MetaFields Array of String 元数据信息列表, 可选值为 SOURCEFILENAMETIMESTAMPHOSTNAME
    注意:此字段可能返回 null,表示取不到有效值。
    JsonType Integer 投递Json格式,0:字符串方式投递;1:以结构化方式投递
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1

    KafkaConsumerContent

    kafka协议消费内容

    被如下接口引用:DescribeKafkaConsumer, ModifyKafkaConsumer, OpenKafkaConsumer。

    名称 类型 必选 描述
    Format Integer 消费数据格式。 0:原始内容;1:JSON。
    示例值:1
    EnableTag Boolean 是否投递 TAG 信息
    Format为0时,此字段不需要赋值
    示例值:false
    MetaFields Array of String 元数据信息列表, 可选值为:__SOURCE__、__FILENAME__
    、__TIMESTAMP__、__HOSTNAME__、__PKGID__
    Format为0时,此字段不需要赋值
    示例值:["__HOSTNAME__"]
    TagTransaction Integer 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"}
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    JsonType Integer 消费数据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

    KafkaProtocolInfo

    Kafka访问协议

    被如下接口引用:CheckRechargeKafkaServer, CreateKafkaRecharge, DescribeKafkaRecharges, ModifyKafkaRecharge, PreviewKafkaRecharge。

    名称 类型 必选 描述
    Protocol String 协议类型,支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl,此协议会进行连接加密同时需要用户认证。
    入参必填
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:sasl_plaintext
    Mechanism String 加密类型,支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。
    当Protocol为sasl_plaintext或sasl_ssl时必填
    注意:此字段可能返回 null,表示取不到有效值。
    UserName String 用户名。
    当Protocol为sasl_plaintext或sasl_ssl时必填
    注意:此字段可能返回 null,表示取不到有效值。
    Password String 用户密码。
    当Protocol为sasl_plaintext或sasl_ssl时必填
    注意:此字段可能返回 null,表示取不到有效值。

    KafkaRechargeInfo

    Kafka导入配置信息

    被如下接口引用:DescribeKafkaRecharges。

    名称 类型 描述
    Id String Kafka数据订阅配置的ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:86076b49-1234-4321-ab09-a5d7e7972825
    TopicId String 日志主题ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:957f4aed-1234-4321-b98b-c3c806f9e71b
    Name String Kafka导入任务名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:xxx任务导入
    KafkaType Integer 导入Kafka类型,0: 腾讯云CKafka,1: 用户自建Kafka
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    KafkaInstance String 腾讯云CKafka实例ID,KafkaType为0时必填
    注意:此字段可能返回 null,表示取不到有效值。
    ServerAddr String 服务地址
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:kafkaconsumer-ap-chongqing.aaa.com:1234
    IsEncryptionAddr Boolean ServerAddr是否为加密连接
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
    Protocol KafkaProtocolInfo 加密访问协议,IsEncryptionAddr参数为true时必填
    UserKafkaTopics String 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1256238147-f3061593-cd5b-4321-1234-3ba507d43301
    ConsumerGroupName String 用户Kafka消费组名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:cls-xxxxx
    Status Integer 状态 ,1:运行中;2:暂停。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    Offset Integer 导入数据位置,-2:最早(默认),-1:最晚
    注意:此字段可能返回 null,表示取不到有效值。
    CreateTime String 创建时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2021-11-08 14:40:22
    UpdateTime String 更新时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2021-11-08 14:40:22
    LogRechargeRule LogRechargeRuleInfo 日志导入规则
    注意:此字段可能返回 null,表示取不到有效值。

    KeyRegexInfo

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

    被如下接口引用:CreateConfig, CreateConfigExtra, CreateCosRecharge, DescribeCosRecharges, ModifyConfig, ModifyConfigExtra, ModifyCosRecharge。

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

    KeyValueInfo

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

    被如下接口引用:CreateIndex, DescribeIndex, ModifyIndex。

    名称 类型 必选 描述
    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
    Value ValueInfo 字段的索引描述信息

    LogContextInfo

    日志上下文信息

    被如下接口引用:DescribeLogContext。

    名称 类型 描述
    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 Integer 日志包内一条日志的序号
    示例值:196609
    BTime Integer 日志时间戳
    示例值:2021-04-25 14:25:00.000
    HostName String 日志来源主机名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:hostName-1
    RawLog String 原始日志(仅在日志创建索引异常时有值)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:{"content":"test"}
    IndexStatus String 日志创建索引异常原因(仅在日志创建索引异常时有值)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:IndexAllFail:fields like 'a' and 'a.b' can not appear in the same topic
    HighLights Array of HighLightItem 日志内容的高亮描述信息
    注意:此字段可能返回 null,表示取不到有效值。

    LogInfo

    日志结果信息

    被如下接口引用:GetAlarmLog, SearchLog。

    名称 类型 描述
    Time Integer 日志时间,单位ms
    示例值:1619162953000
    TopicId String 日志主题ID
    示例值:4463e7b0-3ec8-41a1-ae48-5d24b22167c2
    TopicName String 日志主题名称
    示例值:test
    Source String 日志来源IP
    示例值:10.0.0.1
    FileName String 日志文件名称
    示例值:/test/access.log
    PkgId String 日志上报请求包的ID
    示例值:0
    PkgLogId String 请求包内日志的ID
    示例值:0
    LogJson String 日志内容的Json序列化字符串
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:{\"content\":\"test\"}
    HostName String 日志来源主机名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:hostName-1
    RawLog String 原始日志(仅在日志创建索引异常时有值)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:{\"content\":\"test\"}
    IndexStatus String 日志创建索引异常原因(仅在日志创建索引异常时有值)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:IndexAllFail:fields like 'a' and 'a.b' can not appear in the same topic

    LogItem

    日志中的KV对

    被如下接口引用:GetAlarmLog, SearchLog。

    名称 类型 描述
    Key String 日志Key
    Value String 日志Value

    LogItems

    LogItem的数组

    被如下接口引用:GetAlarmLog, SearchLog。

    名称 类型 描述
    Data Array of LogItem 分析结果返回的KV数据对

    LogRechargeRuleInfo

    日志导入规则

    被如下接口引用:CreateKafkaRecharge, DescribeKafkaRecharges, ModifyKafkaRecharge, PreviewKafkaRecharge。

    名称 类型 必选 描述
    RechargeType String 导入类型,支持json_log:json格式日志,minimalist_log: 单行全文,fullregex_log: 单行完全正则
    示例值:json_log
    EncodingFormat Integer 解析编码格式,0: UTF-8(默认值),1: GBK
    示例值:0
    DefaultTimeSwitch Boolean 使用默认时间,true:开启(默认值), flase:关闭
    示例值:true
    LogRegex String 整条日志匹配规则,只有RechargeType为fullregex_log时有效
    注意:此字段可能返回 null,表示取不到有效值。
    UnMatchLogSwitch Boolean 解析失败日志是否上传,true表示上传,false表示不上传
    示例值:true
    UnMatchLogKey String 解析失败日志的键名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:LogParseFailure
    UnMatchLogTimeSrc Integer 解析失败日志时间来源,0: 系统当前时间,1: Kafka消息时间戳
    注意:此字段可能返回 null,表示取不到有效值。
    DefaultTimeSrc Integer 默认时间来源,0: 系统当前时间,1: Kafka消息时间戳
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    TimeKey String 时间字段
    注意:此字段可能返回 null,表示取不到有效值。
    TimeRegex String 时间提取正则表达式
    注意:此字段可能返回 null,表示取不到有效值。
    TimeFormat String 时间字段格式
    注意:此字段可能返回 null,表示取不到有效值。
    TimeZone String 时间字段时区
    注意:此字段可能返回 null,表示取不到有效值。
    Metadata Array of String 元数据信息,Kafka导入支持kafka_topic,kafka_partition,kafka_offset,kafka_timestamp
    注意:此字段可能返回 null,表示取不到有效值。
    Keys Array of String 日志Key列表,RechargeType为full_regex_log时必填
    注意:此字段可能返回 null,表示取不到有效值。

    LogsetInfo

    日志集相关信息

    被如下接口引用:DescribeLogsets。

    名称 类型 描述
    LogsetId String 日志集ID
    示例值:4463e7b0-3ec8-41a1-ae48-5d24b22167c2
    LogsetName String 日志集名称
    示例值:test
    CreateTime String 创建时间
    示例值:2021-04-01 08:00:00
    AssumerName String 云产品标识,日志集由其它云产品创建时,该字段会显示云产品名称,例如CDN、TKE
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:TCB
    Tags Array of Tag 日志集绑定的标签
    注意:此字段可能返回 null,表示取不到有效值。
    TopicCount Integer 日志集下日志主题的数目
    示例值:10
    RoleName String 若AssumerName非空,则表示创建该日志集的服务方角色
    示例值:TCB_QcsRole

    MachineGroupInfo

    机器组信息

    被如下接口引用:DescribeConfigMachineGroups, DescribeMachineGroups。

    名称 类型 描述
    GroupId String 机器组ID
    示例值:559d015f-fac7-43cd-ad6e-3c4523fe8767
    GroupName String 机器组名称
    示例值:test
    MachineGroupType MachineGroupTypeInfo 机器组类型
    CreateTime String 创建时间
    示例值:2021-03-05 00:40:22
    Tags Array of Tag 机器组绑定的标签列表
    注意:此字段可能返回 null,表示取不到有效值。
    AutoUpdate String 是否开启机器组自动更新
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"true"
    UpdateStartTime String 升级开始时间,建议业务低峰期升级LogListener
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"12:00:00"
    UpdateEndTime String 升级结束时间,建议业务低峰期升级LogListener
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"13:00:00"
    ServiceLogging Boolean 是否开启服务日志,用于记录因Loglistener 服务自身产生的log,开启后,会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business,不产生计费
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
    DelayCleanupTime Integer 机器组中机器离线定期清理时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:30
    MetaTags Array of MetaTagInfo 机器组元数据信息列表
    OSType Integer 操作系统类型,0: Linux,1: windows
    示例值:0

    MachineGroupTypeInfo

    机器组类型描述

    被如下接口引用:AddMachineGroupInfo, CreateMachineGroup, DeleteMachineGroupInfo, DescribeConfigMachineGroups, DescribeMachineGroups, ModifyMachineGroup。

    名称 类型 必选 描述
    Type String 机器组类型。支持 ip 和 label。
    - ip:表示该机器组Values中存的是采集机器的ip地址
    - label:表示该机器组Values中存储的是机器的标签
    Values Array of String 机器描述列表。

    MachineInfo

    机器状态信息

    被如下接口引用:DescribeMachines。

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

    MetaTagInfo

    元数据信息

    被如下接口引用:CreateConfig, CreateConfigExtra, CreateCosRecharge, CreateMachineGroup, DescribeConfigMachineGroups, DescribeCosRecharges, DescribeMachineGroups, ModifyConfig, ModifyConfigExtra, ModifyCosRecharge, ModifyMachineGroup。

    名称 类型 必选 描述
    Key String 元数据key
    示例值:test
    Value String 元数据value
    示例值:test

    MetricLabel

    过滤器

    被如下接口引用:CreateScheduledSql, DescribeScheduledSqlInfo, ModifyScheduledSql。

    名称 类型 必选 描述
    Key String 指标名称
    注意:此字段可能返回 null,表示取不到有效值。
    Value String 指标内容
    注意:此字段可能返回 null,表示取不到有效值。

    MonitorTime

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

    被如下接口引用:CreateAlarm, DescribeAlarms, ModifyAlarm。

    名称 类型 必选 描述
    Type String 执行周期, 可选值:PeriodFixedCron

    - Period:固定频率
    - Fixed:固定时间
    - Cron:Cron表达式
    Time Integer 执行的周期,或者定制执行的时间节点。单位为分钟,取值范围为1~1440。
    当type为Period,Fixed时,time字段生效。
    CronExpression String 执行的周期cron表达式。示例:"*/1 * * * *" 从左到右每个field的含义 Minutes field, Hours field,Day of month field,Month field,Day of week field, 不支持秒级别。
    当type为Cron时,CronExpression字段生效。
    注意:此字段可能返回 null,表示取不到有效值。

    MultiCondition

    多触发条件。

    被如下接口引用:CreateAlarm, DescribeAlarms, ModifyAlarm。

    名称 类型 必选 描述
    Condition String 触发条件。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:$1.count > 10
    AlarmLevel Integer 告警级别。0:警告(Warn); 1:提醒(Info); 2:紧急 (Critical)。
  • 不填则默认为0。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
  • MultiTopicSearchInformation

    多日志主题检索相关信息

    被如下接口引用:SearchLog。

    名称 类型 必选 描述
    TopicId String 要检索分析的日志主题ID
    示例值:682d0718-07bb-4ec0-xxxx-f1e9a2767e0b
    Context String 透传上次接口返回的Context值,可获取后续更多日志,总计最多可获取1万条原始日志,过期时间1小时
    示例值:Y29udGV4dC04MjMzNWRkMi01YmMxLTQ4NGYtYjQ4MS04MDg0NzAwYjQ1NDUxNjcy

    NoticeContent

    通知内容模板详细配置

    被如下接口引用:CreateNoticeContent, DescribeNoticeContents, ModifyNoticeContent。

    名称 类型 必选 描述
    Type String 渠道类型

    Email:邮件;Sms:短信;WeChat:微信;Phone:电话;WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调;
    示例值:"Email"
    TriggerContent NoticeContentInfo 告警触发通知内容模板。
    注意:此字段可能返回 null,表示取不到有效值。
    RecoveryContent NoticeContentInfo 告警恢复通知内容模板。
    注意:此字段可能返回 null,表示取不到有效值。

    NoticeContentInfo

    通知模板内容

    被如下接口引用:CreateNoticeContent, DescribeNoticeContents, ModifyNoticeContent。

    名称 类型 必选 描述
    Title String 通知内容模板标题信息。
    部分通知渠道类型不支持“标题”,请参照腾讯云控制台页面。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:这是标题。
    Content String 通知内容模板正文信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:这是正文。
    Headers Array of String 请求头(Request Headers):在HTTP请求中,请求头包含了客户端向服务器发送的附加信息,如用户代理、授权凭证、期望的响应格式等。
    仅“自定义回调”支持该配置。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["Content-Type:application/json"]

    NoticeContentTemplate

    通知内容模板信息

    被如下接口引用:DescribeNoticeContents。

    名称 类型 描述
    NoticeContentId String 通知内容模板ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:noticetempalte-qwer-asdf-zxcv
    Name String 通知内容模板名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:这个是名称
    Type Integer 语言类型。

    0: 中文
    1: 英文
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    NoticeContents Array of NoticeContent 通知内容模板信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Flag Integer 通知内容模板标记。

    0: 用户自定义
    1: 系统内置
    注意:此字段可能返回 null,表示取不到有效值。
    Uin Integer 创建者主账号。
    注意:此字段可能返回 null,表示取不到有效值。
    SubUin Integer 创建/修改者子账号。
    注意:此字段可能返回 null,表示取不到有效值。
    CreateTime Integer 创建时间 秒级时间戳。
    注意:此字段可能返回 null,表示取不到有效值。
    UpdateTime Integer 更新时间 秒级时间戳。
    注意:此字段可能返回 null,表示取不到有效值。

    NoticeReceiver

    告警通知接收者信息

    被如下接口引用:CreateAlarmNotice, DescribeAlarmNotices, ModifyAlarmNotice。

    名称 类型 必选 描述
    ReceiverType String 接受者类型。可选值:
    - Uin - 用户ID
    - Group - 用户组ID
    暂不支持其余接收者类型。
    示例值:Group
    ReceiverIds Array of Integer 接收者。
    当ReceiverType为Uin时,ReceiverIds的值为用户uid。子用户信息查询
    当ReceiverType为Group时,ReceiverIds的值为用户组id。CAM用户组
    示例值:[1234,2345]
    ReceiverChannels Array of String 通知接收渠道。
    - Email - 邮件
    - Sms - 短信
    - WeChat - 微信
    - Phone - 电话
    示例值:['Sms']
    NoticeContentId String 通知内容模板ID,使用Default-zh引用默认模板(中文),使用Default-en引用DefaultTemplate(English)。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1"
    StartTime String 允许接收信息的开始时间。格式:15:04:05。必填
    示例值:00:00:00
    EndTime String 允许接收信息的结束时间。格式:15:04:05。必填
    示例值:23:59:59
    Index Integer 位序。

    - 入参时无效。
    - 出参时有效。
    示例值:1

    NoticeRule

    通知规则

    被如下接口引用:CreateAlarmNotice, DescribeAlarmNotices, ModifyAlarmNotice。

    名称 类型 必选 描述
    Rule String 匹配规则 JSON串。
    rule规则树格式为嵌套结构体JSON字符串
    {"Value":"AND","Type":"Operation","Children":[{"Value":"OR","Type":"Operation","Children":[{"Type":"Condition","Value":"Level","Children":[{"Value":"In","Type":"Compare"},{"Value":"[1,0]","Type":"Value"}]},{"Type":"Condition","Value":"Level","Children":[{"Value":"NotIn","Type":"Compare"},{"Value":"[2]","Type":"Value"}]}]}]}

    rule规则树限制规则如下
    - 顶层rule中Type可取值:ConditionOperation
    - Type为Operation的子节点支持的Type可取值:ConditionOperation
    - Type为Condition的子节点支持的Type可取值:StringCompareArrayTimeRangeValueKey
    - 其他Type无子节点
    - 当rule Type为Operation时,value可取值:ANDOR
    - 当rule Type为Condition时,value不可为空,子节点个数不能小于2
    - 当子节点Type为 Compare 时,value可取值:><>=<==!=BetweenNotBetween=~!=~InNotIn
    - value为BetweenNotBetween时,下一个子节点value必须是长度为2的数组
    - value为=~!=~时,下一个子节点value必须是一个正则表达式
    - value为InNotIn时, 下一个子节点value必须是一个数组

    业务参数含义
    - Type:Condition 表示是规则条件,Value:Level 表示告警等级
    - 子节点Type支持Compare,Value支持InNotIn
    - 下一个子节点value支持的值:0(警告),1(提醒),2 (紧急)
    以下示例表示:告警等级属于提醒
    {\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Level\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]}]}

    - Type:Condition 表示是规则条件,Value:NotifyType 表示通知类型
    - 子节点Type支持Compare,Value支持InNotIn
    - 下一个子节点value支持的值:1(告警通知),2 (恢复通知)
    以下示例表示:通知类型属于告警通知或通知类型不属于恢复通知
    {\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"NotIn\",\"Type\":\"Compare\"},{\"Value\":\"[2]\",\"Type\":\"Value\"}]}]}]}

    - Type:Condition 表示是规则条件,Value:AlarmID 表示告警策略
    - 子节点Type支持Compare,Value支持InNotIn
    - 下一个子节点value支持的值:告警策略id数组
    以下示例表示:告警策略属于alarm-53af048c-254b-4c73-bb48-xxx,alarm-6dfa8bc5-08da-4d64-b6cb-xxx或告警策略不属于alarm-1036314c-1e49-4cee-a8fb-xxx
    "{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"AlarmID\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"alarm-53af048c-254b-4c73-bb48-xxx\\\",\\\"alarm-6dfa8bc5-08da-4d64-b6cb-xxx\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmID\",\"Children\":[{\"Value\":\"NotIn\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"alarm-1036314c-1e49-4cee-a8fb-xxx\\\"]\",\"Type\":\"Value\"}]}]}]}"

    - Type:Condition 表示是规则条件,Value:AlarmName 表示告警策略名称
    - 子节点Type支持Compare,Value支持=~!=~
    - 下一个子节点value支持的值:必须是正则表达式
    以下示例表示:告警策略名称正则匹配^test$或告警策略名称正则不匹配^hahaha$
    {\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"AlarmName\",\"Children\":[{\"Value\":\"=~\",\"Type\":\"Compare\"},{\"Value\":\"^test$\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmName\",\"Children\":[{\"Value\":\"!=~\",\"Type\":\"Compare\"},{\"Value\":\"^hahaha$\",\"Type\":\"Value\"}]}]}]}

    - Type:Condition 表示是规则条件,Value:Label 表示告警分类字段
    - 子节点Type支持Compare,Value支持InNotIn=~!=~
    - 下一个子节点value支持的值:InNotIn 时value是数组,=~!=~时value是正则表达式
    以下示例表示:告警分类字段key1属于v1或告警分类字段key2不属于v2或告警分类字段key3正则匹配^test$或告警分类字段key4正则不匹配^hahaha$
    {\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key1\",\"Type\":\"Key\"},{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"v1\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key2\",\"Type\":\"Key\"},{\"Value\":\"NotIn\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"v2\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key3\",\"Type\":\"Key\"},{\"Value\":\"=~\",\"Type\":\"Compare\"},{\"Value\":\"^test$\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key4\",\"Type\":\"Key\"},{\"Value\":\"!=~\",\"Type\":\"Compare\"},{\"Value\":\"^hahaha$\",\"Type\":\"Value\"}]}]}]}

    - Type:Condition 表示是规则条件,Value:NotifyTime 表示通知时间
    - 子节点Type支持Compare,Value支持BetweenNotBetween
    - 下一个子节点value支持的值:长度为2,格式为14:20:36的字符串数组
    以下示例表示:通知时间在指定范围内14:18:36至14:33:36或通知时间不在指定范围内14:20:36至14:30:36
    {\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyTime\",\"Children\":[{\"Value\":\"Between\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"14:18:36\\\",\\\"14:33:36\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"NotifyTime\",\"Children\":[{\"Value\":\"NotBetween\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"14:20:36\\\",\\\"14:30:36\\\"]\",\"Type\":\"Value\"}]}]}]}

    - Type:Condition 表示是规则条件,Value:Duration 表示告警持续时间
    - 子节点Type支持Compare,Value支持><>=<=
    - 下一个子节点value支持的值:整型值单位分钟
    以下示例表示:告警持续时间大于1分钟或告警持续时间大于等于2分钟或告警持续时间小于3分钟或告警持续时间小于等于4分钟
    {\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\">\",\"Type\":\"Compare\"},{\"Value\":1,\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\">=\",\"Type\":\"Compare\"},{\"Value\":2,\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\"<\",\"Type\":\"Compare\"},{\"Value\":3,\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\"<=\",\"Type\":\"Compare\"},{\"Value\":4,\"Type\":\"Value\"}]}]}]}
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:{"Value":"AND","Type":"Operation","Children":[{"Type":"Condition","Value":"NotifyType","Children":[{"Value":"In","Type":"Compare"},{"Value":"[1,2]","Type":"Value"}]}]}
    NoticeReceivers Array of NoticeReceiver 告警通知接收者信息。
    注意:此字段可能返回 null,表示取不到有效值。
    WebCallbacks Array of WebCallback 告警通知模板回调信息,包括企业微信、钉钉、飞书。
    注意:此字段可能返回 null,表示取不到有效值。
    Escalate Boolean 告警升级开关。true:开启告警升级、false:关闭告警升级,默认:false
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:false
    Type Integer 告警升级条件。1:无人认领且未恢复、2:未恢复,默认为1
    - 无人认领且未恢复:告警没有恢复并且没有人认领则升级
    - 未恢复:当前告警持续未恢复则升级

    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    Interval Integer 告警升级间隔。单位:分钟,范围[1,14400]
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    EscalateNotice EscalateNoticeInfo 告警升级后下一个环节的通知渠道配置
    注意:此字段可能返回 null,表示取不到有效值。

    ParquetInfo

    Parquet内容

    被如下接口引用:CreateShipper, DescribeShippers, ModifyShipper。

    名称 类型 必选 描述
    ParquetKeyInfo Array of ParquetKeyInfo ParquetKeyInfo数组

    ParquetKeyInfo

    Parquet内容描述

    被如下接口引用:CreateShipper, DescribeShippers, ModifyShipper。

    名称 类型 必选 描述
    KeyName String 键值名称
    示例值:content
    KeyType String 数据类型,目前支持6种类型:string、boolean、int32、int64、float、double
    示例值:string
    KeyNonExistingField String 解析失败赋值信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""

    PartitionInfo

    日志主题分区信息

    被如下接口引用:DescribePartitions, MergePartition, SplitPartition。

    名称 类型 描述
    PartitionId Integer 分区ID
    Status String 分区的状态(readwrite或者是readonly)
    InclusiveBeginKey String 分区哈希键起始key
    ExclusiveEndKey String 分区哈希键结束key
    CreateTime String 分区创建时间
    LastWriteTime String 只读分区数据停止写入时间
    注意:此字段可能返回 null,表示取不到有效值。

    PreviewLogStatistic

    预览数据详情

    被如下接口引用:CreateDataTransform。

    名称 类型 必选 描述
    LogContent String 日志内容
    示例值:{"AgentStartTime":"6557160","AvailConnNum":"1","AvgReqSize":"0","ConfigMinVer":"1715073167340919","CpuMax":"0","CpuUsage":"5","DirMax":"5000","FileMax":"15000","IP":"9.135.76.114","InstanceId":"loglistener-24bf21cb-0327-fc1d-be4e-5e056dadxxx","Label":"","LogConfigCnt":"5000","MemMax":"2097152000","MemoryUsed":"66678784","MonitorDirs":"4","MonitorFiles":"0","OpenFiles":"0","ParseFailureLogCount":"0","QueueSize":"0","ReadEventCnt":"188","ResendCnt":"0","SendAvgCost":"0","SendFailureLogCount":"0","SendFailureLogSize":"0","SendFailureReqs":"0","SendSuccessLogCount":"0","SendSuccessLogSize":"0","SendSuccessReqs":"0","SendTimeoutLogCount":"0","SendTimeoutLogSize":"0","SendTimeoutReqs":"0","Status":"22","TotalFinishRsps":"0","TotalParseLogCount":"0","TotalSendLogCount":"0","TotalSendLogSize":"0","TotalSendReqs":"0","TotalSuccessFromStart":"0","Version":"2.9.0","FILENAME":"status","SOURCE":"9.135.76.114"}
    LineNum Integer 行号。从0开始
    示例值:0
    DstTopicId String 目标日志主题
    示例值:4c216645-01f2-414d-8a87-719b97baxxx
    FailReason String 失败错误信息, 空字符串""表示正常
    示例值:error
    Time String 日志时间,格式:2024-05-07 17:13:17.105

    - 入参时无效
    - 出参时有效,为日志中的时间格式
    示例值:2024-05-07 17:13:17.105

    RuleInfo

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

    被如下接口引用:CreateIndex, DescribeIndex, ModifyIndex。

    名称 类型 必选 描述
    FullText FullTextInfo 全文索引配置, 为空时代表未开启全文索引
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:空
    KeyValue RuleKeyValueInfo 键值索引配置,为空时代表未开启键值索引
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:空
    Tag RuleTagInfo 元字段索引配置,为空时代表未开启元字段索引
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:空
    DynamicIndex DynamicIndex 键值索引自动配置,为空时代表未开启该功能。
    启用后自动将日志内的字段添加到键值索引中,包括日志中后续新增的字段。
    注意:此字段可能返回 null,表示取不到有效值。

    RuleKeyValueInfo

    键值索引配置

    被如下接口引用:CreateIndex, DescribeIndex, ModifyIndex。

    名称 类型 必选 描述
    CaseSensitive Boolean 是否大小写敏感
    示例值:false
    KeyValues Array of KeyValueInfo 需要建立索引的键值对信息
    示例值:空

    RuleTagInfo

    元字段索引配置

    被如下接口引用:CreateIndex, DescribeIndex, ModifyIndex。

    名称 类型 必选 描述
    CaseSensitive Boolean 是否大小写敏感
    KeyValues Array of KeyValueInfo 元字段索引配置中的字段信息

    ScheduledSqlResouceInfo

    ScheduledSql的资源信息

    被如下接口引用:CreateScheduledSql, DescribeScheduledSqlInfo, ModifyScheduledSql。

    名称 类型 必选 描述
    TopicId String 目标主题id
    示例值:xxxxxxxx-0889-4ec0-accc-xxxxxxx
    Region String 主题的地域信息
    示例值:ap-guangzhou
    BizType Integer 主题类型:0为日志主题,1为指标主题
    示例值:0
    MetricName String 指标名称。当BizType为1时,MetricName需要填写
    示例值: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 字节
    示例值:[{"Key":"region","Value":"gz"},{"Key":"service","Value":"cgi"}]

    ScheduledSqlTaskInfo

    ScheduledSql任务详情

    被如下接口引用:DescribeScheduledSqlInfo。

    名称 类型 描述
    TaskId String ScheduledSql任务id
    示例值:6ef60bec-0242-43af-bb20-270359fb5xxx
    Name String ScheduledSql任务名称
    示例值:task
    SrcTopicId String 源日志主题id
    示例值:5237e8f4-0889-4ec0-accc-xxxxxxx
    SrcTopicName String 源日志主题名称
    示例值:test-topic
    DstResource ScheduledSqlResouceInfo 定时SQL分析目标主题
    CreateTime String 任务创建时间
    示例值:2023-07-28 11:36:00
    UpdateTime String 任务更新时间
    示例值:2023-07-28 11:36:00
    Status Integer 任务状态,1:运行 2:停止 3:异常-找不到源日志主题 4:异常-找不到目标主题

    5: 访问权限问题 6:内部故障 7:其他故障
    示例值:2
    EnableFlag Integer 任务启用状态,1开启, 2关闭
    示例值:1
    ScheduledSqlContent String 查询语句
    示例值:* | select count(*)
    ProcessStartTime String 调度开始时间
    示例值:2023-07-28 11:36:00
    ProcessType Integer 调度类型,1:持续运行 2:指定时间范围
    示例值:1
    ProcessEndTime String 调度结束时间,当process_type=2时为必传字段
    示例值:2023-07-28 11:36:00
    ProcessPeriod Integer 调度周期(分钟)
    示例值:5
    ProcessTimeWindow String 查询的时间窗口. @m-15m, @m,意为近15分钟
    示例值:@m-15m, @m
    ProcessDelay Integer 执行延迟(秒)
    示例值:5
    SrcTopicRegion String 源topicId的地域信息
    示例值:ap-guangzhou
    SyntaxRule Integer 语法规则,0:Lucene语法,1:CQL语法
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    HasServicesLog Integer 是否开启投递服务日志。1:关闭,2:开启。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1

    SearchLogErrors

    多日志主题检索错误信息

    被如下接口引用:SearchLog。

    名称 类型 描述
    TopicId String 日志主题ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:682d0718-07bb-4ec0-xxxx-f1e9a2767e0b
    ErrorMsg String 错误信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:SyntaxError [field: xxx, can not search on this field, since it is not indexed]
    ErrorCodeStr String 错误码
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:FailedOperation.QueryError

    SearchLogInfos

    多日志主题检索topic信息

    被如下接口引用:SearchLog。

    名称 类型 描述
    TopicId String 日志主题ID
    示例值:682d0718-07bb-xxxx-9fda-f1e9a2767e0b
    Period Integer 日志存储生命周期
    示例值:30
    Context String 透传本次接口返回的Context值,可获取后续更多日志,过期时间1小时
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:Y29udGV4dC04MjMzNWRkMi01YmMxLTQ4NGYtYjQ4MS04MDg0NzAwYjQ1NDUxNjcy

    SearchLogTopics

    多主题检索返回信息

    被如下接口引用:SearchLog。

    名称 类型 描述
    Errors Array of SearchLogErrors 多日志主题检索对应的错误信息
    注意:此字段可能返回 null,表示取不到有效值。
    Infos Array of SearchLogInfos 多日志主题检索各日志主题信息
    注意:此字段可能返回 null,表示取不到有效值。

    ShipperInfo

    投递规则

    被如下接口引用:DescribeShippers。

    名称 类型 描述
    ShipperId String 投递规则ID
    示例值:57f5808c-4a55-11eb-b378-0242ac130002
    TopicId String 日志主题ID
    示例值:57f5808c-4a55-11eb-b378-0242ac130002
    Bucket String 投递的bucket地址
    Prefix String 投递的前缀目录
    ShipperName String 投递规则的名字
    示例值:testShipper
    Interval Integer 投递的时间间隔,单位 秒
    示例值:300
    MaxSize Integer 投递的文件的最大值,单位 MB
    示例值:256
    Status Boolean 是否生效
    示例值:true
    FilterRules Array of FilterRuleInfo 投递日志的过滤规则
    注意:此字段可能返回 null,表示取不到有效值。
    Partition String 投递日志的分区规则,支持strftime的时间格式表示
    Compress CompressInfo 投递日志的压缩配置
    注意:此字段可能返回 null,表示取不到有效值。
    Content ContentInfo 投递日志的内容格式配置
    注意:此字段可能返回 null,表示取不到有效值。
    CreateTime String 投递日志的创建时间
    FilenameMode Integer 投递文件命名配置,0:随机数命名,1:投递时间命名,默认0(随机数命名)
    注意:此字段可能返回 null,表示取不到有效值。
    StartTime Integer 投递数据范围的开始时间点
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1670642281
    EndTime Integer 投递数据范围的结束时间点
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Progress Float 历史数据投递的进度(仅当用户选择的数据内中历史数据时才有效)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:5.6
    RemainTime Integer 历史数据全部投递完成剩余的时间(仅当用户选择的数据中有历史数据时才有效)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:23
    HistoryStatus Integer 历史任务状态:
    0:实时任务
    1:任务准备中
    2:任务运行中
    3:任务运行异常
    4:任务运行结束
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    StorageType String cos桶类型
    注意:此字段可能返回 null,表示取不到有效值。

    ShipperTaskInfo

    投递任务信息

    被如下接口引用:DescribeShipperTasks。

    名称 类型 描述
    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 Integer 本批投递的日志的开始时间戳,毫秒
    示例值:978653222
    RangeEnd Integer 本批投递的日志的结束时间戳, 毫秒
    示例值:978653222
    StartTime Integer 本次投递任务的开始时间戳, 毫秒
    示例值:978653222
    EndTime Integer 本次投递任务的结束时间戳, 毫秒
    示例值:978653222
    Status String 本次投递的结果,"success","running","failed"
    示例值:success
    Message String 结果的详细信息
    示例值:success

    Tag

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

    被如下接口引用:CreateAlarm, CreateAlarmNotice, CreateLogset, CreateMachineGroup, CreateTopic, DescribeAlarmNotices, DescribeConfigMachineGroups, DescribeDashboards, DescribeLogsets, DescribeMachineGroups, DescribeTopics, ModifyAlarm, ModifyAlarmNotice, ModifyLogset, ModifyMachineGroup, ModifyTopic。

    名称 类型 必选 描述
    Key String 标签键
    注意:此字段可能返回 null,表示取不到有效值。
    Value String 标签值
    注意:此字段可能返回 null,表示取不到有效值。

    TopicExtendInfo

    日志主题扩展信息

    被如下接口引用:CreateTopic, DescribeTopics, ModifyTopic。

    名称 类型 必选 描述
    AnonymousAccess AnonymousInfo 日志主题免鉴权配置信息
    注意:此字段可能返回 null,表示取不到有效值。

    TopicIdAndRegion

    仪表盘 topic与地域信息

    被如下接口引用:DescribeDashboards。

    名称 类型 必选 描述
    TopicId String 日志主题id
    示例值:xxx-xxx-xxx-xxx
    RegionId Integer 日志主题id所在的地域id。

    id,地域,简称信息如下:
    - 1, 广州,ap-guangzhou
    - 4, 上海,ap-shanghai
    - 5, 中国香港,ap-hongkong
    - 7, 上海金融,ap-shanghai-fsi
    - 8, 北京,ap-beijing
    - 9, 新加坡,ap-singapore
    - 11, 深圳金融,ap-shenzhen-fsi
    - 15, 硅谷,na-siliconvalley
    - 16, 成都,ap-chengdu
    - 17, 法兰克福,eu-frankfurt
    - 18, 首尔,ap-seoul
    - 19, 重庆,ap-chongqing
    - 21, 孟买,ap-mumbai
    - 22, 弗吉尼亚,na-ashburn
    - 23, 曼谷,ap-bangkok
    - 25, 东京,ap-tokyo
    - 33, 南京,ap-nanjing
    - 46, 北京金融,ap-beijing-fsi
    - 72, 雅加达,ap-jakarta
    - 74, 圣保罗,sa-saopaulo
    示例值:19

    TopicInfo

    主题基本信息

    被如下接口引用:DescribeTopics。

    名称 类型 描述
    LogsetId String 日志集ID
    示例值:57f5808c-4a55-11eb-b378-0242ac130002
    TopicId String 主题ID
    示例值:57f5808c-4a55-11eb-b378-0242ac130002
    TopicName String 主题名称
    示例值:test
    PartitionCount Integer 主题分区个数
    示例值:1
    Index Boolean 主题是否开启索引(主题类型需为日志主题)
    示例值:true
    AssumerName String 云产品标识,主题由其它云产品创建时,该字段会显示云产品名称,例如CDN、TKE
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:test
    CreateTime String 创建时间
    Status Boolean 主题是否开启采集,true:开启采集;false:关闭采集。
    创建日志主题时默认开启,可通过SDK调用ModifyTopic修改此字段。
    控制台目前不支持修改此参数。
    示例值:true
    Tags Array of Tag 主题绑定的标签信息
    注意:此字段可能返回 null,表示取不到有效值。
    AutoSplit Boolean 该主题是否开启自动分裂
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
    MaxSplitPartitions Integer 若开启自动分裂的话,该主题能够允许的最大分区数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:50
    StorageType String 主题的存储类型

    - hot: 标准存储
    - cold: 低频存储
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:hot
    Period Integer 生命周期,单位天,可取值范围1~3600。取值为3640时代表永久保存
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:30
    SubAssumerName String 云产品二级标识,日志主题由其它云产品创建时,该字段会显示云产品名称及其日志类型的二级分类,例如TKE-Audit、TKE-Event。部分云产品仅有云产品标识(AssumerName),无该字段。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:TKE-Audio
    Describes String 主题描述
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:xx部门xx业务topic
    HotPeriod Integer 开启日志沉降,标准存储的生命周期, hotPeriod < Period。
    标准存储为 hotPeriod, 低频存储则为 Period-hotPeriod。(主题类型需为日志主题)
    HotPeriod=0为没有开启日志沉降。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    BizType Integer 主题类型。
    - 0: 日志主题
    - 1: 指标主题
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    IsWebTracking Boolean 免鉴权开关。 false:关闭; true:开启。
    开启后将支持指定操作匿名访问该日志主题。详情请参见日志主题
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:false
    Extends TopicExtendInfo 日志主题扩展信息
    注意:此字段可能返回 null,表示取不到有效值。
    TopicAsyncTaskID String 异步迁移任务ID
    注意:此字段可能返回 null,表示取不到有效值。
    MigrationStatus Integer 异步迁移状态
    注意:此字段可能返回 null,表示取不到有效值。
    EffectiveDate String 异步迁移完成后,预计生效日期
    注意:此字段可能返回 null,表示取不到有效值。

    ValueInfo

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

    被如下接口引用:CreateIndex, DescribeIndex, ModifyIndex。

    名称 类型 必选 描述
    Type String 字段类型,目前支持的类型有:long、text、double
    示例值:long
    Tokenizer String 字段的分词符,其中的每个字符代表一个分词符;
    仅支持英文符号、\n\t\r及转义符\;
    long及double类型字段需为空;
    注意:\n\t\r本身已被转义,直接使用双引号包裹即可作为入参,无需再次转义。使用API Explorer进行调试时请使用JSON参数输入方式,以避免\n\t\r被重复转义
    示例值:.*
    SqlFlag Boolean 字段是否开启分析功能
    示例值:true
    ContainZH Boolean 是否包含中文,long及double类型字段需为false
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:false

    WebCallback

    回调地址

    被如下接口引用:CreateAlarmNotice, DescribeAlarmNotices, ModifyAlarmNotice。

    名称 类型 必选 描述
    CallbackType String 回调的类型。可选值:
    - Http
    - WeCom
    - DingTalk
    - Lark
    示例值:WeCom
    Url String 回调地址,最大支持1024个字节。
    也可使用WebCallbackId引用集成配置中的URL,此时该字段请填写为空字符串。
    示例值:https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=4c3cf1e0-a6e7-47f4-b264-5d2kjnbhjgx
    WebCallbackId String 集成配置ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"webcallback-aaa-bbb-ccc-ddd"
    Method String 回调方法。可选值:
    - POST(默认值)
    - PUT

    注意:
    - 参数CallbackType为Http时为必选,其它回调方式无需填写。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:POST
    NoticeContentId String 通知内容模板ID,使用Default-zh引用默认模板(中文),使用Default-en引用DefaultTemplate(English)。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1"
    RemindType Integer 提醒类型。

    0:不提醒;1:指定人;2:所有人
    注意:此字段可能返回 null,表示取不到有效值。
    Mobiles Array of String 电话列表。
    注意:此字段可能返回 null,表示取不到有效值。
    UserIds Array of String 用户ID列表。
    注意:此字段可能返回 null,表示取不到有效值。
    Headers Array of String 该参数已废弃,请使用NoticeContentId。
    注意:此字段可能返回 null,表示取不到有效值。
    Body String 该参数已废弃,请使用NoticeContentId。
    注意:此字段可能返回 null,表示取不到有效值。
    Index Integer 序号。
    - 入参无效。
    - 出参有效。
    示例值:1