{ "name": "cls", "display_name": "日志服务", "description": "用户可以使用本文档介绍的 API 对日志服务进行相关操作，如创建日志主题、上报日志、检索日志等，具体支持的操作可参见 API 概览。", "domain": "monitor", "api_version": "2020-10-16", "endpoint": "cls.tencentcloudapi.com", "actions": [ { "name": "AddMachineGroupInfo", "description": "用于添加机器组信息", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "机器组Id - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。", "example": "57f5808c-4a55-11eb-b378-0242ac130002" }, { "name": "MachineGroupType", "type": "object", "required": true, "description": "机器组类型 目前type支持 ip 和 label", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "机器组类型。支持 ip 和 label。 - ip：表示该机器组Values中存的是采集机器的ip地址 - label：表示该机器组Values中存储的是机器的标签", "example": "ip" }, { "name": "Values", "type": "array", "required": false, "description": "机器描述列表。", "example": "[10.1.1.1,10.2.2.2]", "item_type": "string" } ] } ], "required": [ "GroupId", "MachineGroupType" ] }, { "name": "ApplyConfigToMachineGroup", "description": "应用采集配置到指定机器组", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "采集配置ID - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。", "example": "3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a" }, { "name": "GroupId", "type": "string", "required": true, "description": "机器组ID - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。", "example": "3581a3be-aa41-423b-995a-54ec84da6264" } ], "required": [ "ConfigId", "GroupId" ] }, { "name": "CancelRebuildIndexTask", "description": "取消重建索引任务", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题ID", "example": "57f5808c-4a55-11eb-b378-0242ac130002" }, { "name": "TaskId", "type": "string", "required": true, "description": "索引重建任务ID", "example": "57f5808c-4a55-11eb-b378-0242ac130002" } ], "required": [ "TopicId", "TaskId" ] }, { "name": "CheckFunction", "description": "本接口用于数据加工DSL函数的语法校验。", "status": "online", "parameters": [ { "name": "EtlContent", "type": "string", "required": true, "description": "加工语句。 当FuncType为2时，EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f) 其他参考文档： - [创建加工任务](https://cloud.tencent.com/document/product/614/63940) - [函数总览](https://cloud.tencent.com/document/product/614/70395)", "example": "fields_set(\"my_field\",\"value\")" }, { "name": "DstResources", "type": "array", "required": false, "description": "加工任务目标topic_id以及别名，当 FuncType 为 1 时，必填。 目标日志主题ID通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "无", "item_type": "object", "children": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题ID通过获取日志主题列表获取日志主题Id。", "example": "abdeace6-9484-4d2e-b670-28289c42b60f" }, { "name": "Alias", "type": "string", "required": false, "description": "别名限制：不能包含字符 |。", "example": "topicname" }, { "name": "IsCrossAccount", "type": "boolean", "required": false, "description": "是否是跨账号主题，false不是跨账号主题，true是跨账号主题默认值：false", "example": "true" }, { "name": "RoleARN", "type": "string", "required": false, "description": "跨账号场景下，被投递账号给投递账号创建的角色ARN值，在被投递账号的角色里查找", "example": "qcs::cam::uin/1234567890:roleName/cls_online_role" }, { "name": "ExternalId", "type": "string", "required": false, "description": "外部ID值，可以在被投递账号的角色-载体里找到该值", "example": "hello123" }, { "name": "TopicName", "type": "string", "required": false, "description": "topic名称", "example": "topic_name_1" }, { "name": "LogsetName", "type": "string", "required": false, "description": "日志集的名称", "example": "logset_name_1" } ] }, { "name": "FuncType", "type": "integer", "required": false, "description": "数据加工目标主题的类型. 1 固定主题 2动态创建", "example": "1" } ], "required": [ "EtlContent" ] }, { "name": "CheckRechargeKafkaServer", "description": "本接口用于校验Kafka服务集群是否可以正常访问", "status": "online", "parameters": [ { "name": "KafkaType", "type": "integer", "required": true, "description": "导入Kafka类型，0: 腾讯云CKafka；1: 用户自建Kafka。", "example": "0" }, { "name": "KafkaInstance", "type": "string", "required": false, "description": "腾讯云CKafka实例ID。 KafkaType为0时，KafkaInstance必填 - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。", "example": "ckafka-5kysm8" }, { "name": "ServerAddr", "type": "string", "required": false, "description": "服务地址。 KafkaType为1时，ServerAddr必填", "example": "192.168.0.1:9095或test.cls.tencentyun.com:9095" }, { "name": "IsEncryptionAddr", "type": "boolean", "required": false, "description": "ServerAddr是否为加密连接，默认值false。当KafkaType为1用户自建kafka时生效。", "example": "true" }, { "name": "Protocol", "type": "object", "required": false, "description": "加密访问协议。KafkaType参数为1并且IsEncryptionAddr参数为true时必填。", "example": "无", "children": [ { "name": "Protocol", "type": "string", "required": false, "description": "协议类型，支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl，此协议会进行连接加密同时需要用户认证。 - 当IsEncryptionAddr为true时，Protocol必填。 - 支持的协议类型如下： - plaintext：纯文本无加密协议 - sasl_ssl：SASL 认证 + SSL 加密 - ssl：纯 SSL/TLS 加密协议 - sasl_plaintext：SASL 认证 + 非加密通道", "example": "sasl_ssl" }, { "name": "Mechanism", "type": "string", "required": false, "description": "加密类型，支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。 - 当Protocol为 `sasl_plaintext` 或 `sasl_ssl` 时 Mechanism 必填。 - 支持加密类型如下 - PLAIN：明文认证 - SCRAM-SHA-256：基于挑战-响应机制，使用PBKDF2-HMAC-SHA256算法 - SCRAM-SHA-512：增强版SCRAM，使用PBKDF2-HMAC-SHA512算法", "example": "PLAIN" }, { "name": "UserName", "type": "string", "required": false, "description": "用户名。 当Protocol为sasl_plaintext或sasl_ssl时必填", "example": "name" }, { "name": "Password", "type": "string", "required": false, "description": "用户密码。 当Protocol为sasl_plaintext或sasl_ssl时必填", "example": "axxxxxx" } ] }, { "name": "UserKafkaMeta", "type": "object", "required": false, "description": "用户kafka拓展信息", "example": "无", "children": [ { "name": "KafkaVersion", "type": "string", "required": true, "description": "用户kafka version 支持如下版本： - 0.10.2.0 - 1.0.0 - 2.0.0 - 2.2.0 - 2.4.0 - 2.6.0 - 2.7.0 - 2.8.0 - 3.0.0 - 3.2.0", "example": "2.0.0" } ] } ], "required": [ "KafkaType" ] }, { "name": "CloseKafkaConsumer", "description": "关闭Kafka协议消费", "status": "online", "parameters": [ { "name": "FromTopicId", "type": "string", "required": true, "description": "日志主题Id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。", "example": "57f5808c-4a55-11eb-b378-0242ac130002" } ], "required": [ "FromTopicId" ] }, { "name": "CommitConsumerOffsets", "description": "提交消费点位", "status": "online", "parameters": [ { "name": "ConsumerGroup", "type": "string", "required": true, "description": "消费组标识", "example": "无" }, { "name": "Consumer", "type": "string", "required": true, "description": "消费机器名称", "example": "无" }, { "name": "LogsetId", "type": "string", "required": true, "description": "日志集id", "example": "无" }, { "name": "TopicPartitionOffsetsInfo", "type": "array", "required": true, "description": "topic分区点位信息", "example": "无", "item_type": "object", "children": [ { "name": "TopicID", "type": "string", "required": true, "description": "日志主题id 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "PartitionOffsets", "type": "array", "required": true, "description": "分区点位信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "PartitionId", "type": "integer", "required": true, "description": "分区id 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Offset", "type": "integer", "required": false, "description": "offset点位 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] } ] } ], "required": [ "ConsumerGroup", "Consumer", "LogsetId", "TopicPartitionOffsetsInfo" ] }, { "name": "CreateAlarm", "description": "本接口用于创建告警策略。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "告警策略名称。最大支持255个字节。 不支持 \u0026#39;|\u0026#39;。", "example": "p1-业务告警" }, { "name": "AlarmTargets", "type": "array", "required": true, "description": "监控对象列表。", "example": "无", "item_type": "object", "children": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID", "example": "380fe1f1-0c7b-4b0d-xxxx-d514959db1bb" }, { "name": "Query", "type": "string", "required": true, "description": "查询语句。", "example": "code:200 | select count(*) as success_counts" }, { "name": "Number", "type": "integer", "required": true, "description": "告警对象序号；从1开始递增。", "example": "1" }, { "name": "StartTimeOffset", "type": "integer", "required": true, "description": "查询范围起始时间相对于告警执行时间的偏移，单位为分钟，取值为非正，最大值为0，最小值为-1440。", "example": "0" }, { "name": "EndTimeOffset", "type": "integer", "required": true, "description": "查询范围终止时间相对于告警执行时间的偏移，单位为分钟，取值为非正，须大于StartTimeOffset，最大值为0，最小值为-1440。", "example": "0" }, { "name": "LogsetId", "type": "string", "required": true, "description": "日志集ID。通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志集ID", "example": "1c072db7-2cfd-4418-xxxx-7342c7a42516" }, { "name": "SyntaxRule", "type": "integer", "required": false, "description": "检索语法规则，默认值为0。 0：Lucene语法，1：CQL语法。 详细说明参见检索条件语法规则", "example": "1" } ] }, { "name": "MonitorTime", "type": "object", "required": true, "description": "监控任务运行时间点。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "执行周期， 可选值：`Period`、`Fixed`、`Cron`。 - Period：固定频率 - Fixed：固定时间 - Cron：Cron表达式", "example": "Period" }, { "name": "Time", "type": "integer", "required": false, "description": "执行的周期，或者定制执行的时间节点。单位为分钟，取值范围为1~1440。 当type为`Period`,`Fixed`时，time字段生效。", "example": "1" }, { "name": "CronExpression", "type": "string", "required": false, "description": "执行的周期cron表达式。示例：`\"*/1 * * * *\"` 从左到右每个field的含义 Minutes field(分钟), Hours field(小时),Day of month field(日期),Month field(月份),Day of week field(星期)， 不支持秒级别。 当type为`Cron`时，CronExpression字段生效。", "example": "*/1 * * * *" } ] }, { "name": "TriggerCount", "type": "integer", "required": true, "description": "持续周期。持续满足触发条件TriggerCount个周期后，再进行告警；最小值为1，最大值为2000。", "example": "1" }, { "name": "AlarmPeriod", "type": "integer", "required": true, "description": "告警重复的周期，单位是分钟。取值范围是0~1440。", "example": "0" }, { "name": "Condition", "type": "string", "required": false, "description": "告警发送通知的触发条件 注意: Condition和AlarmLevel是一组配置，MultiConditions是另一组配置，2组配置互斥。", "example": "$1.count \u003e 10" }, { "name": "AlarmLevel", "type": "integer", "required": false, "description": "告警级别0:警告(Warn); 1:提醒(Info); 2:紧急 (Critical)。注意: 不填则默认为0。Condition和AlarmLevel是一组配置，MultiConditions是另一组配置，2组配置互斥。", "example": "0" }, { "name": "MultiConditions", "type": "array", "required": false, "description": "多触发条件 注意: Condition和AlarmLevel是一组配置，MultiConditions是另一组配置，2组配置互斥。", "example": "无", "item_type": "object", "children": [ { "name": "Condition", "type": "string", "required": false, "description": "触发条件。", "example": "[$1.__QUERYCOUNT__]\u003e 0" }, { "name": "AlarmLevel", "type": "integer", "required": false, "description": "告警级别。0:警告(Warn); 1:提醒(Info); 2:紧急 (Critical)。 - 不填则默认为0。", "example": "0" } ] }, { "name": "Status", "type": "boolean", "required": false, "description": "是否开启告警策略。默认值为true", "example": "true" }, { "name": "MessageTemplate", "type": "string", "required": false, "description": "用户自定义告警内容", "example": "{{range .AnalysisResult.sync}}\\n\\n集群{{.ClusterID}}中节点失败\\n\\n{{end}}" }, { "name": "CallBack", "type": "object", "required": false, "description": "用户自定义回调", "example": "无", "children": [ { "name": "Body", "type": "string", "required": true, "description": "回调时的Body。 可将各类告警变量放在请求内容中，详见[帮助文档](https://cloud.tencent.com/document/product/614/74718)。 如下示例： ``` { \"TopicId\": \"{{ .QueryLog[0][0].topicId }}\", \"key\": \"{{.Alarm}}\", \"time\": \"{{ .QueryLog[0][0].time }}\", \"log\": \"{{ .QueryLog[0][0].content.__CONTENT__ }}\", \"namespace\": \"{{ .QueryLog[0][0].content.__TAG__.namespace }}\" } ```", "example": "{\"User\":\"{{.User}}\",\"AlarmID\":\"{{.AlarmID}}\",\"AlarmName\":\"{{.AlarmName}}\",\"Condition\":\"{{.Condition}}\"}" }, { "name": "Headers", "type": "array", "required": false, "description": "回调时的HTTP请求头部字段。 例如：下面请求头部字段来告知服务器请求主体的内容类型为JSON。 ``` \"Content-Type: application/json\" ```", "example": "[\"Content-Type: application/json\"]", "item_type": "string" } ] }, { "name": "Analysis", "type": "array", "required": false, "description": "多维分析", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "分析名称", "example": "status 502 pv" }, { "name": "Type", "type": "string", "required": true, "description": "分析类型：query(自定义检索分析)，field(字段TOP5及占比统计) ，original(相关原始日志)", "example": "query" }, { "name": "Content", "type": "string", "required": true, "description": "分析内容", "example": "*|select count(1) as pv where status = 502" }, { "name": "ConfigInfo", "type": "array", "required": false, "description": "多维分析配置。 当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\", // 查不到这个字段也是老...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "键。支持以下key： SyntaxRule：语法规则，value支持 0：Lucene语法；1： CQL语法。 QueryIndex：执行语句序号。value支持 -1：自定义； 1：执行语句1； 2：执行语句2。 CustomQuery：检索语句。 QueryIndex为-1时有效且必填，value示例： \"* | select count(*) as count\"。 Fields：字段。value支持 __SOURCE__；__FILENAME__；__HOSTNAME__；__TIMESTAMP__；__INDEX_STATUS__；__PKG_LOGID__；__TOPIC__。 Format：显示形式。value支持 1：...", "example": "k" }, { "name": "Value", "type": "string", "required": true, "description": "值。 键对应值如下： SyntaxRule：语法规则，value支持 0：Lucene语法；1： CQL语法。 QueryIndex：执行语句序号。value支持 -1：自定义； 1：执行语句1； 2：执行语句2。 CustomQuery：检索语句。 QueryIndex为-1时有效且必填，value示例： \"* | select count(*) as count\"。 Fields：字段。value支持 __SOURCE__；__FILENAME__；__HOSTNAME__；__TIMESTAMP__；__INDEX_STATUS__；__PKG_LOGID__；__TOPIC__。 Format：显示形式。value支持 ...", "example": "v" } ] } ] }, { "name": "GroupTriggerStatus", "type": "boolean", "required": false, "description": "分组触发状态。默认值false", "example": "true" }, { "name": "GroupTriggerCondition", "type": "array", "required": false, "description": "分组触发条件。", "example": "[\"$1.conut\"]", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "标签描述列表，通过指定该参数可以同时绑定标签到相应的告警策略。最大支持10个标签键值对，并且不能有重复的键值对。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "业务A" } ] }, { "name": "MonitorObjectType", "type": "integer", "required": false, "description": "监控对象类型。0:执行语句共用监控对象; 1:每个执行语句单独选择监控对象。不填则默认为0。当值为1时，AlarmTargets元素个数不能超过10个，AlarmTargets中的Number必须是从1开始的连续正整数，不能重复。", "example": "0" }, { "name": "Classifications", "type": "array", "required": false, "description": "告警附加分类信息列表。Classifications元素个数不能超过20个。Classifications元素的Key不能为空，不能重复，长度不能超过50个字符，符合正则 ^[a-z]([a-z0-9_]{0,49})$。Classifications元素的Value长度不能超过200个字符。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "分类键", "example": "key_sample" }, { "name": "Value", "type": "string", "required": true, "description": "分类值", "example": "value_sample" } ] }, { "name": "AlarmNoticeIds", "type": "array", "required": false, "description": "关联的日志服务告警通知渠道组列表。-通过获取通知渠道组列表获取关联的告警通知渠道组列表，和MonitorNotice互斥", "example": "[\"notice-b02af159-f67b-44c3-877c-a55343f874c3\"]", "item_type": "string" }, { "name": "MonitorNotice", "type": "object", "required": false, "description": "关联的可观测平台通知模板，与 AlarmNoticeIds 参数互斥，不能同时使用", "example": "无", "children": [ { "name": "Notices", "type": "array", "required": false, "description": "以数组的形式提供MonitorNoticeRule", "example": "无", "item_type": "object", "children": [ { "name": "NoticeId", "type": "string", "required": false, "description": "腾讯云可观测平台通知模板 ID", "example": "notice-xxx" }, { "name": "ContentTmplId", "type": "string", "required": false, "description": "腾讯云可观测平台内容模板ID，为空时使用默认内容模板 注意：此字段可能返回 null，表示取不到有效值。", "example": "tmpl-xxx" }, { "name": "AlarmLevels", "type": "array", "required": false, "description": "告警级别,0:警告(Warn); 1:提醒(Info); 2:紧急 (Critical)", "example": "[0,1,2]", "item_type": "integer" } ] } ] } ], "required": [ "Name", "AlarmTargets", "MonitorTime", "TriggerCount", "AlarmPeriod" ] }, { "name": "CreateAlarmNotice", "description": "该接口用于创建通知渠道组，提供两种配置模式，二选一： 1，简易模式，提供最基本的通知渠道功能。需填写如下参数： - Type - NoticeReceivers - WebCallbacks 2，高级模式，在简易模式基础上，支持设定规则，为不同类型的告警分别设定通知渠道，并支持告警升级功能。需填写如下参数： - NoticeRules", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "通知渠道组名称。最大支持255个字节。 不支持 '|'。", "example": "研发通知渠道组" }, { "name": "Tags", "type": "array", "required": false, "description": "标签描述列表，通过指定该参数可以同时绑定标签到相应的通知渠道组。最大支持50个标签键值对，并且不能有重复的键值对。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "业务A" } ] }, { "name": "Type", "type": "string", "required": false, "description": "【简易模式】（简易模式/告警模式二选一，分别配置相应参数） 需要发送通知的告警类型。可选值： - Trigger - 告警触发 - Recovery - 告警恢复 - All - 告警触发和告警恢复", "example": "All" }, { "name": "NoticeReceivers", "type": "array", "required": false, "description": "【简易模式】（简易模式/告警模式二选一，分别配置相应参数） 通知接收对象。", "example": "无", "item_type": "object", "children": [ { "name": "ReceiverType", "type": "string", "required": true, "description": "接受者类型。可选值： - Uin - 用户ID - Group - 用户组ID 暂不支持其余接收者类型。", "example": "Group" }, { "name": "ReceiverIds", "type": "array", "required": true, "description": "接收者。 当ReceiverType为Uin时，ReceiverIds的值为用户uid。[子用户信息查询](https://cloud.tencent.com/document/api/598/53486) 当ReceiverType为Group时，ReceiverIds的值为用户组id。[CAM用户组](https://cloud.tencent.com/document/product/598/34589)", "example": "[1234,2345]", "item_type": "integer" }, { "name": "ReceiverChannels", "type": "array", "required": true, "description": "通知接收渠道。 - Email - 邮件 - Sms - 短信 - WeChat - 微信 - Phone - 电话", "example": "[\"Sms\"]", "item_type": "string" }, { "name": "NoticeContentId", "type": "string", "required": false, "description": "通知内容模板ID，使用Default-zh引用默认模板（中文），使用Default-en引用DefaultTemplate(English)。-通过[获取通知内容模板](https://cloud.tencent.com/document/product/614/111714)获取通知内容模板ID", "example": "\"noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1\"" }, { "name": "StartTime", "type": "string", "required": false, "description": "允许接收信息的开始时间。格式：`15:04:05`。必填", "example": "00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "允许接收信息的结束时间。格式：`15:04:05`。必填", "example": "23:59:59" }, { "name": "Index", "type": "integer", "required": false, "description": "位序。 - 入参时无效。 - 出参时有效。", "example": "1" } ] }, { "name": "WebCallbacks", "type": "array", "required": false, "description": "【简易模式】（简易模式/告警模式二选一，分别配置相应参数） 接口回调信息（包括企业微信、钉钉、飞书）。", "example": "无", "item_type": "object", "children": [ { "name": "CallbackType", "type": "string", "required": true, "description": "回调的类型。可选值： - Http(自定义接口回调) - WeCom(企业微信) - DingTalk(钉钉) - Lark(飞书)", "example": "WeCom" }, { "name": "Url", "type": "string", "required": true, "description": "回调地址，最大支持1024个字节。 也可使用WebCallbackId引用集成配置中的URL，此时该字段请填写为空字符串。", "example": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=937xxxe47-xxxx-xxxx-a063-216xxxx9226f" }, { "name": "WebCallbackId", "type": "string", "required": false, "description": "集成配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/product/614/115229)获取集成配置ID", "example": "\"webcallback-aaa-bbb-ccc-ddd\"" }, { "name": "Method", "type": "string", "required": false, "description": "回调方法。可选值： - POST（默认值） - PUT 注意： - 参数CallbackType为Http时为必选，其它回调方式无需填写。", "example": "POST" }, { "name": "NoticeContentId", "type": "string", "required": false, "description": "通知内容模板ID，使用Default-zh引用默认模板（中文），使用Default-en引用DefaultTemplate(English)。", "example": "\"noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1\"" }, { "name": "RemindType", "type": "integer", "required": false, "description": "提醒类型。 0：不提醒；1：指定人；2：所有人", "example": "0" }, { "name": "Mobiles", "type": "array", "required": false, "description": "电话列表。", "example": "[\"15111111111\"]", "item_type": "string" }, { "name": "UserIds", "type": "array", "required": false, "description": "用户ID列表。", "example": "[\"11274\"]", "item_type": "string" }, { "name": "Index", "type": "integer", "required": false, "description": "序号。 - 入参无效。 - 出参有效。", "example": "1" } ] }, { "name": "NoticeRules", "type": "array", "required": false, "description": "【高级模式】（简易模式/告警模式二选一，分别配置相应参数） 通知规则。", "example": "无", "item_type": "object", "children": [ { "name": "Rule", "type": "string", "required": false, "description": "匹配规则 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可取值：`Condition`，`Operatio...", "example": "{\\\"Value\\\":\\\"AND\\\",\\\"Type\\\":\\\"Operation\\\",\\\"Children\\\":[{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"NotifyType\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"In\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":\\\"[1,2]\\\",\\\"Type\\\":\\\"Value\\\"}]}]}" }, { "name": "NoticeReceivers", "type": "array", "required": false, "description": "告警通知接收者信息。", "example": "无", "item_type": "object", "children": [ { "name": "ReceiverType", "type": "string", "required": true, "description": "接受者类型。可选值： - Uin - 用户ID - Group - 用户组ID 暂不支持其余接收者类型。", "example": "Group" }, { "name": "ReceiverIds", "type": "array", "required": true, "description": "接收者。 当ReceiverType为Uin时，ReceiverIds的值为用户uid。[子用户信息查询](https://cloud.tencent.com/document/api/598/53486) 当ReceiverType为Group时，ReceiverIds的值为用户组id。[CAM用户组](https://cloud.tencent.com/document/product/598/34589)", "example": "[1234,2345]", "item_type": "integer" }, { "name": "ReceiverChannels", "type": "array", "required": true, "description": "通知接收渠道。 - Email - 邮件 - Sms - 短信 - WeChat - 微信 - Phone - 电话", "example": "[\"Sms\"]", "item_type": "string" }, { "name": "NoticeContentId", "type": "string", "required": false, "description": "通知内容模板ID，使用Default-zh引用默认模板（中文），使用Default-en引用DefaultTemplate(English)。-通过[获取通知内容模板](https://cloud.tencent.com/document/product/614/111714)获取通知内容模板ID", "example": "\"noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1\"" }, { "name": "StartTime", "type": "string", "required": false, "description": "允许接收信息的开始时间。格式：`15:04:05`。必填", "example": "00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "允许接收信息的结束时间。格式：`15:04:05`。必填", "example": "23:59:59" }, { "name": "Index", "type": "integer", "required": false, "description": "位序。 - 入参时无效。 - 出参时有效。", "example": "1" } ] }, { "name": "WebCallbacks", "type": "array", "required": false, "description": "告警通知模板回调信息，包括企业微信、钉钉、飞书。", "example": "无", "item_type": "object", "children": [ { "name": "CallbackType", "type": "string", "required": true, "description": "回调的类型。可选值： - Http(自定义接口回调) - WeCom(企业微信) - DingTalk(钉钉) - Lark(飞书)", "example": "WeCom" }, { "name": "Url", "type": "string", "required": true, "description": "回调地址，最大支持1024个字节。 也可使用WebCallbackId引用集成配置中的URL，此时该字段请填写为空字符串。", "example": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=937xxxe47-xxxx-xxxx-a063-216xxxx9226f" }, { "name": "WebCallbackId", "type": "string", "required": false, "description": "集成配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/product/614/115229)获取集成配置ID", "example": "\"webcallback-aaa-bbb-ccc-ddd\"" }, { "name": "Method", "type": "string", "required": false, "description": "回调方法。可选值： - POST（默认值） - PUT 注意： - 参数CallbackType为Http时为必选，其它回调方式无需填写。", "example": "POST" }, { "name": "NoticeContentId", "type": "string", "required": false, "description": "通知内容模板ID，使用Default-zh引用默认模板（中文），使用Default-en引用DefaultTemplate(English)。", "example": "\"noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1\"" }, { "name": "RemindType", "type": "integer", "required": false, "description": "提醒类型。 0：不提醒；1：指定人；2：所有人", "example": "0" }, { "name": "Mobiles", "type": "array", "required": false, "description": "电话列表。", "example": "[\"15111111111\"]", "item_type": "string" }, { "name": "UserIds", "type": "array", "required": false, "description": "用户ID列表。", "example": "[\"11274\"]", "item_type": "string" }, { "name": "Index", "type": "integer", "required": false, "description": "序号。 - 入参无效。 - 出参有效。", "example": "1" } ] }, { "name": "Escalate", "type": "boolean", "required": false, "description": "告警升级开关。`true`：开启告警升级、`false`：关闭告警升级，默认：false", "example": "false" }, { "name": "Type", "type": "integer", "required": false, "description": "告警升级条件。`1`：无人认领且未恢复、`2`：未恢复，默认为1 - 无人认领且未恢复：告警没有恢复并且没有人认领则升级 - 未恢复：当前告警持续未恢复则升级", "example": "1" }, { "name": "Interval", "type": "integer", "required": false, "description": "告警升级间隔。单位：分钟，范围`[1，14400]`", "example": "1" }, { "name": "EscalateNotice", "type": "object", "required": false, "description": "告警升级后下一个环节的通知渠道配置", "example": "无", "children": [ { "name": "NoticeReceivers", "type": "array", "required": true, "description": "告警通知模板接收者信息。", "example": "无", "item_type": "object", "children": [ { "name": "ReceiverType", "type": "string", "required": true, "description": "接受者类型。可选值： - Uin - 用户ID - Group - 用户组ID 暂不支持其余接收者类型。", "example": "Group" }, { "name": "ReceiverIds", "type": "array", "required": true, "description": "接收者。 当ReceiverType为Uin时，ReceiverIds的值为用户uid。[子用户信息查询](https://cloud.tencent.com/document/api/598/53486) 当ReceiverType为Group时，ReceiverIds的值为用户组id。[CAM用户组](https://cloud.tencent.com/document/product/598/34589)", "example": "[1234,2345]", "item_type": "integer" }, { "name": "ReceiverChannels", "type": "array", "required": true, "description": "通知接收渠道。 - Email - 邮件 - Sms - 短信 - WeChat - 微信 - Phone - 电话", "example": "[\"Sms\"]", "item_type": "string" }, { "name": "NoticeContentId", "type": "string", "required": false, "description": "通知内容模板ID，使用Default-zh引用默认模板（中文），使用Default-en引用DefaultTemplate(English)。-通过[获取通知内容模板](https://cloud.tencent.com/document/product/614/111714)获取通知内容模板ID", "example": "\"noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1\"" }, { "name": "StartTime", "type": "string", "required": false, "description": "允许接收信息的开始时间。格式：`15:04:05`。必填", "example": "00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "允许接收信息的结束时间。格式：`15:04:05`。必填", "example": "23:59:59" }, { "name": "Index", "type": "integer", "required": false, "description": "位序。 - 入参时无效。 - 出参时有效。", "example": "1" } ] }, { "name": "WebCallbacks", "type": "array", "required": true, "description": "告警通知模板回调信息。", "example": "无", "item_type": "object", "children": [ { "name": "CallbackType", "type": "string", "required": true, "description": "回调的类型。可选值： - Http(自定义接口回调) - WeCom(企业微信) - DingTalk(钉钉) - Lark(飞书)", "example": "WeCom" }, { "name": "Url", "type": "string", "required": true, "description": "回调地址，最大支持1024个字节。 也可使用WebCallbackId引用集成配置中的URL，此时该字段请填写为空字符串。", "example": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=937xxxe47-xxxx-xxxx-a063-216xxxx9226f" }, { "name": "WebCallbackId", "type": "string", "required": false, "description": "集成配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/product/614/115229)获取集成配置ID", "example": "\"webcallback-aaa-bbb-ccc-ddd\"" }, { "name": "Method", "type": "string", "required": false, "description": "回调方法。可选值： - POST（默认值） - PUT 注意： - 参数CallbackType为Http时为必选，其它回调方式无需填写。", "example": "POST" }, { "name": "NoticeContentId", "type": "string", "required": false, "description": "通知内容模板ID，使用Default-zh引用默认模板（中文），使用Default-en引用DefaultTemplate(English)。", "example": "\"noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1\"" }, { "name": "RemindType", "type": "integer", "required": false, "description": "提醒类型。 0：不提醒；1：指定人；2：所有人", "example": "0" }, { "name": "Mobiles", "type": "array", "required": false, "description": "电话列表。", "example": "[\"15111111111\"]", "item_type": "string" }, { "name": "UserIds", "type": "array", "required": false, "description": "用户ID列表。", "example": "[\"11274\"]", "item_type": "string" }, { "name": "Index", "type": "integer", "required": false, "description": "序号。 - 入参无效。 - 出参有效。", "example": "1" } ] }, { "name": "Escalate", "type": "boolean", "required": false, "description": "告警升级开关。`true`：开启告警升级、`false`：关闭告警升级，默认：false", "example": "false" }, { "name": "Interval", "type": "integer", "required": false, "description": "告警升级间隔。单位：分钟，范围`[1，14400]`", "example": "5" }, { "name": "Type", "type": "integer", "required": false, "description": "升级条件。`1`：无人认领且未恢复、`2`：未恢复，默认为1 - 无人认领且未恢复：告警没有恢复并且没有人认领则升级 - 未恢复：当前告警持续未恢复则升级", "example": "1" }, { "name": "EscalateNotice", "type": "object", "required": false, "description": "告警升级后下一个环节的通知渠道配置，最多可配置5个环节。", "example": "无", "children": [ { "name": "NoticeReceivers", "type": "array", "required": true, "description": "告警通知模板接收者信息。", "example": "无", "item_type": "string" }, { "name": "WebCallbacks", "type": "array", "required": true, "description": "告警通知模板回调信息。", "example": "无", "item_type": "string" }, { "name": "Escalate", "type": "boolean", "required": false, "description": "告警升级开关。`true`：开启告警升级、`false`：关闭告警升级，默认：false", "example": "false" }, { "name": "Interval", "type": "integer", "required": false, "description": "告警升级间隔。单位：分钟，范围`[1，14400]`", "example": "5" }, { "name": "Type", "type": "integer", "required": false, "description": "升级条件。`1`：无人认领且未恢复、`2`：未恢复，默认为1 - 无人认领且未恢复：告警没有恢复并且没有人认领则升级 - 未恢复：当前告警持续未恢复则升级", "example": "1" }, { "name": "EscalateNotice", "type": "object", "required": false, "description": "告警升级后下一个环节的通知渠道配置，最多可配置5个环节。", "example": "无" } ] } ] } ] }, { "name": "JumpDomain", "type": "string", "required": false, "description": "查询数据链接。http:// 或者 https:// 开头，不能/结尾", "example": "https://console.cloud.tencent.com" }, { "name": "DeliverStatus", "type": "integer", "required": false, "description": "投递日志开关。可取值如下： 1：关闭（默认值）； 2：开启 投递日志开关开启时， DeliverConfig参数必填。", "example": "2" }, { "name": "DeliverConfig", "type": "object", "required": false, "description": "投递日志配置参数。当DeliverStatus开启时，必填。", "example": "无", "children": [ { "name": "Region", "type": "string", "required": true, "description": "地域信息。 示例： ap-guangzhou 广州地域； ap-nanjing 南京地域。 详细信息请查看官网[地域和访问域名](https://cloud.tencent.com/document/product/614/18940)", "example": "ap-guangzhou" }, { "name": "TopicId", "type": "string", "required": true, "description": "日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID", "example": "17312724-asdfa-13513-66254" }, { "name": "Scope", "type": "integer", "required": true, "description": "投递数据范围。 0: 全部日志, 包括告警策略日常周期执行的所有日志，也包括告警策略变更产生的日志，默认值 1:仅告警触发及恢复日志", "example": "0" } ] }, { "name": "AlarmShieldStatus", "type": "integer", "required": false, "description": "免登录操作告警开关。可取值如下： - 1：关闭 - 2：开启（默认值）", "example": "1" }, { "name": "CallbackPrioritize", "type": "boolean", "required": false, "description": "统一设定自定义回调参数。 - true: 使用通知内容模板中的自定义回调参数覆盖告警策略中单独配置的请求头及请求内容。 - false:优先使用告警策略中单独配置的请求头及请求内容。", "example": "true" } ], "required": [ "Name" ] }, { "name": "CreateAlarmShield", "description": "该接口用于创建告警屏蔽规则。", "status": "online", "parameters": [ { "name": "AlarmNoticeId", "type": "string", "required": true, "description": "通知渠道组id。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取通知渠道组id", "example": "notice-bb42f112-xxxx-476e-b3c4-ff5472911b42" }, { "name": "StartTime", "type": "integer", "required": true, "description": "屏蔽规则开始时间，秒级(s)时间戳。", "example": "1701872657" }, { "name": "EndTime", "type": "integer", "required": true, "description": "屏蔽规则结束时间，秒级(s)时间戳。结束时间需要大于当前时间", "example": "1701883657" }, { "name": "Type", "type": "integer", "required": true, "description": "屏蔽类型。1：屏蔽所有通知，2：按照Rule参数屏蔽匹配规则的通知。", "example": "2" }, { "name": "Reason", "type": "string", "required": true, "description": "屏蔽原因。", "example": "屏蔽原因" }, { "name": "Rule", "type": "string", "required": false, "description": "屏蔽规则，当Type为2时必填。规则填写方式详见[产品文档](https://cloud.tencent.com/document/product/614/103178#rule)。", "example": "{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Level\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmID\"}]}" } ], "required": [ "AlarmNoticeId", "StartTime", "EndTime", "Type", "Reason" ] }, { "name": "CreateCloudProductLogCollection", "description": "内部云产品接入使用相关接口", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID - 通过各个接入云产品官方文档获取", "example": "ins-r8hrxxx" }, { "name": "AssumerName", "type": "string", "required": true, "description": "云产品标识，支持枚举：CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS", "example": "CDB" }, { "name": "LogType", "type": "string", "required": true, "description": "日志类型，支持枚举：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", "example": "CDB-AUDIT" }, { "name": "CloudProductRegion", "type": "string", "required": true, "description": "云产品地域。 不同日志类型(LogType)地域入参格式存在差异， 请参考如下示例： - CDS所有日志类型：ap-guangzhou - CDB-AUDIT: gz - TDSQL-C-AUDIT: gz - MongoDB-AUDIT: gz - MongoDB-SlowLog：ap-guangzhou - MongoDB-ErrorLog：ap-guangzhou - TDMYSQL-SLOW：gz - DCDB所有日志类型：gz - MariaDB所有日志类型：gz - PostgreSQL所有日志类型：gz - BH所有日志类型：overseas-polaris(中国香港地区和其他)/fsi-polaris(金融区)/general-polaris(普\ufffd...", "example": "ap-guangzhou" }, { "name": "ClsRegion", "type": "string", "required": true, "description": "CLS目标地域 - 支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档", "example": "ap-guangzhou" }, { "name": "LogsetName", "type": "string", "required": false, "description": "日志集名称，未填LogsetId时必填。若日志集不存在, 将自动创建", "example": "logset" }, { "name": "TopicName", "type": "string", "required": false, "description": "日志主题名称，在未填TopicId时必填。 若日志主题不存在，将自动创建", "example": "topic" }, { "name": "Extend", "type": "string", "required": false, "description": "日志配置扩展信息， 一般用于存储额外的日志投递配置", "example": "{\"ServiceName\":[\"HDFS\",\"KNOX\",\"YARN\",\"ZOOKEEPER\"],\"Policy\":0}" }, { "name": "LogsetId", "type": "string", "required": false, "description": "日志集id - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。", "example": "92cdd6d4-da98-4a6e-9494-175b44338680" }, { "name": "TopicId", "type": "string", "required": false, "description": "日志主题id - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "92cdd6d4-da98-4a6e-" } ], "required": [ "InstanceId", "AssumerName", "LogType", "CloudProductRegion", "ClsRegion" ] }, { "name": "CreateConfig", "description": "创建采集规则配置", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "采集配置名称 - 名称种不得包含特殊字符｜ - 名称最长255字符，超过截断", "example": "testname" }, { "name": "Output", "type": "string", "required": true, "description": "采集配置所属日志主题ID即TopicId - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "f948972f-a063-408c-a59f-8c3230bddaf6" }, { "name": "Path", "type": "string", "required": false, "description": "日志采集路径，包含文件名，支持多个路径，多个路径之间英文逗号分隔，文件采集情况下必填", "example": "/data/nginx/log/**/access.log" }, { "name": "LogType", "type": "string", "required": false, "description": "采集的日志类型，默认为minimalist_log。支持以下类型： - json_log代表：JSON-文件日志（详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419)）； - delimiter_log代表：分隔符-文件日志（详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420)）； - minimalist_log代表：单行全文-文件日志（详见[使用单行全文提取模式采集日志](https://cloud.tencent.c...", "example": "delimiter_log" }, { "name": "ExtractRule", "type": "object", "required": false, "description": "提取规则，如果设置了ExtractRule，则必须设置LogType", "example": "无", "children": [ { "name": "TimeKey", "type": "string", "required": false, "description": "时间字段的key名字，TimeKey和TimeFormat必须成对出现", "example": "time" }, { "name": "TimeFormat", "type": "string", "required": false, "description": "时间字段的格式，参考c语言的strftime函数对于时间的格式说明输出参数 - 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档", "example": "%Y-%m-%d %H:%M:%S" }, { "name": "Delimiter", "type": "string", "required": false, "description": "分隔符类型日志的分隔符，只有LogType为delimiter_log时有效", "example": "," }, { "name": "LogRegex", "type": "string", "required": false, "description": "整条日志匹配规则，只有LogType为fullregex_log时有效", "example": "\\w" }, { "name": "BeginRegex", "type": "string", "required": false, "description": "行首匹配规则，只有LogType为multiline_log或fullregex_log时有效", "example": "\\w" }, { "name": "Keys", "type": "array", "required": false, "description": "取的每个字段的key名字，为空的key代表丢弃这个字段，只有LogType为delimiter_log时有效，json_log的日志使用json本身的key。限制100个。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"name\",\"address\"]", "item_type": "string" }, { "name": "FilterKeyRegex", "type": "array", "required": false, "description": "日志过滤规则列表（旧版），需要过滤日志的key，及其对应的regex。 注意：2.9.3及以上版本LogListener ，建议使用AdvanceFilterRules配置日志过滤规则。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤日志的key", "example": "response_code" }, { "name": "Regex", "type": "string", "required": true, "description": "key对应的过滤规则regex", "example": "400|500" } ] }, { "name": "UnMatchUpLoadSwitch", "type": "boolean", "required": false, "description": "解析失败日志是否上传，true表示上传，false表示不上传 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "UnMatchLogKey", "type": "string", "required": false, "description": "失败日志的key，当UnMatchUpLoadSwitch为true时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "testlog" }, { "name": "Backtracking", "type": "integer", "required": false, "description": "增量采集模式下的回溯数据量，默认：-1（全量采集）；其他非负数表示增量采集（从最新的位置，往前采集${Backtracking}字节（Byte）的日志）最大支持1073741824（1G）。 注意： - COS导入不支持此字段。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "IsGBK", "type": "integer", "required": false, "description": "是否为Gbk编码。 0：否；1：是。 注意 - 目前取0值时，表示UTF-8编码 - COS导入不支持此字段。", "example": "0" }, { "name": "JsonStandard", "type": "integer", "required": false, "description": "是否为标准json。 0：否； 1：是。 - 标准json指采集器使用业界标准开源解析器进行json解析，非标json指采集器使用CLS自研json解析器进行解析，两种解析器没有本质区别，建议客户使用标准json进行解析。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "syslog传输协议，取值为tcp或者udp，只有在LogType为service_syslog时生效，其余类型无需填写。 注意： - 该字段适用于：创建采集规则配置、修改采集规则配置。 - COS导入不支持此字段。", "example": "tcp" }, { "name": "Address", "type": "string", "required": false, "description": "syslog系统日志采集指定采集器监听的地址和端口 ，形式：[ip]:[port]，只有在LogType为service_syslog时生效，其余类型无需填写。 注意： - 该字段适用于：创建采集规则配置、修改采集规则配置。 - COS导入不支持此字段。", "example": "127.0.0.1:9000" }, { "name": "ParseProtocol", "type": "string", "required": false, "description": "rfc3164：指定系统日志采集使用RFC3164协议解析日志。 rfc5424：指定系统日志采集使用RFC5424协议解析日志。 auto：自动匹配rfc3164或者rfc5424其中一种协议。 只有在LogType为service_syslog时生效，其余类型无需填写。 注意： - 该字段适用于：创建采集规则配置、修改采集规则配置 - COS导入不支持此字段。", "example": "RFC3164" }, { "name": "MetadataType", "type": "integer", "required": false, "description": "元数据类型。0: 不使用元数据信息；1:使用机器组元数据；2:使用用户自定义元数据；3:使用采集配置路径。 注意： - COS导入不支持此字段。", "example": "0" }, { "name": "PathRegex", "type": "string", "required": false, "description": "采集配置路径正则表达式。 ``` 请用\"()\"标识路径中目标字段对应的正则表达式，解析时将\"()\"视为捕获组，并以__TAG__.{i}:{目标字段}的形式与日志一起上报，其中i为捕获组的序号。 若不希望以序号为键名，可以通过命名捕获组\"(?{正则})\"自定义键名，并以__TAG__.{键名}:{目标字段}的形式与日志一起上报。最多支持5个捕获组 ``` 注意： - MetadataType为3时必填。 - COS导入不支持此字段。", "example": "/(?\u003capp\u003e.*?)/(?\u003cuser\u003e.*?)/access.log" }, { "name": "MetaTags", "type": "array", "required": false, "description": "用户自定义元数据信息。 注意： - MetadataType为2时必填。 - COS导入不支持此字段。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "元数据key", "example": "buss_key" }, { "name": "Value", "type": "string", "required": false, "description": "元数据value", "example": "buss_value" } ] }, { "name": "EventLogRules", "type": "array", "required": false, "description": "Windows事件日志采集规则，只有在LogType为windows_event_log时生效，其余类型无需填写。", "example": "无", "item_type": "object", "children": [ { "name": "EventChannel", "type": "string", "required": true, "description": "事件通道，支持 - Application 应用日志 - Security 安全日志 - Setup 启动日志 - System 系统日志 - ALL 所有日志", "example": "Application" }, { "name": "TimeType", "type": "integer", "required": true, "description": "时间字段（Timestamp）支持的类型 - 1（用户自定义时间） - 2（当前时间）", "example": "1" }, { "name": "Timestamp", "type": "integer", "required": false, "description": "时间，用户选择自定义时间类型时，需要指定时间，单位秒 格式：时间戳，1754897446", "example": "1754897446" }, { "name": "EventIDs", "type": "array", "required": false, "description": "事件ID过滤列表 选填，为空表示不做过滤 支持正向过滤单个值（例：20）或范围（例：0-20），也支持反向过滤单个值(例：-20) 多个过滤项之间可由逗号隔开，例：1-200,-100表示采集1-200范围内除了100以外的事件日志", "example": "[\"1\",\"-100\"]", "item_type": "string" } ] }, { "name": "AdvanceFilterRules", "type": "array", "required": false, "description": "日志过滤规则列表（新版）。 注意： - 2.9.3以下版本LogListener不支持， 请使用FilterKeyRegex配置日志过滤规则。 - 自建k8s采集配置（CreateConfigExtra、ModifyConfigExtra）不支持此字段。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "过滤字段", "example": "http_code" }, { "name": "Rule", "type": "integer", "required": true, "description": "过滤规则，0:等于，1:字段存在，2:字段不存在", "example": "0" }, { "name": "Value", "type": "string", "required": false, "description": "过滤值", "example": "400|500" } ] } ] }, { "name": "ExcludePaths", "type": "array", "required": false, "description": "采集黑名单路径列表", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，选填File或Path", "example": "File" }, { "name": "Value", "type": "string", "required": true, "description": "Type对应的具体内容", "example": "/loglistener_auto_test/black_list/after_black_test.log" } ] }, { "name": "UserDefineRule", "type": "string", "required": false, "description": "用户自定义采集规则，Json格式序列化的字符串。当LogType为user_define_log时，必填。", "example": "\"{\\\"processors\\\":[{\\\"type\\\":\\\"processor_split_delimiter\\\",\\\"detail\\\":{\\\"Delimiter\\\":\\\",\\\",\\\"ExtractKeys\\\":[\\\"time\\\",\\\"msg1\\\",\\\"msg2\\\"]}}]}\"" }, { "name": "AdvancedConfig", "type": "string", "required": false, "description": "高级采集配置。 Json字符串， Key/Value定义为如下： - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数， 0为不超时 - ClsAgentMaxDepth(最大目录深度)，取值范围: 大于等于0的整数 - ClsAgentParseFailMerge(合并解析失败日志)，取值范围: true或false 样例： `{\\\"ClsAgentFileTimeout\\\":0,\\\"ClsAgentMaxDepth\\\":10,\\\"ClsAgentParseFailMerge\\\":true}` 控制台默认占位值：`{\\\"ClsAgentDefault\\\":0}`", "example": "\"{\\\"ClsAgentFileTimeout\\\":0,\\\"ClsAgentMaxDepth\\\":10,\\\"ClsAgentParseFailMerge\\\":true}\"" }, { "name": "InputType", "type": "string", "required": false, "description": "日志输入类型（注：windows场景必填且仅支持file和windows_event类型） - file: 文件类型采集 - windows_event：windows事件采集 - syslog：系统日志采集", "example": "file" } ], "required": [ "Name", "Output" ] }, { "name": "CreateConfigExtra", "description": "本接口用于创建特殊采集配置任务，特殊采集配置应用于自建K8S环境的采集Agent", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "采集配置规程名称，最长63个字符，只能包含小写字符、数字及分隔符（“-”），且必须以小写字符开头，数字或小写字符结尾", "example": "configname" }, { "name": "TopicId", "type": "string", "required": true, "description": "日志主题id - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "3269961d-52e0-407b-9dcd-34bd830c6f19" }, { "name": "Type", "type": "string", "required": true, "description": "日志源类型。支持 container_stdout：容器标准输出；container_file：容器文件路径；host_file：节点文件路径。", "example": "container_stdout" }, { "name": "LogType", "type": "string", "required": true, "description": "采集的日志类型，默认为minimalist_log。支持以下类型： - json_log代表：JSON-文件日志（详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419)）； - delimiter_log代表：分隔符-文件日志（详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420)）； - minimalist_log代表：单行全文-文件日志（详见[使用单行全文提取模式采集日志](https://cloud.tencent.c...", "example": "minimalist_log" }, { "name": "ConfigFlag", "type": "string", "required": true, "description": "采集配置标记。 - 目前只支持label_k8s，用于标记自建k8s集群使用的采集配置", "example": "label_k8s" }, { "name": "LogsetId", "type": "string", "required": true, "description": "日志集id - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。", "example": "57f5808c-4a55-11eb-b378-0242ac130002" }, { "name": "LogsetName", "type": "string", "required": true, "description": "日志集名称 - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集名称。", "example": "name1" }, { "name": "TopicName", "type": "string", "required": true, "description": "日志主题名称 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题名称。", "example": "name2" }, { "name": "HostFile", "type": "object", "required": false, "description": "自建k8s-节点文件配置信息,包括文件路径、名称及元数据相关信息。 - 详细参考 [HostFileInfo](https://cloud.tencent.com/document/api/614/56471#HostFileInfo) 信息。", "example": "无", "children": [ { "name": "LogPath", "type": "string", "required": true, "description": "日志文件夹", "example": "/xxx/xxx" }, { "name": "FilePattern", "type": "string", "required": true, "description": "日志文件名", "example": "**.log" }, { "name": "CustomLabels", "type": "array", "required": false, "description": "metadata信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"key1=value1\",\"key2=value2\"]", "item_type": "string" } ] }, { "name": "ContainerFile", "type": "object", "required": false, "description": "容器文件路径类型配置。", "example": "无", "children": [ { "name": "Namespace", "type": "string", "required": true, "description": "namespace可以多个，用分隔号分割,例如A,B", "example": "kube-system" }, { "name": "Container", "type": "string", "required": true, "description": "容器名称", "example": "container1" }, { "name": "LogPath", "type": "string", "required": true, "description": "日志文件夹", "example": "/var/log/tmep" }, { "name": "FilePattern", "type": "string", "required": true, "description": "日志名称", "example": "*.log" }, { "name": "FilePaths", "type": "array", "required": false, "description": "日志文件信息", "example": "无", "item_type": "object", "children": [ { "name": "Path", "type": "string", "required": false, "description": "文件路径", "example": "/log" }, { "name": "File", "type": "string", "required": false, "description": "文件名称", "example": "test.log" } ] }, { "name": "IncludeLabels", "type": "array", "required": false, "description": "pod标签信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"key1=value1\"]", "item_type": "string" }, { "name": "WorkLoad", "type": "object", "required": false, "description": "工作负载信息", "example": "无", "children": [ { "name": "Kind", "type": "string", "required": true, "description": "工作负载的类型，支持的取值如下： - deployment：无状态应用部署控制器。可管理无状态应用的多副本 Pod；支持滚动更新和回滚，实现无缝发布；通过 ReplicaSet 确保指定数量的 Pod 副本持续运行。适合 Web 服务、API 服务、微服务等不需要持久化存储或唯一标识的应用。 - statefulset：用于管理有状态应用的控制器。可以为每个 Pod 提供稳定的、唯一的标识（有序的主机名和网络标识...", "example": "daemonset" }, { "name": "Name", "type": "string", "required": true, "description": "工作负载的名称", "example": "tke-log-agent" }, { "name": "Container", "type": "string", "required": false, "description": "容器名", "example": "container_adsf" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "kube-system" } ] }, { "name": "ExcludeNamespace", "type": "string", "required": false, "description": "需要排除的namespace可以多个，用分隔号分割,例如A,B", "example": "kube-system" }, { "name": "ExcludeLabels", "type": "array", "required": false, "description": "需要排除的pod标签信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"key1=value1\"]", "item_type": "string" }, { "name": "CustomLabels", "type": "array", "required": false, "description": "metadata信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"key1=value1\",\"key2=value2\"]", "item_type": "string" } ] }, { "name": "ContainerStdout", "type": "object", "required": false, "description": "自建k8s-容器标准输出信息，包括容器、命名空间等。 - 详细参考 [ContainerStdoutInfo](https://cloud.tencent.com/document/api/614/56471#ContainerStdoutInfo) 信息。", "example": "无", "children": [ { "name": "AllContainers", "type": "boolean", "required": true, "description": "是否所有容器", "example": "true / false" }, { "name": "Container", "type": "string", "required": false, "description": "container为空表所有的，不为空采集指定的容器", "example": "container_xzdfg" }, { "name": "Namespace", "type": "string", "required": false, "description": "namespace可以多个，用分隔号分割,例如A,B；为空或者没有这个字段，表示所有namespace", "example": "kube-system" }, { "name": "IncludeLabels", "type": "array", "required": false, "description": "pod标签信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"key1=value1\"]", "item_type": "string" }, { "name": "WorkLoads", "type": "array", "required": false, "description": "工作负载信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Kind", "type": "string", "required": true, "description": "工作负载的类型，支持的取值如下： - deployment：无状态应用部署控制器。可管理无状态应用的多副本 Pod；支持滚动更新和回滚，实现无缝发布；通过 ReplicaSet 确保指定数量的 Pod 副本持续运行。适合 Web 服务、API 服务、微服务等不需要持久化存储或唯一标识的应用。 - statefulset：用于管理有状态应用的控制器。可以为每个 Pod 提供稳定的、唯一的标识（有序的主机名和网络标识...", "example": "daemonset" }, { "name": "Name", "type": "string", "required": true, "description": "工作负载的名称", "example": "tke-log-agent" }, { "name": "Container", "type": "string", "required": false, "description": "容器名", "example": "container_adsf" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "kube-system" } ] }, { "name": "ExcludeNamespace", "type": "string", "required": false, "description": "需要排除的namespace可以多个，用分隔号分割,例如A,B", "example": "kube-system" }, { "name": "ExcludeLabels", "type": "array", "required": false, "description": "需要排除的pod标签信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"key1=value1\"]", "item_type": "string" }, { "name": "CustomLabels", "type": "array", "required": false, "description": "metadata信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"key1=value1\",\"key2=value2\"]", "item_type": "string" } ] }, { "name": "ExtractRule", "type": "object", "required": false, "description": "提取规则，如果设置了ExtractRule，则必须设置LogType", "example": "无", "children": [ { "name": "TimeKey", "type": "string", "required": false, "description": "时间字段的key名字，TimeKey和TimeFormat必须成对出现", "example": "time" }, { "name": "TimeFormat", "type": "string", "required": false, "description": "时间字段的格式，参考c语言的strftime函数对于时间的格式说明输出参数 - 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档", "example": "%Y-%m-%d %H:%M:%S" }, { "name": "Delimiter", "type": "string", "required": false, "description": "分隔符类型日志的分隔符，只有LogType为delimiter_log时有效", "example": "," }, { "name": "LogRegex", "type": "string", "required": false, "description": "整条日志匹配规则，只有LogType为fullregex_log时有效", "example": "\\w" }, { "name": "BeginRegex", "type": "string", "required": false, "description": "行首匹配规则，只有LogType为multiline_log或fullregex_log时有效", "example": "\\w" }, { "name": "Keys", "type": "array", "required": false, "description": "取的每个字段的key名字，为空的key代表丢弃这个字段，只有LogType为delimiter_log时有效，json_log的日志使用json本身的key。限制100个。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"name\",\"address\"]", "item_type": "string" }, { "name": "FilterKeyRegex", "type": "array", "required": false, "description": "日志过滤规则列表（旧版），需要过滤日志的key，及其对应的regex。 注意：2.9.3及以上版本LogListener ，建议使用AdvanceFilterRules配置日志过滤规则。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤日志的key", "example": "response_code" }, { "name": "Regex", "type": "string", "required": true, "description": "key对应的过滤规则regex", "example": "400|500" } ] }, { "name": "UnMatchUpLoadSwitch", "type": "boolean", "required": false, "description": "解析失败日志是否上传，true表示上传，false表示不上传 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "UnMatchLogKey", "type": "string", "required": false, "description": "失败日志的key，当UnMatchUpLoadSwitch为true时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "testlog" }, { "name": "Backtracking", "type": "integer", "required": false, "description": "增量采集模式下的回溯数据量，默认：-1（全量采集）；其他非负数表示增量采集（从最新的位置，往前采集${Backtracking}字节（Byte）的日志）最大支持1073741824（1G）。 注意： - COS导入不支持此字段。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "IsGBK", "type": "integer", "required": false, "description": "是否为Gbk编码。 0：否；1：是。 注意 - 目前取0值时，表示UTF-8编码 - COS导入不支持此字段。", "example": "0" }, { "name": "JsonStandard", "type": "integer", "required": false, "description": "是否为标准json。 0：否； 1：是。 - 标准json指采集器使用业界标准开源解析器进行json解析，非标json指采集器使用CLS自研json解析器进行解析，两种解析器没有本质区别，建议客户使用标准json进行解析。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "syslog传输协议，取值为tcp或者udp，只有在LogType为service_syslog时生效，其余类型无需填写。 注意： - 该字段适用于：创建采集规则配置、修改采集规则配置。 - COS导入不支持此字段。", "example": "tcp" }, { "name": "Address", "type": "string", "required": false, "description": "syslog系统日志采集指定采集器监听的地址和端口 ，形式：[ip]:[port]，只有在LogType为service_syslog时生效，其余类型无需填写。 注意： - 该字段适用于：创建采集规则配置、修改采集规则配置。 - COS导入不支持此字段。", "example": "127.0.0.1:9000" }, { "name": "ParseProtocol", "type": "string", "required": false, "description": "rfc3164：指定系统日志采集使用RFC3164协议解析日志。 rfc5424：指定系统日志采集使用RFC5424协议解析日志。 auto：自动匹配rfc3164或者rfc5424其中一种协议。 只有在LogType为service_syslog时生效，其余类型无需填写。 注意： - 该字段适用于：创建采集规则配置、修改采集规则配置 - COS导入不支持此字段。", "example": "RFC3164" }, { "name": "MetadataType", "type": "integer", "required": false, "description": "元数据类型。0: 不使用元数据信息；1:使用机器组元数据；2:使用用户自定义元数据；3:使用采集配置路径。 注意： - COS导入不支持此字段。", "example": "0" }, { "name": "PathRegex", "type": "string", "required": false, "description": "采集配置路径正则表达式。 ``` 请用\"()\"标识路径中目标字段对应的正则表达式，解析时将\"()\"视为捕获组，并以__TAG__.{i}:{目标字段}的形式与日志一起上报，其中i为捕获组的序号。 若不希望以序号为键名，可以通过命名捕获组\"(?{正则})\"自定义键名，并以__TAG__.{键名}:{目标字段}的形式与日志一起上报。最多支持5个捕获组 ``` 注意： - MetadataType为3时必填。 - COS导入不支持此字段。", "example": "/(?\u003capp\u003e.*?)/(?\u003cuser\u003e.*?)/access.log" }, { "name": "MetaTags", "type": "array", "required": false, "description": "用户自定义元数据信息。 注意： - MetadataType为2时必填。 - COS导入不支持此字段。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "元数据key", "example": "buss_key" }, { "name": "Value", "type": "string", "required": false, "description": "元数据value", "example": "buss_value" } ] }, { "name": "EventLogRules", "type": "array", "required": false, "description": "Windows事件日志采集规则，只有在LogType为windows_event_log时生效，其余类型无需填写。", "example": "无", "item_type": "object", "children": [ { "name": "EventChannel", "type": "string", "required": true, "description": "事件通道，支持 - Application 应用日志 - Security 安全日志 - Setup 启动日志 - System 系统日志 - ALL 所有日志", "example": "Application" }, { "name": "TimeType", "type": "integer", "required": true, "description": "时间字段（Timestamp）支持的类型 - 1（用户自定义时间） - 2（当前时间）", "example": "1" }, { "name": "Timestamp", "type": "integer", "required": false, "description": "时间，用户选择自定义时间类型时，需要指定时间，单位秒 格式：时间戳，1754897446", "example": "1754897446" }, { "name": "EventIDs", "type": "array", "required": false, "description": "事件ID过滤列表 选填，为空表示不做过滤 支持正向过滤单个值（例：20）或范围（例：0-20），也支持反向过滤单个值(例：-20) 多个过滤项之间可由逗号隔开，例：1-200,-100表示采集1-200范围内除了100以外的事件日志", "example": "[\"1\",\"-100\"]", "item_type": "string" } ] }, { "name": "AdvanceFilterRules", "type": "array", "required": false, "description": "日志过滤规则列表（新版）。 注意： - 2.9.3以下版本LogListener不支持， 请使用FilterKeyRegex配置日志过滤规则。 - 自建k8s采集配置（CreateConfigExtra、ModifyConfigExtra）不支持此字段。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "过滤字段", "example": "http_code" }, { "name": "Rule", "type": "integer", "required": true, "description": "过滤规则，0:等于，1:字段存在，2:字段不存在", "example": "0" }, { "name": "Value", "type": "string", "required": false, "description": "过滤值", "example": "400|500" } ] } ] }, { "name": "ExcludePaths", "type": "array", "required": false, "description": "采集黑名单路径列表", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，选填File或Path", "example": "File" }, { "name": "Value", "type": "string", "required": true, "description": "Type对应的具体内容", "example": "/loglistener_auto_test/black_list/after_black_test.log" } ] }, { "name": "UserDefineRule", "type": "string", "required": false, "description": "组合解析采集规则，用于复杂场景下的日志采集。 - 取值参考：[使用组合解析提取模式采集日志 ](https://cloud.tencent.com/document/product/614/61310)", "example": "{\"processors\":[{\"type\":\"\",\"detail\":{\"ExtractRegex\":\"\\\\w+\",\"ExtractKeys\":[\"\"],\"BeginRegex\":\"[a-z].*\"},\"processors\":[]}]}" }, { "name": "GroupId", "type": "string", "required": false, "description": "绑定的机器组ID - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。 - GroupId 与 GroupIds 选择其一即可，不可同时为空。", "example": "57f5808c-4a55-11eb-b378-0242ac130002" }, { "name": "GroupIds", "type": "array", "required": false, "description": "绑定的机器组ID列表 - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id信息。 - GroupId 与 GroupIds 选择其一即可，不可同时为空。", "example": "[\"59b6014b-6507-44c2-9d4f-a5bee6df9ab5\",\"0af7e6bb-fc91-4ee8-ad24-1129e9c91c6c\"]", "item_type": "string" }, { "name": "CollectInfos", "type": "array", "required": false, "description": "采集相关配置信息。详细参考 [CollectInfo](https://cloud.tencent.com/document/api/614/56471#CollectInfo) 信息。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "采集类型，必填字段。 0：元数据配置。 1：指定Pod Label。", "example": "0" }, { "name": "CollectConfigs", "type": "array", "required": false, "description": "指定采集类型的采集配置信息。 当Type为0时，CollectConfigs不允许为空。 当Type为1时，CollectConfigs为空时，表示选择所有Pod Label；否则CollectConfigs为指定Pod Label。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "指定采集类型的采集配置名称信息。 当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名称。", "example": "pod_name" } ] } ] }, { "name": "AdvancedConfig", "type": "string", "required": false, "description": "高级采集配置。 Json字符串， Key/Value定义为如下： - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数， 0为不超时 - ClsAgentMaxDepth(最大目录深度)，取值范围: 大于等于0的整数 - ClsAgentParseFailMerge(合并解析失败日志)，取值范围: true或false - ClsAgentDefault(自定义默认值，无特殊含义，用于清空其他选项)，建议取值0", "example": "{\\\"ClsAgentFileTimeout\\\":0,\\\"ClsAgentMaxDepth\\\":10,\\\"ClsAgentParseFailMerge\\\":true}" } ], "required": [ "Name", "TopicId", "Type", "LogType", "ConfigFlag", "LogsetId", "LogsetName", "TopicName" ] }, { "name": "CreateConsoleSharing", "description": "创建控制台分享", "status": "online", "parameters": [ { "name": "SharingConfig", "type": "object", "required": true, "description": "免密分享配置", "example": "无", "children": [ { "name": "Name", "type": "string", "required": true, "description": "分享链接名称", "example": "my-sharing" }, { "name": "Type", "type": "integer", "required": true, "description": "仪表盘: 1; 检索页:2", "example": "1" }, { "name": "DurationMilliseconds", "type": "integer", "required": true, "description": "分享链接有效期，单位：毫秒，最长支持30天", "example": "1800000" }, { "name": "Resources", "type": "array", "required": true, "description": "允许访问的资源列表，目前仅支持一个Resource", "example": "[\"qcs::cls::uin/10000xxxxx:dashboard/dashboard-xx\", \"qcs::cls:ap-guangzhou:uin/10000xxxxx:topic/cxxx\"]", "item_type": "string" }, { "name": "Domain", "type": "string", "required": false, "description": "分享链接域名，可选范围 - 公网匿名分享：填写clsshare.com - datasight内网匿名分享(若开启)：datasight内网域名 注意：此字段可能返回 null，表示取不到有效值。", "example": "clsshare.com" }, { "name": "VerifyCode", "type": "string", "required": false, "description": "分享链接加密访问验证码。支持0-9和a-z(不区分大小写)在内的6个字符，可为空，代表免验证码访问 注意：此字段可能返回 null，表示取不到有效值。", "example": "lEC0V0" }, { "name": "StartTime", "type": "string", "required": false, "description": "默认查询范围的开始时间点，支持绝对时间(13位Unix时间戳)或相对时间表达式", "example": "'1706781017413'或now-7d" }, { "name": "EndTime", "type": "string", "required": false, "description": "默认查询范围的结束时间点，支持绝对时间(13位Unix时间戳)或相对时间表达式。注意，结束时间点要大于开始时间点", "example": "'1706791017413'或now" }, { "name": "NowTime", "type": "integer", "required": false, "description": "仅当StartTime/EndTime为相对时间时使用，基于NowTime计算绝对时间，默认为创建时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "1706797306086" }, { "name": "Params", "type": "array", "required": false, "description": "默认的检索分析语句，仅当Type为2时使用 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "query" }, { "name": "Value", "type": "string", "required": false, "description": "值 注意：此字段可能返回 null，表示取不到有效值。", "example": "* | select *" } ] }, { "name": "IsLockTimeRange", "type": "boolean", "required": false, "description": "是否允许访问者自行修改检索分析时间范围。默认不锁定（false）", "example": "false" }, { "name": "IsLockQuery", "type": "boolean", "required": false, "description": "是否允许访问者自行修改日志检索语句。在检索页分享中表示检索语句锁定状态；在仪表盘中表示过滤变量锁定状态。默认不锁定（false）", "example": "false" }, { "name": "IsSupportLogExport", "type": "boolean", "required": false, "description": "检索页分享是否允许访问者下载日志，默认不允许（false） 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] } ], "required": [ "SharingConfig" ] }, { "name": "CreateConsumer", "description": "本接口用于创建投递CKafka任务", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "投递任务绑定的日志主题Id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。", "example": "871710c5-35cd-4d1e-8e79-2fa92c35d612" }, { "name": "NeedContent", "type": "boolean", "required": false, "description": "是否投递日志的元数据信息，默认为 true。 当NeedContent为true时：字段Content有效。 当NeedContent为false时：字段Content无效。", "example": "false" }, { "name": "Content", "type": "object", "required": false, "description": "如果需要投递元数据信息，元数据信息的描述", "example": "无", "children": [ { "name": "EnableTag", "type": "boolean", "required": true, "description": "是否投递 TAG 信息。 当EnableTag为true时，表示投递TAG元信息。", "example": "false" }, { "name": "MetaFields", "type": "array", "required": true, "description": "需要投递的元数据列表，目前仅支持：\\_\\_SOURCE\\_\\_，\\_\\_FILENAME\\_\\_，\\_\\_TIMESTAMP\\_\\_，\\_\\_HOSTNAME\\_\\_和\\_\\_PKGID\\_\\_", "example": "[\"\\_\\_SOURCE\\_\\_\", \"\\_\\_FILENAME\\_\\_\", \"\\_\\_TIMESTAMP\\_\\_\"]", "item_type": "string" }, { "name": "TagJsonNotTiled", "type": "boolean", "required": false, "description": "当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\"}`", "example": "false" }, { "name": "TimestampAccuracy", "type": "integer", "required": false, "description": "投递时间戳精度，可选项 [1：秒；2：毫秒] ，默认是1。", "example": "1" }, { "name": "JsonType", "type": "integer", "required": false, "description": "投递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\\\"}\"}`", "example": "0" } ] }, { "name": "Ckafka", "type": "object", "required": false, "description": "CKafka的描述", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "Ckafka 的 InstanceId。 - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。 - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取实例id。", "example": "ckafka-8j4rotest" }, { "name": "TopicName", "type": "string", "required": true, "description": "Ckafka 的 TopicName。 - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicName。 - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicName。", "example": "mrxy-business" }, { "name": "Vip", "type": "string", "required": false, "description": "Ckafka 的 Vip。 - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip信息。 - 如果是通过 角色ARN 方式创建投递任务，则Vip字段可为空。", "example": "172.16.0.17" }, { "name": "Vport", "type": "string", "required": false, "description": "Ckafka 的 Vport。 - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip port信息。 - 如果是通过 角色ARN 方式创建投递任务，则Vport字段可为空。", "example": "9092" }, { "name": "InstanceName", "type": "string", "required": false, "description": "Ckafka 的 InstanceName。 - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取InstanceName。 - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取InstanceName。 - 如果是通过 角色ARN 方式创建投递任务，则InstanceName字段可为空。", "example": "kafka协议消费监控用" }, { "name": "TopicId", "type": "string", "required": false, "description": "Ckafka 的 TopicId。 - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicId。 - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicId。 - 如果是通过 角色ARN 方式创建投递任务，则TopicId字段可为空。", "example": "1254011820-24a0d67e-748b-4e30-9502-78779bcc5test" } ] }, { "name": "Compression", "type": "integer", "required": false, "description": "投递时压缩方式，取值0，2，3。[0：NONE；2：SNAPPY；3：LZ4]", "example": "0" }, { "name": "RoleArn", "type": "string", "required": false, "description": "角色访问描述名 [创建角色](https://cloud.tencent.com/document/product/598/19381)", "example": "qcs::cam::uin/${uin}:roleName/xxxtest" }, { "name": "ExternalId", "type": "string", "required": false, "description": "外部ID", "example": "external_id_demo" }, { "name": "AdvancedConfig", "type": "object", "required": false, "description": "高级配置项", "example": "无", "children": [ { "name": "PartitionHashStatus", "type": "boolean", "required": false, "description": "Ckafka分区hash状态。 默认 false - true：开启根据字段 Hash 值结果相等的信息投递到统一 ckafka 分区 - false：关闭根据字段 Hash 值结果相等的信息投递到统一 ckafka 分区", "example": "true" }, { "name": "PartitionFields", "type": "array", "required": false, "description": "需要计算 hash 的字段列表。最大支持5个字段。", "example": "[\"name\",\"address\"]", "item_type": "string" } ] } ], "required": [ "TopicId" ] }, { "name": "CreateConsumerGroup", "description": "消费组心跳", "status": "online", "parameters": [ { "name": "ConsumerGroup", "type": "string", "required": true, "description": "创建的消费者组标识 限制： 字母数字下划线，不允许数字开头，长度限制256", "example": "无" }, { "name": "Timeout", "type": "integer", "required": true, "description": "消费者心跳超时时间（秒）", "example": "无" }, { "name": "Topics", "type": "array", "required": true, "description": "创建的消费者组包含的日志主题列表", "example": "无", "item_type": "string" }, { "name": "LogsetId", "type": "string", "required": true, "description": "日志集Id（日志主题所属的日志集）", "example": "无" } ], "required": [ "ConsumerGroup", "Timeout", "Topics", "LogsetId" ] }, { "name": "CreateCosRecharge", "description": "本接口用于创建cos导入任务", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题Id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "ae13f7db-00b5-41ac-916e-407802axxxxx" }, { "name": "LogsetId", "type": "string", "required": true, "description": "日志集Id。 - 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。", "example": "0af7e6bb-fc91-4ee8-ad24-1129e9cxxxxx" }, { "name": "Name", "type": "string", "required": true, "description": "COS导入任务名称,最大支持128个字节。", "example": "cos导入" }, { "name": "Bucket", "type": "string", "required": true, "description": "COS存储桶，详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。 - 通过[GET Service（List Buckets）](https://cloud.tencent.com/document/product/436/8291)获取COS存储桶。", "example": "examplebucket-1250000000" }, { "name": "BucketRegion", "type": "string", "required": true, "description": "COS存储桶所在地域，详见产品支持的[地域列表](https://cloud.tencent.com/document/product/436/6224)。", "example": "ap-guangzhou" }, { "name": "LogType", "type": "string", "required": true, "description": "采集的日志类型，json_log代表json格式日志，delimiter_log代表分隔符格式日志，minimalist_log代表单行全文； 默认为minimalist_log", "example": "minimalist_log" }, { "name": "Prefix", "type": "string", "required": false, "description": "COS文件所在文件夹的前缀。默认为空，投递存储桶下所有的文件。", "example": "var/xxx" }, { "name": "Compress", "type": "string", "required": false, "description": "supported: \"\", \"gzip\", \"lzop\", \"snappy\"。默认空，不压缩。", "example": "gzip" }, { "name": "ExtractRuleInfo", "type": "object", "required": false, "description": "提取规则，如果设置了ExtractRule，则必须设置LogType", "example": "无", "children": [ { "name": "TimeKey", "type": "string", "required": false, "description": "时间字段的key名字，TimeKey和TimeFormat必须成对出现", "example": "time" }, { "name": "TimeFormat", "type": "string", "required": false, "description": "时间字段的格式，参考c语言的strftime函数对于时间的格式说明输出参数 - 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档", "example": "%Y-%m-%d %H:%M:%S" }, { "name": "Delimiter", "type": "string", "required": false, "description": "分隔符类型日志的分隔符，只有LogType为delimiter_log时有效", "example": "," }, { "name": "LogRegex", "type": "string", "required": false, "description": "整条日志匹配规则，只有LogType为fullregex_log时有效", "example": "\\w" }, { "name": "BeginRegex", "type": "string", "required": false, "description": "行首匹配规则，只有LogType为multiline_log或fullregex_log时有效", "example": "\\w" }, { "name": "Keys", "type": "array", "required": false, "description": "取的每个字段的key名字，为空的key代表丢弃这个字段，只有LogType为delimiter_log时有效，json_log的日志使用json本身的key。限制100个。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"name\",\"address\"]", "item_type": "string" }, { "name": "FilterKeyRegex", "type": "array", "required": false, "description": "日志过滤规则列表（旧版），需要过滤日志的key，及其对应的regex。 注意：2.9.3及以上版本LogListener ，建议使用AdvanceFilterRules配置日志过滤规则。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤日志的key", "example": "response_code" }, { "name": "Regex", "type": "string", "required": true, "description": "key对应的过滤规则regex", "example": "400|500" } ] }, { "name": "UnMatchUpLoadSwitch", "type": "boolean", "required": false, "description": "解析失败日志是否上传，true表示上传，false表示不上传 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "UnMatchLogKey", "type": "string", "required": false, "description": "失败日志的key，当UnMatchUpLoadSwitch为true时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "testlog" }, { "name": "Backtracking", "type": "integer", "required": false, "description": "增量采集模式下的回溯数据量，默认：-1（全量采集）；其他非负数表示增量采集（从最新的位置，往前采集${Backtracking}字节（Byte）的日志）最大支持1073741824（1G）。 注意： - COS导入不支持此字段。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "IsGBK", "type": "integer", "required": false, "description": "是否为Gbk编码。 0：否；1：是。 注意 - 目前取0值时，表示UTF-8编码 - COS导入不支持此字段。", "example": "0" }, { "name": "JsonStandard", "type": "integer", "required": false, "description": "是否为标准json。 0：否； 1：是。 - 标准json指采集器使用业界标准开源解析器进行json解析，非标json指采集器使用CLS自研json解析器进行解析，两种解析器没有本质区别，建议客户使用标准json进行解析。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "syslog传输协议，取值为tcp或者udp，只有在LogType为service_syslog时生效，其余类型无需填写。 注意： - 该字段适用于：创建采集规则配置、修改采集规则配置。 - COS导入不支持此字段。", "example": "tcp" }, { "name": "Address", "type": "string", "required": false, "description": "syslog系统日志采集指定采集器监听的地址和端口 ，形式：[ip]:[port]，只有在LogType为service_syslog时生效，其余类型无需填写。 注意： - 该字段适用于：创建采集规则配置、修改采集规则配置。 - COS导入不支持此字段。", "example": "127.0.0.1:9000" }, { "name": "ParseProtocol", "type": "string", "required": false, "description": "rfc3164：指定系统日志采集使用RFC3164协议解析日志。 rfc5424：指定系统日志采集使用RFC5424协议解析日志。 auto：自动匹配rfc3164或者rfc5424其中一种协议。 只有在LogType为service_syslog时生效，其余类型无需填写。 注意： - 该字段适用于：创建采集规则配置、修改采集规则配置 - COS导入不支持此字段。", "example": "RFC3164" }, { "name": "MetadataType", "type": "integer", "required": false, "description": "元数据类型。0: 不使用元数据信息；1:使用机器组元数据；2:使用用户自定义元数据；3:使用采集配置路径。 注意： - COS导入不支持此字段。", "example": "0" }, { "name": "PathRegex", "type": "string", "required": false, "description": "采集配置路径正则表达式。 ``` 请用\"()\"标识路径中目标字段对应的正则表达式，解析时将\"()\"视为捕获组，并以__TAG__.{i}:{目标字段}的形式与日志一起上报，其中i为捕获组的序号。 若不希望以序号为键名，可以通过命名捕获组\"(?{正则})\"自定义键名，并以__TAG__.{键名}:{目标字段}的形式与日志一起上报。最多支持5个捕获组 ``` 注意： - MetadataType为3时必填。 - COS导入不支持此字段。", "example": "/(?\u003capp\u003e.*?)/(?\u003cuser\u003e.*?)/access.log" }, { "name": "MetaTags", "type": "array", "required": false, "description": "用户自定义元数据信息。 注意： - MetadataType为2时必填。 - COS导入不支持此字段。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "元数据key", "example": "buss_key" }, { "name": "Value", "type": "string", "required": false, "description": "元数据value", "example": "buss_value" } ] }, { "name": "EventLogRules", "type": "array", "required": false, "description": "Windows事件日志采集规则，只有在LogType为windows_event_log时生效，其余类型无需填写。", "example": "无", "item_type": "object", "children": [ { "name": "EventChannel", "type": "string", "required": true, "description": "事件通道，支持 - Application 应用日志 - Security 安全日志 - Setup 启动日志 - System 系统日志 - ALL 所有日志", "example": "Application" }, { "name": "TimeType", "type": "integer", "required": true, "description": "时间字段（Timestamp）支持的类型 - 1（用户自定义时间） - 2（当前时间）", "example": "1" }, { "name": "Timestamp", "type": "integer", "required": false, "description": "时间，用户选择自定义时间类型时，需要指定时间，单位秒 格式：时间戳，1754897446", "example": "1754897446" }, { "name": "EventIDs", "type": "array", "required": false, "description": "事件ID过滤列表 选填，为空表示不做过滤 支持正向过滤单个值（例：20）或范围（例：0-20），也支持反向过滤单个值(例：-20) 多个过滤项之间可由逗号隔开，例：1-200,-100表示采集1-200范围内除了100以外的事件日志", "example": "[\"1\",\"-100\"]", "item_type": "string" } ] }, { "name": "AdvanceFilterRules", "type": "array", "required": false, "description": "日志过滤规则列表（新版）。 注意： - 2.9.3以下版本LogListener不支持， 请使用FilterKeyRegex配置日志过滤规则。 - 自建k8s采集配置（CreateConfigExtra、ModifyConfigExtra）不支持此字段。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "过滤字段", "example": "http_code" }, { "name": "Rule", "type": "integer", "required": true, "description": "过滤规则，0:等于，1:字段存在，2:字段不存在", "example": "0" }, { "name": "Value", "type": "string", "required": false, "description": "过滤值", "example": "400|500" } ] } ] }, { "name": "TaskType", "type": "integer", "required": false, "description": "COS导入任务类型。1：一次性导入任务；2：持续性导入任务。默认为1：一次性导入任务", "example": "1" }, { "name": "Metadata", "type": "array", "required": false, "description": "元数据。", "example": "[\"bucket\",\"object\"]", "item_type": "string" } ], "required": [ "TopicId", "LogsetId", "Name", "Bucket", "BucketRegion", "LogType" ] }, { "name": "CreateDashboard", "description": "本接口用于创建仪表盘", "status": "online", "parameters": [ { "name": "DashboardName", "type": "string", "required": true, "description": "仪表盘名称", "example": "xxxxxx-xx-xx-xx-xxxxxxxx" }, { "name": "Data", "type": "string", "required": false, "description": "仪表盘配置数据", "example": "testname" }, { "name": "Tags", "type": "array", "required": false, "description": "标签描述列表，通过指定该参数可以同时绑定标签到相应的日志主题。最大支持10个标签键值对，同一个资源只能绑定到同一个标签键下。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "业务A" } ] } ], "required": [ "DashboardName" ] }, { "name": "CreateDashboardSubscribe", "description": "此接口用于创建仪表盘订阅", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "仪表盘订阅名称。 输入限制： - 不能为空 - 长度不能超过128字节 - 不能包含字符'|'", "example": "仪表盘-CLS-日报" }, { "name": "DashboardId", "type": "string", "required": true, "description": "仪表盘Id。 - 通过[获取仪表盘](https://cloud.tencent.com/document/product/614/95636)获取仪表盘Id。", "example": "dashboard-0d954d68-xxxx-xxxx-95a6-f9eff0db370f" }, { "name": "Cron", "type": "string", "required": true, "description": "订阅时间cron表达式，格式为：{秒数} {分钟} {小时} {日期} {月份} {星期}；（有效数据为：{分钟} {小时} {日期} {月份} {星期}）。 - {秒数} 取值范围： 0 ~ 59 - {分钟} 取值范围： 0 ~ 59 - {小时} 取值范围： 0 ~ 23 - {日期} 取值范围： 1 ~ 31 AND (dayOfMonth最后一天： L) - {月份} 取值范围： 1 ~ 12 - {星期} 取值范围： 0 ~ 6 【0:星期日， 6星期六】", "example": "\"0 40 20 * * ?\"" }, { "name": "SubscribeData", "type": "object", "required": true, "description": "仪表盘订阅数据。", "example": "无", "children": [ { "name": "NoticeModes", "type": "array", "required": true, "description": "仪表盘订阅通知方式。", "example": "无", "item_type": "object", "children": [ { "name": "ReceiverType", "type": "string", "required": true, "description": "仪表盘通知方式。 - Uin：腾讯云用户 - Group：腾讯云用户组 - WeCom：企业微信回调 - Email：自定义邮件 - DingTalk：钉钉 - Lark：飞书", "example": "Uin" }, { "name": "Values", "type": "array", "required": false, "description": "知方式对应的值。 - 当ReceiverType为：`WeCom`、`DingTalk`、`Lark` 时，Values必须为空，且Url字段必填。 - 当ReceiverType为：`Uin`、`Group`、`Email` 时，Values必填，且Url字段必须为空。 - 当ReceiverType为：`Uin ` 时，Values为用户id，通过 [拉取子用户](https://cloud.tencent.com/document/product/598/34587) 获取子用户 UID 。 - 当ReceiverType为：`Group` 时，Values为用户组id，通过 [查询用户组列表](https://cloud.tencent.com...", "example": "[\"168053\",\"1\"]", "item_type": "string" }, { "name": "ReceiverChannels", "type": "array", "required": false, "description": "仪表盘通知渠道。 - 支持：[\"Email\",\"Sms\",\"WeChat\",\"Phone\"]。 - 当ReceiverType为 `Email` 或 `WeCom` 时，ReceiverChannels无效。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"Email\",\"Sms\",\"WeChat\",\"Phone\"]", "item_type": "string" }, { "name": "Url", "type": "string", "required": false, "description": "订阅方式 - 回调地址。 - 当ReceiverType为：`WeCom`、`DingTalk`、`Lark` 时，Url字段必填为各渠道的回调地址。 - 为：`WeCom` 时，Url为 企业微信回调地址。 - 为：`DingTalk` 时，Url为 钉钉机器人Webhook地址。 - 为：`Lark` 时，Url为 飞书机器人Webhook地址。 - 当ReceiverType为：`Uin`、`Group`、`Email` 时，Url字段必须为空。", "example": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=ctestea1a5-7xx9-4xx3-8xxb-w5fxxbd6" } ] }, { "name": "DashboardTime", "type": "array", "required": false, "description": "仪表盘订阅时间，为空标识取仪表盘默认的时间。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"now-5m\",\"now\"]", "item_type": "string" }, { "name": "TemplateVariables", "type": "array", "required": false, "description": "仪表盘订阅模板变量。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "key的值", "example": "TopicId" }, { "name": "Values", "type": "array", "required": true, "description": "key对应的values取值values", "example": "[\"xxxx-xxxx-xxxx-xxxx\",\"123414-12341234-12345-3456\"]", "item_type": "string" } ] }, { "name": "Timezone", "type": "string", "required": false, "description": "时区。参考：https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#SHANGHAI", "example": "Asia/Shanghai" }, { "name": "SubscribeLanguage", "type": "string", "required": false, "description": "语言。 zh 中文、en`英文。", "example": "zh" }, { "name": "JumpDomain", "type": "string", "required": false, "description": "调用链接域名。http:// 或者 https:// 开头，不能/结尾", "example": "https://console.cloud.tencent.com" }, { "name": "JumpUrl", "type": "string", "required": false, "description": "自定义跳转链接。", "example": "https://www.xxx.com/getxxx" } ] } ], "required": [ "Name", "DashboardId", "Cron", "SubscribeData" ] }, { "name": "CreateDataTransform", "description": "本接口用于创建数据加工任务。", "status": "online", "parameters": [ { "name": "FuncType", "type": "integer", "required": true, "description": "任务类型. 1: 指定主题；2:动态创建。详情请参考[创建加工任务文档](https://cloud.tencent.com/document/product/614/63940)。", "example": "1" }, { "name": "SrcTopicId", "type": "string", "required": true, "description": "日志主题ID - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "topicid-1" }, { "name": "Name", "type": "string", "required": true, "description": "加工任务名称 名称限制 - 不能为空字符串 - 不能包含字符'|' - 最长128 个字符", "example": "task1" }, { "name": "EtlContent", "type": "string", "required": true, "description": "加工语句。 当FuncType为2时，EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f) 其他参考文档： - [创建加工任务](https://cloud.tencent.com/document/product/614/63940) - [函数总览](https://cloud.tencent.com/document/product/614/70395)", "example": "fields_drop(\"message\")" }, { "name": "TaskType", "type": "integer", "required": true, "description": "加工类型。 1：使用源日志主题中的随机数据，进行加工预览；2：使用用户自定义测试数据，进行加工预览；3：创建真实加工任务。", "example": "1" }, { "name": "DstResources", "type": "array", "required": false, "description": "加工任务目标topic_id以及别名,当FuncType=1时，该参数必填，当FuncType=2时，无需填写。 目标topic_id，通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 别名限制 1.不能为空字符串，2. 不能包含字符'|'。", "example": "无", "item_type": "object", "children": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题ID通过获取日志主题列表获取日志主题Id。", "example": "abdeace6-9484-4d2e-b670-28289c42b60f" }, { "name": "Alias", "type": "string", "required": false, "description": "别名限制：不能包含字符 |。", "example": "topicname" }, { "name": "IsCrossAccount", "type": "boolean", "required": false, "description": "是否是跨账号主题，false不是跨账号主题，true是跨账号主题默认值：false", "example": "true" }, { "name": "RoleARN", "type": "string", "required": false, "description": "跨账号场景下，被投递账号给投递账号创建的角色ARN值，在被投递账号的角色里查找", "example": "qcs::cam::uin/1234567890:roleName/cls_online_role" }, { "name": "ExternalId", "type": "string", "required": false, "description": "外部ID值，可以在被投递账号的角色-载体里找到该值", "example": "hello123" }, { "name": "TopicName", "type": "string", "required": false, "description": "topic名称", "example": "topic_name_1" }, { "name": "LogsetName", "type": "string", "required": false, "description": "日志集的名称", "example": "logset_name_1" } ] }, { "name": "EnableFlag", "type": "integer", "required": false, "description": "任务启动状态. 默认为1:开启, 2:关闭", "example": "1" }, { "name": "PreviewLogStatistics", "type": "array", "required": false, "description": "用于预览加工结果的测试数据 目标日志主题ID通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "无", "item_type": "object", "children": [ { "name": "LogContent", "type": "string", "required": true, "description": "日志内容", "example": "{\\\"hello\\\":\\\"world\\\"}" }, { "name": "LineNum", "type": "integer", "required": true, "description": "行号。从0开始", "example": "0" }, { "name": "DstTopicId", "type": "string", "required": false, "description": "目标日志主题ID - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "4c216645-01f2-414d-8a87-719b97baxxx" }, { "name": "FailReason", "type": "string", "required": false, "description": "失败错误信息， 空字符串\"\"表示正常", "example": "error" }, { "name": "Time", "type": "string", "required": false, "description": "日志时间，格式：`2024-05-07 17:13:17.105` - 入参时无效 - 出参时有效，为日志中的时间格式", "example": "2024-05-07 17:13:17.105" } ] }, { "name": "BackupGiveUpData", "type": "boolean", "required": false, "description": "当FuncType为2时，动态创建的日志集、日志主题的个数超出产品规格限制是否丢弃数据， 默认为false。 false：创建兜底日志集、日志主题并将日志写入兜底主题； true：丢弃日志数据。", "example": "false" }, { "name": "HasServicesLog", "type": "integer", "required": false, "description": "是否开启投递服务日志。1：关闭，2：开启。", "example": "2" }, { "name": "DataTransformType", "type": "integer", "required": false, "description": "数据加工类型。0：标准加工任务； 1：前置加工任务。前置加工任务将采集的日志处理完成后，再写入日志主题。", "example": "0" }, { "name": "KeepFailureLog", "type": "integer", "required": false, "description": "保留失败日志状态，1:不保留(默认)，2:保留。", "example": "1" }, { "name": "FailureLogKey", "type": "string", "required": false, "description": "失败日志的字段名称", "example": "ETLParseFailure" }, { "name": "ProcessFromTimestamp", "type": "integer", "required": false, "description": "指定加工数据的开始时间, 秒级时间戳。 - 日志主题生命周期内的任意时间范围，如果超出了生命周期,只处理生命周期内有数据的部分。", "example": "1746686554" }, { "name": "ProcessToTimestamp", "type": "integer", "required": false, "description": "指定加工数据的结束时间，秒级时间戳。 - 不可指定未来的时间 - 不填则表示持续执行", "example": "1746687554" }, { "name": "TaskId", "type": "string", "required": false, "description": "对已经创建的并且使用了关联外部数据库能力的任务预览（TaskType 为 1 或 2）时，该值必传 数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。", "example": "abdeace6-9484-4d2e-b670-28289c42b60f" }, { "name": "DataTransformSqlDataSources", "type": "array", "required": false, "description": "关联的数据源信息", "example": "无", "item_type": "object", "children": [ { "name": "DataSource", "type": "integer", "required": true, "description": "数据源类型 1:MySql;2:自建mysql;3:pgsql", "example": "1" }, { "name": "Region", "type": "string", "required": true, "description": "InstanceId所属地域。例如：ap-guangzhou", "example": "ap-guangzhou" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id。 - 当DataSource为1时，表示云数据库Mysql 实例id，如：cdb-zxcvbnm", "example": "cdb-zxcvbnm" }, { "name": "User", "type": "string", "required": true, "description": "mysql访问用户名", "example": "user_00" }, { "name": "AliasName", "type": "string", "required": true, "description": "别名。数据加工语句中使用", "example": "my_db1x" }, { "name": "Password", "type": "string", "required": false, "description": "mysql访问密码。", "example": "ps_00" } ] }, { "name": "EnvInfos", "type": "array", "required": false, "description": "设置的环境变量", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "环境变量名", "example": "SecretKey" }, { "name": "Value", "type": "string", "required": false, "description": "环境变量值", "example": "key_ubsgg_demo" } ] } ], "required": [ "FuncType", "SrcTopicId", "Name", "EtlContent", "TaskType" ] }, { "name": "CreateDeliverCloudFunction", "description": "本接口用于创建投递SCF任务", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "投递规则属于的TopicId。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。", "example": "871710c5-35cd-4d1e-8e79-2fa92c35d612" }, { "name": "FunctionName", "type": "string", "required": true, "description": "投递的云函数名字。仅支持[事件函数](https://cloud.tencent.com/document/product/583/9694#scf-.E4.BA.8B.E4.BB.B6.E5.87.BD.E6.95.B0) （[函数类型选型](https://cloud.tencent.com/document/product/583/73483)） 通过 [获取函数列表](https://cloud.tencent.com/document/product/583/18582) 获取函数信息。", "example": "functionName1" }, { "name": "Namespace", "type": "string", "required": true, "description": "命名空间。参考 [命名空间管理](https://cloud.tencent.com/document/product/583/35913) - 通过 [列出命名空间列表](https://cloud.tencent.com/document/product/583/37158) 获取Name。", "example": "ns1" }, { "name": "Qualifier", "type": "string", "required": true, "description": "函数版本。 - 通过 [查询函数版本 ](https://cloud.tencent.com/document/product/583/37162) 获取函数版本。", "example": "$LATEST" }, { "name": "Timeout", "type": "integer", "required": false, "description": "投递最长等待时间，单位：秒。 默认：60", "example": "60" }, { "name": "MaxMsgNum", "type": "integer", "required": false, "description": "投递最大消息数。默认为100。支持范围[1,10000]", "example": "100" } ], "required": [ "TopicId", "FunctionName", "Namespace", "Qualifier" ] }, { "name": "CreateDlcDeliver", "description": "创建DLC投递任务", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题id。通过获取日志主题列表获取日志主题Id。", "example": "715094e3-01b0-4aeb-91f5-ee9f46a4a13c" }, { "name": "Name", "type": "string", "required": true, "description": "名称：长度不超过64字符，以字母开头，接受0-9,a-z,A-Z, _,-,中文字符。", "example": "template_1" }, { "name": "DeliverType", "type": "integer", "required": true, "description": "投递类型。0:批投递,1:实时投递", "example": "1" }, { "name": "StartTime", "type": "integer", "required": true, "description": "投递时间范围的开始时间", "example": "1741005340" }, { "name": "DlcInfo", "type": "object", "required": true, "description": "dlc配置信息", "example": "无", "children": [ { "name": "TableInfo", "type": "object", "required": true, "description": "dlc表信息", "example": "无", "children": [ { "name": "DataDirectory", "type": "string", "required": true, "description": "数据目录", "example": "data_directory" }, { "name": "DatabaseName", "type": "string", "required": true, "description": "数据库", "example": "database_name" }, { "name": "TableName", "type": "string", "required": true, "description": "数据表", "example": "table_name" } ] }, { "name": "FieldInfos", "type": "array", "required": true, "description": "dlc数据字段信息", "example": "无", "item_type": "object", "children": [ { "name": "ClsField", "type": "string", "required": true, "description": "cls日志中的字段名", "example": "table_name" }, { "name": "DlcField", "type": "string", "required": true, "description": "数据湖计算服务表的列名", "example": "table_name" }, { "name": "DlcFieldType", "type": "string", "required": true, "description": "数据湖计算服务字段类型枚举值：int|string|struct等： 参考 DLC cloumn中的Type 定义", "example": "string" }, { "name": "FillField", "type": "string", "required": false, "description": "解析失败填充字段", "example": "NULL" }, { "name": "Disable", "type": "boolean", "required": false, "description": "是否禁用", "example": "false" } ] }, { "name": "PartitionInfos", "type": "array", "required": true, "description": "dlc分区信息", "example": "无", "item_type": "object", "children": [ { "name": "ClsField", "type": "string", "required": true, "description": "cls日志中的字段名", "example": "table_name" }, { "name": "DlcField", "type": "string", "required": true, "description": "dlc表的列名", "example": "table_name" }, { "name": "DlcFieldType", "type": "string", "required": true, "description": "请参考 DLC cloumn中的Type 定义 枚举值：int|string|array等： 请参考 DLC cloumn中的Type 定义", "example": "string" } ] }, { "name": "PartitionExtra", "type": "object", "required": false, "description": "dlc分区额外信息", "example": "无", "children": [ { "name": "TimeFormat", "type": "string", "required": false, "description": "时间格式 eg: %Y-%m-%d %H:%M:%S.%f", "example": "%Y-%m-%d %H:%M:%S.%f" }, { "name": "TimeZone", "type": "string", "required": false, "description": "时间时区", "example": "UTC+08:00" } ] } ] }, { "name": "MaxSize", "type": "integer", "required": false, "description": "投递文件大小,单位MB。 DeliverType=0时必填，范围 5\u0026lt;= MaxSize \u0026lt;= 256。", "example": "5" }, { "name": "Interval", "type": "integer", "required": false, "description": "投递间隔，单位秒。 DeliverType=0时必填，范围 300\u0026lt;= Interval \u0026lt;=900。", "example": "300" }, { "name": "EndTime", "type": "integer", "required": false, "description": "投递时间范围的结束时间。 如果为空，则表示不限时。EndTime不为空时，需要大于StartTime。", "example": "1741006340" }, { "name": "HasServicesLog", "type": "integer", "required": false, "description": "是否开启投递服务日志。1关闭，2开启。默认开启", "example": "2" } ], "required": [ "TopicId", "Name", "DeliverType", "StartTime", "DlcInfo" ] }, { "name": "CreateEsRecharge", "description": "创建es导入配置", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。", "example": "715094e3-01b0-4aeb-91f5-ee9f46a4a13c" }, { "name": "Name", "type": "string", "required": true, "description": "名称：长度不超过64字符。", "example": "template_1" }, { "name": "Index", "type": "string", "required": true, "description": "索引信息。不同索引可以通过英文逗号分隔，支持*通配符", "example": "base-2026-01-*" }, { "name": "Query", "type": "string", "required": true, "description": "es查询语句。", "example": "tags.service.name:session" }, { "name": "EsInfo", "type": "object", "required": true, "description": "es集群配置信息。", "example": "无", "children": [ { "name": "EsType", "type": "integer", "required": true, "description": "es类型。 1:云es, 2:自建es", "example": "2" }, { "name": "AccessMode", "type": "integer", "required": false, "description": "访问方式 1:内网, 2:外网。自建es必填", "example": "2" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例id。云es实例必填", "example": "es-fbs7gqxx" }, { "name": "User", "type": "string", "required": false, "description": "用户名。", "example": "user" }, { "name": "Address", "type": "string", "required": false, "description": "访问地址。自建es必填", "example": "10.0.0.10" }, { "name": "Port", "type": "integer", "required": false, "description": "访问端口。自建es必填", "example": "9200" }, { "name": "VpcId", "type": "string", "required": false, "description": "所属网络。自建es且访问方式为内网访问时必填", "example": "vpc-xymnt" }, { "name": "VirtualGatewayType", "type": "integer", "required": false, "description": "网络服务类型。自建es且访问方式为内网访问时必填。 负载均衡 CLB:1025 云服务器CVM:0", "example": "1025" }, { "name": "Password", "type": "string", "required": false, "description": "密码。", "example": "password" } ] }, { "name": "ImportInfo", "type": "object", "required": true, "description": "es导入信息。", "example": "无", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "导入模式。 1. 导入历史数据 2. 导入实时数据", "example": "1" }, { "name": "StartTime", "type": "integer", "required": false, "description": "开始时间。 单位:秒级时间戳。", "example": "1739783039" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间。 单位：秒级时间戳。", "example": "1739784039" }, { "name": "MaxDelay", "type": "integer", "required": false, "description": "最大延迟时间。单位：s 导入模式为 2: 导入实时数据时必填", "example": "600" }, { "name": "CheckInterval", "type": "integer", "required": false, "description": "检查间隔。单位：s 导入模式为 2: 导入实时数据时必填", "example": "60" } ] }, { "name": "TimeInfo", "type": "object", "required": true, "description": "es导入时间字段信息。", "example": "无", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "时间类型 1: 日志采集时间 2: 指定日志字段", "example": "2" }, { "name": "TimeKey", "type": "string", "required": false, "description": "日志时间字段。 时间类型为 2: 指定日志字段时必填", "example": "time_key" }, { "name": "TimeFormat", "type": "string", "required": false, "description": "日志时间格式。 时间类型为 2: 指定日志字段时必填", "example": "%Y-%m-%d %H:%M:%S.%f" }, { "name": "TimeZone", "type": "string", "required": false, "description": "时间字段时区。 时间类型为 2: 指定日志字段时必填", "example": "UTC+08:00" } ] }, { "name": "HasServicesLog", "type": "integer", "required": false, "description": "是否开启投递服务日志。1：关闭，2：开启。默认开启。", "example": "2" } ], "required": [ "TopicId", "Name", "Index", "Query", "EsInfo", "ImportInfo", "TimeInfo" ] }, { "name": "CreateExport", "description": "本接口仅创建下载任务。任务返回的下载地址，请用户调用[DescribeExports](https://cloud.tencent.com/document/product/614/56449)查看任务列表，其中有下载地址CosPath参数。", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题Id - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "ee20bb16-3025-4048-b81a-dd436373062e" }, { "name": "Count", "type": "integer", "required": true, "description": "日志导出数量, 最大值5000万", "example": "100" }, { "name": "Query", "type": "string", "required": true, "description": "日志导出检索语句，不支持[SQL语句]", "example": "status:200" }, { "name": "From", "type": "integer", "required": true, "description": "日志导出起始时间，毫秒时间戳", "example": "1607499107000" }, { "name": "To", "type": "integer", "required": true, "description": "日志导出结束时间，毫秒时间戳", "example": "1607499207000" }, { "name": "Order", "type": "string", "required": false, "description": "日志导出时间排序。desc，asc，默认为desc", "example": "desc" }, { "name": "Format", "type": "string", "required": false, "description": "日志导出数据格式。json，csv，默认为json", "example": "json" }, { "name": "SyntaxRule", "type": "integer", "required": false, "description": "语法规则, 默认值为0。 0：Lucene语法，1：CQL语法。", "example": "1" }, { "name": "DerivedFields", "type": "array", "required": false, "description": "导出字段", "example": "[\"__timestamp__\"]", "item_type": "string" } ], "required": [ "TopicId", "Count", "Query", "From", "To" ] }, { "name": "CreateHostMetricConfig", "description": "创建主机指标采集配置", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "指标日志主题id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题（默认值）， 1:指标主题 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题（默认值）， 1:指标主题", "example": "715094e3-01b0-4aeb-91f5-ee9f46a4a13c" }, { "name": "Name", "type": "string", "required": true, "description": "名称。 - 长度不超过 64字符。", "example": "template-1" }, { "name": "MachineGroupIds", "type": "array", "required": true, "description": "机器组id列表。最多支持100个机器组。", "example": "[\"81853bcf-67b4-4a4f-82c7-7882fd004613\"]", "item_type": "string" }, { "name": "Interval", "type": "integer", "required": true, "description": "采集频率。单位:ms。 最小支持5000ms", "example": "5000" }, { "name": "HostMetricItems", "type": "array", "required": true, "description": "采集项。支持\"cpu\"，\"mem\"，\"net\"，\"disk\"，\"system\"。**目前仅支持:所有采集项都需配置**。 - cpu：CPU - mem：内存 - net：网络 - disk：磁盘 - system：系统", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "主机指标采集项类型。支持\"cpu\"，\"mem\"，\"net\"，\"disk\"，\"system\"。 - cpu：CPU - mem：内存 - net：网络 - disk：磁盘 - system：系统", "example": "cpu" } ] } ], "required": [ "TopicId", "Name", "MachineGroupIds", "Interval", "HostMetricItems" ] }, { "name": "CreateIndex", "description": "本接口用于创建索引", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题Id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "75f531f6-3644-45e5-8717-af1dc294cc93" }, { "name": "Rule", "type": "object", "required": true, "description": "索引规则", "example": "无", "children": [ { "name": "FullText", "type": "object", "required": false, "description": "全文索引配置, 为空时代表未开启全文索引 注意：此字段可能返回 null，表示取不到有效值。", "example": "空", "children": [ { "name": "CaseSensitive", "type": "boolean", "required": true, "description": "是否大小写敏感", "example": "false" }, { "name": "Tokenizer", "type": "string", "required": true, "description": "全文索引的分词符，其中的每个字符代表一个分词符； 仅支持英文符号、\\n\\t\\r及转义符\\； 注意：\\n\\t\\r本身已被转义，直接使用双引号包裹即可作为入参，无需再次转义。使用API Explorer进行调试时请使用JSON参数输入方式，以避免\\n\\t\\r被重复转义", "example": "@\u0026?|#()='\",;:\u003c\u003e[]{}/ \\n\\t\\r\\\\" }, { "name": "ContainZH", "type": "boolean", "required": false, "description": "是否包含中文", "example": "false" } ] }, { "name": "KeyValue", "type": "object", "required": false, "description": "键值索引配置，为空时代表未开启键值索引 注意：此字段可能返回 null，表示取不到有效值。", "example": "空", "children": [ { "name": "CaseSensitive", "type": "boolean", "required": true, "description": "是否大小写敏感", "example": "false" }, { "name": "KeyValues", "type": "array", "required": false, "description": "需要建立索引的键值对信息", "example": "空", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要配置键值或者元字段索引的字段名称，仅支持字母、数字、下划线和-./@，且不能以下划线开头 注意： 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父\ufffd\ufffd...", "example": "address" }, { "name": "Value", "type": "object", "required": true, "description": "字段的索引描述信息", "example": "无" } ] } ] }, { "name": "Tag", "type": "object", "required": false, "description": "元字段索引配置，为空时代表未开启元字段索引 注意：此字段可能返回 null，表示取不到有效值。", "example": "空", "children": [ { "name": "CaseSensitive", "type": "boolean", "required": true, "description": "是否大小写敏感", "example": "false" }, { "name": "KeyValues", "type": "array", "required": true, "description": "元字段索引配置中的字段信息", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要配置键值或者元字段索引的字段名称，仅支持字母、数字、下划线和-./@，且不能以下划线开头 注意： 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父\ufffd\ufffd...", "example": "address" }, { "name": "Value", "type": "object", "required": true, "description": "字段的索引描述信息", "example": "无" } ] } ] }, { "name": "DynamicIndex", "type": "object", "required": false, "description": "键值索引自动配置，为空时代表未开启该功能。 启用后自动将日志内的字段添加到键值索引中，包括日志中后续新增的字段。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Status", "type": "boolean", "required": false, "description": "键值索引自动配置开关", "example": "false" } ] } ] }, { "name": "Status", "type": "boolean", "required": false, "description": "是否生效，默认为true", "example": "true" }, { "name": "IncludeInternalFields", "type": "boolean", "required": false, "description": "内置保留字段（`__FILENAME__`，`__HOSTNAME__`及`__SOURCE__`）是否包含至全文索引，默认为false，推荐设置为true * false:不包含 * true:包含", "example": "true" }, { "name": "MetadataFlag", "type": "integer", "required": false, "description": "元数据字段（前缀为`__TAG__`的字段）是否包含至全文索引，默认为0，推荐设置为1 * 0:仅包含开启键值索引的元数据字段 * 1:包含所有元数据字段 * 2:不包含任何元数据字段", "example": "0" }, { "name": "CoverageField", "type": "string", "required": false, "description": "自定义日志解析异常存储字段。", "example": "RAWLOG" } ], "required": [ "TopicId", "Rule" ] }, { "name": "CreateKafkaRecharge", "description": "本接口用于创建Kafka数据订阅任务", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "导入CLS目标TopicId。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。", "example": "b53fe5be-7ee3-4031-8043-5a73bad4f572" }, { "name": "Name", "type": "string", "required": true, "description": "Kafka导入配置名称", "example": "mysql-subscribe" }, { "name": "KafkaType", "type": "integer", "required": true, "description": "导入Kafka类型，0: 腾讯云CKafka，1: 用户自建Kafka", "example": "0" }, { "name": "UserKafkaTopics", "type": "string", "required": true, "description": "用户需要导入的Kafka相关topic列表，多个topic之间使用半角逗号隔开", "example": "topic1,topic2" }, { "name": "Offset", "type": "integer", "required": true, "description": "导入数据位置，-2:最早（默认），-1：最晚", "example": "-1" }, { "name": "LogRechargeRule", "type": "object", "required": true, "description": "日志导入规则。", "example": "无", "children": [ { "name": "RechargeType", "type": "string", "required": true, "description": "导入类型，支持json_log：json格式日志，minimalist_log: 单行全文，fullregex_log: 单行完全正则", "example": "json_log" }, { "name": "EncodingFormat", "type": "integer", "required": true, "description": "解析编码格式，0: UTF-8（默认值），1: GBK", "example": "0" }, { "name": "DefaultTimeSwitch", "type": "boolean", "required": true, "description": "使用默认时间状态。true：开启后将使用系统当前时间或 Kafka 消息时间戳作为日志时间戳；false：关闭将使用日志中的时间字段作为日志时间戳。 默认：true", "example": "true" }, { "name": "LogRegex", "type": "string", "required": false, "description": "整条日志匹配规则，只有RechargeType为fullregex_log时有效", "example": "(\\\\w+).*" }, { "name": "UnMatchLogSwitch", "type": "boolean", "required": false, "description": "解析失败日志是否上传，true表示上传，false表示不上传", "example": "true" }, { "name": "UnMatchLogKey", "type": "string", "required": false, "description": "解析失败日志的键名称", "example": "LogParseFailure" }, { "name": "UnMatchLogTimeSrc", "type": "integer", "required": false, "description": "解析失败日志时间来源，0: 系统当前时间，1: Kafka消息时间戳", "example": "1" }, { "name": "DefaultTimeSrc", "type": "integer", "required": false, "description": "默认时间来源，0: 系统当前时间，1: Kafka消息时间戳", "example": "0" }, { "name": "TimeKey", "type": "string", "required": false, "description": "时间字段，日志中代表时间的字段名。 - 当DefaultTimeSwitch为false，且RechargeType数据提取模式为 `json_log` JSON-文件日志 或 `fullregex_log` 单行完全正则-文件日志时， TimeKey不能为空。", "example": "__TIMESTAMP__" }, { "name": "TimeRegex", "type": "string", "required": false, "description": "时间提取正则表达式。 - 当DefaultTimeSwitch为false，且RechargeType数据提取模式为 `minimalist_log` 单行全文-文件日志时， TimeRegex不能为空。 - 仅需输入日志中代表时间的字段的正则表达式即可；若匹配到多个字段，将使用第一个。 例：日志原文为：message with time 2022-08-08 14:20:20，则您可以设置提取时间正则为\\d\\d\\d\\d-\\d\\d-\\d\\d \\d\\d:\\d\\d:\\d\\d", "example": "(\\d{4})-(\\d{2})-(\\d{2}) (\\d{2}):(\\d{2}):(\\d{2})" }, { "name": "TimeFormat", "type": "string", "required": false, "description": "时间字段格式。 - 当DefaultTimeSwitch为false时， TimeFormat不能为空。", "example": "%Y-%m-%d %H:%M:%S" }, { "name": "TimeZone", "type": "string", "required": false, "description": "时间字段时区。 - 当DefaultTimeSwitch为false时， TimeZone不能为空。 - 时区格式规则 ​前缀​：使用 GMT 或 UTC 作为时区基准 ​偏移量​： - `-` 表示西时区（比基准时间晚） - `+` 表示东时区（比基准时间早） - 格式为 ±HH:MM（小时:分钟） - 当前支持： ``` \"GMT-12:00\" \"GMT-11:00\" \"GMT-10:00\" \"GMT-09:30\" \"GMT-09:00\" \"GMT-08:00\" \"GMT-07:00\" \"GMT-06:00\" \"GMT-05:00\" \"GMT-04:00\" \"GMT-03:30\" \"GMT-03:00\" \"GMT-02:00\" \"GMT-01:00\" \"GM...", "example": "UTC+08:00" }, { "name": "Metadata", "type": "array", "required": false, "description": "元数据信息，Kafka导入支持kafka_topic,kafka_partition,kafka_offset,kafka_timestamp", "example": "[\"kafka_topic\",\"kafka_partition\",\"kafka_offset\",\"kafka_timestamp\"]", "item_type": "string" }, { "name": "Keys", "type": "array", "required": false, "description": "日志Key列表，RechargeType为full_regex_log、delimiter_log时必填", "example": "[\"name\",\"address\"]", "item_type": "string" }, { "name": "ParseArray", "type": "boolean", "required": false, "description": "json解析模式，开启首层数据解析", "example": "false" }, { "name": "Delimiter", "type": "string", "required": false, "description": "分隔符解析模式-分隔符 当解析格式为分隔符提取时，该字段必填", "example": "," } ] }, { "name": "KafkaInstance", "type": "string", "required": false, "description": "腾讯云CKafka实例ID，KafkaType为0时必填。 - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。", "example": "ckafka-2vrgxbxa" }, { "name": "ServerAddr", "type": "string", "required": false, "description": "服务地址，KafkaType为1时必填。", "example": "192.168.0.1:9095或test.cls.tencentyun.com:9095" }, { "name": "IsEncryptionAddr", "type": "boolean", "required": false, "description": "ServerAddr是否为加密连接，KafkaType为1时必填。", "example": "true" }, { "name": "Protocol", "type": "object", "required": false, "description": "加密访问协议。 KafkaType为1并且IsEncryptionAddr为true时Protocol必填。", "example": "无", "children": [ { "name": "Protocol", "type": "string", "required": false, "description": "协议类型，支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl，此协议会进行连接加密同时需要用户认证。 - 当IsEncryptionAddr为true时，Protocol必填。 - 支持的协议类型如下： - plaintext：纯文本无加密协议 - sasl_ssl：SASL 认证 + SSL 加密 - ssl：纯 SSL/TLS 加密协议 - sasl_plaintext：SASL 认证 + 非加密通道", "example": "sasl_ssl" }, { "name": "Mechanism", "type": "string", "required": false, "description": "加密类型，支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。 - 当Protocol为 `sasl_plaintext` 或 `sasl_ssl` 时 Mechanism 必填。 - 支持加密类型如下 - PLAIN：明文认证 - SCRAM-SHA-256：基于挑战-响应机制，使用PBKDF2-HMAC-SHA256算法 - SCRAM-SHA-512：增强版SCRAM，使用PBKDF2-HMAC-SHA512算法", "example": "PLAIN" }, { "name": "UserName", "type": "string", "required": false, "description": "用户名。 当Protocol为sasl_plaintext或sasl_ssl时必填", "example": "name" }, { "name": "Password", "type": "string", "required": false, "description": "用户密码。 当Protocol为sasl_plaintext或sasl_ssl时必填", "example": "axxxxxx" } ] }, { "name": "ConsumerGroupName", "type": "string", "required": false, "description": "用户Kafka消费组名称。 - 消费组是 Kafka 提供的可扩展且具有容错性的消费者机制，一个消费组中存在多个消费者，组内的所有消费者共同消费订阅 Topic 中的消息。一个消费者可同时消费多个 Partition，但一个 Partition 只能被消费组内的一个消费者消费。", "example": "consumer-group-name" }, { "name": "UserKafkaMeta", "type": "object", "required": false, "description": "用户kafka拓展信息", "example": "无", "children": [ { "name": "KafkaVersion", "type": "string", "required": true, "description": "用户kafka version 支持如下版本： - 0.10.2.0 - 1.0.0 - 2.0.0 - 2.2.0 - 2.4.0 - 2.6.0 - 2.7.0 - 2.8.0 - 3.0.0 - 3.2.0", "example": "2.0.0" } ] } ], "required": [ "TopicId", "Name", "KafkaType", "UserKafkaTopics", "Offset", "LogRechargeRule" ] }, { "name": "CreateLogset", "description": "本接口用于创建日志集，返回新创建的日志集的 ID。", "status": "online", "parameters": [ { "name": "LogsetName", "type": "string", "required": true, "description": "日志集名字。 - 最大支持255个字符。不支持`|`字符。", "example": "业务流日志集" }, { "name": "Tags", "type": "array", "required": false, "description": "标签描述列表。最大支持10个标签键值对，并且不能有重复的键值对", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "业务A" } ] }, { "name": "LogsetId", "type": "string", "required": false, "description": "日志集ID，格式为：用户自定义部分-用户APPID。未填写该参数时将自动生成ID。 - 用户自定义部分仅支持小写字母、数字和-，且不能以-开头和结尾，长度为3至40字符。 - 尾部需要使用-拼接用户APPID，APPID可在https://console.cloud.tencent.com/developer页面查询。 - 如果指定该字段，需保证全地域唯一", "example": "user-diy-1254139626" } ], "required": [ "LogsetName" ] }, { "name": "CreateMachineGroup", "description": "创建机器组", "status": "online", "parameters": [ { "name": "GroupName", "type": "string", "required": true, "description": "机器组名字。 输入限制： - 最大支持255个字符，不能为空字符串 - 不能包含字符'|'", "example": "testgroup" }, { "name": "MachineGroupType", "type": "object", "required": true, "description": "创建机器组类型。取值如下： - Type：ip，Values中为ip字符串列表创建机器组 - Type：label，Values中为标签字符串列表创建机器组", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "机器组类型。支持 ip 和 label。 - ip：表示该机器组Values中存的是采集机器的ip地址 - label：表示该机器组Values中存储的是机器的标签", "example": "ip" }, { "name": "Values", "type": "array", "required": false, "description": "机器描述列表。", "example": "[10.1.1.1,10.2.2.2]", "item_type": "string" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "标签描述列表，通过指定该参数可以同时绑定标签到相应的机器组。最大支持10个标签键值对，同一个资源只能绑定到同一个标签键下。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "业务A" } ] }, { "name": "AutoUpdate", "type": "boolean", "required": false, "description": "是否开启机器组自动更新。默认false", "example": "true" }, { "name": "UpdateStartTime", "type": "string", "required": false, "description": "升级开始时间，建议业务低峰期升级LogListener 时间格式：HH:mm:ss", "example": "\"12:00:00\"" }, { "name": "UpdateEndTime", "type": "string", "required": false, "description": "升级结束时间，建议业务低峰期升级LogListener 时间格式：HH:mm:ss", "example": "\"13:00:00\"" }, { "name": "ServiceLogging", "type": "boolean", "required": false, "description": "是否开启服务日志，用于记录因Loglistener 服务自身产生的log，开启后，会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business，不产生计费。默认false", "example": "true" }, { "name": "DelayCleanupTime", "type": "integer", "required": false, "description": "机器组中机器离线清理时间。单位：天 - 大于0时生效。", "example": "30" }, { "name": "MetaTags", "type": "array", "required": false, "description": "机器组元数据信息列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "元数据key", "example": "buss_key" }, { "name": "Value", "type": "string", "required": false, "description": "元数据value", "example": "buss_value" } ] }, { "name": "OSType", "type": "integer", "required": false, "description": "系统类型，取值如下： - 0：Linux （默认值） - 1：Windows", "example": "0" } ], "required": [ "GroupName", "MachineGroupType" ] }, { "name": "CreateMetricConfig", "description": "创建指标采集配置", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "指标日志主题id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题（默认值）， 1:指标主题 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题（默认值）， 1:指标主题", "example": "715094e3-01b0-4aeb-91f5-ee9f46a4a13c" }, { "name": "Source", "type": "integer", "required": true, "description": "采集配置来源。支持 ：`0`、`1` - 0:自建k8s - 1:TKE", "example": "0" }, { "name": "GroupIds", "type": "array", "required": true, "description": "机器组id。", "example": "[\"81853bcf-67b4-4a4f-82c7-7882fd004613\"]", "item_type": "string" }, { "name": "Type", "type": "integer", "required": true, "description": "监控类型。支持 ：`0`、`1`，不支持修改 - 0:基础监控 - 1:自定义监控,", "example": "0" }, { "name": "Flag", "type": "integer", "required": true, "description": "采集配置方式。支持 ：`0`、`1`，不支持修改 - 0:普通配置方式，Type字段只能为：``1` - 1:YAML导入方式， Type 可以是：`0`或者`1`", "example": "0" }, { "name": "Name", "type": "string", "required": false, "description": "名称：长度不超过253字符，校验格式 ` [a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*`。", "example": "template-1" }, { "name": "Spec", "type": "object", "required": false, "description": "采集对象, Flag=0时生效", "example": "无", "children": [ { "name": "CustomSpecs", "type": "array", "required": false, "description": "自定义指标采集配置项 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Port", "type": "string", "required": true, "description": "端口。取值范围 [1,65535] 注意：此字段可能返回 null，表示取不到有效值。", "example": "80" }, { "name": "Path", "type": "string", "required": true, "description": "Metric地址。校验格式：`^/[a-zA-Z0-9-_./]*$` 注意：此字段可能返回 null，表示取不到有效值。", "example": "/metric" }, { "name": "Namespaces", "type": "array", "required": false, "description": "命名空间列表。 - 最大支持100个 - namespace 校验格式 `[a-z0-9]([-a-z0-9]*[a-z0-9])?` ， 长度不能超过63 - namespace 不能重复 注意：此字段可能返回 null，表示取不到有效值。", "example": "kebe-system", "item_type": "string" }, { "name": "PodLabel", "type": "array", "required": false, "description": "Pod标签。 - 最大支持100个 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签的键。有效标签键有两个部分：可选前缀和名称，以斜杠 (/) 分隔。名称部分是必需的，并且必须不超过 63 个字符，以字母数字字符 ([a-z0-9A-Z]) 开头和结尾，中间有破折号(-)、下划线(_)、点(.) 和字母数字。前缀是可选的。如果指定，前缀必须是 DNS 子域：一系列以点 (.) 分隔的 DNS 标签，总长度不超过 253 个字符，后跟斜杠 ( /)。 - prefix 格式 `[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([...", "example": "app" }, { "name": "Operate", "type": "string", "required": true, "description": "标签键值直接的比较关系。 不同业务场景支持的比较符不同，具体支持那些参考接口业务描述。 例如：`in`、`notin` 注意：此字段可能返回 null，表示取不到有效值。", "example": "in" }, { "name": "Values", "type": "array", "required": false, "description": "标签的值. - 最大支持63个字符。 - 格式：`([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]` 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"k8s-x\"]", "item_type": "string" } ] } ] } ] }, { "name": "MetricRelabels", "type": "array", "required": false, "description": "标签处理, Flag=0时生效", "example": "无", "item_type": "object", "children": [ { "name": "Action", "type": "string", "required": true, "description": "基于正则表达式匹配执行的动作。 - replace: Label替换, 必填: SourceLabels, Separator, Regex, TargetLabel, Replacement - labeldrop: 丢弃Label, 必填: Regex - labelkeep: 保留Label, 必填: Regex - lowercase: 小写化, 必填: SourceLabels, Separator, TargetLabel - uppercase: 大写化, 必填: SourceLabels, Separator, TargetLabel - dropequal: 丢弃指标-完全匹配, 必填: SourceLabels, Separator, TargetLabel - keepequal: 保留指标-完全匹配, 必填: SourceLabels, ...", "example": "replace" }, { "name": "SourceLabels", "type": "array", "required": false, "description": "原始label 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"__meta_kubernetes_pod_label_app\"]", "item_type": "string" }, { "name": "Separator", "type": "string", "required": false, "description": "原始label连接符。 必填时不能为空串， 长度不能超过256 注意：此字段可能返回 null，表示取不到有效值。", "example": ";" }, { "name": "TargetLabel", "type": "string", "required": false, "description": "目标label。必填时不能为空串，校验格式：`^[a-zA-Z_][a-zA-Z0-9_]*$` ， 长度不能超过256 注意：此字段可能返回 null，表示取不到有效值。", "example": "application" }, { "name": "Replacement", "type": "string", "required": false, "description": "替换值。如果正则表达式匹配，则对其执行替换操作。 - 必填时不能为空串，长度不能超过256 - 当action为LabelMap时， Replacement 校验格式：`^(?:(?:[a-zA-Z_]|\\$(?:\\{\\w+\\}|\\w+))+\\w*)+$` 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Regex", "type": "string", "required": false, "description": "正则表达式。提取与之匹配值。必填时不能为空串，校验必须是一个合法的 RE2 注意：此字段可能返回 null，表示取不到有效值。", "example": "(.*)" }, { "name": "Modulus", "type": "integer", "required": false, "description": "获取源标签值的哈希值。必填时不能为空,不能为0 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "MetricLabel", "type": "object", "required": false, "description": "自定义元数据, Flag=0时生效", "example": "无", "children": [ { "name": "Metadata", "type": "array", "required": false, "description": "元数据。 支持 - `namespace` - `pod_name` - `pod_ip` - `pod_uid` - `container_name` - `container_id` - `image_name` - `cluster_id` - `node_id` - `node_ip` 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"namespace\",\"pod_name\"]", "item_type": "string" }, { "name": "Label", "type": "object", "required": false, "description": "元数据Pod Label信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "指定标签类型。 - 0：所有Pod label，Keys字段无效 - 1：指定Pod label，Keys字段不能为空 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Keys", "type": "array", "required": false, "description": "元数据Pod标签的键。有效标签键有两个部分：可选前缀和名称，以斜杠 (/) 分隔。名称部分是必需的，并且必须不超过 63 个字符，以字母数字字符 ([a-z0-9A-Z]) 开头和结尾，中间有破折号(-)、下划线(_)、点(.) 和字母数字。前缀是可选的。如果指定，前缀必须是 DNS 子域：一系列以点 (.) 分隔的 DNS 标签，总长度不超过 253 个字符，后跟斜杠 ( /)。 - prefix 格式 `[a-z0-9]([-a-z0-9]*[a-z0-9])?(...", "example": "[\"k8s-key\"]", "item_type": "string" } ] }, { "name": "CustomLabels", "type": "array", "required": false, "description": "自定义label信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签的键。 - 必须以字母或下划线开头，但不可以双下划线（__）开头，后面可以跟任意字母，数字或下划线。 - 最大支持256个字符。 - key不能重复 注意：此字段可能返回 null，表示取不到有效值。", "example": "app" }, { "name": "Value", "type": "string", "required": true, "description": "标签的值。 - 最大支持256个字符。 注意：此字段可能返回 null，表示取不到有效值。", "example": "k8s-x" } ] } ] }, { "name": "Scheme", "type": "string", "required": false, "description": "通信协议 http、https; Flag=0时生效", "example": "http" }, { "name": "ScrapeInterval", "type": "string", "required": false, "description": "采集频率, Flag=0时生效 - 校验格式：`^(((\\d+)y)?((\\d+)w)?((\\d+)d)?((\\d+)h)?((\\d+)m)?((\\d+)s)?((\\d+)ms)?|0)$` - 默认：60s", "example": "60s" }, { "name": "ScrapeTimeout", "type": "string", "required": false, "description": "采集超时时间， Flag=0时生效 - 校验格式：`^(((\\d+)y)?((\\d+)w)?((\\d+)d)?((\\d+)h)?((\\d+)m)?((\\d+)s)?((\\d+)ms)?|0)$` - 默认：30s", "example": "30s" }, { "name": "HonorLabels", "type": "boolean", "required": false, "description": "Prometheus如何处理标签之间的冲突。当Flag=0时生效，支持`true`,`false` - `false`:配置数据中冲突的标签重命名 - `true`:忽略冲突的服务器端标签", "example": "false" }, { "name": "YamlSpec", "type": "object", "required": false, "description": "采集配置yaml格式字符串, Flag=1时必填", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "yaml监控类型。 支持： - PodMonitor - ServiceMonitor - ScrapeConfig - ScrapeConfig-prometheus `PodMonitor `,`ServiceMonitor `,`ScrapeConfig ` 属于prometheus-operator `ScrapeConfig-prometheus` 属于prometheus 注意：此字段可能返回 null，表示取不到有效值。", "example": "ServiceMonitor" }, { "name": "Spec", "type": "string", "required": true, "description": "配置yaml格式。 例如：Type: ServiceMonitor ``` apiVersion: monitoring.coreos.com/v1 kind: ServiceMonitor metadata: name: test namespace: test labels: k8s-app1: test k8s-app2: test spec: endpoints: - interval: 15s port: 8080-8080-tcp path: /metrics relabelings: - action: replace sourceLabels: - __meta_kubernetes_pod_label_app targetLabel: application namespaceSelector: matchNames: - test selector: matchLabels: app: test ``` 注意：此字段可能返回 null，表示取不到有效值。", "example": " \"apiVersion: monitoring.coreos.com/v1\\nkind: ServiceMonitor\\nmetadata:\\n name: test\\n namespace: test\\n labels:\\n k8s-app1: test\\n k8s-app2: test\\nspec:\\n endpoints:\\n - interval: 15s\\n port: 8080-8080-tcp\\n path: /metrics\\n relabelings:\\n - action: replace\\n sourceLabels:\\n - __meta_kubernetes_pod_label_app\\n targetLabel: application\\n namespaceSelector:\\n matchNames:\\n - test\\n selector:\\n matchLabels:\\n app: test\"" } ] } ], "required": [ "TopicId", "Source", "GroupIds", "Type", "Flag" ] }, { "name": "CreateMetricSubscribe", "description": "创建指标订阅配置", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "名称：长度不超过64字符，以字母开头，接受0-9,a-z,A-Z, _,-,中文字符。", "example": "template_1" }, { "name": "TopicId", "type": "string", "required": true, "description": "日志主题id。", "example": "715094e3-01b0-4aeb-91f5-ee9f46a4a13c" }, { "name": "Namespace", "type": "string", "required": true, "description": "云产品命名空间。", "example": "QCE/CVM" }, { "name": "Metrics", "type": "array", "required": true, "description": "数据库配置信息。", "example": "无", "item_type": "object", "children": [ { "name": "MetricName", "type": "string", "required": true, "description": "指标名称", "example": "metric_name" }, { "name": "Periods", "type": "array", "required": true, "description": "统计周期,单位:秒（s）", "example": "[60,120]", "item_type": "integer" }, { "name": "MetricLabels", "type": "array", "required": false, "description": "自定义指标标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "指标名称", "example": "ErrorMessage" }, { "name": "Value", "type": "string", "required": true, "description": "指标内容", "example": "Unauthorized" } ] } ] }, { "name": "InstanceInfo", "type": "object", "required": true, "description": "实例配置配置。", "example": "无", "children": [ { "name": "InstanceDimension", "type": "array", "required": true, "description": "实例维度", "example": "[\"bucket\",\"appid\"]", "item_type": "string" }, { "name": "Instances", "type": "array", "required": true, "description": "实例值", "example": "无", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "实例信息", "example": "[\"key1-value\",\"key2-value\"]", "item_type": "string" } ] } ] } ], "required": [ "Name", "TopicId", "Namespace", "Metrics", "InstanceInfo" ] }, { "name": "CreateNetworkApplication", "description": "创建网络应用", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "网络应用名称：长度不超过64字符，名称不能重复。只能包含以下字符：英文字母（大小写）数字下划线连字符（减号）汉字至少包含一个字符不能包含空格不能包含其他特殊字符（如 @、#、$、% 等）", "example": "network_application_demo" }, { "name": "LogsetId", "type": "string", "required": true, "description": "日志集ID通过获取日志集列表获取日志集Id。", "example": "b2927b70-6650-4bae-ba42-2cdc569f202e" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称。名称限制如下：不能为空字符串不能包含字符\u0026#39;|\u0026#39;不能使用以下名称[\u0026quot;cls_service_log\u0026quot;,\u0026quot;loglistener_status\u0026quot;,\u0026quot;loglistener_alarm\u0026quot;,\u0026quot;loglistener_business\u0026quot;,\u0026quot;cls_service_metric\u0026quot;]", "example": "network_application_topic_name" } ], "required": [ "Name", "LogsetId", "TopicName" ] }, { "name": "CreateNoticeContent", "description": "该接口用于创建通知内容。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "模板名称。最大支持255个字节", "example": "告警内容模板" }, { "name": "Type", "type": "integer", "required": false, "description": "模板内容语言。0：中文1：英文", "example": "0" }, { "name": "NoticeContents", "type": "array", "required": false, "description": "模板详细配置。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "渠道类型 Email:邮件;Sms:短信;WeChat:微信;Phone:电话;WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调;", "example": "\"Email\"" }, { "name": "TriggerContent", "type": "object", "required": false, "description": "告警触发通知内容模板。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "通知内容模板标题信息。 部分通知渠道类型不支持“标题”，请参照[腾讯云控制台页面](https://console.cloud.tencent.com/cls/alarm/notice-template)。", "example": "这是标题。" }, { "name": "Content", "type": "string", "required": false, "description": "通知内容模板正文信息。", "example": "这是正文。" }, { "name": "Headers", "type": "array", "required": false, "description": "请求头（Request Headers）：在HTTP请求中，请求头包含了客户端向服务器发送的附加信息，如用户代理、授权凭证、期望的响应格式等。 仅“自定义回调”支持该配置。", "example": "[\"Content-Type:application/json\"]", "item_type": "string" } ] }, { "name": "RecoveryContent", "type": "object", "required": false, "description": "告警恢复通知内容模板。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "通知内容模板标题信息。 部分通知渠道类型不支持“标题”，请参照[腾讯云控制台页面](https://console.cloud.tencent.com/cls/alarm/notice-template)。", "example": "这是标题。" }, { "name": "Content", "type": "string", "required": false, "description": "通知内容模板正文信息。", "example": "这是正文。" }, { "name": "Headers", "type": "array", "required": false, "description": "请求头（Request Headers）：在HTTP请求中，请求头包含了客户端向服务器发送的附加信息，如用户代理、授权凭证、期望的响应格式等。 仅“自定义回调”支持该配置。", "example": "[\"Content-Type:application/json\"]", "item_type": "string" } ] } ] } ], "required": [ "Name" ] }, { "name": "CreateRebuildIndexTask", "description": "创建重建索引任务 注意： - 单个日志主题同时仅允许运行一个重建索引任务，单个日志主题最多同时拥有10个重建索引任务记录，需删除不再需要的任务记录后才能新建索引任务。 - 同一时间范围内的日志，仅允许重建一次索引，需删除之前的任务记录后才能再次重建。 - 删除重建索引任务记录将恢复重建索引前的索引数据。 - 所选时间范围对应日志写流量不能超出5TB。 - 重\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题ID", "example": "57f5808c-4a55-11eb-b378-0242ac130002" }, { "name": "StartTime", "type": "integer", "required": true, "description": "重建起始时间戳，毫秒 起始时间不允许超过日志生命周期", "example": "978653222" }, { "name": "EndTime", "type": "integer", "required": true, "description": "重建结束时间戳，毫秒 结束时间不晚于当前时间往前推15分钟 注意：建议提前使用“预估重建索引任务(EstimateRebuildIndexTask)”接口评估该时间范围重建索引涉及到的数据量及耗时，避免因数据量过大导致费用成本过高或耗时过长", "example": "978653222" } ], "required": [ "TopicId", "StartTime", "EndTime" ] }, { "name": "CreateScheduledSql", "description": "本接口用于创建定时SQL分析任务", "status": "online", "parameters": [ { "name": "SrcTopicId", "type": "string", "required": true, "description": "源日志主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "6ef60bec-0242-43af-bb20-270359fbxxx" }, { "name": "Name", "type": "string", "required": true, "description": "任务名称，0~255字符", "example": "scheduler_sql_delete_task" }, { "name": "EnableFlag", "type": "integer", "required": true, "description": "任务启动状态. 1开启, 2关闭", "example": "1" }, { "name": "DstResource", "type": "object", "required": true, "description": "定时SQL分析目标日志主题", "example": "无", "children": [ { "name": "TopicId", "type": "string", "required": true, "description": "通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。", "example": "xxxxxxxx-0889-4ec0-accc-xxxxxxx" }, { "name": "Region", "type": "string", "required": false, "description": "主题的地域信息，当前不支持跨地域，支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。", "example": "ap-guangzhou" }, { "name": "BizType", "type": "integer", "required": false, "description": "主题类型：0为日志主题，1为指标主题", "example": "0" }, { "name": "MetricName", "type": "string", "required": false, "description": "指标名称。当BizType为1时，MetricName需要填写", "example": "cpu_usage" }, { "name": "MetricNames", "type": "array", "required": false, "description": "指标名称 BizType为1时，优先使用MetricNames字段多指标只能填充到MetricNames字段，单指标建议填充到MetricName字段", "example": "[\"cpu_usage\",\"mem_usage\"]", "item_type": "string" }, { "name": "MetricLabels", "type": "array", "required": false, "description": "指标维度，不接受时间类型。", "example": "[\"cluster\",\"ip\"]", "item_type": "string" }, { "name": "CustomTime", "type": "string", "required": false, "description": "指标时间戳，默认值为SQL查询时间范围的左侧时间点，您也可以指定其他字段（类型为uinx时间、TimeStamp，精度毫秒）为指标时间戳。", "example": "unix_ts,或者TimeStamp 2021-07-15T17:11:56.735+08:00" }, { "name": "CustomMetricLabels", "type": "array", "required": false, "description": "除了MetricLabels，您还可以使用该参数，为指标补充静态的维度。 维度名以字母或下划线开头，后面可以跟字母、数字或下划线，长度小于等于1024 字节", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "指标名称", "example": "ErrorMessage" }, { "name": "Value", "type": "string", "required": true, "description": "指标内容", "example": "Unauthorized" } ] } ] }, { "name": "ScheduledSqlContent", "type": "string", "required": true, "description": "查询语句", "example": "* | select count(*)" }, { "name": "ProcessStartTime", "type": "integer", "required": true, "description": "调度开始时间,Unix时间戳，单位ms", "example": "1690515360000" }, { "name": "ProcessType", "type": "integer", "required": true, "description": "调度类型，1:持续运行 2:指定时间范围", "example": "1" }, { "name": "ProcessPeriod", "type": "integer", "required": true, "description": "调度周期(分钟)，1~1440分钟", "example": "2" }, { "name": "ProcessTimeWindow", "type": "string", "required": true, "description": "单次查询的时间窗口,如果您的目标主题为指标主题，建议该参数的大小不超过30分钟，否则可能转指标失败。", "example": "@m-15m,@m" }, { "name": "ProcessDelay", "type": "integer", "required": true, "description": "执行延迟(秒)，0~120秒，默认60秒", "example": "60" }, { "name": "SrcTopicRegion", "type": "string", "required": true, "description": "源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档", "example": "ap-guangzhou" }, { "name": "ProcessEndTime", "type": "integer", "required": false, "description": "调度结束时间，当ProcessType=2时为必传字段, Unix时间戳，单位ms", "example": "1690515440000" }, { "name": "SyntaxRule", "type": "integer", "required": false, "description": "查询语法规则。 默认值为0。0：Lucene语法，1：CQL语法", "example": "0" } ], "required": [ "SrcTopicId", "Name", "EnableFlag", "DstResource", "ScheduledSqlContent", "ProcessStartTime", "ProcessType", "ProcessPeriod", "ProcessTimeWindow", "ProcessDelay", "SrcTopicRegion" ] }, { "name": "CreateShipper", "description": "新建投递到COS的任务，【！！！注意】使用此接口，需要检查是否配置了投递COS的角色和权限。如果没有配置，请参考文档投递权限查看和配置https://cloud.tencent.com/document/product/614/71623。", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "创建的投递规则所属的日志主题Id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "fadcc986-xxxx-xxxx-b766-9ce9c193da32" }, { "name": "Bucket", "type": "string", "required": true, "description": "COS存储桶，详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。 - 通过[GET Service（List Buckets）](https://cloud.tencent.com/document/product/436/8291)获取COS存储桶。", "example": "examplebucket-1250000000" }, { "name": "Prefix", "type": "string", "required": true, "description": "投递规则投递的新的目录前缀。 - 仅支持0-9A-Za-z-_/ - 最大支持256个字符", "example": "var/xxx" }, { "name": "ShipperName", "type": "string", "required": true, "description": "投递规则的名字。最大支持255个字符", "example": "testShipper" }, { "name": "Interval", "type": "integer", "required": false, "description": "投递的时间间隔，单位 秒，默认300，范围 300-900", "example": "300" }, { "name": "MaxSize", "type": "integer", "required": false, "description": "投递的文件的最大值，单位 MB，默认256，范围 5-256", "example": "256" }, { "name": "FilterRules", "type": "array", "required": false, "description": "投递日志的过滤规则，匹配的日志进行投递，各rule之间是and关系，最多5个，数组为空则表示不过滤而全部投递", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "过滤规则Key", "example": "testKey" }, { "name": "Regex", "type": "string", "required": true, "description": "过滤规则", "example": "/w" }, { "name": "Value", "type": "string", "required": true, "description": "过滤规则Value", "example": "testValue" } ] }, { "name": "Partition", "type": "string", "required": false, "description": "投递日志的分区规则，支持strftime的时间格式表示", "example": "%Y%m%d" }, { "name": "Compress", "type": "object", "required": false, "description": "投递日志的压缩配置", "example": "无", "children": [ { "name": "Format", "type": "string", "required": true, "description": "压缩格式，支持gzip、lzop、snappy和none不压缩", "example": "none" } ] }, { "name": "Content", "type": "object", "required": false, "description": "投递日志的内容格式配置", "example": "无", "children": [ { "name": "Format", "type": "string", "required": true, "description": "内容格式，支持json，csv，parquet", "example": "json" }, { "name": "Csv", "type": "object", "required": false, "description": "csv格式内容描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "PrintKey", "type": "boolean", "required": true, "description": "csv首行是否打印key", "example": "true" }, { "name": "Keys", "type": "array", "required": true, "description": "每列key的名字 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"__SOURCE__\",\"__FILENAME__\",\"__HOSTNAME__\"]", "item_type": "string" }, { "name": "Delimiter", "type": "string", "required": true, "description": "各字段间的分隔符", "example": "|" }, { "name": "EscapeChar", "type": "string", "required": true, "description": "若字段内容中包含分隔符，则使用该转义符包裹改字段，只能填写单引号、双引号、空字符串", "example": "'" }, { "name": "NonExistingField", "type": "string", "required": true, "description": "对于上面指定的不存在字段使用该内容填充", "example": "not_exist" } ] }, { "name": "Json", "type": "object", "required": false, "description": "json格式内容描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "EnableTag", "type": "boolean", "required": true, "description": "启用标志", "example": "true" }, { "name": "MetaFields", "type": "array", "required": true, "description": "元数据信息列表, 可选值为 __SOURCE__、__FILENAME__、__TIMESTAMP__、__HOSTNAME__。 - __SOURCE__：日志采集的源 IP，示例：10.0.1.2 - __FILENAME__：日志采集的文件名，示例：/data/log/nginx/access.log - __TIMESTAMP__：日志时间戳（毫秒级别 Unix 时间戳），按时间范围检索日志时，将自动使用该时间对日志进行检索，在控制台显示为“日志时间”，示例：1640005601188 - __HOSTNAME__：日志来源机器名称，需使\ufffd\ufffd...", "example": "[\"__SOURCE__\",\"__FILENAME__\",\"__TIMESTAMP__\",\"__HOSTNAME__\"]", "item_type": "string" }, { "name": "JsonType", "type": "integer", "required": false, "description": "投递Json格式，0：字符串方式投递；1:以结构化方式投递", "example": "1" } ] }, { "name": "Parquet", "type": "object", "required": false, "description": "parquet格式内容描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ParquetKeyInfo", "type": "array", "required": true, "description": "ParquetKeyInfo数组", "example": "无", "item_type": "object", "children": [ { "name": "KeyName", "type": "string", "required": true, "description": "键值名称", "example": "content" }, { "name": "KeyType", "type": "string", "required": true, "description": "数据类型，目前支持6种类型：string、boolean、int32、int64、float、double", "example": "string" }, { "name": "KeyNonExistingField", "type": "string", "required": true, "description": "解析失败赋值信息", "example": "NotExist" } ] } ] } ] }, { "name": "FilenameMode", "type": "integer", "required": false, "description": "投递文件命名配置，0：随机数命名，1：投递时间命名，默认0（随机数命名）", "example": "1" }, { "name": "StartTime", "type": "integer", "required": false, "description": "投递数据范围的开始时间点（秒级时间戳），不能超出日志主题的生命周期起点。 如果用户不填写，默认为用户新建投递任务的时间。", "example": "1713410880" }, { "name": "EndTime", "type": "integer", "required": false, "description": "投递数据范围的结束时间点（秒级时间戳），不能填写未来时间。 如果用户不填写，默认为持续投递，即无限。", "example": "1713497280" }, { "name": "StorageType", "type": "string", "required": false, "description": "对象存储类型，默认值为 STANDARD。枚举值请参见[ 存储类型概述](https://cloud.tencent.com/document/product/436/33417) 文档。 参考值有： - STANDARD：标准存储 - STANDARD_IA：低频存储 - ARCHIVE：归档存储 - DEEP_ARCHIVE：深度归档存储 - MAZ_STANDARD：标准存储（多 AZ） - MAZ_STANDARD_IA：低频存储（多 AZ） - INTELLIGENT_TIERING：智能分层存储 - MAZ_INTELLIGENT_TIERING：智能分层存储（多 AZ）", "example": "STANDARD" }, { "name": "RoleArn", "type": "string", "required": false, "description": "角色访问描述名 [创建角色](https://cloud.tencent.com/document/product/598/19381)", "example": "qcs::cam::uin/${uin}:roleName/xxxtest" }, { "name": "ExternalId", "type": "string", "required": false, "description": "外部ID", "example": "external_id_demo" } ], "required": [ "TopicId", "Bucket", "Prefix", "ShipperName" ] }, { "name": "CreateSplunkDeliver", "description": "创建Splunk投递任务", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题id- 通过获取日志主题列表获取日志主题Id。", "example": "06cc3d03-44a0-4d94-89c2-aeac27a1d9f1" }, { "name": "Name", "type": "string", "required": true, "description": "splunk投递任务名称；name有如下限制：- 不能为空- 长度不大于64- 只能包含aA-zZ、下划线、-、0-9", "example": "template-1" }, { "name": "NetInfo", "type": "object", "required": true, "description": "Splunk投递任务-目标配置-网络信息", "example": "无", "children": [ { "name": "Host", "type": "string", "required": true, "description": "网络地址", "example": "127.0.0.1" }, { "name": "Port", "type": "integer", "required": true, "description": "端口", "example": "8080" }, { "name": "Token", "type": "string", "required": true, "description": "认证token", "example": "abce" }, { "name": "NetType", "type": "integer", "required": true, "description": "网络类型;1：内网；2:外网", "example": "1" }, { "name": "VpcId", "type": "string", "required": false, "description": "所属网络；如果网络类型为内网，该字段必填", "example": "vpc-ab12" }, { "name": "VirtualGatewayType", "type": "integer", "required": false, "description": "网络服务类型；如果网络类型为内网，该字段必填 - 0:云上cvm - 3:云上专线网关 - 11:云联网 - 1025:云上clb", "example": "0" }, { "name": "IsSSL", "type": "boolean", "required": false, "description": "认证机制，是否使用SSL，默认不使用", "example": "false" } ] }, { "name": "MetadataInfo", "type": "object", "required": true, "description": "Splunk投递任务元信息", "example": "无", "children": [ { "name": "Format", "type": "string", "required": true, "description": "数据格式,rawlog/json", "example": "json" }, { "name": "MetaFields", "type": "array", "required": false, "description": "投递字段，包括\\_\\_SOURCE\\_\\_、\\_\\_FILENAME\\_\\_ 、\\_\\_TIMESTAMP\\_\\_、\\_\\_HOSTNAME\\_\\_、\\_\\_PKG\\_ID\\_\\_", "example": "[\"__SOURCE__\",\"__FILENAME__\",\"__TIMESTAMP__\",\"__HOSTNAME__\"]", "item_type": "string" }, { "name": "EnableTag", "type": "boolean", "required": false, "description": "是否投递__TAG__字段", "example": "true" }, { "name": "TagJsonTiled", "type": "boolean", "required": false, "description": "JSON是否平铺，投递__TAG__字段时必填", "example": "false" } ] }, { "name": "HasServiceLog", "type": "integer", "required": false, "description": "是否开启服务日志 1:关闭；2:开启 ;默认开启", "example": "2" }, { "name": "IndexAck", "type": "integer", "required": false, "description": "高级配置-是否启用索引器；1-不启用；2-启用；默认：1", "example": "1" }, { "name": "Source", "type": "string", "required": false, "description": "高级配置-数据来源；不超过64个字符", "example": "client-01" }, { "name": "SourceType", "type": "string", "required": false, "description": "高级配置-数据来源类型；不超过64个字符", "example": "json" }, { "name": "Index", "type": "string", "required": false, "description": "高级配置-Splunk写入的索引；不超过64个字符", "example": "main" }, { "name": "Channel", "type": "string", "required": false, "description": "高级配置-通道需满足限制：如果启用索引器，那么Channel必填", "example": "template-1" }, { "name": "DSLFilter", "type": "string", "required": false, "description": "日志预过滤-数据写入 Splunk 的原始数据进行预过滤处理", "example": "log_keep(op_str_eq(v(\"type\"), \"kibana_stats\"))" } ], "required": [ "TopicId", "Name", "NetInfo", "MetadataInfo" ] }, { "name": "CreateTopic", "description": "本接口用于创建日志或指标主题。", "status": "online", "parameters": [ { "name": "LogsetId", "type": "string", "required": true, "description": "日志集ID - 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。", "example": "64aebb76-644b-4e60-90f6-3c183094da40-ab2f-47ab-9dcd-31413b057812" }, { "name": "TopicName", "type": "string", "required": true, "description": "主题名称 名称限制 - 不能为空字符串 - 不能包含字符'|' - 不能使用以下名称[\"cls_service_log\",\"loglistener_status\",\"loglistener_alarm\",\"loglistener_business\",\"cls_service_metric\"]", "example": "testname" }, { "name": "PartitionCount", "type": "integer", "required": false, "description": "主题分区个数。默认创建1个，最大支持创建10个分区。", "example": "1" }, { "name": "Tags", "type": "array", "required": false, "description": "标签描述列表，通过指定该参数可以同时绑定标签到相应的主题。最大支持10个标签键值对，同一个资源只能绑定到同一个标签键下。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "业务A" } ] }, { "name": "AutoSplit", "type": "boolean", "required": false, "description": "是否开启自动分裂，默认值为true", "example": "true" }, { "name": "MaxSplitPartitions", "type": "integer", "required": false, "description": "开启自动分裂后，每个主题能够允许的最大分区数，默认值为50", "example": "50" }, { "name": "StorageType", "type": "string", "required": false, "description": "日志主题的存储类型，可选值 hot（标准存储），cold（低频存储）；默认为hot。指标主题不支持该配置。", "example": "hot" }, { "name": "Period", "type": "integer", "required": false, "description": "存储时间，单位天。 - 日志主题：日志接入标准存储时，支持1至3600天，值为3640时代表永久保存。 - 日志主题：日志接入低频存储时，支持7至3600天，值为3640时代表永久保存。 - 指标主题：支持1至3600天，值为3640时代表永久保存。", "example": "30" }, { "name": "Describes", "type": "string", "required": false, "description": "主题描述", "example": "xx部门xx任务topic" }, { "name": "HotPeriod", "type": "integer", "required": false, "description": "0：日志主题关闭日志沉降。 非0：日志主题开启日志沉降后标准存储的天数，HotPeriod需要大于等于7，且小于Period。 仅在StorageType为 hot 时生效，指标主题不支持该配置。", "example": "7" }, { "name": "Encryption", "type": "integer", "required": false, "description": "加密相关参数。 支持加密地域并且开白用户可以传此参数，其他场景不能传递该参数。 0或者不传： 不加密 1：kms-cls 云产品密钥加密 支持地域：ap-beijing,ap-guangzhou,ap-shanghai,ap-singapore,ap-bangkok,ap-jakarta,eu-frankfurt,ap-seoul,ap-tokyo", "example": "0" }, { "name": "BizType", "type": "integer", "required": false, "description": "主题类型 - 0:日志主题，默认值 - 1:指标主题", "example": "0" }, { "name": "TopicId", "type": "string", "required": false, "description": "主题自定义ID，格式为：用户自定义部分-用户APPID。未填写该参数时将自动生成ID。 - 用户自定义部分仅支持小写字母、数字和-，且不能以-开头和结尾，长度为3至40字符 - 尾部需要使用-拼接用户APPID，APPID可在https://console.cloud.tencent.com/developer页面查询。 - 如果指定该字段，需保证全地域唯一", "example": "eb9ec10d-1343-4386-9a6e-75fd9d68726e" }, { "name": "IsWebTracking", "type": "boolean", "required": false, "description": "免鉴权开关。 false：关闭； true：开启。默认为false。 开启后将支持指定操作匿名访问该日志主题。详情请参见[日志主题](https://cloud.tencent.com/document/product/614/41035)。指标主题不支持该配置。", "example": "false" }, { "name": "Extends", "type": "object", "required": false, "description": "主题扩展信息", "example": "无", "children": [ { "name": "AnonymousAccess", "type": "object", "required": false, "description": "日志主题免鉴权配置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Operations", "type": "array", "required": false, "description": "操作列表，支持trackLog(JS/HTTP上传日志 )和realtimeProducer(kafka协议上传日志)", "example": "realtimeProducer", "item_type": "string" }, { "name": "Conditions", "type": "array", "required": false, "description": "条件列表", "example": "无", "item_type": "object", "children": [ { "name": "Attributes", "type": "string", "required": false, "description": "条件属性，目前只支持VpcID", "example": "VpcID" }, { "name": "Rule", "type": "integer", "required": false, "description": "条件规则，1:等于，2:不等于", "example": "1" }, { "name": "ConditionValue", "type": "string", "required": false, "description": "对应条件属性的值", "example": "vpc-6jfhit1t" } ] } ] } ] }, { "name": "IsSourceFrom", "type": "boolean", "required": false, "description": "开启记录公网来源ip和服务端接收时间", "example": "false" } ], "required": [ "LogsetId", "TopicName" ] }, { "name": "CreateWebCallback", "description": "该接口用于创建告警渠道回调配置。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "通知内容名称。最大支持255个字节", "example": "监控告警专用" }, { "name": "Type", "type": "string", "required": true, "description": "渠道类型。 WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调。", "example": "WeCom" }, { "name": "Webhook", "type": "string", "required": true, "description": "Webhook地址。", "example": "http://xxxx.com/send" }, { "name": "Method", "type": "string", "required": false, "description": "请求方式。 支持POST、PUT。 当Type为Http时，必填。", "example": "POST" }, { "name": "Key", "type": "string", "required": false, "description": "秘钥。最大支持1024个字节", "example": "AASFFGGYYBHGTDJ" } ], "required": [ "Name", "Type", "Webhook" ] }, { "name": "DeleteAlarm", "description": "本接口用于删除告警策略。", "status": "online", "parameters": [ { "name": "AlarmId", "type": "string", "required": true, "description": "告警策略ID。", "example": "alarm-59df14aa-f35f-4ed2-9399-2b27ce69a53c" } ], "required": [ "AlarmId" ] }, { "name": "DeleteAlarmNotice", "description": "该接口用于删除通知渠道组", "status": "online", "parameters": [ { "name": "AlarmNoticeId", "type": "string", "required": true, "description": "通知渠道组ID。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/api/614/56462)获取通知渠道组ID", "example": "notice-d7286484-46d9-4be3-b7ba-2c464e6a5ad1" } ], "required": [ "AlarmNoticeId" ] }, { "name": "DeleteAlarmShield", "description": "该接口用于删除告警屏蔽规则。当告警屏蔽规则在生效中或者是在失效中，无法被删除", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "屏蔽规则id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID", "example": "bc42f172-a74d-496e-b3c4-ff5472911b42" }, { "name": "AlarmNoticeId", "type": "string", "required": true, "description": "通知渠道组id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id", "example": "notice-bb42f112-a74d-476e-b3c4-ff5472911b42" } ], "required": [ "TaskId", "AlarmNoticeId" ] }, { "name": "DeleteCloudProductLogCollection", "description": "内部云产品接入使用相关接口", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "ins-r8hr2upy" }, { "name": "AssumerName", "type": "string", "required": true, "description": "云产品标识，支持枚举：CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS", "example": "CDB" }, { "name": "LogType", "type": "string", "required": true, "description": "日志类型，支持枚举：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", "example": "CDB-AUDIT" }, { "name": "CloudProductRegion", "type": "string", "required": true, "description": "云产品地域。 不同日志类型(LogType)地域入参格式存在差异， 请参考如下示例： - CDS所有日志类型：ap-guangzhou - CDB-AUDIT: gz - TDSQL-C-AUDIT: gz - MongoDB-AUDIT: gz - MongoDB-SlowLog：ap-guangzhou - MongoDB-ErrorLog：ap-guangzhou - TDMYSQL-SLOW：gz - DCDB所有日志类型：gz - MariaDB所有日志类型：gz - PostgreSQL所有日志类型：gz - BH所有日志类型：overseas-polaris(中国香港地区和其他)/fsi-polaris(金融区)/general-polaris(普\ufffd...", "example": "ap-guangzhou" } ], "required": [ "InstanceId", "AssumerName", "LogType", "CloudProductRegion" ] }, { "name": "DeleteConfig", "description": "删除采集规则配置", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "采集配置ID - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。", "example": "3581a3be-aa41-423b-995a-54ec84da6264" } ], "required": [ "ConfigId" ] }, { "name": "DeleteConfigExtra", "description": "本接口用于删除特殊采集规则配置，特殊采集配置应用于自建K8S环境的采集Agent", "status": "online", "parameters": [ { "name": "ConfigExtraId", "type": "string", "required": true, "description": "特殊采集规则扩展配置ID - 通过[获取特殊采集配置](https://cloud.tencent.com/document/api/614/71164)特殊采集规则扩展配置ID。", "example": "00903f17-3e27-4f32-b1f5-489cf6e5bf08" } ], "required": [ "ConfigExtraId" ] }, { "name": "DeleteConfigFromMachineGroup", "description": "删除应用到机器组的采集配置", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "机器组ID - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。", "example": "3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a" }, { "name": "ConfigId", "type": "string", "required": true, "description": "采集配置ID - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。", "example": "3581a3be-aa41-423b-995a-54ec84da6264" } ], "required": [ "GroupId", "ConfigId" ] }, { "name": "DeleteConsoleSharing", "description": "删除控制台分享", "status": "online", "parameters": [ { "name": "SharingId", "type": "string", "required": true, "description": "免密分享Id。 - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。 - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。", "example": "13cez28h" } ], "required": [ "SharingId" ] }, { "name": "DeleteConsumer", "description": "删除投递Ckafka任务", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "投递任务绑定的日志主题Id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。", "example": "871710c5-35cd-4d1e-8e79-2fa92c35d612" } ], "required": [ "TopicId" ] }, { "name": "DeleteConsumerGroup", "description": "删除消费组", "status": "online", "parameters": [ { "name": "ConsumerGroup", "type": "string", "required": true, "description": "需要删除的消费者组标识", "example": "无" }, { "name": "LogsetId", "type": "string", "required": true, "description": "日志集id", "example": "无" } ], "required": [ "ConsumerGroup", "LogsetId" ] }, { "name": "DeleteCosRecharge", "description": "本接口用于删除cos导入任务", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": true, "description": "COS导入配置Id。 - 通过 [获取cos导入配置](https://cloud.tencent.com/document/product/614/88099) 获取COS导入配置Id。", "example": "ca092608-98e8-4ad9-83c5-a6b3bbexxxxx" }, { "name": "TopicId", "type": "string", "required": true, "description": "日志主题Id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/api/614/56454)获取日志主题Id。", "example": "ae13f7db-00b5-41ac-916e-407802axxxxx" } ], "required": [ "Id", "TopicId" ] }, { "name": "DeleteDashboard", "description": "本接口用于删除仪表盘", "status": "online", "parameters": [ { "name": "DashboardId", "type": "string", "required": true, "description": "仪表盘id", "example": "682d0718-07bb-4ec0-9fda-f1e9a2767e0b" } ], "required": [ "DashboardId" ] }, { "name": "DeleteDashboardSubscribe", "description": "此接口用于删除仪表盘订阅", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "仪表盘订阅记录id。通过 [获取仪表盘订阅列表](https://cloud.tencent.com/document/api/614/105779)接口获取Id。", "example": "10000123" } ], "required": [ "Id" ] }, { "name": "DeleteDataTransform", "description": "本接口用于删除数据加工任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。", "example": "4c216645-01f2-414d-8a87-719b97ba205a" } ], "required": [ "TaskId" ] }, { "name": "DeleteDlcDeliver", "description": "删除DLC投递任务", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "715094e3-01b0-4aeb-91f5-ee9f46a4a13c" }, { "name": "TaskId", "type": "string", "required": true, "description": "任务id。", "example": "111024e3-01b0-4aeb-91f5-ee9f46a4a13c" } ], "required": [ "TopicId", "TaskId" ] }, { "name": "DeleteEsRecharge", "description": "删除es导入配置", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务id", "example": "5871c48d-219b-4274-829b-5aa7fb24229b" }, { "name": "TopicId", "type": "string", "required": true, "description": "任务配置的日志主题id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。", "example": "1111c48d-219b-4274-829b-5aa7fb24229b" } ], "required": [ "TaskId", "TopicId" ] }, { "name": "DeleteExport", "description": "本接口用于删除日志下载任务", "status": "online", "parameters": [ { "name": "ExportId", "type": "string", "required": true, "description": "日志导出任务Id - 通过[获取日志下载任务列表](https://cloud.tencent.com/document/product/614/56449)获取日志导出任务Id。", "example": "57196a6a-7622-47be-bc92-d2ebea959a0f" } ], "required": [ "ExportId" ] }, { "name": "DeleteHostMetricConfig", "description": "删除主机指标采集配置", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "指标日志主题id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题（默认值）， 1:指标主题 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题（默认值）， 1:指标主题", "example": "715094e3-01b0-4aeb-91f5-ee9f46a4a13c" }, { "name": "ConfigId", "type": "string", "required": true, "description": "采集配置id。", "example": "715094e3-01b0-4aeb-91f5-ee9f46a4a13c" } ], "required": [ "TopicId", "ConfigId" ] }, { "name": "DeleteIndex", "description": "本接口用于删除日志主题的索引配置，删除索引配置后将无法检索和查询采集到的日志。", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题Id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "75f531f6-3644-45e5-8717-af1dc294cc93" } ], "required": [ "TopicId" ] }, { "name": "DeleteKafkaRecharge", "description": "本接口用于删除Kafka数据订阅任务", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": true, "description": "Kafka导入配置Id。 - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。 - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。", "example": "06bdb6f6-ae6e-41f6-9e7b-fcab91cb0895" }, { "name": "TopicId", "type": "string", "required": true, "description": "导入CLS目标日志主题Id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "1014cc79-f006-48e4-8820-1dc727054111" } ], "required": [ "Id", "TopicId" ] }, { "name": "DeleteLogset", "description": "本接口用于删除日志集。", "status": "online", "parameters": [ { "name": "LogsetId", "type": "string", "required": true, "description": "日志集Id。通过 [获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。", "example": "eb6eafd9-1656-4d60-b3c2-0a5bf91c9b0d" } ], "required": [ "LogsetId" ] }, { "name": "DeleteMachineGroup", "description": "删除机器组", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "机器组Id - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。", "example": "57f5808c-4a55-11eb-b378-0242ac130002" } ], "required": [ "GroupId" ] }, { "name": "DeleteMachineGroupInfo", "description": "用于删除机器组信息", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "机器组Id - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。", "example": "57f5808c-4a55-11eb-b378-0242ac130002" }, { "name": "MachineGroupType", "type": "object", "required": true, "description": "机器组类型 目前type支持 ip 和 label", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "机器组类型。支持 ip 和 label。 - ip：表示该机器组Values中存的是采集机器的ip地址 - label：表示该机器组Values中存储的是机器的标签", "example": "ip" }, { "name": "Values", "type": "array", "required": false, "description": "机器描述列表。", "example": "[10.1.1.1,10.2.2.2]", "item_type": "string" } ] } ], "required": [ "GroupId", "MachineGroupType" ] }, { "name": "DeleteMetricConfig", "description": "删除指标采集配置", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "指标日志主题id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题（默认值）， 1:指标主题 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题（默认值）， 1:指标主题", "example": "715094e3-01b0-4aeb-91f5-ee9f46a4a13c" }, { "name": "ConfigId", "type": "string", "required": true, "description": "指标采集配置id。", "example": "81853bcf-67b4-4a4f-82c7-7882fd004613" } ], "required": [ "TopicId", "ConfigId" ] }, { "name": "DeleteMetricSubscribe", "description": "删除指标订阅配置", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "指标采集任务id", "example": "5871c48d-219b-4274-829b-5aa7fb24229b" }, { "name": "TopicId", "type": "string", "required": true, "description": "指标采集任务配置的日志主题id。", "example": "1111c48d-219b-4274-829b-5aa7fb24229b" } ], "required": [ "TaskId", "TopicId" ] }, { "name": "DeleteNetworkApplication", "description": "删除网络应用", "status": "online", "parameters": [ { "name": "NetworkAppId", "type": "string", "required": true, "description": "网络应用id。", "example": "638ca7fd-c7d3-492b-bc01-65304426783e" } ], "required": [ "NetworkAppId" ] }, { "name": "DeleteNoticeContent", "description": "该接口用于删除通知内容配置", "status": "online", "parameters": [ { "name": "NoticeContentId", "type": "string", "required": true, "description": "通知内容模板ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知内容模版ID", "example": "noticetemplate-d72867484-46d9-4be3-b7ba-2c464e6a5ad1" } ], "required": [ "NoticeContentId" ] }, { "name": "DeleteScheduledSql", "description": "本接口用于删除定时SQL分析任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID，通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取", "example": "absbdbfb-0242-43af-bb20-270359fb5xxx" }, { "name": "SrcTopicId", "type": "string", "required": true, "description": "源日志主题ID，通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取", "example": "6ef60bec-0242-43af-bb20-270359fxxxx" } ], "required": [ "TaskId", "SrcTopicId" ] }, { "name": "DeleteShipper", "description": "删除投递COS任务", "status": "online", "parameters": [ { "name": "ShipperId", "type": "string", "required": true, "description": "投递规则Id。 - 通过 [获取投递任务列表](https://cloud.tencent.com/document/product/614/58745)获取ShipperId。", "example": "57f5808c-4a55-11eb-b378-0242ac130002" } ], "required": [ "ShipperId" ] }, { "name": "DeleteSplunkDeliver", "description": "删除Splunk投递任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务id", "example": "111024e3-01b0-4aeb-91f5-ee" }, { "name": "TopicId", "type": "string", "required": true, "description": "日志主题id - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "06cc3d03-44a0-4d94-89c2-aeac27a1d9f1" } ], "required": [ "TaskId", "TopicId" ] }, { "name": "DeleteTopic", "description": "本接口用于删除日志或指标主题。", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "a5ce0c9c-0690-44a5-bc79-5f2190626bd0" } ], "required": [ "TopicId" ] }, { "name": "DeleteWebCallback", "description": "该接口用于删除告警渠道回调配置。", "status": "online", "parameters": [ { "name": "WebCallbackId", "type": "string", "required": true, "description": "告警渠道回调配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/api/614/115229)获取告警渠道回调配置ID", "example": "webcallback-d7286794-46d9-4be3-b7ba-2c464e6a5ad1" } ], "required": [ "WebCallbackId" ] }, { "name": "DescribeAlarmNotices", "description": "该接口用于获取通知渠道组列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "name 按照【通知渠道组名称】进行过滤。 类型：String 示例：\"Filters\":[{\"Key\":\"name\",\"Values\":[\"test-notice\"]}] 必选：否 alarmNoticeId 按照【通知渠道组ID】进行过滤。 类型：String 示例：\"Filters\": [{Key: \"alarmNoticeId\", Values: [\"notice-5281f1d2-6275-4e56-9ec3-a1eb19d8bc2f\"]}] 必选：否 uid 按照【接收用户ID】进行过滤。 类型：String 示例：\"Filters\": [{Key: \"uid\", Values: [\"1137546\"]}] 必选：否 groupId 按照【接收用户组ID\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "1" }, { "name": "HasAlarmShieldCount", "type": "boolean", "required": false, "description": "是否需要返回通知渠道组配置的告警屏蔽统计状态数量信息。 - true：需要返回； - false：不返回（默认false）。", "example": "false" } ], "required": [] }, { "name": "DescribeAlarmShields", "description": "获取告警屏蔽配置规则", "status": "online", "parameters": [ { "name": "AlarmNoticeId", "type": "string", "required": true, "description": "通知渠道组id。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/api/614/56462)获取通知渠道组id", "example": "notice-bb42f112-xxxx-476e-b3c4-ff5472911b42" }, { "name": "Filters", "type": "array", "required": false, "description": "- taskId:按照【规则id】进行过滤。类型：String 必选：否 - status:按照【规则状态】进行过滤。类型：String。 支持 0:暂未生效，1:生效中，2:已失效。 必选：否 每次请求的Filters的上限为10，Filter.Values的上限为100。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "20" } ], "required": [ "AlarmNoticeId" ] }, { "name": "DescribeAlarms", "description": "本接口用于获取告警策略列表。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "name - 按照【告警策略名称】进行过滤。 - 类型：String - 必选：否 - 示例：test-alarm alarmId - 按照【告警策略ID】进行过滤。 - 类型：String - 必选：否 - 示例：alarm-b60cf034-c3d6-4b01-xxxx-4e877ebb4751 topicId - 按照【监控对象的日志主题ID】进行过滤。 - 类型：String - 必选：否 - 示例：6766f83d-659e-xxxx-a8f7-9104a1012743 enable - 按照【启用状态】进行过滤。 - 类型：String - 备注：enable参数值范围: 1, t...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "1" } ], "required": [] }, { "name": "DescribeAlertRecordHistory", "description": "获取告警历史，例如今天未恢复的告警", "status": "online", "parameters": [ { "name": "From", "type": "integer", "required": true, "description": "查询时间范围启始时间，毫秒级unix时间戳(ms)", "example": "1619063300000" }, { "name": "To", "type": "integer", "required": true, "description": "查询时间范围结束时间，毫秒级unix时间戳(ms)", "example": "1619581700000" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页的偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页单页限制数目，最大值100。", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "- alertId：按照告警策略ID进行过滤。类型：String 必选：否 - topicId：按照监控对象ID进行过滤。类型：String 必选：否 - status：按照告警状态进行过滤。类型：String 必选：否，0代表未恢复，1代表已恢复，2代表已失效 - alarmLevel：按照告警等级进行过滤。类型：String 必选：否，0代表警告，1代表提醒，2代表紧急 每次请求的Filters的上限为10，Filter.Values的上限为100。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] } ], "required": [ "From", "To", "Offset", "Limit" ] }, { "name": "DescribeCloudProductLogTasks", "description": "云产品接入使用相关接口", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为100，最大值100。", "example": "10" }, { "name": "Filters", "type": "array", "required": false, "description": "- assumerName - 按照【云产品标识】进行过滤。 - 类型：String - 必选：否 - 枚举：CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS - 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、PostgreSQ...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeClusterBaseMetricConfigs", "description": "获取指标订阅配置", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "机器组id", "example": "5871c48d-219b-4274-829b-5aa7fb24229b" }, { "name": "Filters", "type": "array", "required": false, "description": "topicId按照【指标主题id】进行过滤。类型：String 必选：否 每次请求的Filters的上限为10，所有Filter.Values总和上限为100。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "20" } ], "required": [ "GroupId" ] }, { "name": "DescribeClusterMetricConfigs", "description": "获取指标订阅配置", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "机器组id", "example": "5871c48d-219b-4274-829b-5aa7fb24229b" }, { "name": "Filters", "type": "array", "required": false, "description": "configId按照【指标采集配置id】进行过滤。类型：String 必选：否 name按照【配置名称】进行过滤。类型：String 必选：否 每次请求的Filters的上限为10，所有Filter.Values总和上限为100。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "20" } ], "required": [ "GroupId" ] }, { "name": "DescribeConfigExtras", "description": "本接口用于获取特殊采集配置，特殊采集配置应用于自建K8S环境的采集Agent", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤器，支持如下选项： name - 按照【特殊采集配置名称】进行模糊匹配过滤。 - 类型：String - 示例：test-config configExtraId - 按照【特殊采集配置ID】进行过滤。 - 类型：String - 示例：3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a topicId - 按照【日志主题】进行过滤。 - 类型：String - 示例：3581a3be-aa41-423b-995a-54ec84da6264 machineGroupId - 按照【机器组ID】进行过滤。 - 类型：String - 示例：f948972f-a063-408c-a59f...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页的限制数目，默认值为20，最大值100", "example": "10" } ], "required": [] }, { "name": "DescribeConfigMachineGroups", "description": "获取采集规则配置所绑定的机器组", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "采集配置ID - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。", "example": "3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a" } ], "required": [ "ConfigId" ] }, { "name": "DescribeConfigs", "description": "获取采集规则配置", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "configName - 按照【采集配置名称】进行模糊匹配过滤。 - 类型：String - 必选：否 - 示例：test-config configId - 按照【采集配置ID】进行过滤。 - 类型：String - 必选：否 - 示例：3581a3be-aa41-423b-995a-54ec84da6264 topicId - 按照【日志主题】进行过滤。 - 类型：String - 必选：否 - 示例：3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页的限制数目，默认值为20，最大值100", "example": "10" } ], "required": [] }, { "name": "DescribeConsoleSharingList", "description": "批量查询控制台分享列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeConsumer", "description": "本接口用于获取投递配置", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "投递任务绑定的日志主题Id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。", "example": "871710c5-35cd-4d1e-8e79-2fa92c35d612" } ], "required": [ "TopicId" ] }, { "name": "DescribeConsumerGroups", "description": "获取消费组列表", "status": "online", "parameters": [ { "name": "LogsetId", "type": "string", "required": true, "description": "日志集Id（日志主题所属的日志集）", "example": "无" }, { "name": "Topics", "type": "array", "required": false, "description": "topic列表", "example": "无", "item_type": "string" } ], "required": [ "LogsetId" ] }, { "name": "DescribeConsumerOffsets", "description": "获取消费组点位信息", "status": "online", "parameters": [ { "name": "ConsumerGroup", "type": "string", "required": true, "description": "日志主题对应的消费组标识", "example": "无" }, { "name": "From", "type": "string", "required": true, "description": "时间戳(秒级时间戳)", "example": "无" }, { "name": "LogsetId", "type": "string", "required": true, "description": "日志集id(日志主题对应的id)", "example": "无" }, { "name": "TopicId", "type": "string", "required": false, "description": "日志主题id", "example": "无" }, { "name": "PartitionId", "type": "string", "required": false, "description": "分区id", "example": "无" } ], "required": [ "ConsumerGroup", "From", "LogsetId" ] }, { "name": "DescribeConsumerPreview", "description": "本接口用于kafka投递数据预览", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeConsumers", "description": "获取投递规则信息列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "- consumerId 按照【投递规则ID】进行过滤。 类型：String 必选：否 - topicId 按照【日志主题】进行过滤。 类型：String 必选：否 - taskStatus 按照【任务运行状态】进行过滤。 支持`0`：停止，`1`：运行中，`2`：异常 类型：String 必选：否 每次请求的Filters的上限为10，Filter.Values的上限为10。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页的限制数目，默认值为20，最大值100", "example": "10" } ], "required": [] }, { "name": "DescribeCosRecharges", "description": "本接口用于获取cos导入配置", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题Id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/api/614/56454)获取日志主题Id。", "example": "ae13f7db-00b5-41ac-916e-407802axxxxx" }, { "name": "Status", "type": "integer", "required": false, "description": "状态 status 0: 已创建, 1: 运行中, 2: 已停止, 3: 已完成, 4: 运行失败。", "example": "1" }, { "name": "Enable", "type": "integer", "required": false, "description": "是否启用: 0： 未启用 ， 1：启用", "example": "1" } ], "required": [ "TopicId" ] }, { "name": "DescribeDashboardSubscribes", "description": "本接口用于获取仪表盘订阅列表，支持分页", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "dashboardId：按照【仪表盘id】进行过滤。类型：String必选：否 - 仪表盘id。通过 [获取仪表盘](https://cloud.tencent.com/document/api/614/95636)接口获取DashboardId。 - 入参示例：dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5 每次请求的Filters的上限为10，Filter.Values的上限为100。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "10" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "30" } ], "required": [] }, { "name": "DescribeDashboards", "description": "本接口用于获取仪表盘", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "5" }, { "name": "Filters", "type": "array", "required": false, "description": "- dashboardId 按照【仪表盘id】进行过滤，类型：String， 必选：否。 - 示例值：dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5 - dashboardName 按照【仪表盘名字】进行模糊搜索过滤，类型：String，必选：否。 - 示例值：业务大盘 - dashboardRegion 按照【仪表盘地域】进行过滤（兼容老的仪表盘），通过云API创建的仪表盘该属性，类型：String，必选：否。 - 参考 [地域和访问域名](https://cloud.tencent.com...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "TopicIdRegionFilter", "type": "array", "required": false, "description": "按照topicId和regionId过滤。 - topicId:日志主题Id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 - 示例值：439a5304-08f9-484b-9c4d-46ff57133816 - regionId - 1:广州 - 4:上海 - 5:中国香港 - 7:上海金融 - 8:北京 - 9:新加坡 - 11:深圳金融 - 15:硅谷 - 16:成都 - 17:法兰克福 - 18:首尔 - 19:重庆 - 22:弗吉尼亚 - 23:曼谷 - 25:东京 - 33:南京 - 36:天津 - 39:台北 - 46:北京金融 - 7...", "example": "无", "item_type": "object", "children": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题id", "example": "xxx-xxx-xxx-xxx" }, { "name": "RegionId", "type": "integer", "required": true, "description": "日志主题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 - 22, 弗吉尼亚,na-ashburn - 23, 曼谷,ap-bangkok - 25, 东京,ap-tokyo - 33, 南京,ap-nanjing ...", "example": "19" } ] } ], "required": [] }, { "name": "DescribeDataTransformInfo", "description": "本接口用于获取数据加工任务列表基本信息", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "- taskName 按照【加工任务名称】进行过滤。 类型：String 必选：否 示例：test-task - taskId 按照【加工任务id】进行过滤。 类型：String 必选：否 示例：a3622556-6402-4942-b4ff-5ae32ec29810 数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。 - topicId 按照【源topicId】进行过滤。 类型：String 必选：否 示例：756cec3e-a0a5-44c3-85a8-090...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "1" }, { "name": "Type", "type": "integer", "required": false, "description": "默认值为2. 1: 获取单个任务的详细信息 2：获取任务列表", "example": "1" }, { "name": "TaskId", "type": "string", "required": false, "description": "Type为1， 此参数必填 数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。", "example": "task-id" } ], "required": [] }, { "name": "DescribeDlcDelivers", "description": "获取告警渠道回调配置列表。", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "715094e3-01b0-4aeb-91f5-ee9f46a4a13c" }, { "name": "Filters", "type": "array", "required": false, "description": "- taskId 按照【任务id】进行过滤。 类型：String 必选：否 - name 按照【任务名称】进行过滤。 类型：String 必选：否 - tableName 按照【数据表】进行过滤。 类型：String 必选：否 - statusFlag 按照【状态】进行过滤。支持：\"1\",\"2\",\"3\",\"4\"。含义：1：RUNNING，2：STOPPED，3：FINISHED，4：FAILED 类型：String 必选：否 每次请求的Filters的上限为10，Filter.Values的上限为10。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "1" } ], "required": [ "TopicId" ] }, { "name": "DescribeEsRechargePreview", "description": "es导入预览", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "名称：长度不超过64字符。", "example": "template_1" }, { "name": "TopicId", "type": "string", "required": true, "description": "日志主题id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。", "example": "715094e3-01b0-4aeb-91f5-ee9f46a4a13c" }, { "name": "Index", "type": "string", "required": true, "description": "索引信息。不同索引可以通过英文逗号分隔，支持*通配符", "example": "base-2026-01-*" }, { "name": "Query", "type": "string", "required": true, "description": "es查询语句。", "example": "tags.service.name:session" }, { "name": "EsInfo", "type": "object", "required": true, "description": "es集群配置信息。", "example": "无", "children": [ { "name": "EsType", "type": "integer", "required": true, "description": "es类型。 1:云es, 2:自建es", "example": "2" }, { "name": "AccessMode", "type": "integer", "required": false, "description": "访问方式 1:内网, 2:外网。自建es必填", "example": "2" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例id。云es实例必填", "example": "es-fbs7gqxx" }, { "name": "User", "type": "string", "required": false, "description": "用户名。", "example": "user" }, { "name": "Address", "type": "string", "required": false, "description": "访问地址。自建es必填", "example": "10.0.0.10" }, { "name": "Port", "type": "integer", "required": false, "description": "访问端口。自建es必填", "example": "9200" }, { "name": "VpcId", "type": "string", "required": false, "description": "所属网络。自建es且访问方式为内网访问时必填", "example": "vpc-xymnt" }, { "name": "VirtualGatewayType", "type": "integer", "required": false, "description": "网络服务类型。自建es且访问方式为内网访问时必填。 负载均衡 CLB:1025 云服务器CVM:0", "example": "1025" }, { "name": "Password", "type": "string", "required": false, "description": "密码。", "example": "password" } ] }, { "name": "ImportInfo", "type": "object", "required": true, "description": "es导入信息。", "example": "无", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "导入模式。 1. 导入历史数据 2. 导入实时数据", "example": "1" }, { "name": "StartTime", "type": "integer", "required": false, "description": "开始时间。 单位:秒级时间戳。", "example": "1739783039" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间。 单位：秒级时间戳。", "example": "1739784039" }, { "name": "MaxDelay", "type": "integer", "required": false, "description": "最大延迟时间。单位：s 导入模式为 2: 导入实时数据时必填", "example": "600" }, { "name": "CheckInterval", "type": "integer", "required": false, "description": "检查间隔。单位：s 导入模式为 2: 导入实时数据时必填", "example": "60" } ] }, { "name": "TimeInfo", "type": "object", "required": true, "description": "es导入时间字段信息。", "example": "无", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "时间类型 1: 日志采集时间 2: 指定日志字段", "example": "2" }, { "name": "TimeKey", "type": "string", "required": false, "description": "日志时间字段。 时间类型为 2: 指定日志字段时必填", "example": "time_key" }, { "name": "TimeFormat", "type": "string", "required": false, "description": "日志时间格式。 时间类型为 2: 指定日志字段时必填", "example": "%Y-%m-%d %H:%M:%S.%f" }, { "name": "TimeZone", "type": "string", "required": false, "description": "时间字段时区。 时间类型为 2: 指定日志字段时必填", "example": "UTC+08:00" } ] } ], "required": [ "Name", "TopicId", "Index", "Query", "EsInfo", "ImportInfo", "TimeInfo" ] }, { "name": "DescribeEsRecharges", "description": "获取es导入配置", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。", "example": "5871c48d-219b-4274-829b-5aa7fb24229b" }, { "name": "Filters", "type": "array", "required": false, "description": "- taskId按照【配置id】进行过滤。类型：String 必选：否 - name按照【配置名称】进行过滤。类型：String 必选：否 - statusFlag按照【配置状态标记】进行过滤。类型：String 必选：否 - 每次请求的Filters的上限为10，Filter.Values的上限为100。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "20" } ], "required": [ "TopicId" ] }, { "name": "DescribeExports", "description": "本接口用于获取日志下载任务列表", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题Id - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "ee20bb16-3025-4048-b81a-dd436373062e" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100", "example": "5" } ], "required": [ "TopicId" ] }, { "name": "DescribeHostMetricConfigs", "description": "获取指标订阅配置", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "指标日志主题id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题（默认值）， 1:指标主题 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题（默认值）， 1:指标主题", "example": "5871c48d-219b-4274-829b-5aa7fb24229b" }, { "name": "Filters", "type": "array", "required": false, "description": "- configId按照【配置id】进行过滤。类型：String 必选：否 - name按照【配置名称】进行过滤。类型：String 必选：否 每次请求的Filters的上限为10，Filter.Values的上限为10。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "20" } ], "required": [ "TopicId" ] }, { "name": "DescribeIndex", "description": "本接口用于获取索引配置信息", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题Id。通过获取日志主题列表获取日志主题Id。", "example": "75f531f6-3644-45e5-8717-af1dc294cc93" } ], "required": [ "TopicId" ] }, { "name": "DescribeKafkaConsumer", "description": "获取Kafka协议消费信息", "status": "online", "parameters": [ { "name": "FromTopicId", "type": "string", "required": true, "description": "日志主题Id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。", "example": "57f5808c-4a55-11eb-b378-0242ac130002" } ], "required": [ "FromTopicId" ] }, { "name": "DescribeKafkaConsumerGroupDetail", "description": "获取Kafka协议消费组详情", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "57f5808c-4a55-11eb-b378-0242ac130002" }, { "name": "Group", "type": "string", "required": true, "description": "消费组名称", "example": "消费组1" } ], "required": [ "TopicId", "Group" ] }, { "name": "DescribeKafkaConsumerGroupList", "description": "获取Kafka协议消费组信息列表", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "57f5808c-4a55-11eb-b378-0242ac130002" }, { "name": "Filters", "type": "array", "required": false, "description": "- group 按照【消费组名称】进行过滤。 类型：String 必选：否 示例：消费组1 每次请求的Filters的上限为10，Filter.Values的上限为10。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "10" } ], "required": [ "TopicId" ] }, { "name": "DescribeKafkaConsumerPreview", "description": "kafka协议消费预览接口", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeKafkaConsumerTopics", "description": "本接口用于获取kafka协议消费主题信息列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeKafkaRecharges", "description": "本接口用于获取Kafka数据订阅任务", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题Id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "6bf3355c-xxxx-xxxx-89c8-76c3ca37bae9" }, { "name": "Id", "type": "string", "required": false, "description": "导入配置Id。 - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。 - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。", "example": "f574db7d-45ff-xxxx-xxxx-35f7fe71a4d0" }, { "name": "Status", "type": "integer", "required": false, "description": "状态。1: 运行中，2: 暂停，3：错误", "example": "1" } ], "required": [ "TopicId" ] }, { "name": "DescribeLogContext", "description": "本接口用于搜索日志上下文附近的内容，详情参考[上下文检索](https://cloud.tencent.com/document/product/614/53248)。 API返回数据包最大49MB，建议启用 gzip 压缩（HTTP Request Header Accept-Encoding:gzip）。", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "要查询的日志主题Id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。", "example": "682d0718-07bb-4ec0-9fda-f1e9a2767e0b" }, { "name": "BTime", "type": "string", "required": true, "description": "日志时间, 即 [检索分析日志](https://cloud.tencent.com/document/product/614/56447) 接口返回信息中Results结构体中的Time，需按照 UTC+8 时区将该毫秒级Unix时间戳转换为 YYYY-mm-dd HH:MM:SS.FFF 格式的字符串。", "example": "2021-04-25 14:25:00.000" }, { "name": "PkgId", "type": "string", "required": true, "description": "日志包序号，即 [检索分析日志](https://cloud.tencent.com/document/product/614/56447) 接口返回信息中Results结构体中的PkgId。", "example": "528C1318606EFEB8-1A7" }, { "name": "PkgLogId", "type": "integer", "required": true, "description": "日志包内一条日志的序号，即 [检索分析日志](https://cloud.tencent.com/document/product/614/56447) 接口返回信息中Results结构中的PkgLogId。", "example": "65536" }, { "name": "PrevLogs", "type": "integer", "required": false, "description": "前${PrevLogs}条日志，默认值10。", "example": "10" }, { "name": "NextLogs", "type": "integer", "required": false, "description": "后${NextLogs}条日志，默认值10。", "example": "10" }, { "name": "Query", "type": "string", "required": false, "description": "检索语句，对日志上下文进行过滤，最大长度为12KB 语句由 [检索条件]构成，不支持SQL语句", "example": "http_status:200" }, { "name": "From", "type": "integer", "required": false, "description": "上下文检索的开始时间，单位：毫秒级时间戳 注意： - From为空时，表示上下文检索的开始时间不做限制 - From和To非空时，From \u003c To - 暂时仅支持上海 / 弗吉尼亚/ 新加坡地域", "example": "1716532075000" }, { "name": "To", "type": "integer", "required": false, "description": "上下文检索的结束时间，单位：毫秒级时间戳。 注意： - To为空时，表示上下文检索的结束时间不做限制 - From和To非空时，From \u003c To - 暂时仅支持上海 / 弗吉尼亚/ 新加坡地域", "example": "1716532085000" } ], "required": [ "TopicId", "BTime", "PkgId", "PkgLogId" ] }, { "name": "DescribeLogHistogram", "description": "本接口用于构建日志数量直方图", "status": "online", "parameters": [ { "name": "From", "type": "integer", "required": true, "description": "要查询的日志的起始时间，Unix时间戳，单位ms", "example": "1608794855000" }, { "name": "To", "type": "integer", "required": true, "description": "要查询的日志的结束时间，Unix时间戳，单位ms", "example": "1608794855000" }, { "name": "Query", "type": "string", "required": true, "description": "检索分析语句。 语句由 [检索条件] | [SQL语句]构成，无需对日志进行统计分析时，可省略其中的管道符 | 及SQL语句。 使用*或空字符串可查询所有日志。", "example": "http_status:200" }, { "name": "TopicId", "type": "string", "required": false, "description": "要查询的日志主题ID - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "682d0718-07bb-4ec0-9fda-f1e9a2767e0b" }, { "name": "Interval", "type": "integer", "required": false, "description": "时间间隔: 单位ms 限制性条件：(To-From) / interval \u003c= 200", "example": "10" }, { "name": "SyntaxRule", "type": "integer", "required": false, "description": "检索语法规则，默认值为0。 0：Lucene语法，1：CQL语法。 详细说明参见检索条件语法规则", "example": "1" } ], "required": [ "From", "To", "Query" ] }, { "name": "DescribeLogsets", "description": "本接口用于获取日志集信息列表。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "logsetName - 按照【日志集名称】进行过滤。 - 类型：String - 必选：否 - 通过 [获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集名称。 logsetId - 按照【日志集ID】进行过滤。 - 类型：String - 必选：否 - 通过 [获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。 tagKey - 按照【标签键】进行过滤。 - 类型：String - 必选：否 tag:tagKey - 按照【标签键...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页的限制数目，默认值为20，最大值100", "example": "1" } ], "required": [] }, { "name": "DescribeMachineGroupConfigs", "description": "获取机器组绑定的采集规则配置", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "机器组ID - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。", "example": "3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a" } ], "required": [ "GroupId" ] }, { "name": "DescribeMachineGroups", "description": "获取机器组信息列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件 machineGroupName - 按照【机器组名称】进行过滤。 - 类型：String - 必选：否 machineGroupId - 按照【机器组ID】进行过滤。 - 类型：String - 必选：否 osType - 按照【操作系统类型】进行过滤。0： Linux；1： Windows - 类型：Int - 必选：否 tagKey - 按照【标签键】进行过滤。 - 类型：String - 必选：否 tag:tagKey - 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换。 - 类型：St...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页的限制数目，默认值为20，最大值100", "example": "10" } ], "required": [] }, { "name": "DescribeMachines", "description": "获取指定机器组下的机器状态", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "查询的机器组ID。 - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组ID。", "example": "ae0d14a7-94e1-461e-8f5d-7d66a0d56d35 " }, { "name": "Filters", "type": "array", "required": false, "description": "ip - 按照ip进行过滤。 - 类型：String - 必选：否 instance - 按照实例id进行过滤。 - 类型：String - 必选：否 version - 按照LogListener版本进行过滤。 - 类型：String - 必选：否 status - 按照机器状态进行过滤。 - 类型：String - 必选：否 - 可选值：0：离线，1：正常 offlineTime - 按照机器离线时间进行过滤。 - 类型：String - 必选：否 - -可选值：0：无离线时间，12：12小时内，24：一天内，48：两...", "example": "[{\"Key\":\"status\",\"Values\":[\"1\"]}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目。最大支持100", "example": "10" } ], "required": [ "GroupId" ] }, { "name": "DescribeMetricCorrectDimension", "description": "获取指标订阅配置", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeMetricSubscribePreview", "description": "创建指标订阅配置", "status": "online", "parameters": [ { "name": "Namespace", "type": "string", "required": true, "description": "云产品命名空间。", "example": "QCE/CVM" }, { "name": "Metrics", "type": "array", "required": true, "description": "数据库配置信息。", "example": "无", "item_type": "object", "children": [ { "name": "MetricName", "type": "string", "required": true, "description": "指标名称", "example": "metric_name" }, { "name": "Periods", "type": "array", "required": true, "description": "统计周期,单位:秒（s）", "example": "[60,120]", "item_type": "integer" }, { "name": "MetricLabels", "type": "array", "required": false, "description": "自定义指标标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "指标名称", "example": "ErrorMessage" }, { "name": "Value", "type": "string", "required": true, "description": "指标内容", "example": "Unauthorized" } ] } ] }, { "name": "InstanceInfo", "type": "object", "required": true, "description": "实例配置配置。", "example": "无", "children": [ { "name": "InstanceDimension", "type": "array", "required": true, "description": "实例维度", "example": "[\"bucket\",\"appid\"]", "item_type": "string" }, { "name": "Instances", "type": "array", "required": true, "description": "实例值", "example": "无", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "实例信息", "example": "[\"key1-value\",\"key2-value\"]", "item_type": "string" } ] } ] } ], "required": [ "Namespace", "Metrics", "InstanceInfo" ] }, { "name": "DescribeMetricSubscribes", "description": "获取指标订阅配置", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题id", "example": "5871c48d-219b-4274-829b-5aa7fb24229b" }, { "name": "Filters", "type": "array", "required": false, "description": "taskId按照【配置id】进行过滤。类型：String 必选：否 name按照【配置名称】进行过滤。类型：String 必选：否 status按照【配置状态标记】进行过滤。类型：String 必选：否 每次请求的Filters的上限为10，Filter.Values的上限为100。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "20" } ], "required": [ "TopicId" ] }, { "name": "DescribeNetworkApplicationDetail", "description": "获取网络应用详情", "status": "online", "parameters": [ { "name": "NetworkAppId", "type": "string", "required": true, "description": "网络应用id", "example": "638ca7fd-c7d3-492b-bc01-65304426783e" } ], "required": [ "NetworkAppId" ] }, { "name": "DescribeNetworkApplications", "description": "获取网络应用列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤项name按照【任务名称】进行过滤。模糊匹配方式查询。类型：String必选：否networkAppId按照【网络应用id】进行过滤。类型：String必选：否每次请求的Filters的上限为10，Filter.Values的上限为10。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "2" } ], "required": [] }, { "name": "DescribeNoticeContents", "description": "获取通知内容列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "name 按照【通知内容模板名称】进行过滤。 类型：String 必选：否 noticeContentId 按照【通知内容模板ID】进行过滤。 类型：String 必选：否 每次请求的Filters的上限为10，Filter.Values的上限为100。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "1" } ], "required": [] }, { "name": "DescribePartitions", "description": "该接口已废弃，如需获取分区数量，请使用DescribeTopics接口。", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题Id - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "eb9ec10d-1343-4386-9a6e-75fd9d68726e" } ], "required": [ "TopicId" ] }, { "name": "DescribeRebuildIndexTasks", "description": "获取重建索引任务列表", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题ID", "example": "57f5808c-4a55-11eb-b378-0242ac130002" }, { "name": "TaskId", "type": "string", "required": false, "description": "索引重建任务ID", "example": "57f5808c-4a55-11eb-b378-0242ac130002" }, { "name": "Status", "type": "string", "required": false, "description": "索引重建任务状态，不填返回所有状态任务列表，多种状态之间用逗号分隔。枚举值：0： 索引重建任务已创建1： 正在创建索引重建资源2： 已创建索引重建资源3： 重建中4： 暂停5： 重建完成6： 重建成功（可检索）7： 重建失败8： 任务取消9： 元数据和索引已删除", "example": "0,1,2,3" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为10，最大值20。", "example": "10" } ], "required": [ "TopicId" ] }, { "name": "DescribeScheduledSqlInfo", "description": "本接口用于获取定时SQL分析任务列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "10" }, { "name": "Name", "type": "string", "required": false, "description": "任务名称。", "example": "scheduler_sql_delete_task" }, { "name": "TaskId", "type": "string", "required": false, "description": "任务id。", "example": "9c64f9c1-a14e-4b59-b074-5b73cac3dd66" }, { "name": "Filters", "type": "array", "required": false, "description": "- srcTopicName按照【源日志主题名称】进行过滤，模糊匹配。类型：String。必选：否。示例：业务日志主题1 ，通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。 - dstTopicName按照【目标日志主题名称】进行过滤，模糊匹配。类型：String。必选：否。示例：业务日志主题 2，通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeShipperTasks", "description": "获取投递任务列表", "status": "online", "parameters": [ { "name": "ShipperId", "type": "string", "required": true, "description": "投递规则Id。 - 通过 [获取投递任务列表](https://cloud.tencent.com/document/product/614/58745)获取ShipperId。", "example": "53d355bc-9814-43b4-b10a-4be50405095f" }, { "name": "StartTime", "type": "integer", "required": true, "description": "查询的开始时间戳，支持最近3天的查询， 毫秒。 StartTime必须小于EndTime", "example": "1753878541000" }, { "name": "EndTime", "type": "integer", "required": true, "description": "查询的结束时间戳， 毫秒。 StartTime必须小于EndTime", "example": "1753878621000" } ], "required": [ "ShipperId", "StartTime", "EndTime" ] }, { "name": "DescribeShippers", "description": "获取投递到COS的任务配置信息", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "- shipperName：按照【投递规则名称】进行过滤。 类型：String。 必选：否 - shipperId：按照【投递规则ID】进行过滤。 类型：String。 必选：否 - topicId：按照【日志主题】进行过滤。 类型：String。 必选：否 - taskStatus：按照【任务运行状态】进行过滤。 支持`0`：停止，`1`：运行中，`2`：异常 类型：String 必选：否 每次请求的Filters的上限为10，Filter.Values的上限为10。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页的限制数目，默认值为20，最大值100", "example": "10" }, { "name": "PreciseSearch", "type": "integer", "required": false, "description": "控制Filters相关字段是否为精确匹配。 0: 默认值，shipperName模糊匹配 1: shipperName 精确匹配", "example": "0" } ], "required": [] }, { "name": "DescribeSplunkDelivers", "description": "获取Splunk投递任务列表", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题Id- 通过获取日志主题列表获取日志主题Id。", "example": "06cc3d03-44a0-4d94-89c2-aeac27a1d9f1" }, { "name": "Filters", "type": "array", "required": false, "description": "taskId 按照【任务id】进行过滤。 类型：String 必选：否 name 按照【任务名称】进行过滤。 类型：String 必选：否 statusFlag 按照【状态】进行过滤。 类型：String 必选：否 每次请求的Filters的上限为10，Filter.Values的上限为10。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "20" } ], "required": [ "TopicId" ] }, { "name": "DescribeSplunkPreview", "description": "splunk投递任务预览", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题id。- 通过获取日志主题列表获取日志主题Id。", "example": "d1d7d473-827e-4dad-9a42-f0287ad42098" }, { "name": "MetadataInfo", "type": "object", "required": true, "description": "splunk投递任务-元信息", "example": "无", "children": [ { "name": "Format", "type": "string", "required": true, "description": "数据格式,rawlog/json", "example": "json" }, { "name": "MetaFields", "type": "array", "required": false, "description": "投递字段，包括\\_\\_SOURCE\\_\\_、\\_\\_FILENAME\\_\\_ 、\\_\\_TIMESTAMP\\_\\_、\\_\\_HOSTNAME\\_\\_、\\_\\_PKG\\_ID\\_\\_", "example": "[\"__SOURCE__\",\"__FILENAME__\",\"__TIMESTAMP__\",\"__HOSTNAME__\"]", "item_type": "string" }, { "name": "EnableTag", "type": "boolean", "required": false, "description": "是否投递__TAG__字段", "example": "true" }, { "name": "TagJsonTiled", "type": "boolean", "required": false, "description": "JSON是否平铺，投递__TAG__字段时必填", "example": "false" } ] }, { "name": "DSLFilter", "type": "string", "required": false, "description": "splunk投递任务-投递 splunk过滤原始日志语句", "example": "log_keep(op_str_eq(v(\"type\"), \"kibana_stats\"))" } ], "required": [ "TopicId", "MetadataInfo" ] }, { "name": "DescribeTopicBaseMetricConfigs", "description": "获取指标订阅配置", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "指标日志主题id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题（默认值）， 1:指标主题 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题（默认值）， 1:指标主题", "example": "5871c48d-219b-4274-829b-5aa7fb24229b" }, { "name": "Filters", "type": "array", "required": false, "description": "groupId按照【机器组id】进行过滤。类型：String 必选：否 每次请求的Filters的上限为10，所有Filter.Values总和上限为100。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "20" } ], "required": [ "TopicId" ] }, { "name": "DescribeTopicMetricConfigs", "description": "获取指标订阅配置", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "指标日志主题id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题（默认值）， 1:指标主题 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题（默认值）， 1:指标主题", "example": "5871c48d-219b-4274-829b-5aa7fb24229b" }, { "name": "Filters", "type": "array", "required": false, "description": "configId按照【指标采集配置id】进行过滤。类型：String 必选：否 name按照【配置名称】进行过滤。类型：String 必选：否 每次请求的Filters的上限为10，所有Filter.Values总和上限为100。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "20" } ], "required": [ "TopicId" ] }, { "name": "DescribeTopics", "description": "本接口用于获取日志或指标主题列表，支持分页", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "topicName 按照【主题名称】进行过滤，默认为模糊匹配，可使用 PreciseSearch 参数设置为精确匹配。类型：String。必选：否 logsetName 按照【日志集名称】进行过滤，默认为模糊匹配，可使用 PreciseSearch 参数设置为精确匹配。类型：String。必选：否 topicId 按照【主题ID】进行过滤。类型：String。必选：否 logsetId 按照【日志集ID】进行过滤，可通过调用 DescribeLogsets 查询已创建的日志集...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "10" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "30" }, { "name": "PreciseSearch", "type": "integer", "required": false, "description": "控制Filters相关字段是否为精确匹配。 0: 默认值，topicName 和 logsetName 模糊匹配 1: topicName 精确匹配 2: logsetName精确匹配 3: topicName 和logsetName 都精确匹配", "example": "1" }, { "name": "BizType", "type": "integer", "required": false, "description": "主题类型 - 0:日志主题，默认值 - 1:指标主题", "example": "0" } ], "required": [] }, { "name": "DescribeWebCallbacks", "description": "获取告警渠道回调配置列表。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "- name 按照【告警渠道回调配置名称】进行过滤。 类型：String 必选：否 - webCallbackId 按照【告警渠道回调配置ID】进行过滤。 类型：String 必选：否 - type 按照【告警渠道回调配置渠道类型】进行过滤。 类型：String 必选：否 枚举值：WeCom，DingTalk，Lark，Http 每次请求的Filters的上限为10，Filter.Values的上限为100。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "taskId" }, { "name": "Values", "type": "array", "required": true, "description": "需要过滤的值。", "example": "[\"fadcc986-xxxx-xxxx-b766-9ce9c193da32\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页的偏移量，默认值为0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页单页限制数目，默认值为20，最大值100。", "example": "1" } ], "required": [] }, { "name": "EstimateRebuildIndexTask", "description": "预估重建索引任务", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题ID", "example": "57f5808c-4a55-11eb-b378-0242ac130002" }, { "name": "StartTime", "type": "integer", "required": true, "description": "预估任务起始时间，毫秒", "example": "978653222" }, { "name": "EndTime", "type": "integer", "required": true, "description": "预估任务结束时间，毫秒", "example": "978653222" } ], "required": [ "TopicId", "StartTime", "EndTime" ] }, { "name": "GetAlarmLog", "description": "本接口用于获取告警策略执行详情", "status": "online", "parameters": [ { "name": "From", "type": "integer", "required": true, "description": "要查询的执行详情的起始时间，Unix时间戳，单位ms。", "example": "1702569600000" }, { "name": "To", "type": "integer", "required": true, "description": "要查询的执行详情的结束时间，Unix时间戳，单位ms。", "example": "1702655999999" }, { "name": "Query", "type": "string", "required": true, "description": "查询过滤条件，例如： - 按告警策略ID查询：`alert_id:\"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971\"` - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取告警策略ID - 按监控对象ID查询：`monitored_object:\"823d8bfa-76a7-xxxx-8399-8cda74d4009b\" ` - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取监控对象ID - 按告警策略ID及监控对象ID查询：`alert_id:\"alarm-0745ec00-e605-xxxx-b50b-54...", "example": "alert_id:notice-c0960eb3-6454-4eef-xxxx-8feb766a9fbd" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次查询返回的执行详情条数，最大值为1000", "example": "100" }, { "name": "Context", "type": "string", "required": false, "description": "透传上次接口返回的Context值，可获取后续更多日志，总计最多可获取1万条原始日志，过期时间1小时。 注意： * 透传该参数时，请勿修改除该参数外的其它参数 * 仅当检索分析语句(Query)不包含SQL时有效，SQL获取后续结果参考SQL LIMIT语法", "example": "Y29udGxxxxC04MjMzNWRkMi01YmMxLTQ4NGYtYjQ4MS04MDg0NzAwYjQ1NDUxNjcy" }, { "name": "Sort", "type": "string", "required": false, "description": "原始日志是否按时间排序返回；可选值：asc(升序)、desc(降序)，默认为 desc 注意： * 仅当检索分析语句(Query)不包含SQL时有效 * SQL结果排序方式参考SQL ORDER BY语法", "example": "asc" }, { "name": "UseNewAnalysis", "type": "boolean", "required": false, "description": "true：代表使用新的检索结果返回方式，输出参数AnalysisRecords和Columns有效； false：代表使用老的检索结果返回方式，输出AnalysisResults和ColNames有效； 两种返回方式在编码格式上有少量区别，建议使用true。", "example": "false" } ], "required": [ "From", "To", "Query" ] }, { "name": "GetMetricLabelValues", "description": "获取时序label values列表", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "时序主题id", "example": "3a05cb9c-3471-42b8-b212-6ecbc0c49a4a" }, { "name": "LabelName", "type": "string", "required": true, "description": "时序label名称", "example": "__name__" }, { "name": "Start", "type": "integer", "required": false, "description": "起始时间", "example": "1772787397" }, { "name": "End", "type": "integer", "required": false, "description": "结束时间", "example": "1772787697" }, { "name": "Match", "type": "array", "required": false, "description": "Label匹配规则", "example": "[\"http_server_requests_seconds_count\"]", "item_type": "string" } ], "required": [ "TopicId", "LabelName" ] }, { "name": "MergePartition", "description": "该接口已废弃，如需修改分区数量，请使用ModifyTopic接口。", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题Id - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "427bba81-e149-4a8b-bd0d-b2a412520d7b" }, { "name": "PartitionId", "type": "integer", "required": true, "description": "合并的PartitionId（找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等，且找到的分区必须是读写分区（Status:readwrite），入参PartitionId与找到的PartitionId设置为只读分区（Status:readonly）,再新建一个新的读写分区） 。[获取分区列表](https://cloud.tencent.com/document/product/614/56470) 1. 入参PartitionId只能是读写分区（Status的值有readonly，readwrite），且能找到入参PartitionId的下一\ufffd...", "example": "2" } ], "required": [ "TopicId", "PartitionId" ] }, { "name": "ModifyAlarm", "description": "本接口用于修改告警策略。需要至少修改一项有效内容。", "status": "online", "parameters": [ { "name": "AlarmId", "type": "string", "required": true, "description": "告警策略ID。-通过获取告警策略列表获取告警策略ID", "example": "alarm-bea71170-4a59-11eb-b378-0242ac130002" }, { "name": "Name", "type": "string", "required": false, "description": "告警策略名称。最大支持255个字节，不支持 \u0026#39;|\u0026#39;。", "example": "访问拦截告警" }, { "name": "MonitorTime", "type": "object", "required": false, "description": "监控任务运行时间点。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "执行周期， 可选值：`Period`、`Fixed`、`Cron`。 - Period：固定频率 - Fixed：固定时间 - Cron：Cron表达式", "example": "Period" }, { "name": "Time", "type": "integer", "required": false, "description": "执行的周期，或者定制执行的时间节点。单位为分钟，取值范围为1~1440。 当type为`Period`,`Fixed`时，time字段生效。", "example": "1" }, { "name": "CronExpression", "type": "string", "required": false, "description": "执行的周期cron表达式。示例：`\"*/1 * * * *\"` 从左到右每个field的含义 Minutes field(分钟), Hours field(小时),Day of month field(日期),Month field(月份),Day of week field(星期)， 不支持秒级别。 当type为`Cron`时，CronExpression字段生效。", "example": "*/1 * * * *" } ] }, { "name": "Condition", "type": "string", "required": false, "description": "告警信息发送的触发条件。注意: Condition和AlarmLevel是一组配置，MultiConditions是另一组配置，2组配置互斥。", "example": "$1.source='10.0.0.1'" }, { "name": "AlarmLevel", "type": "integer", "required": false, "description": "告警级别。0:警告(Warn);1:提醒(Info);2:紧急 (Critical)注意: Condition和AlarmLevel是一组配置，MultiConditions是另一组配置，2组配置互斥。", "example": "0" }, { "name": "MultiConditions", "type": "array", "required": false, "description": "多触发条件。 注意: Condition和AlarmLevel是一组配置，MultiConditions是另一组配置，2组配置互斥。", "example": "无", "item_type": "object", "children": [ { "name": "Condition", "type": "string", "required": false, "description": "触发条件。", "example": "[$1.__QUERYCOUNT__]\u003e 0" }, { "name": "AlarmLevel", "type": "integer", "required": false, "description": "告警级别。0:警告(Warn); 1:提醒(Info); 2:紧急 (Critical)。 - 不填则默认为0。", "example": "0" } ] }, { "name": "TriggerCount", "type": "integer", "required": false, "description": "持续周期。持续满足触发条件TriggerCount个周期后，再进行告警；最小值为1，最大值为2000。", "example": "1" }, { "name": "AlarmPeriod", "type": "integer", "required": false, "description": "告警重复的周期。单位是分钟。取值范围是0~1440。", "example": "0" }, { "name": "AlarmTargets", "type": "array", "required": false, "description": "监控对象列表。", "example": "无", "item_type": "object", "children": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID", "example": "380fe1f1-0c7b-4b0d-xxxx-d514959db1bb" }, { "name": "Query", "type": "string", "required": true, "description": "查询语句。", "example": "code:200 | select count(*) as success_counts" }, { "name": "Number", "type": "integer", "required": true, "description": "告警对象序号；从1开始递增。", "example": "1" }, { "name": "StartTimeOffset", "type": "integer", "required": true, "description": "查询范围起始时间相对于告警执行时间的偏移，单位为分钟，取值为非正，最大值为0，最小值为-1440。", "example": "0" }, { "name": "EndTimeOffset", "type": "integer", "required": true, "description": "查询范围终止时间相对于告警执行时间的偏移，单位为分钟，取值为非正，须大于StartTimeOffset，最大值为0，最小值为-1440。", "example": "0" }, { "name": "LogsetId", "type": "string", "required": true, "description": "日志集ID。通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志集ID", "example": "1c072db7-2cfd-4418-xxxx-7342c7a42516" }, { "name": "SyntaxRule", "type": "integer", "required": false, "description": "检索语法规则，默认值为0。 0：Lucene语法，1：CQL语法。 详细说明参见检索条件语法规则", "example": "1" } ] }, { "name": "Status", "type": "boolean", "required": false, "description": "是否开启告警策略。", "example": "true" }, { "name": "MessageTemplate", "type": "string", "required": false, "description": "用户自定义告警内容", "example": "{{.Label}}" }, { "name": "CallBack", "type": "object", "required": false, "description": "用户自定义回调", "example": "无", "children": [ { "name": "Body", "type": "string", "required": true, "description": "回调时的Body。 可将各类告警变量放在请求内容中，详见[帮助文档](https://cloud.tencent.com/document/product/614/74718)。 如下示例： ``` { \"TopicId\": \"{{ .QueryLog[0][0].topicId }}\", \"key\": \"{{.Alarm}}\", \"time\": \"{{ .QueryLog[0][0].time }}\", \"log\": \"{{ .QueryLog[0][0].content.__CONTENT__ }}\", \"namespace\": \"{{ .QueryLog[0][0].content.__TAG__.namespace }}\" } ```", "example": "{\"User\":\"{{.User}}\",\"AlarmID\":\"{{.AlarmID}}\",\"AlarmName\":\"{{.AlarmName}}\",\"Condition\":\"{{.Condition}}\"}" }, { "name": "Headers", "type": "array", "required": false, "description": "回调时的HTTP请求头部字段。 例如：下面请求头部字段来告知服务器请求主体的内容类型为JSON。 ``` \"Content-Type: application/json\" ```", "example": "[\"Content-Type: application/json\"]", "item_type": "string" } ] }, { "name": "Analysis", "type": "array", "required": false, "description": "多维分析", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "分析名称", "example": "status 502 pv" }, { "name": "Type", "type": "string", "required": true, "description": "分析类型：query(自定义检索分析)，field(字段TOP5及占比统计) ，original(相关原始日志)", "example": "query" }, { "name": "Content", "type": "string", "required": true, "description": "分析内容", "example": "*|select count(1) as pv where status = 502" }, { "name": "ConfigInfo", "type": "array", "required": false, "description": "多维分析配置。 当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\", // 查不到这个字段也是老...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "键。支持以下key： SyntaxRule：语法规则，value支持 0：Lucene语法；1： CQL语法。 QueryIndex：执行语句序号。value支持 -1：自定义； 1：执行语句1； 2：执行语句2。 CustomQuery：检索语句。 QueryIndex为-1时有效且必填，value示例： \"* | select count(*) as count\"。 Fields：字段。value支持 __SOURCE__；__FILENAME__；__HOSTNAME__；__TIMESTAMP__；__INDEX_STATUS__；__PKG_LOGID__；__TOPIC__。 Format：显示形式。value支持 1：...", "example": "k" }, { "name": "Value", "type": "string", "required": true, "description": "值。 键对应值如下： SyntaxRule：语法规则，value支持 0：Lucene语法；1： CQL语法。 QueryIndex：执行语句序号。value支持 -1：自定义； 1：执行语句1； 2：执行语句2。 CustomQuery：检索语句。 QueryIndex为-1时有效且必填，value示例： \"* | select count(*) as count\"。 Fields：字段。value支持 __SOURCE__；__FILENAME__；__HOSTNAME__；__TIMESTAMP__；__INDEX_STATUS__；__PKG_LOGID__；__TOPIC__。 Format：显示形式。value支持 ...", "example": "v" } ] } ] }, { "name": "GroupTriggerStatus", "type": "boolean", "required": false, "description": "分组触发状态。true：开启，false：关闭（默认）", "example": "true" }, { "name": "GroupTriggerCondition", "type": "array", "required": false, "description": "分组触发条件。", "example": "[\"$1.conut\"]", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "标签描述列表，通过指定该参数可以同时绑定标签到相应的告警策略。最大支持10个标签键值对，并且不能有重复的键值对。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "业务A" } ] }, { "name": "MonitorObjectType", "type": "integer", "required": false, "description": "监控对象类型。0:执行语句共用监控对象; 1:每个执行语句单独选择监控对象。当值为1时，AlarmTargets元素个数不能超过10个，AlarmTargets中的Number必须是从1开始的连续正整数，不能重复。", "example": "0" }, { "name": "Classifications", "type": "array", "required": false, "description": "告警附加分类信息列表。Classifications元素个数不能超过20个。Classifications元素的Key不能为空，不能重复，长度不能超过50个字符，符合正则 ^[a-z]([a-z0-9_]{0,49})$。Classifications元素的Value长度不能超过200个字符。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "分类键", "example": "key_sample" }, { "name": "Value", "type": "string", "required": true, "description": "分类值", "example": "value_sample" } ] }, { "name": "AlarmNoticeIds", "type": "array", "required": false, "description": "关联的日志服务告警通知渠道组列表。-通过获取通知渠道组列表获取关联的告警通知渠道组列表，和MonitorNotice互斥", "example": "[\"notice-479dec34-4a59-11eb-b378-0242ac130002\"]", "item_type": "string" }, { "name": "MonitorNotice", "type": "object", "required": false, "description": "关联的可观测平台通知模板，与 AlarmNoticeIds 参数互斥，不能同时使用", "example": "无", "children": [ { "name": "Notices", "type": "array", "required": false, "description": "以数组的形式提供MonitorNoticeRule", "example": "无", "item_type": "object", "children": [ { "name": "NoticeId", "type": "string", "required": false, "description": "腾讯云可观测平台通知模板 ID", "example": "notice-xxx" }, { "name": "ContentTmplId", "type": "string", "required": false, "description": "腾讯云可观测平台内容模板ID，为空时使用默认内容模板 注意：此字段可能返回 null，表示取不到有效值。", "example": "tmpl-xxx" }, { "name": "AlarmLevels", "type": "array", "required": false, "description": "告警级别,0:警告(Warn); 1:提醒(Info); 2:紧急 (Critical)", "example": "[0,1,2]", "item_type": "integer" } ] } ] } ], "required": [ "AlarmId" ] }, { "name": "ModifyAlarmNotice", "description": "该接口用于修改通知渠道组", "status": "online", "parameters": [ { "name": "AlarmNoticeId", "type": "string", "required": true, "description": "通知渠道组ID。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/api/614/56462)获取通知渠道组ID", "example": "notice-5b2ea996-4dae-47cc-bbad-5b12888b4c89" }, { "name": "Tags", "type": "array", "required": false, "description": "标签描述列表，通过指定该参数可以同时绑定标签到相应的通知渠道组。最大支持10个标签键值对，并且不能有重复的键值对。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "业务A" } ] }, { "name": "Name", "type": "string", "required": false, "description": "通知渠道组名称。", "example": "Demo访问日志通知渠道组" }, { "name": "Type", "type": "string", "required": false, "description": "通知类型。可选值： Trigger - 告警触发 Recovery - 告警恢复 All - 告警触发和告警恢复", "example": "All" }, { "name": "NoticeReceivers", "type": "array", "required": false, "description": "通知接收对象。", "example": "无", "item_type": "object", "children": [ { "name": "ReceiverType", "type": "string", "required": true, "description": "接受者类型。可选值： - Uin - 用户ID - Group - 用户组ID 暂不支持其余接收者类型。", "example": "Group" }, { "name": "ReceiverIds", "type": "array", "required": true, "description": "接收者。 当ReceiverType为Uin时，ReceiverIds的值为用户uid。[子用户信息查询](https://cloud.tencent.com/document/api/598/53486) 当ReceiverType为Group时，ReceiverIds的值为用户组id。[CAM用户组](https://cloud.tencent.com/document/product/598/34589)", "example": "[1234,2345]", "item_type": "integer" }, { "name": "ReceiverChannels", "type": "array", "required": true, "description": "通知接收渠道。 - Email - 邮件 - Sms - 短信 - WeChat - 微信 - Phone - 电话", "example": "[\"Sms\"]", "item_type": "string" }, { "name": "NoticeContentId", "type": "string", "required": false, "description": "通知内容模板ID，使用Default-zh引用默认模板（中文），使用Default-en引用DefaultTemplate(English)。-通过[获取通知内容模板](https://cloud.tencent.com/document/product/614/111714)获取通知内容模板ID", "example": "\"noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1\"" }, { "name": "StartTime", "type": "string", "required": false, "description": "允许接收信息的开始时间。格式：`15:04:05`。必填", "example": "00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "允许接收信息的结束时间。格式：`15:04:05`。必填", "example": "23:59:59" }, { "name": "Index", "type": "integer", "required": false, "description": "位序。 - 入参时无效。 - 出参时有效。", "example": "1" } ] }, { "name": "WebCallbacks", "type": "array", "required": false, "description": "接口回调信息（包括企业微信等）。", "example": "无", "item_type": "object", "children": [ { "name": "CallbackType", "type": "string", "required": true, "description": "回调的类型。可选值： - Http(自定义接口回调) - WeCom(企业微信) - DingTalk(钉钉) - Lark(飞书)", "example": "WeCom" }, { "name": "Url", "type": "string", "required": true, "description": "回调地址，最大支持1024个字节。 也可使用WebCallbackId引用集成配置中的URL，此时该字段请填写为空字符串。", "example": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=937xxxe47-xxxx-xxxx-a063-216xxxx9226f" }, { "name": "WebCallbackId", "type": "string", "required": false, "description": "集成配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/product/614/115229)获取集成配置ID", "example": "\"webcallback-aaa-bbb-ccc-ddd\"" }, { "name": "Method", "type": "string", "required": false, "description": "回调方法。可选值： - POST（默认值） - PUT 注意： - 参数CallbackType为Http时为必选，其它回调方式无需填写。", "example": "POST" }, { "name": "NoticeContentId", "type": "string", "required": false, "description": "通知内容模板ID，使用Default-zh引用默认模板（中文），使用Default-en引用DefaultTemplate(English)。", "example": "\"noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1\"" }, { "name": "RemindType", "type": "integer", "required": false, "description": "提醒类型。 0：不提醒；1：指定人；2：所有人", "example": "0" }, { "name": "Mobiles", "type": "array", "required": false, "description": "电话列表。", "example": "[\"15111111111\"]", "item_type": "string" }, { "name": "UserIds", "type": "array", "required": false, "description": "用户ID列表。", "example": "[\"11274\"]", "item_type": "string" }, { "name": "Index", "type": "integer", "required": false, "description": "序号。 - 入参无效。 - 出参有效。", "example": "1" } ] }, { "name": "NoticeRules", "type": "array", "required": false, "description": "通知规则。 注意: - Type、NoticeReceivers和WebCallbacks是一组配置，NoticeRules是另一组配置，2组配置互斥。 - 传其中一组数据，则另一组数据置空。", "example": "无", "item_type": "object", "children": [ { "name": "Rule", "type": "string", "required": false, "description": "匹配规则 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可取值：`Condition`，`Operatio...", "example": "{\\\"Value\\\":\\\"AND\\\",\\\"Type\\\":\\\"Operation\\\",\\\"Children\\\":[{\\\"Type\\\":\\\"Condition\\\",\\\"Value\\\":\\\"NotifyType\\\",\\\"Children\\\":[{\\\"Value\\\":\\\"In\\\",\\\"Type\\\":\\\"Compare\\\"},{\\\"Value\\\":\\\"[1,2]\\\",\\\"Type\\\":\\\"Value\\\"}]}]}" }, { "name": "NoticeReceivers", "type": "array", "required": false, "description": "告警通知接收者信息。", "example": "无", "item_type": "object", "children": [ { "name": "ReceiverType", "type": "string", "required": true, "description": "接受者类型。可选值： - Uin - 用户ID - Group - 用户组ID 暂不支持其余接收者类型。", "example": "Group" }, { "name": "ReceiverIds", "type": "array", "required": true, "description": "接收者。 当ReceiverType为Uin时，ReceiverIds的值为用户uid。[子用户信息查询](https://cloud.tencent.com/document/api/598/53486) 当ReceiverType为Group时，ReceiverIds的值为用户组id。[CAM用户组](https://cloud.tencent.com/document/product/598/34589)", "example": "[1234,2345]", "item_type": "integer" }, { "name": "ReceiverChannels", "type": "array", "required": true, "description": "通知接收渠道。 - Email - 邮件 - Sms - 短信 - WeChat - 微信 - Phone - 电话", "example": "[\"Sms\"]", "item_type": "string" }, { "name": "NoticeContentId", "type": "string", "required": false, "description": "通知内容模板ID，使用Default-zh引用默认模板（中文），使用Default-en引用DefaultTemplate(English)。-通过[获取通知内容模板](https://cloud.tencent.com/document/product/614/111714)获取通知内容模板ID", "example": "\"noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1\"" }, { "name": "StartTime", "type": "string", "required": false, "description": "允许接收信息的开始时间。格式：`15:04:05`。必填", "example": "00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "允许接收信息的结束时间。格式：`15:04:05`。必填", "example": "23:59:59" }, { "name": "Index", "type": "integer", "required": false, "description": "位序。 - 入参时无效。 - 出参时有效。", "example": "1" } ] }, { "name": "WebCallbacks", "type": "array", "required": false, "description": "告警通知模板回调信息，包括企业微信、钉钉、飞书。", "example": "无", "item_type": "object", "children": [ { "name": "CallbackType", "type": "string", "required": true, "description": "回调的类型。可选值： - Http(自定义接口回调) - WeCom(企业微信) - DingTalk(钉钉) - Lark(飞书)", "example": "WeCom" }, { "name": "Url", "type": "string", "required": true, "description": "回调地址，最大支持1024个字节。 也可使用WebCallbackId引用集成配置中的URL，此时该字段请填写为空字符串。", "example": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=937xxxe47-xxxx-xxxx-a063-216xxxx9226f" }, { "name": "WebCallbackId", "type": "string", "required": false, "description": "集成配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/product/614/115229)获取集成配置ID", "example": "\"webcallback-aaa-bbb-ccc-ddd\"" }, { "name": "Method", "type": "string", "required": false, "description": "回调方法。可选值： - POST（默认值） - PUT 注意： - 参数CallbackType为Http时为必选，其它回调方式无需填写。", "example": "POST" }, { "name": "NoticeContentId", "type": "string", "required": false, "description": "通知内容模板ID，使用Default-zh引用默认模板（中文），使用Default-en引用DefaultTemplate(English)。", "example": "\"noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1\"" }, { "name": "RemindType", "type": "integer", "required": false, "description": "提醒类型。 0：不提醒；1：指定人；2：所有人", "example": "0" }, { "name": "Mobiles", "type": "array", "required": false, "description": "电话列表。", "example": "[\"15111111111\"]", "item_type": "string" }, { "name": "UserIds", "type": "array", "required": false, "description": "用户ID列表。", "example": "[\"11274\"]", "item_type": "string" }, { "name": "Index", "type": "integer", "required": false, "description": "序号。 - 入参无效。 - 出参有效。", "example": "1" } ] }, { "name": "Escalate", "type": "boolean", "required": false, "description": "告警升级开关。`true`：开启告警升级、`false`：关闭告警升级，默认：false", "example": "false" }, { "name": "Type", "type": "integer", "required": false, "description": "告警升级条件。`1`：无人认领且未恢复、`2`：未恢复，默认为1 - 无人认领且未恢复：告警没有恢复并且没有人认领则升级 - 未恢复：当前告警持续未恢复则升级", "example": "1" }, { "name": "Interval", "type": "integer", "required": false, "description": "告警升级间隔。单位：分钟，范围`[1，14400]`", "example": "1" }, { "name": "EscalateNotice", "type": "object", "required": false, "description": "告警升级后下一个环节的通知渠道配置", "example": "无", "children": [ { "name": "NoticeReceivers", "type": "array", "required": true, "description": "告警通知模板接收者信息。", "example": "无", "item_type": "object", "children": [ { "name": "ReceiverType", "type": "string", "required": true, "description": "接受者类型。可选值： - Uin - 用户ID - Group - 用户组ID 暂不支持其余接收者类型。", "example": "Group" }, { "name": "ReceiverIds", "type": "array", "required": true, "description": "接收者。 当ReceiverType为Uin时，ReceiverIds的值为用户uid。[子用户信息查询](https://cloud.tencent.com/document/api/598/53486) 当ReceiverType为Group时，ReceiverIds的值为用户组id。[CAM用户组](https://cloud.tencent.com/document/product/598/34589)", "example": "[1234,2345]", "item_type": "integer" }, { "name": "ReceiverChannels", "type": "array", "required": true, "description": "通知接收渠道。 - Email - 邮件 - Sms - 短信 - WeChat - 微信 - Phone - 电话", "example": "[\"Sms\"]", "item_type": "string" }, { "name": "NoticeContentId", "type": "string", "required": false, "description": "通知内容模板ID，使用Default-zh引用默认模板（中文），使用Default-en引用DefaultTemplate(English)。-通过[获取通知内容模板](https://cloud.tencent.com/document/product/614/111714)获取通知内容模板ID", "example": "\"noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1\"" }, { "name": "StartTime", "type": "string", "required": false, "description": "允许接收信息的开始时间。格式：`15:04:05`。必填", "example": "00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "允许接收信息的结束时间。格式：`15:04:05`。必填", "example": "23:59:59" }, { "name": "Index", "type": "integer", "required": false, "description": "位序。 - 入参时无效。 - 出参时有效。", "example": "1" } ] }, { "name": "WebCallbacks", "type": "array", "required": true, "description": "告警通知模板回调信息。", "example": "无", "item_type": "object", "children": [ { "name": "CallbackType", "type": "string", "required": true, "description": "回调的类型。可选值： - Http(自定义接口回调) - WeCom(企业微信) - DingTalk(钉钉) - Lark(飞书)", "example": "WeCom" }, { "name": "Url", "type": "string", "required": true, "description": "回调地址，最大支持1024个字节。 也可使用WebCallbackId引用集成配置中的URL，此时该字段请填写为空字符串。", "example": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=937xxxe47-xxxx-xxxx-a063-216xxxx9226f" }, { "name": "WebCallbackId", "type": "string", "required": false, "description": "集成配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/product/614/115229)获取集成配置ID", "example": "\"webcallback-aaa-bbb-ccc-ddd\"" }, { "name": "Method", "type": "string", "required": false, "description": "回调方法。可选值： - POST（默认值） - PUT 注意： - 参数CallbackType为Http时为必选，其它回调方式无需填写。", "example": "POST" }, { "name": "NoticeContentId", "type": "string", "required": false, "description": "通知内容模板ID，使用Default-zh引用默认模板（中文），使用Default-en引用DefaultTemplate(English)。", "example": "\"noticetemplate-1eba4ed8-9584-40e3-a948-c8cff121eed1\"" }, { "name": "RemindType", "type": "integer", "required": false, "description": "提醒类型。 0：不提醒；1：指定人；2：所有人", "example": "0" }, { "name": "Mobiles", "type": "array", "required": false, "description": "电话列表。", "example": "[\"15111111111\"]", "item_type": "string" }, { "name": "UserIds", "type": "array", "required": false, "description": "用户ID列表。", "example": "[\"11274\"]", "item_type": "string" }, { "name": "Index", "type": "integer", "required": false, "description": "序号。 - 入参无效。 - 出参有效。", "example": "1" } ] }, { "name": "Escalate", "type": "boolean", "required": false, "description": "告警升级开关。`true`：开启告警升级、`false`：关闭告警升级，默认：false", "example": "false" }, { "name": "Interval", "type": "integer", "required": false, "description": "告警升级间隔。单位：分钟，范围`[1，14400]`", "example": "5" }, { "name": "Type", "type": "integer", "required": false, "description": "升级条件。`1`：无人认领且未恢复、`2`：未恢复，默认为1 - 无人认领且未恢复：告警没有恢复并且没有人认领则升级 - 未恢复：当前告警持续未恢复则升级", "example": "1" }, { "name": "EscalateNotice", "type": "object", "required": false, "description": "告警升级后下一个环节的通知渠道配置，最多可配置5个环节。", "example": "无", "children": [ { "name": "NoticeReceivers", "type": "array", "required": true, "description": "告警通知模板接收者信息。", "example": "无", "item_type": "string" }, { "name": "WebCallbacks", "type": "array", "required": true, "description": "告警通知模板回调信息。", "example": "无", "item_type": "string" }, { "name": "Escalate", "type": "boolean", "required": false, "description": "告警升级开关。`true`：开启告警升级、`false`：关闭告警升级，默认：false", "example": "false" }, { "name": "Interval", "type": "integer", "required": false, "description": "告警升级间隔。单位：分钟，范围`[1，14400]`", "example": "5" }, { "name": "Type", "type": "integer", "required": false, "description": "升级条件。`1`：无人认领且未恢复、`2`：未恢复，默认为1 - 无人认领且未恢复：告警没有恢复并且没有人认领则升级 - 未恢复：当前告警持续未恢复则升级", "example": "1" }, { "name": "EscalateNotice", "type": "object", "required": false, "description": "告警升级后下一个环节的通知渠道配置，最多可配置5个环节。", "example": "无" } ] } ] } ] }, { "name": "JumpDomain", "type": "string", "required": false, "description": "调用链接域名。http:// 或者 https:// 开头，不能/结尾", "example": "https://console.cloud.tencent.com" }, { "name": "DeliverStatus", "type": "integer", "required": false, "description": "投递日志开关。 参数值： 1：关闭； 2：开启", "example": "2" }, { "name": "DeliverConfig", "type": "object", "required": false, "description": "投递日志配置。", "example": "无", "children": [ { "name": "Region", "type": "string", "required": true, "description": "地域信息。 示例： ap-guangzhou 广州地域； ap-nanjing 南京地域。 详细信息请查看官网[地域和访问域名](https://cloud.tencent.com/document/product/614/18940)", "example": "ap-guangzhou" }, { "name": "TopicId", "type": "string", "required": true, "description": "日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID", "example": "17312724-asdfa-13513-66254" }, { "name": "Scope", "type": "integer", "required": true, "description": "投递数据范围。 0: 全部日志, 包括告警策略日常周期执行的所有日志，也包括告警策略变更产生的日志，默认值 1:仅告警触发及恢复日志", "example": "0" } ] }, { "name": "AlarmShieldStatus", "type": "integer", "required": false, "description": "免登录操作告警开关。 参数值： 1：关闭 2：开启（默认开启）", "example": "2" }, { "name": "CallbackPrioritize", "type": "boolean", "required": false, "description": "统一设定自定义回调参数。 - true: 使用通知内容模板中的自定义回调参数覆盖告警策略中单独配置的请求头及请求内容。 - false:优先使用告警策略中单独配置的请求头及请求内容。", "example": "false" } ], "required": [ "AlarmNoticeId" ] }, { "name": "ModifyAlarmShield", "description": "该接口用于修改告警屏蔽规则。当告警屏蔽规则为失效中时，无法对其进行修改", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "屏蔽规则ID。-通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID", "example": "cb37f589-6232-431a-xxxx-e2b61fb375d1" }, { "name": "AlarmNoticeId", "type": "string", "required": true, "description": "通知渠道组id。-通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id", "example": "notice-bb42f112-xxxx-456e-b3c4-ff5472911b42" }, { "name": "StartTime", "type": "integer", "required": false, "description": "屏蔽开始时间，秒级(s)时间戳。", "example": "1701872657" }, { "name": "EndTime", "type": "integer", "required": false, "description": "屏蔽结束时间，秒级(s)时间戳。", "example": "1701883657" }, { "name": "Type", "type": "integer", "required": false, "description": "屏蔽类型。1：屏蔽所有通知，2：按照Rule参数屏蔽匹配规则的通知。", "example": "2" }, { "name": "Rule", "type": "string", "required": false, "description": "屏蔽规则，当Type为2时必填。规则填写方式详见[产品文档](https://cloud.tencent.com/document/product/614/103178#rule)。", "example": "{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Level\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmID\"}]}" }, { "name": "Reason", "type": "string", "required": false, "description": "屏蔽原因。", "example": "屏蔽原因" }, { "name": "Status", "type": "integer", "required": false, "description": "规则状态。只有规则状态为生效中（status:1）时，才能将其修改为已失效（status:2）。 枚举：0（未生效），1（生效中），2（已失效）", "example": "2" } ], "required": [ "TaskId", "AlarmNoticeId" ] }, { "name": "ModifyCloudProductLogCollection", "description": "内部云产品接入使用相关接口", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "ins-r8hr2upy" }, { "name": "AssumerName", "type": "string", "required": true, "description": "云产品标识，支持枚举：CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS", "example": "CDB" }, { "name": "LogType", "type": "string", "required": true, "description": "日志类型，支持枚举：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", "example": "CDB-AUDIT" }, { "name": "CloudProductRegion", "type": "string", "required": true, "description": "云产品地域。 不同日志类型(LogType)地域入參格式存在差异， 请参考如下示例： - CDS所有日志类型：ap-guangzhou - CDB-AUDIT: gz - TDSQL-C-AUDIT: gz - MongoDB-AUDIT: gz - MongoDB-SlowLog：ap-guangzhou - MongoDB-ErrorLog：ap-guangzhou - TDMYSQL-SLOW：gz - DCDB所有日志类型：gz - MariaDB所有日志类型：gz - PostgreSQL所有日志类型：gz - BH所有日志类型：overseas-polaris(中国香港地区和其他)/fsi-polaris(金融区)/general-polaris(普\ufffd...", "example": "ap-guangzhou" }, { "name": "Extend", "type": "string", "required": false, "description": "日志配置拓展信息， 一般用于存储额外的日志投递配置", "example": "{\"ServiceName\":[\"HDFS\",\"KNOX\",\"YARN\",\"ZOOKEEPER\"],\"Policy\":0}" } ], "required": [ "InstanceId", "AssumerName", "LogType", "CloudProductRegion" ] }, { "name": "ModifyConfig", "description": "修改采集规则配置", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "采集规则配置ID，通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)返回信息获取。", "example": "a2c6342c-270a-4468-86cf-92625e466401" }, { "name": "Name", "type": "string", "required": false, "description": "采集规则配置名称 - 不能包含特殊字符｜ - 长度不能超过255字符，超过会被截断", "example": "testname" }, { "name": "Path", "type": "string", "required": false, "description": "日志采集路径，包含文件名", "example": "/data/nginx/log/access.log" }, { "name": "LogType", "type": "string", "required": false, "description": "采集的日志类型。支持以下类型： - json_log代表：JSON-文件日志（详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419)）； - delimiter_log代表：分隔符-文件日志（详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420)）； - minimalist_log代表：单行全文-文件日志（详见[使用单行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17...", "example": "delimiter_log" }, { "name": "ExtractRule", "type": "object", "required": false, "description": "提取规则，如果设置了ExtractRule，则必须设置LogType", "example": "无", "children": [ { "name": "TimeKey", "type": "string", "required": false, "description": "时间字段的key名字，TimeKey和TimeFormat必须成对出现", "example": "time" }, { "name": "TimeFormat", "type": "string", "required": false, "description": "时间字段的格式，参考c语言的strftime函数对于时间的格式说明输出参数 - 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档", "example": "%Y-%m-%d %H:%M:%S" }, { "name": "Delimiter", "type": "string", "required": false, "description": "分隔符类型日志的分隔符，只有LogType为delimiter_log时有效", "example": "," }, { "name": "LogRegex", "type": "string", "required": false, "description": "整条日志匹配规则，只有LogType为fullregex_log时有效", "example": "\\w" }, { "name": "BeginRegex", "type": "string", "required": false, "description": "行首匹配规则，只有LogType为multiline_log或fullregex_log时有效", "example": "\\w" }, { "name": "Keys", "type": "array", "required": false, "description": "取的每个字段的key名字，为空的key代表丢弃这个字段，只有LogType为delimiter_log时有效，json_log的日志使用json本身的key。限制100个。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"name\",\"address\"]", "item_type": "string" }, { "name": "FilterKeyRegex", "type": "array", "required": false, "description": "日志过滤规则列表（旧版），需要过滤日志的key，及其对应的regex。 注意：2.9.3及以上版本LogListener ，建议使用AdvanceFilterRules配置日志过滤规则。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤日志的key", "example": "response_code" }, { "name": "Regex", "type": "string", "required": true, "description": "key对应的过滤规则regex", "example": "400|500" } ] }, { "name": "UnMatchUpLoadSwitch", "type": "boolean", "required": false, "description": "解析失败日志是否上传，true表示上传，false表示不上传 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "UnMatchLogKey", "type": "string", "required": false, "description": "失败日志的key，当UnMatchUpLoadSwitch为true时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "testlog" }, { "name": "Backtracking", "type": "integer", "required": false, "description": "增量采集模式下的回溯数据量，默认：-1（全量采集）；其他非负数表示增量采集（从最新的位置，往前采集${Backtracking}字节（Byte）的日志）最大支持1073741824（1G）。 注意： - COS导入不支持此字段。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "IsGBK", "type": "integer", "required": false, "description": "是否为Gbk编码。 0：否；1：是。 注意 - 目前取0值时，表示UTF-8编码 - COS导入不支持此字段。", "example": "0" }, { "name": "JsonStandard", "type": "integer", "required": false, "description": "是否为标准json。 0：否； 1：是。 - 标准json指采集器使用业界标准开源解析器进行json解析，非标json指采集器使用CLS自研json解析器进行解析，两种解析器没有本质区别，建议客户使用标准json进行解析。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "syslog传输协议，取值为tcp或者udp，只有在LogType为service_syslog时生效，其余类型无需填写。 注意： - 该字段适用于：创建采集规则配置、修改采集规则配置。 - COS导入不支持此字段。", "example": "tcp" }, { "name": "Address", "type": "string", "required": false, "description": "syslog系统日志采集指定采集器监听的地址和端口 ，形式：[ip]:[port]，只有在LogType为service_syslog时生效，其余类型无需填写。 注意： - 该字段适用于：创建采集规则配置、修改采集规则配置。 - COS导入不支持此字段。", "example": "127.0.0.1:9000" }, { "name": "ParseProtocol", "type": "string", "required": false, "description": "rfc3164：指定系统日志采集使用RFC3164协议解析日志。 rfc5424：指定系统日志采集使用RFC5424协议解析日志。 auto：自动匹配rfc3164或者rfc5424其中一种协议。 只有在LogType为service_syslog时生效，其余类型无需填写。 注意： - 该字段适用于：创建采集规则配置、修改采集规则配置 - COS导入不支持此字段。", "example": "RFC3164" }, { "name": "MetadataType", "type": "integer", "required": false, "description": "元数据类型。0: 不使用元数据信息；1:使用机器组元数据；2:使用用户自定义元数据；3:使用采集配置路径。 注意： - COS导入不支持此字段。", "example": "0" }, { "name": "PathRegex", "type": "string", "required": false, "description": "采集配置路径正则表达式。 ``` 请用\"()\"标识路径中目标字段对应的正则表达式，解析时将\"()\"视为捕获组，并以__TAG__.{i}:{目标字段}的形式与日志一起上报，其中i为捕获组的序号。 若不希望以序号为键名，可以通过命名捕获组\"(?{正则})\"自定义键名，并以__TAG__.{键名}:{目标字段}的形式与日志一起上报。最多支持5个捕获组 ``` 注意： - MetadataType为3时必填。 - COS导入不支持此字段。", "example": "/(?\u003capp\u003e.*?)/(?\u003cuser\u003e.*?)/access.log" }, { "name": "MetaTags", "type": "array", "required": false, "description": "用户自定义元数据信息。 注意： - MetadataType为2时必填。 - COS导入不支持此字段。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "元数据key", "example": "buss_key" }, { "name": "Value", "type": "string", "required": false, "description": "元数据value", "example": "buss_value" } ] }, { "name": "EventLogRules", "type": "array", "required": false, "description": "Windows事件日志采集规则，只有在LogType为windows_event_log时生效，其余类型无需填写。", "example": "无", "item_type": "object", "children": [ { "name": "EventChannel", "type": "string", "required": true, "description": "事件通道，支持 - Application 应用日志 - Security 安全日志 - Setup 启动日志 - System 系统日志 - ALL 所有日志", "example": "Application" }, { "name": "TimeType", "type": "integer", "required": true, "description": "时间字段（Timestamp）支持的类型 - 1（用户自定义时间） - 2（当前时间）", "example": "1" }, { "name": "Timestamp", "type": "integer", "required": false, "description": "时间，用户选择自定义时间类型时，需要指定时间，单位秒 格式：时间戳，1754897446", "example": "1754897446" }, { "name": "EventIDs", "type": "array", "required": false, "description": "事件ID过滤列表 选填，为空表示不做过滤 支持正向过滤单个值（例：20）或范围（例：0-20），也支持反向过滤单个值(例：-20) 多个过滤项之间可由逗号隔开，例：1-200,-100表示采集1-200范围内除了100以外的事件日志", "example": "[\"1\",\"-100\"]", "item_type": "string" } ] }, { "name": "AdvanceFilterRules", "type": "array", "required": false, "description": "日志过滤规则列表（新版）。 注意： - 2.9.3以下版本LogListener不支持， 请使用FilterKeyRegex配置日志过滤规则。 - 自建k8s采集配置（CreateConfigExtra、ModifyConfigExtra）不支持此字段。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "过滤字段", "example": "http_code" }, { "name": "Rule", "type": "integer", "required": true, "description": "过滤规则，0:等于，1:字段存在，2:字段不存在", "example": "0" }, { "name": "Value", "type": "string", "required": false, "description": "过滤值", "example": "400|500" } ] } ] }, { "name": "ExcludePaths", "type": "array", "required": false, "description": "采集黑名单路径列表", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，选填File或Path", "example": "File" }, { "name": "Value", "type": "string", "required": true, "description": "Type对应的具体内容", "example": "/loglistener_auto_test/black_list/after_black_test.log" } ] }, { "name": "Output", "type": "string", "required": false, "description": "采集配置关联的日志主题（TopicId） - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "57f5808c-4a55-11eb-b378-0242ac130002" }, { "name": "UserDefineRule", "type": "string", "required": false, "description": "用户自定义解析字符串，Json格式序列化的字符串。", "example": "\"{\\\"processors\\\":[{\\\"type\\\":\\\"processor_split_delimiter\\\",\\\"detail\\\":{\\\"Delimiter\\\":\\\",\\\",\\\"ExtractKeys\\\":[\\\"time\\\",\\\"msg1\\\",\\\"msg2\\\"]}}]}\"" }, { "name": "AdvancedConfig", "type": "string", "required": false, "description": "高级采集配置。 Json字符串， Key/Value定义为如下： - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数， 0为不超时 - ClsAgentMaxDepth(最大目录深度)，取值范围: 大于等于0的整数 - ClsAgentParseFailMerge(合并解析失败日志)，取值范围: true或false 样例： `{\\\"ClsAgentFileTimeout\\\":0,\\\"ClsAgentMaxDepth\\\":10,\\\"ClsAgentParseFailMerge\\\":true}`", "example": "\"{\\\"ClsAgentFileTimeout\\\":0,\\\"ClsAgentMaxDepth\\\":10,\\\"ClsAgentParseFailMerge\\\":true}\"" }, { "name": "InputType", "type": "string", "required": false, "description": "日志输入类型（注：windows场景必填且仅支持file和windows_event类型） - file: 文件类型采集 - windows_event：windows事件采集 - syslog：系统日志采集", "example": "file" } ], "required": [ "ConfigId" ] }, { "name": "ModifyConfigExtra", "description": "本接口用于修改特殊采集配置任务，特殊采集配置应用于自建K8S环境的采集Agent", "status": "online", "parameters": [ { "name": "ConfigExtraId", "type": "string", "required": true, "description": "采集配置扩展信息id - 通过[获取特殊采集配置](https://cloud.tencent.com/document/api/614/71164)获取采集配置扩展信息id。", "example": "6ef60bec-0242-43af-bb20-270359fb54a8" }, { "name": "Name", "type": "string", "required": false, "description": "采集配置规程名称，最长63个字符，只能包含小写字符、数字及分隔符（“-”），且必须以小写字符开头，数字或小写字符结尾", "example": "table-config1" }, { "name": "TopicId", "type": "string", "required": false, "description": "日志主题id - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "6ef60bec-0242-43af-bb20-270359fb54a8" }, { "name": "HostFile", "type": "object", "required": false, "description": "自建k8s-节点文件配置信息,包括文件路径、名称及元数据相关信息。 - 详情参考 [HostFileInfo](https://cloud.tencent.com/document/api/614/56471#HostFileInfo) 文档。", "example": "无", "children": [ { "name": "LogPath", "type": "string", "required": true, "description": "日志文件夹", "example": "/xxx/xxx" }, { "name": "FilePattern", "type": "string", "required": true, "description": "日志文件名", "example": "**.log" }, { "name": "CustomLabels", "type": "array", "required": false, "description": "metadata信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"key1=value1\",\"key2=value2\"]", "item_type": "string" } ] }, { "name": "ContainerFile", "type": "object", "required": false, "description": "采集配置标记。 - 目前只支持label_k8s，用于标记自建k8s集群使用的采集配置 - 详情参考 [ ContainerFileInfo](https://cloud.tencent.com/document/api/614/56471#ContainerFileInfo) 文档", "example": "无", "children": [ { "name": "Namespace", "type": "string", "required": true, "description": "namespace可以多个，用分隔号分割,例如A,B", "example": "kube-system" }, { "name": "Container", "type": "string", "required": true, "description": "容器名称", "example": "container1" }, { "name": "LogPath", "type": "string", "required": true, "description": "日志文件夹", "example": "/var/log/tmep" }, { "name": "FilePattern", "type": "string", "required": true, "description": "日志名称", "example": "*.log" }, { "name": "FilePaths", "type": "array", "required": false, "description": "日志文件信息", "example": "无", "item_type": "object", "children": [ { "name": "Path", "type": "string", "required": false, "description": "文件路径", "example": "/log" }, { "name": "File", "type": "string", "required": false, "description": "文件名称", "example": "test.log" } ] }, { "name": "IncludeLabels", "type": "array", "required": false, "description": "pod标签信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"key1=value1\"]", "item_type": "string" }, { "name": "WorkLoad", "type": "object", "required": false, "description": "工作负载信息", "example": "无", "children": [ { "name": "Kind", "type": "string", "required": true, "description": "工作负载的类型，支持的取值如下： - deployment：无状态应用部署控制器。可管理无状态应用的多副本 Pod；支持滚动更新和回滚，实现无缝发布；通过 ReplicaSet 确保指定数量的 Pod 副本持续运行。适合 Web 服务、API 服务、微服务等不需要持久化存储或唯一标识的应用。 - statefulset：用于管理有状态应用的控制器。可以为每个 Pod 提供稳定的、唯一的标识（有序的主机名和网络标识...", "example": "daemonset" }, { "name": "Name", "type": "string", "required": true, "description": "工作负载的名称", "example": "tke-log-agent" }, { "name": "Container", "type": "string", "required": false, "description": "容器名", "example": "container_adsf" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "kube-system" } ] }, { "name": "ExcludeNamespace", "type": "string", "required": false, "description": "需要排除的namespace可以多个，用分隔号分割,例如A,B", "example": "kube-system" }, { "name": "ExcludeLabels", "type": "array", "required": false, "description": "需要排除的pod标签信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"key1=value1\"]", "item_type": "string" }, { "name": "CustomLabels", "type": "array", "required": false, "description": "metadata信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"key1=value1\",\"key2=value2\"]", "item_type": "string" } ] }, { "name": "ContainerStdout", "type": "object", "required": false, "description": "自建k8s-容器标准输出信息，包括容器、命名空间等， - 详情参考 [ContainerStdoutInfo]( https://cloud.tencent.com/document/api/614/56471#ContainerStdoutInfo) 文档", "example": "无", "children": [ { "name": "AllContainers", "type": "boolean", "required": true, "description": "是否所有容器", "example": "true / false" }, { "name": "Container", "type": "string", "required": false, "description": "container为空表所有的，不为空采集指定的容器", "example": "container_xzdfg" }, { "name": "Namespace", "type": "string", "required": false, "description": "namespace可以多个，用分隔号分割,例如A,B；为空或者没有这个字段，表示所有namespace", "example": "kube-system" }, { "name": "IncludeLabels", "type": "array", "required": false, "description": "pod标签信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"key1=value1\"]", "item_type": "string" }, { "name": "WorkLoads", "type": "array", "required": false, "description": "工作负载信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Kind", "type": "string", "required": true, "description": "工作负载的类型，支持的取值如下： - deployment：无状态应用部署控制器。可管理无状态应用的多副本 Pod；支持滚动更新和回滚，实现无缝发布；通过 ReplicaSet 确保指定数量的 Pod 副本持续运行。适合 Web 服务、API 服务、微服务等不需要持久化存储或唯一标识的应用。 - statefulset：用于管理有状态应用的控制器。可以为每个 Pod 提供稳定的、唯一的标识（有序的主机名和网络标识...", "example": "daemonset" }, { "name": "Name", "type": "string", "required": true, "description": "工作负载的名称", "example": "tke-log-agent" }, { "name": "Container", "type": "string", "required": false, "description": "容器名", "example": "container_adsf" }, { "name": "Namespace", "type": "string", "required": false, "description": "命名空间", "example": "kube-system" } ] }, { "name": "ExcludeNamespace", "type": "string", "required": false, "description": "需要排除的namespace可以多个，用分隔号分割,例如A,B", "example": "kube-system" }, { "name": "ExcludeLabels", "type": "array", "required": false, "description": "需要排除的pod标签信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"key1=value1\"]", "item_type": "string" }, { "name": "CustomLabels", "type": "array", "required": false, "description": "metadata信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"key1=value1\",\"key2=value2\"]", "item_type": "string" } ] }, { "name": "LogType", "type": "string", "required": false, "description": "采集的日志类型，默认为minimalist_log。支持以下类型： - json_log代表：JSON-文件日志（详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419)）； - delimiter_log代表：分隔符-文件日志（详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420)）； - minimalist_log代表：单行全文-文件日志（详见[使用单行全文提取模式采集日志](https://cloud.tencent.c...", "example": "minimalist_log" }, { "name": "ExtractRule", "type": "object", "required": false, "description": "提取规则，如果设置了ExtractRule，则必须设置LogType。", "example": "无", "children": [ { "name": "TimeKey", "type": "string", "required": false, "description": "时间字段的key名字，TimeKey和TimeFormat必须成对出现", "example": "time" }, { "name": "TimeFormat", "type": "string", "required": false, "description": "时间字段的格式，参考c语言的strftime函数对于时间的格式说明输出参数 - 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档", "example": "%Y-%m-%d %H:%M:%S" }, { "name": "Delimiter", "type": "string", "required": false, "description": "分隔符类型日志的分隔符，只有LogType为delimiter_log时有效", "example": "," }, { "name": "LogRegex", "type": "string", "required": false, "description": "整条日志匹配规则，只有LogType为fullregex_log时有效", "example": "\\w" }, { "name": "BeginRegex", "type": "string", "required": false, "description": "行首匹配规则，只有LogType为multiline_log或fullregex_log时有效", "example": "\\w" }, { "name": "Keys", "type": "array", "required": false, "description": "取的每个字段的key名字，为空的key代表丢弃这个字段，只有LogType为delimiter_log时有效，json_log的日志使用json本身的key。限制100个。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"name\",\"address\"]", "item_type": "string" }, { "name": "FilterKeyRegex", "type": "array", "required": false, "description": "日志过滤规则列表（旧版），需要过滤日志的key，及其对应的regex。 注意：2.9.3及以上版本LogListener ，建议使用AdvanceFilterRules配置日志过滤规则。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤日志的key", "example": "response_code" }, { "name": "Regex", "type": "string", "required": true, "description": "key对应的过滤规则regex", "example": "400|500" } ] }, { "name": "UnMatchUpLoadSwitch", "type": "boolean", "required": false, "description": "解析失败日志是否上传，true表示上传，false表示不上传 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "UnMatchLogKey", "type": "string", "required": false, "description": "失败日志的key，当UnMatchUpLoadSwitch为true时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "testlog" }, { "name": "Backtracking", "type": "integer", "required": false, "description": "增量采集模式下的回溯数据量，默认：-1（全量采集）；其他非负数表示增量采集（从最新的位置，往前采集${Backtracking}字节（Byte）的日志）最大支持1073741824（1G）。 注意： - COS导入不支持此字段。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "IsGBK", "type": "integer", "required": false, "description": "是否为Gbk编码。 0：否；1：是。 注意 - 目前取0值时，表示UTF-8编码 - COS导入不支持此字段。", "example": "0" }, { "name": "JsonStandard", "type": "integer", "required": false, "description": "是否为标准json。 0：否； 1：是。 - 标准json指采集器使用业界标准开源解析器进行json解析，非标json指采集器使用CLS自研json解析器进行解析，两种解析器没有本质区别，建议客户使用标准json进行解析。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "syslog传输协议，取值为tcp或者udp，只有在LogType为service_syslog时生效，其余类型无需填写。 注意： - 该字段适用于：创建采集规则配置、修改采集规则配置。 - COS导入不支持此字段。", "example": "tcp" }, { "name": "Address", "type": "string", "required": false, "description": "syslog系统日志采集指定采集器监听的地址和端口 ，形式：[ip]:[port]，只有在LogType为service_syslog时生效，其余类型无需填写。 注意： - 该字段适用于：创建采集规则配置、修改采集规则配置。 - COS导入不支持此字段。", "example": "127.0.0.1:9000" }, { "name": "ParseProtocol", "type": "string", "required": false, "description": "rfc3164：指定系统日志采集使用RFC3164协议解析日志。 rfc5424：指定系统日志采集使用RFC5424协议解析日志。 auto：自动匹配rfc3164或者rfc5424其中一种协议。 只有在LogType为service_syslog时生效，其余类型无需填写。 注意： - 该字段适用于：创建采集规则配置、修改采集规则配置 - COS导入不支持此字段。", "example": "RFC3164" }, { "name": "MetadataType", "type": "integer", "required": false, "description": "元数据类型。0: 不使用元数据信息；1:使用机器组元数据；2:使用用户自定义元数据；3:使用采集配置路径。 注意： - COS导入不支持此字段。", "example": "0" }, { "name": "PathRegex", "type": "string", "required": false, "description": "采集配置路径正则表达式。 ``` 请用\"()\"标识路径中目标字段对应的正则表达式，解析时将\"()\"视为捕获组，并以__TAG__.{i}:{目标字段}的形式与日志一起上报，其中i为捕获组的序号。 若不希望以序号为键名，可以通过命名捕获组\"(?{正则})\"自定义键名，并以__TAG__.{键名}:{目标字段}的形式与日志一起上报。最多支持5个捕获组 ``` 注意： - MetadataType为3时必填。 - COS导入不支持此字段。", "example": "/(?\u003capp\u003e.*?)/(?\u003cuser\u003e.*?)/access.log" }, { "name": "MetaTags", "type": "array", "required": false, "description": "用户自定义元数据信息。 注意： - MetadataType为2时必填。 - COS导入不支持此字段。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "元数据key", "example": "buss_key" }, { "name": "Value", "type": "string", "required": false, "description": "元数据value", "example": "buss_value" } ] }, { "name": "EventLogRules", "type": "array", "required": false, "description": "Windows事件日志采集规则，只有在LogType为windows_event_log时生效，其余类型无需填写。", "example": "无", "item_type": "object", "children": [ { "name": "EventChannel", "type": "string", "required": true, "description": "事件通道，支持 - Application 应用日志 - Security 安全日志 - Setup 启动日志 - System 系统日志 - ALL 所有日志", "example": "Application" }, { "name": "TimeType", "type": "integer", "required": true, "description": "时间字段（Timestamp）支持的类型 - 1（用户自定义时间） - 2（当前时间）", "example": "1" }, { "name": "Timestamp", "type": "integer", "required": false, "description": "时间，用户选择自定义时间类型时，需要指定时间，单位秒 格式：时间戳，1754897446", "example": "1754897446" }, { "name": "EventIDs", "type": "array", "required": false, "description": "事件ID过滤列表 选填，为空表示不做过滤 支持正向过滤单个值（例：20）或范围（例：0-20），也支持反向过滤单个值(例：-20) 多个过滤项之间可由逗号隔开，例：1-200,-100表示采集1-200范围内除了100以外的事件日志", "example": "[\"1\",\"-100\"]", "item_type": "string" } ] }, { "name": "AdvanceFilterRules", "type": "array", "required": false, "description": "日志过滤规则列表（新版）。 注意： - 2.9.3以下版本LogListener不支持， 请使用FilterKeyRegex配置日志过滤规则。 - 自建k8s采集配置（CreateConfigExtra、ModifyConfigExtra）不支持此字段。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "过滤字段", "example": "http_code" }, { "name": "Rule", "type": "integer", "required": true, "description": "过滤规则，0:等于，1:字段存在，2:字段不存在", "example": "0" }, { "name": "Value", "type": "string", "required": false, "description": "过滤值", "example": "400|500" } ] } ] }, { "name": "ExcludePaths", "type": "array", "required": false, "description": "采集黑名单路径列表", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，选填File或Path", "example": "File" }, { "name": "Value", "type": "string", "required": true, "description": "Type对应的具体内容", "example": "/loglistener_auto_test/black_list/after_black_test.log" } ] }, { "name": "UserDefineRule", "type": "string", "required": false, "description": "组合解析采集规则，用于复杂场景下的日志采集。 - 取值参考：[使用组合解析提取模式采集日志 ](https://cloud.tencent.com/document/product/614/61310)", "example": "{\"processors\":[{\"type\":\"processor_multiline_fullregex\",\"detail\":{\"ExtractRegex\":\"\\\\w+\\\\n(\\\\d.*).*\",\"ExtractKeys\":[\"test\"],\"BeginRegex\":\"[a-zA-Z].*\"},\"processors\":[]}]}" }, { "name": "Type", "type": "string", "required": false, "description": "容器场景，日志采集输入类型，支持以下三种类型 - container_stdout 标准输出 - container_file 容器文件 - host_file 主机节点文件", "example": "container_stdout" }, { "name": "GroupId", "type": "string", "required": false, "description": "机器组ID - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。", "example": "6ef60bec-0242-43af-bb20-270359fb54a8" }, { "name": "ConfigFlag", "type": "string", "required": false, "description": "自建采集配置标", "example": "label_k8s" }, { "name": "LogsetId", "type": "string", "required": false, "description": "日志集ID - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。", "example": "6ef60bec-0242-43af-bb20-270359fb54a8" }, { "name": "LogsetName", "type": "string", "required": false, "description": "日志集名称 - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集名称。", "example": "test-logset" }, { "name": "TopicName", "type": "string", "required": false, "description": "日志主题名称 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题名称。", "example": "test-topic" }, { "name": "AdvancedConfig", "type": "string", "required": false, "description": "高级采集配置。 Json字符串， Key/Value定义为如下： - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数， 0为不超时 - ClsAgentMaxDepth(最大目录深度)，取值范围: 大于等于0的整数 - ClsAgentParseFailMerge(合并解析失败日志)，取值范围: true或false - ClsAgentDefault(自定义默认值，无特殊含义，用于清空其他选项)，建议取值0", "example": "{\\\"ClsAgentFileTimeout\\\":0,\\\"ClsAgentMaxDepth\\\":10,\\\"ClsAgentParseFailMerge\\\":true}" } ], "required": [ "ConfigExtraId" ] }, { "name": "ModifyConsoleSharing", "description": "修改控制台分享，目前仅允许修改有效期", "status": "online", "parameters": [ { "name": "SharingId", "type": "string", "required": true, "description": "免密分享Id。 - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。 - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。", "example": "13cez28h" }, { "name": "DurationMilliseconds", "type": "integer", "required": true, "description": "指定分享链接有效期，单位：毫秒，最长可设定有效期为30天", "example": "1800000" } ], "required": [ "SharingId", "DurationMilliseconds" ] }, { "name": "ModifyConsumer", "description": "本接口用于修改投递Ckafka任务", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "投递任务绑定的日志主题Id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。", "example": "871710c5-35cd-4d1e-8e79-2fa92c35d612" }, { "name": "Effective", "type": "boolean", "required": false, "description": "投递任务是否生效，默认不生效", "example": "false" }, { "name": "NeedContent", "type": "boolean", "required": false, "description": "是否投递日志的元数据信息，默认为 true。 当NeedContent为true时：字段Content有效。 当NeedContent为false时：字段Content无效。", "example": "false" }, { "name": "Content", "type": "object", "required": false, "description": "如果需要投递元数据信息，元数据信息的描述", "example": "无", "children": [ { "name": "EnableTag", "type": "boolean", "required": true, "description": "是否投递 TAG 信息。 当EnableTag为true时，表示投递TAG元信息。", "example": "false" }, { "name": "MetaFields", "type": "array", "required": true, "description": "需要投递的元数据列表，目前仅支持：\\_\\_SOURCE\\_\\_，\\_\\_FILENAME\\_\\_，\\_\\_TIMESTAMP\\_\\_，\\_\\_HOSTNAME\\_\\_和\\_\\_PKGID\\_\\_", "example": "[\"\\_\\_SOURCE\\_\\_\", \"\\_\\_FILENAME\\_\\_\", \"\\_\\_TIMESTAMP\\_\\_\"]", "item_type": "string" }, { "name": "TagJsonNotTiled", "type": "boolean", "required": false, "description": "当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\"}`", "example": "false" }, { "name": "TimestampAccuracy", "type": "integer", "required": false, "description": "投递时间戳精度，可选项 [1：秒；2：毫秒] ，默认是1。", "example": "1" }, { "name": "JsonType", "type": "integer", "required": false, "description": "投递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\\\"}\"}`", "example": "0" } ] }, { "name": "Ckafka", "type": "object", "required": false, "description": "CKafka的描述", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "Ckafka 的 InstanceId。 - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。 - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取实例id。", "example": "ckafka-8j4rotest" }, { "name": "TopicName", "type": "string", "required": true, "description": "Ckafka 的 TopicName。 - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicName。 - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicName。", "example": "mrxy-business" }, { "name": "Vip", "type": "string", "required": false, "description": "Ckafka 的 Vip。 - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip信息。 - 如果是通过 角色ARN 方式创建投递任务，则Vip字段可为空。", "example": "172.16.0.17" }, { "name": "Vport", "type": "string", "required": false, "description": "Ckafka 的 Vport。 - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip port信息。 - 如果是通过 角色ARN 方式创建投递任务，则Vport字段可为空。", "example": "9092" }, { "name": "InstanceName", "type": "string", "required": false, "description": "Ckafka 的 InstanceName。 - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取InstanceName。 - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取InstanceName。 - 如果是通过 角色ARN 方式创建投递任务，则InstanceName字段可为空。", "example": "kafka协议消费监控用" }, { "name": "TopicId", "type": "string", "required": false, "description": "Ckafka 的 TopicId。 - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicId。 - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicId。 - 如果是通过 角色ARN 方式创建投递任务，则TopicId字段可为空。", "example": "1254011820-24a0d67e-748b-4e30-9502-78779bcc5test" } ] }, { "name": "Compression", "type": "integer", "required": false, "description": "投递时压缩方式，取值0，2，3。[0：NONE；2：SNAPPY；3：LZ4]", "example": "0" }, { "name": "RoleArn", "type": "string", "required": false, "description": "角色访问描述名 [创建角色](https://cloud.tencent.com/document/product/598/19381)", "example": "qcs::cam::uin/${uin}:roleName/xxxtest" }, { "name": "ExternalId", "type": "string", "required": false, "description": "外部ID", "example": "external_id_demo" }, { "name": "AdvancedConfig", "type": "object", "required": false, "description": "高级配置", "example": "无", "children": [ { "name": "PartitionHashStatus", "type": "boolean", "required": false, "description": "Ckafka分区hash状态。 默认 false - true：开启根据字段 Hash 值结果相等的信息投递到统一 ckafka 分区 - false：关闭根据字段 Hash 值结果相等的信息投递到统一 ckafka 分区", "example": "true" }, { "name": "PartitionFields", "type": "array", "required": false, "description": "需要计算 hash 的字段列表。最大支持5个字段。", "example": "[\"name\",\"address\"]", "item_type": "string" } ] } ], "required": [ "TopicId" ] }, { "name": "ModifyConsumerGroup", "description": "更新消费组信息", "status": "online", "parameters": [ { "name": "ConsumerGroup", "type": "string", "required": true, "description": "更新的目标消费者组标识", "example": "无" }, { "name": "Timeout", "type": "integer", "required": true, "description": "消费者心跳超时时间（秒）", "example": "无" }, { "name": "Topics", "type": "array", "required": true, "description": "更新的消费者组包含的日志主题列表", "example": "无", "item_type": "string" }, { "name": "LogsetId", "type": "string", "required": true, "description": "日志集Id（日志主题所属的日志集）", "example": "无" } ], "required": [ "ConsumerGroup", "Timeout", "Topics", "LogsetId" ] }, { "name": "ModifyCosRecharge", "description": "本接口用于修改cos导入任务", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": true, "description": "COS导入配置Id。 - 通过[获取cos导入配置](https://cloud.tencent.com/document/product/614/88099)接口获取COS导入配置Id。", "example": "ca092608-98e8-4ad9-83c5-a6b3bbexxxxx" }, { "name": "TopicId", "type": "string", "required": true, "description": "日志主题Id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "ae13f7db-00b5-41ac-916e-407802axxxxx" }, { "name": "Name", "type": "string", "required": false, "description": "COS导入任务名称,最大支持128个字节。", "example": "导入任务1" }, { "name": "Enable", "type": "integer", "required": false, "description": "任务状态 0： 停用 ， 1：启用", "example": "1" }, { "name": "Bucket", "type": "string", "required": false, "description": "COS存储桶，详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。 - 通过[GET Service（List Buckets）](https://cloud.tencent.com/document/product/436/8291)获取COS存储桶。", "example": "examplebucket-1250000000" }, { "name": "BucketRegion", "type": "string", "required": false, "description": "COS存储桶所在地域，详见产品支持的[地域列表](https://cloud.tencent.com/document/product/436/6224)。", "example": "ap-guangzhou" }, { "name": "Prefix", "type": "string", "required": false, "description": "COS文件所在文件夹的前缀。为空串时投递存储桶下所有的文件。", "example": "var/xxx" }, { "name": "LogType", "type": "string", "required": false, "description": "采集的日志类型，json_log代表json格式日志，delimiter_log代表分隔符格式日志，minimalist_log代表单行全文； 默认为minimalist_log", "example": "minimalist_log" }, { "name": "Compress", "type": "string", "required": false, "description": "解析格式。supported: \"\", \"gzip\", \"lzop\", \"snappy\"。空串表示不压缩。", "example": "gzip" }, { "name": "ExtractRuleInfo", "type": "object", "required": false, "description": "提取规则，如果设置了ExtractRule，则必须设置LogType", "example": "无", "children": [ { "name": "TimeKey", "type": "string", "required": false, "description": "时间字段的key名字，TimeKey和TimeFormat必须成对出现", "example": "time" }, { "name": "TimeFormat", "type": "string", "required": false, "description": "时间字段的格式，参考c语言的strftime函数对于时间的格式说明输出参数 - 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档", "example": "%Y-%m-%d %H:%M:%S" }, { "name": "Delimiter", "type": "string", "required": false, "description": "分隔符类型日志的分隔符，只有LogType为delimiter_log时有效", "example": "," }, { "name": "LogRegex", "type": "string", "required": false, "description": "整条日志匹配规则，只有LogType为fullregex_log时有效", "example": "\\w" }, { "name": "BeginRegex", "type": "string", "required": false, "description": "行首匹配规则，只有LogType为multiline_log或fullregex_log时有效", "example": "\\w" }, { "name": "Keys", "type": "array", "required": false, "description": "取的每个字段的key名字，为空的key代表丢弃这个字段，只有LogType为delimiter_log时有效，json_log的日志使用json本身的key。限制100个。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"name\",\"address\"]", "item_type": "string" }, { "name": "FilterKeyRegex", "type": "array", "required": false, "description": "日志过滤规则列表（旧版），需要过滤日志的key，及其对应的regex。 注意：2.9.3及以上版本LogListener ，建议使用AdvanceFilterRules配置日志过滤规则。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要过滤日志的key", "example": "response_code" }, { "name": "Regex", "type": "string", "required": true, "description": "key对应的过滤规则regex", "example": "400|500" } ] }, { "name": "UnMatchUpLoadSwitch", "type": "boolean", "required": false, "description": "解析失败日志是否上传，true表示上传，false表示不上传 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "UnMatchLogKey", "type": "string", "required": false, "description": "失败日志的key，当UnMatchUpLoadSwitch为true时必填 注意：此字段可能返回 null，表示取不到有效值。", "example": "testlog" }, { "name": "Backtracking", "type": "integer", "required": false, "description": "增量采集模式下的回溯数据量，默认：-1（全量采集）；其他非负数表示增量采集（从最新的位置，往前采集${Backtracking}字节（Byte）的日志）最大支持1073741824（1G）。 注意： - COS导入不支持此字段。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "IsGBK", "type": "integer", "required": false, "description": "是否为Gbk编码。 0：否；1：是。 注意 - 目前取0值时，表示UTF-8编码 - COS导入不支持此字段。", "example": "0" }, { "name": "JsonStandard", "type": "integer", "required": false, "description": "是否为标准json。 0：否； 1：是。 - 标准json指采集器使用业界标准开源解析器进行json解析，非标json指采集器使用CLS自研json解析器进行解析，两种解析器没有本质区别，建议客户使用标准json进行解析。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "syslog传输协议，取值为tcp或者udp，只有在LogType为service_syslog时生效，其余类型无需填写。 注意： - 该字段适用于：创建采集规则配置、修改采集规则配置。 - COS导入不支持此字段。", "example": "tcp" }, { "name": "Address", "type": "string", "required": false, "description": "syslog系统日志采集指定采集器监听的地址和端口 ，形式：[ip]:[port]，只有在LogType为service_syslog时生效，其余类型无需填写。 注意： - 该字段适用于：创建采集规则配置、修改采集规则配置。 - COS导入不支持此字段。", "example": "127.0.0.1:9000" }, { "name": "ParseProtocol", "type": "string", "required": false, "description": "rfc3164：指定系统日志采集使用RFC3164协议解析日志。 rfc5424：指定系统日志采集使用RFC5424协议解析日志。 auto：自动匹配rfc3164或者rfc5424其中一种协议。 只有在LogType为service_syslog时生效，其余类型无需填写。 注意： - 该字段适用于：创建采集规则配置、修改采集规则配置 - COS导入不支持此字段。", "example": "RFC3164" }, { "name": "MetadataType", "type": "integer", "required": false, "description": "元数据类型。0: 不使用元数据信息；1:使用机器组元数据；2:使用用户自定义元数据；3:使用采集配置路径。 注意： - COS导入不支持此字段。", "example": "0" }, { "name": "PathRegex", "type": "string", "required": false, "description": "采集配置路径正则表达式。 ``` 请用\"()\"标识路径中目标字段对应的正则表达式，解析时将\"()\"视为捕获组，并以__TAG__.{i}:{目标字段}的形式与日志一起上报，其中i为捕获组的序号。 若不希望以序号为键名，可以通过命名捕获组\"(?{正则})\"自定义键名，并以__TAG__.{键名}:{目标字段}的形式与日志一起上报。最多支持5个捕获组 ``` 注意： - MetadataType为3时必填。 - COS导入不支持此字段。", "example": "/(?\u003capp\u003e.*?)/(?\u003cuser\u003e.*?)/access.log" }, { "name": "MetaTags", "type": "array", "required": false, "description": "用户自定义元数据信息。 注意： - MetadataType为2时必填。 - COS导入不支持此字段。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "元数据key", "example": "buss_key" }, { "name": "Value", "type": "string", "required": false, "description": "元数据value", "example": "buss_value" } ] }, { "name": "EventLogRules", "type": "array", "required": false, "description": "Windows事件日志采集规则，只有在LogType为windows_event_log时生效，其余类型无需填写。", "example": "无", "item_type": "object", "children": [ { "name": "EventChannel", "type": "string", "required": true, "description": "事件通道，支持 - Application 应用日志 - Security 安全日志 - Setup 启动日志 - System 系统日志 - ALL 所有日志", "example": "Application" }, { "name": "TimeType", "type": "integer", "required": true, "description": "时间字段（Timestamp）支持的类型 - 1（用户自定义时间） - 2（当前时间）", "example": "1" }, { "name": "Timestamp", "type": "integer", "required": false, "description": "时间，用户选择自定义时间类型时，需要指定时间，单位秒 格式：时间戳，1754897446", "example": "1754897446" }, { "name": "EventIDs", "type": "array", "required": false, "description": "事件ID过滤列表 选填，为空表示不做过滤 支持正向过滤单个值（例：20）或范围（例：0-20），也支持反向过滤单个值(例：-20) 多个过滤项之间可由逗号隔开，例：1-200,-100表示采集1-200范围内除了100以外的事件日志", "example": "[\"1\",\"-100\"]", "item_type": "string" } ] }, { "name": "AdvanceFilterRules", "type": "array", "required": false, "description": "日志过滤规则列表（新版）。 注意： - 2.9.3以下版本LogListener不支持， 请使用FilterKeyRegex配置日志过滤规则。 - 自建k8s采集配置（CreateConfigExtra、ModifyConfigExtra）不支持此字段。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "过滤字段", "example": "http_code" }, { "name": "Rule", "type": "integer", "required": true, "description": "过滤规则，0:等于，1:字段存在，2:字段不存在", "example": "0" }, { "name": "Value", "type": "string", "required": false, "description": "过滤值", "example": "400|500" } ] } ] }, { "name": "TaskType", "type": "integer", "required": false, "description": "COS导入任务类型。1：一次性导入任务；2：持续性导入任务。", "example": "1" }, { "name": "Metadata", "type": "array", "required": false, "description": "元数据。支持 bucket，object。", "example": "[\"bucket\",\"object\"]", "item_type": "string" } ], "required": [ "Id", "TopicId" ] }, { "name": "ModifyDashboard", "description": "本接口用于修改仪表盘", "status": "online", "parameters": [ { "name": "DashboardId", "type": "string", "required": true, "description": "仪表盘id。通过 [获取仪表盘](https://cloud.tencent.com/document/api/614/95636)接口获取DashboardId。", "example": "dashboard-e7497a78-667f-45ee-b785-4ac8fca05dc6" }, { "name": "DashboardName", "type": "string", "required": false, "description": "仪表盘名称", "example": "主机指标监控预制仪表盘" }, { "name": "Data", "type": "string", "required": false, "description": "仪表盘配置数据", "example": "\"{\\\"timezone\\\":\\\"browser\\\",\\\"subType\\\":\\\"CLS_Host\\\"}\"" }, { "name": "Tags", "type": "array", "required": false, "description": "标签描述列表，通过指定该参数可以同时绑定标签到相应的日志主题。最大支持10个标签键值对，同一个资源只能绑定到同一个标签键下。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "业务A" } ] } ], "required": [ "DashboardId" ] }, { "name": "ModifyDashboardSubscribe", "description": "此接口用于修改仪表盘订阅", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "仪表盘订阅id。通过 [获取仪表盘订阅列表](https://cloud.tencent.com/document/api/614/105779)接口获取Id。", "example": "21683" }, { "name": "DashboardId", "type": "string", "required": false, "description": "仪表盘id。通过 [获取仪表盘](https://cloud.tencent.com/document/api/614/95636)接口获取DashboardId。", "example": "dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5" }, { "name": "Name", "type": "string", "required": false, "description": "仪表盘订阅名称。最大支持128个字符，且不支持'|'字符。", "example": "仪表盘-CLS-日报" }, { "name": "Cron", "type": "string", "required": false, "description": "订阅时间cron表达式，格式为：{秒数} {分钟} {小时} {日期} {月份} {星期}；（有效数据为：{分钟} {小时} {日期} {月份} {星期}）。", "example": "0 0 10 * * ?" }, { "name": "SubscribeData", "type": "object", "required": false, "description": "仪表盘订阅数据。", "example": "无", "children": [ { "name": "NoticeModes", "type": "array", "required": true, "description": "仪表盘订阅通知方式。", "example": "无", "item_type": "object", "children": [ { "name": "ReceiverType", "type": "string", "required": true, "description": "仪表盘通知方式。 - Uin：腾讯云用户 - Group：腾讯云用户组 - WeCom：企业微信回调 - Email：自定义邮件 - DingTalk：钉钉 - Lark：飞书", "example": "Uin" }, { "name": "Values", "type": "array", "required": false, "description": "知方式对应的值。 - 当ReceiverType为：`WeCom`、`DingTalk`、`Lark` 时，Values必须为空，且Url字段必填。 - 当ReceiverType为：`Uin`、`Group`、`Email` 时，Values必填，且Url字段必须为空。 - 当ReceiverType为：`Uin ` 时，Values为用户id，通过 [拉取子用户](https://cloud.tencent.com/document/product/598/34587) 获取子用户 UID 。 - 当ReceiverType为：`Group` 时，Values为用户组id，通过 [查询用户组列表](https://cloud.tencent.com...", "example": "[\"168053\",\"1\"]", "item_type": "string" }, { "name": "ReceiverChannels", "type": "array", "required": false, "description": "仪表盘通知渠道。 - 支持：[\"Email\",\"Sms\",\"WeChat\",\"Phone\"]。 - 当ReceiverType为 `Email` 或 `WeCom` 时，ReceiverChannels无效。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"Email\",\"Sms\",\"WeChat\",\"Phone\"]", "item_type": "string" }, { "name": "Url", "type": "string", "required": false, "description": "订阅方式 - 回调地址。 - 当ReceiverType为：`WeCom`、`DingTalk`、`Lark` 时，Url字段必填为各渠道的回调地址。 - 为：`WeCom` 时，Url为 企业微信回调地址。 - 为：`DingTalk` 时，Url为 钉钉机器人Webhook地址。 - 为：`Lark` 时，Url为 飞书机器人Webhook地址。 - 当ReceiverType为：`Uin`、`Group`、`Email` 时，Url字段必须为空。", "example": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=ctestea1a5-7xx9-4xx3-8xxb-w5fxxbd6" } ] }, { "name": "DashboardTime", "type": "array", "required": false, "description": "仪表盘订阅时间，为空标识取仪表盘默认的时间。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"now-5m\",\"now\"]", "item_type": "string" }, { "name": "TemplateVariables", "type": "array", "required": false, "description": "仪表盘订阅模板变量。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "key的值", "example": "TopicId" }, { "name": "Values", "type": "array", "required": true, "description": "key对应的values取值values", "example": "[\"xxxx-xxxx-xxxx-xxxx\",\"123414-12341234-12345-3456\"]", "item_type": "string" } ] }, { "name": "Timezone", "type": "string", "required": false, "description": "时区。参考：https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#SHANGHAI", "example": "Asia/Shanghai" }, { "name": "SubscribeLanguage", "type": "string", "required": false, "description": "语言。 zh 中文、en`英文。", "example": "zh" }, { "name": "JumpDomain", "type": "string", "required": false, "description": "调用链接域名。http:// 或者 https:// 开头，不能/结尾", "example": "https://console.cloud.tencent.com" }, { "name": "JumpUrl", "type": "string", "required": false, "description": "自定义跳转链接。", "example": "https://www.xxx.com/getxxx" } ] } ], "required": [ "Id" ] }, { "name": "ModifyDataTransform", "description": "本接口用于修改数据加工任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "数据加工任务ID - 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。", "example": "abdeace6-9484-4d2e-b670-28289c42b60f" }, { "name": "Name", "type": "string", "required": false, "description": "加工任务名称 - 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务名称。 名称限制 - 不能为空字符串 - 不能包含字符'|' - 最长 255 个字符", "example": "task1" }, { "name": "EtlContent", "type": "string", "required": false, "description": "加工语句。 当FuncType为2时，EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f) 其他参考文档： - [创建加工任务](https://cloud.tencent.com/document/product/614/63940) - [函数总览](https://cloud.tencent.com/document/product/614/70395)", "example": "fields_drop(\"message\")" }, { "name": "EnableFlag", "type": "integer", "required": false, "description": "任务启动状态. 默认为1，开启, 2关闭", "example": "1" }, { "name": "DstResources", "type": "array", "required": false, "description": "加工任务目的topic_id以及别名", "example": "无", "item_type": "object", "children": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题ID通过获取日志主题列表获取日志主题Id。", "example": "abdeace6-9484-4d2e-b670-28289c42b60f" }, { "name": "Alias", "type": "string", "required": false, "description": "别名限制：不能包含字符 |。", "example": "topicname" }, { "name": "IsCrossAccount", "type": "boolean", "required": false, "description": "是否是跨账号主题，false不是跨账号主题，true是跨账号主题默认值：false", "example": "true" }, { "name": "RoleARN", "type": "string", "required": false, "description": "跨账号场景下，被投递账号给投递账号创建的角色ARN值，在被投递账号的角色里查找", "example": "qcs::cam::uin/1234567890:roleName/cls_online_role" }, { "name": "ExternalId", "type": "string", "required": false, "description": "外部ID值，可以在被投递账号的角色-载体里找到该值", "example": "hello123" }, { "name": "TopicName", "type": "string", "required": false, "description": "topic名称", "example": "topic_name_1" }, { "name": "LogsetName", "type": "string", "required": false, "description": "日志集的名称", "example": "logset_name_1" } ] }, { "name": "BackupGiveUpData", "type": "boolean", "required": false, "description": "超限之后是否丢弃日志数据", "example": "false" }, { "name": "HasServicesLog", "type": "integer", "required": false, "description": "是否开启投递服务日志。1关闭，2开启", "example": "2" }, { "name": "KeepFailureLog", "type": "integer", "required": false, "description": "保留失败日志状态。 1:不保留，2:保留", "example": "1" }, { "name": "FailureLogKey", "type": "string", "required": false, "description": "失败日志的字段名称", "example": "ETLParseFailure" }, { "name": "DataTransformSqlDataSources", "type": "array", "required": false, "description": "外部数据源信息", "example": "无", "item_type": "object", "children": [ { "name": "DataSource", "type": "integer", "required": true, "description": "数据源类型 1:MySql;2:自建mysql;3:pgsql", "example": "1" }, { "name": "Region", "type": "string", "required": true, "description": "InstanceId所属地域。例如：ap-guangzhou", "example": "ap-guangzhou" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id。 - 当DataSource为1时，表示云数据库Mysql 实例id，如：cdb-zxcvbnm", "example": "cdb-zxcvbnm" }, { "name": "User", "type": "string", "required": true, "description": "mysql访问用户名", "example": "user_00" }, { "name": "AliasName", "type": "string", "required": true, "description": "别名。数据加工语句中使用", "example": "my_db1x" }, { "name": "Password", "type": "string", "required": false, "description": "mysql访问密码。", "example": "ps_00" } ] }, { "name": "EnvInfos", "type": "array", "required": false, "description": "设置的环境变量", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "环境变量名", "example": "SecretKey" }, { "name": "Value", "type": "string", "required": false, "description": "环境变量值", "example": "key_ubsgg_demo" } ] } ], "required": [ "TaskId" ] }, { "name": "ModifyDlcDeliver", "description": "修改DLC投递任务", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题id。通过获取日志主题列表获取日志主题Id。", "example": "715094e3-01b0-4aeb-91f5-ee9f46a4a13c" }, { "name": "TaskId", "type": "string", "required": true, "description": "任务id。", "example": "111024e3-01b0-4aeb-91f5-ee9f46a4a13c" }, { "name": "Name", "type": "string", "required": false, "description": "名称：长度不超过64字符，以字母开头，接受0-9,a-z,A-Z, _,-,中文字符。", "example": "template_1" }, { "name": "DeliverType", "type": "integer", "required": false, "description": "投递类型。0:批投递,1:实时投递", "example": "1" }, { "name": "StartTime", "type": "integer", "required": false, "description": "投递时间范围的开始时间", "example": "1741005340" }, { "name": "EndTime", "type": "integer", "required": false, "description": "投递时间范围的结束时间。 如果为空，则表示不限时", "example": "1741006340" }, { "name": "MaxSize", "type": "integer", "required": false, "description": "投递文件大小,单位MB。 DeliverType=0时必填，范围 5\u0026lt;= MaxSize \u0026lt;= 256。", "example": "5" }, { "name": "Interval", "type": "integer", "required": false, "description": "投递间隔，单位秒。 DeliverType=0时必填，范围 300\u0026lt;= Interval \u0026lt;=900。", "example": "300" }, { "name": "DlcInfo", "type": "object", "required": false, "description": "dlc配置信息", "example": "无", "children": [ { "name": "TableInfo", "type": "object", "required": true, "description": "dlc表信息", "example": "无", "children": [ { "name": "DataDirectory", "type": "string", "required": true, "description": "数据目录", "example": "data_directory" }, { "name": "DatabaseName", "type": "string", "required": true, "description": "数据库", "example": "database_name" }, { "name": "TableName", "type": "string", "required": true, "description": "数据表", "example": "table_name" } ] }, { "name": "FieldInfos", "type": "array", "required": true, "description": "dlc数据字段信息", "example": "无", "item_type": "object", "children": [ { "name": "ClsField", "type": "string", "required": true, "description": "cls日志中的字段名", "example": "table_name" }, { "name": "DlcField", "type": "string", "required": true, "description": "数据湖计算服务表的列名", "example": "table_name" }, { "name": "DlcFieldType", "type": "string", "required": true, "description": "数据湖计算服务字段类型枚举值：int|string|struct等： 参考 DLC cloumn中的Type 定义", "example": "string" }, { "name": "FillField", "type": "string", "required": false, "description": "解析失败填充字段", "example": "NULL" }, { "name": "Disable", "type": "boolean", "required": false, "description": "是否禁用", "example": "false" } ] }, { "name": "PartitionInfos", "type": "array", "required": true, "description": "dlc分区信息", "example": "无", "item_type": "object", "children": [ { "name": "ClsField", "type": "string", "required": true, "description": "cls日志中的字段名", "example": "table_name" }, { "name": "DlcField", "type": "string", "required": true, "description": "dlc表的列名", "example": "table_name" }, { "name": "DlcFieldType", "type": "string", "required": true, "description": "请参考 DLC cloumn中的Type 定义 枚举值：int|string|array等： 请参考 DLC cloumn中的Type 定义", "example": "string" } ] }, { "name": "PartitionExtra", "type": "object", "required": false, "description": "dlc分区额外信息", "example": "无", "children": [ { "name": "TimeFormat", "type": "string", "required": false, "description": "时间格式 eg: %Y-%m-%d %H:%M:%S.%f", "example": "%Y-%m-%d %H:%M:%S.%f" }, { "name": "TimeZone", "type": "string", "required": false, "description": "时间时区", "example": "UTC+08:00" } ] } ] }, { "name": "HasServicesLog", "type": "integer", "required": false, "description": "是否开启投递服务日志。1关闭，2开启。默认开启", "example": "2" }, { "name": "Status", "type": "integer", "required": false, "description": "任务状态。枚举值：1： 运行2： 停止", "example": "2" } ], "required": [ "TopicId", "TaskId" ] }, { "name": "ModifyEsRecharge", "description": "修改es导入配置", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "导入任务id。", "example": "715094e3-01b0-4aeb-91f5-ee9f46a4a13c" }, { "name": "TopicId", "type": "string", "required": true, "description": "日志主题id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。", "example": "715094e3-01b0-4aeb-91f5-ee9f46a4a13c" }, { "name": "Name", "type": "string", "required": false, "description": "名称：长度不超过64字符。", "example": "template_1" }, { "name": "Index", "type": "string", "required": false, "description": "索引信息。不同索引可以通过英文逗号分隔，支持*通配符", "example": "base-2026-01-*" }, { "name": "Query", "type": "string", "required": false, "description": "es查询语句。", "example": "tags.service.name:session" }, { "name": "EsInfo", "type": "object", "required": false, "description": "es集群配置信息。", "example": "无", "children": [ { "name": "EsType", "type": "integer", "required": true, "description": "es类型。 1:云es, 2:自建es", "example": "2" }, { "name": "AccessMode", "type": "integer", "required": false, "description": "访问方式 1:内网, 2:外网。自建es必填", "example": "2" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例id。云es实例必填", "example": "es-fbs7gqxx" }, { "name": "User", "type": "string", "required": false, "description": "用户名。", "example": "user" }, { "name": "Address", "type": "string", "required": false, "description": "访问地址。自建es必填", "example": "10.0.0.10" }, { "name": "Port", "type": "integer", "required": false, "description": "访问端口。自建es必填", "example": "9200" }, { "name": "VpcId", "type": "string", "required": false, "description": "所属网络。自建es且访问方式为内网访问时必填", "example": "vpc-xymnt" }, { "name": "VirtualGatewayType", "type": "integer", "required": false, "description": "网络服务类型。自建es且访问方式为内网访问时必填。 负载均衡 CLB:1025 云服务器CVM:0", "example": "1025" }, { "name": "Password", "type": "string", "required": false, "description": "密码。", "example": "password" } ] }, { "name": "ImportInfo", "type": "object", "required": false, "description": "es导入信息。", "example": "无", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "导入模式。 1. 导入历史数据 2. 导入实时数据", "example": "1" }, { "name": "StartTime", "type": "integer", "required": false, "description": "开始时间。 单位:秒级时间戳。", "example": "1739783039" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间。 单位：秒级时间戳。", "example": "1739784039" }, { "name": "MaxDelay", "type": "integer", "required": false, "description": "最大延迟时间。单位：s 导入模式为 2: 导入实时数据时必填", "example": "600" }, { "name": "CheckInterval", "type": "integer", "required": false, "description": "检查间隔。单位：s 导入模式为 2: 导入实时数据时必填", "example": "60" } ] }, { "name": "TimeInfo", "type": "object", "required": false, "description": "es导入时间字段信息。", "example": "无", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "时间类型 1: 日志采集时间 2: 指定日志字段", "example": "2" }, { "name": "TimeKey", "type": "string", "required": false, "description": "日志时间字段。 时间类型为 2: 指定日志字段时必填", "example": "time_key" }, { "name": "TimeFormat", "type": "string", "required": false, "description": "日志时间格式。 时间类型为 2: 指定日志字段时必填", "example": "%Y-%m-%d %H:%M:%S.%f" }, { "name": "TimeZone", "type": "string", "required": false, "description": "时间字段时区。 时间类型为 2: 指定日志字段时必填", "example": "UTC+08:00" } ] }, { "name": "Status", "type": "integer", "required": false, "description": "任务状态。1:运行， 2:暂停", "example": "1" }, { "name": "HasServicesLog", "type": "integer", "required": false, "description": "是否开启投递服务日志。1：关闭，2：开启。", "example": "2" } ], "required": [ "TaskId", "TopicId" ] }, { "name": "ModifyHostMetricConfig", "description": "修改主机指标采集配置", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "指标日志主题id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题（默认值）， 1:指标主题 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题（默认值）， 1:指标主题", "example": "715094e3-01b0-4aeb-91f5-ee9f46a4a13c" }, { "name": "ConfigId", "type": "string", "required": true, "description": "采集配置id", "example": "e542d884-f08b-4be9-b700-2a99d9aa1545" }, { "name": "Name", "type": "string", "required": false, "description": "名称。 - 长度不超过 64字符。", "example": "template-1" }, { "name": "MachineGroupIds", "type": "array", "required": false, "description": "机器组id列表。最多支持100个机器组。", "example": "[\"81853bcf-67b4-4a4f-82c7-7882fd004613\"]", "item_type": "string" }, { "name": "Interval", "type": "integer", "required": false, "description": "采集频率。单位:ms。 最小支持5000ms", "example": "5000" }, { "name": "HostMetricItems", "type": "array", "required": false, "description": "采集项。支持\"cpu\"，\"mem\"，\"net\"，\"disk\"，\"system\"。**目前仅支持:所有采集项都需配置**。 - cpu：CPU - mem：内存 - net：网络 - disk：磁盘 - system：系统", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "主机指标采集项类型。支持\"cpu\"，\"mem\"，\"net\"，\"disk\"，\"system\"。 - cpu：CPU - mem：内存 - net：网络 - disk：磁盘 - system：系统", "example": "cpu" } ] } ], "required": [ "TopicId", "ConfigId" ] }, { "name": "ModifyIndex", "description": "本接口用于修改索引配置，该接口除受默认接口请求频率限制外，针对单个日志主题，并发数不能超过1，即同一时间同一个日志主题只能有一个正在执行的索引配置修改操作。", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题Id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "826f8b26-b054-4a0d-8c8e-f3d609f5e0ea" }, { "name": "Status", "type": "boolean", "required": false, "description": "索引状态。false：关闭索引， true：开启索引 开启后可对日志进行检索分析，将产生索引流量、索引存储及相应费用。[费用详情](https://cloud.tencent.com/document/product/614/45802#.E8.AE.A1.E8.B4.B9.E9.A1.B9)", "example": "true" }, { "name": "Rule", "type": "object", "required": false, "description": "索引规则", "example": "无", "children": [ { "name": "FullText", "type": "object", "required": false, "description": "全文索引配置, 为空时代表未开启全文索引 注意：此字段可能返回 null，表示取不到有效值。", "example": "空", "children": [ { "name": "CaseSensitive", "type": "boolean", "required": true, "description": "是否大小写敏感", "example": "false" }, { "name": "Tokenizer", "type": "string", "required": true, "description": "全文索引的分词符，其中的每个字符代表一个分词符； 仅支持英文符号、\\n\\t\\r及转义符\\； 注意：\\n\\t\\r本身已被转义，直接使用双引号包裹即可作为入参，无需再次转义。使用API Explorer进行调试时请使用JSON参数输入方式，以避免\\n\\t\\r被重复转义", "example": "@\u0026?|#()='\",;:\u003c\u003e[]{}/ \\n\\t\\r\\\\" }, { "name": "ContainZH", "type": "boolean", "required": false, "description": "是否包含中文", "example": "false" } ] }, { "name": "KeyValue", "type": "object", "required": false, "description": "键值索引配置，为空时代表未开启键值索引 注意：此字段可能返回 null，表示取不到有效值。", "example": "空", "children": [ { "name": "CaseSensitive", "type": "boolean", "required": true, "description": "是否大小写敏感", "example": "false" }, { "name": "KeyValues", "type": "array", "required": false, "description": "需要建立索引的键值对信息", "example": "空", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要配置键值或者元字段索引的字段名称，仅支持字母、数字、下划线和-./@，且不能以下划线开头 注意： 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父\ufffd\ufffd...", "example": "address" }, { "name": "Value", "type": "object", "required": true, "description": "字段的索引描述信息", "example": "无" } ] } ] }, { "name": "Tag", "type": "object", "required": false, "description": "元字段索引配置，为空时代表未开启元字段索引 注意：此字段可能返回 null，表示取不到有效值。", "example": "空", "children": [ { "name": "CaseSensitive", "type": "boolean", "required": true, "description": "是否大小写敏感", "example": "false" }, { "name": "KeyValues", "type": "array", "required": true, "description": "元字段索引配置中的字段信息", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要配置键值或者元字段索引的字段名称，仅支持字母、数字、下划线和-./@，且不能以下划线开头 注意： 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父\ufffd\ufffd...", "example": "address" }, { "name": "Value", "type": "object", "required": true, "description": "字段的索引描述信息", "example": "无" } ] } ] }, { "name": "DynamicIndex", "type": "object", "required": false, "description": "键值索引自动配置，为空时代表未开启该功能。 启用后自动将日志内的字段添加到键值索引中，包括日志中后续新增的字段。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Status", "type": "boolean", "required": false, "description": "键值索引自动配置开关", "example": "false" } ] } ] }, { "name": "IncludeInternalFields", "type": "boolean", "required": false, "description": "内置保留字段（`__FILENAME__`，`__HOSTNAME__`及`__SOURCE__`）是否包含至全文索引，默认为false，推荐设置为true * false:不包含 * true:包含", "example": "false" }, { "name": "MetadataFlag", "type": "integer", "required": false, "description": "元数据字段（前缀为`__TAG__`的字段）是否包含至全文索引，默认为0，推荐设置为1 * 0:仅包含开启键值索引的元数据字段 * 1:包含所有元数据字段 * 2:不包含任何元数据字段", "example": "0" }, { "name": "CoverageField", "type": "string", "required": false, "description": "自定义日志解析异常存储字段。", "example": "ROWLOG" } ], "required": [ "TopicId" ] }, { "name": "ModifyKafkaConsumer", "description": "修改Kafka协议消费信息", "status": "online", "parameters": [ { "name": "FromTopicId", "type": "string", "required": true, "description": "日志主题Id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。", "example": "57f5808c-4a55-11eb-b378-0242ac130002" }, { "name": "Compression", "type": "integer", "required": false, "description": "压缩方式。0：不压缩；2：使用Snappy压缩；3：使用LZ4压缩", "example": "2" }, { "name": "ConsumerContent", "type": "object", "required": false, "description": "kafka协议消费数据格式", "example": "无", "children": [ { "name": "Format", "type": "integer", "required": true, "description": "消费数据格式。 0：原始内容；1：JSON。", "example": "1" }, { "name": "EnableTag", "type": "boolean", "required": true, "description": "是否投递 TAG 信息 Format为0时，此字段不需要赋值", "example": "false" }, { "name": "MetaFields", "type": "array", "required": true, "description": "元数据信息列表, 可选值为：\\_\\_SOURCE\\_\\_、\\_\\_FILENAME\\_\\_ 、\\_\\_TIMESTAMP\\_\\_、\\_\\_HOSTNAME\\_\\_、\\_\\_PKGID\\_\\_ Format为0时，此字段不需要赋值", "example": "[\"\\_\\_HOSTNAME\\_\\_\"]", "item_type": "string" }, { "name": "TagTransaction", "type": "integer", "required": false, "description": "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\"}`", "example": "1" }, { "name": "JsonType", "type": "integer", "required": false, "description": "消费数据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\\\"}\"}`", "example": "1" } ] } ], "required": [ "FromTopicId" ] }, { "name": "ModifyKafkaConsumerGroupOffset", "description": "修改Kafka协议消费组点位", "status": "online", "parameters": [], "required": [] }, { "name": "ModifyKafkaRecharge", "description": "本接口用于修改Kafka数据订阅任务", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": true, "description": "导入配置Id。 - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。 - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。", "example": "1014cc79-f006-48e4-8820-1dc7270540c0" }, { "name": "TopicId", "type": "string", "required": true, "description": "导入CLS目标TopicId。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456)获取日志主题Id。", "example": "06bdb6f6-ae6e-41f6-9e7b-fcab91cb0111" }, { "name": "Name", "type": "string", "required": false, "description": "Kafka导入配置名称", "example": "kafka导入" }, { "name": "KafkaType", "type": "integer", "required": false, "description": "导入Kafka类型，0：腾讯云CKafka：1：用户自建Kafka。", "example": "0" }, { "name": "KafkaInstance", "type": "string", "required": false, "description": "腾讯云CKafka实例ID，KafkaType为0时必填。 - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。", "example": "ckafka-2vrgxbxa" }, { "name": "ServerAddr", "type": "string", "required": false, "description": "服务地址，KafkaType为1时必填。", "example": "192.168.0.1:9095或test.cls.tencentyun.com:9095" }, { "name": "IsEncryptionAddr", "type": "boolean", "required": false, "description": "ServerAddr是否为加密连接，KafkaType为1时必填。", "example": "true" }, { "name": "Protocol", "type": "object", "required": false, "description": "加密访问协议，KafkaType参数为1并且IsEncryptionAddr参数为true时必填。", "example": "无", "children": [ { "name": "Protocol", "type": "string", "required": false, "description": "协议类型，支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl，此协议会进行连接加密同时需要用户认证。 - 当IsEncryptionAddr为true时，Protocol必填。 - 支持的协议类型如下： - plaintext：纯文本无加密协议 - sasl_ssl：SASL 认证 + SSL 加密 - ssl：纯 SSL/TLS 加密协议 - sasl_plaintext：SASL 认证 + 非加密通道", "example": "sasl_ssl" }, { "name": "Mechanism", "type": "string", "required": false, "description": "加密类型，支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。 - 当Protocol为 `sasl_plaintext` 或 `sasl_ssl` 时 Mechanism 必填。 - 支持加密类型如下 - PLAIN：明文认证 - SCRAM-SHA-256：基于挑战-响应机制，使用PBKDF2-HMAC-SHA256算法 - SCRAM-SHA-512：增强版SCRAM，使用PBKDF2-HMAC-SHA512算法", "example": "PLAIN" }, { "name": "UserName", "type": "string", "required": false, "description": "用户名。 当Protocol为sasl_plaintext或sasl_ssl时必填", "example": "name" }, { "name": "Password", "type": "string", "required": false, "description": "用户密码。 当Protocol为sasl_plaintext或sasl_ssl时必填", "example": "axxxxxx" } ] }, { "name": "UserKafkaTopics", "type": "string", "required": false, "description": "用户需要导入的Kafka相关topic列表，多个topic之间使用半角逗号隔开。 - Kafka类型为腾讯云CKafka时：通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获取TopicName。", "example": "topic-subs-0px4qkvu32-cdb-5zi7jf11" }, { "name": "ConsumerGroupName", "type": "string", "required": false, "description": "用户Kafka消费组名称", "example": "cls-xxxxx" }, { "name": "LogRechargeRule", "type": "object", "required": false, "description": "日志导入规则", "example": "无", "children": [ { "name": "RechargeType", "type": "string", "required": true, "description": "导入类型，支持json_log：json格式日志，minimalist_log: 单行全文，fullregex_log: 单行完全正则", "example": "json_log" }, { "name": "EncodingFormat", "type": "integer", "required": true, "description": "解析编码格式，0: UTF-8（默认值），1: GBK", "example": "0" }, { "name": "DefaultTimeSwitch", "type": "boolean", "required": true, "description": "使用默认时间状态。true：开启后将使用系统当前时间或 Kafka 消息时间戳作为日志时间戳；false：关闭将使用日志中的时间字段作为日志时间戳。 默认：true", "example": "true" }, { "name": "LogRegex", "type": "string", "required": false, "description": "整条日志匹配规则，只有RechargeType为fullregex_log时有效", "example": "(\\\\w+).*" }, { "name": "UnMatchLogSwitch", "type": "boolean", "required": false, "description": "解析失败日志是否上传，true表示上传，false表示不上传", "example": "true" }, { "name": "UnMatchLogKey", "type": "string", "required": false, "description": "解析失败日志的键名称", "example": "LogParseFailure" }, { "name": "UnMatchLogTimeSrc", "type": "integer", "required": false, "description": "解析失败日志时间来源，0: 系统当前时间，1: Kafka消息时间戳", "example": "1" }, { "name": "DefaultTimeSrc", "type": "integer", "required": false, "description": "默认时间来源，0: 系统当前时间，1: Kafka消息时间戳", "example": "0" }, { "name": "TimeKey", "type": "string", "required": false, "description": "时间字段，日志中代表时间的字段名。 - 当DefaultTimeSwitch为false，且RechargeType数据提取模式为 `json_log` JSON-文件日志 或 `fullregex_log` 单行完全正则-文件日志时， TimeKey不能为空。", "example": "__TIMESTAMP__" }, { "name": "TimeRegex", "type": "string", "required": false, "description": "时间提取正则表达式。 - 当DefaultTimeSwitch为false，且RechargeType数据提取模式为 `minimalist_log` 单行全文-文件日志时， TimeRegex不能为空。 - 仅需输入日志中代表时间的字段的正则表达式即可；若匹配到多个字段，将使用第一个。 例：日志原文为：message with time 2022-08-08 14:20:20，则您可以设置提取时间正则为\\d\\d\\d\\d-\\d\\d-\\d\\d \\d\\d:\\d\\d:\\d\\d", "example": "(\\d{4})-(\\d{2})-(\\d{2}) (\\d{2}):(\\d{2}):(\\d{2})" }, { "name": "TimeFormat", "type": "string", "required": false, "description": "时间字段格式。 - 当DefaultTimeSwitch为false时， TimeFormat不能为空。", "example": "%Y-%m-%d %H:%M:%S" }, { "name": "TimeZone", "type": "string", "required": false, "description": "时间字段时区。 - 当DefaultTimeSwitch为false时， TimeZone不能为空。 - 时区格式规则 ​前缀​：使用 GMT 或 UTC 作为时区基准 ​偏移量​： - `-` 表示西时区（比基准时间晚） - `+` 表示东时区（比基准时间早） - 格式为 ±HH:MM（小时:分钟） - 当前支持： ``` \"GMT-12:00\" \"GMT-11:00\" \"GMT-10:00\" \"GMT-09:30\" \"GMT-09:00\" \"GMT-08:00\" \"GMT-07:00\" \"GMT-06:00\" \"GMT-05:00\" \"GMT-04:00\" \"GMT-03:30\" \"GMT-03:00\" \"GMT-02:00\" \"GMT-01:00\" \"GM...", "example": "UTC+08:00" }, { "name": "Metadata", "type": "array", "required": false, "description": "元数据信息，Kafka导入支持kafka_topic,kafka_partition,kafka_offset,kafka_timestamp", "example": "[\"kafka_topic\",\"kafka_partition\",\"kafka_offset\",\"kafka_timestamp\"]", "item_type": "string" }, { "name": "Keys", "type": "array", "required": false, "description": "日志Key列表，RechargeType为full_regex_log、delimiter_log时必填", "example": "[\"name\",\"address\"]", "item_type": "string" }, { "name": "ParseArray", "type": "boolean", "required": false, "description": "json解析模式，开启首层数据解析", "example": "false" }, { "name": "Delimiter", "type": "string", "required": false, "description": "分隔符解析模式-分隔符 当解析格式为分隔符提取时，该字段必填", "example": "," } ] }, { "name": "StatusControl", "type": "integer", "required": false, "description": "导入控制，1：暂停；2：启动。", "example": "1" }, { "name": "UserKafkaMeta", "type": "object", "required": false, "description": "用户kafka拓展信息", "example": "无", "children": [ { "name": "KafkaVersion", "type": "string", "required": true, "description": "用户kafka version 支持如下版本： - 0.10.2.0 - 1.0.0 - 2.0.0 - 2.2.0 - 2.4.0 - 2.6.0 - 2.7.0 - 2.8.0 - 3.0.0 - 3.2.0", "example": "2.0.0" } ] } ], "required": [ "Id", "TopicId" ] }, { "name": "ModifyLogset", "description": "本接口用于修改日志集信息", "status": "online", "parameters": [ { "name": "LogsetId", "type": "string", "required": true, "description": "日志集Id。通过 [获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。", "example": "dc01b74a-49e4-11eb-b378-0242ac130002" }, { "name": "LogsetName", "type": "string", "required": false, "description": "日志集名字。- 最大支持255个字符。不支持`|`字符。", "example": "业务流日志集" }, { "name": "Tags", "type": "array", "required": false, "description": "日志集的绑定的标签键值对。最大支持10个标签键值对，同一个资源只能同时绑定一个标签键。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "业务A" } ] } ], "required": [ "LogsetId" ] }, { "name": "ModifyMachineGroup", "description": "修改机器组。 注意：修改接口直接覆盖历史数据，改为本次合法入参数据，请谨慎调用此接口。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "机器组Id - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。", "example": "57f5808c-4a55-11eb-b378-0242ac130002" }, { "name": "GroupName", "type": "string", "required": false, "description": "机器组名称 输入限制： - 不能为空字符串 - 不能包含字符'|'", "example": "testname" }, { "name": "MachineGroupType", "type": "object", "required": false, "description": "机器组类型。 Type：ip，Values中为ip字符串列表机器组； Type：label，Values中为标签字符串列表机器组。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "机器组类型。支持 ip 和 label。 - ip：表示该机器组Values中存的是采集机器的ip地址 - label：表示该机器组Values中存储的是机器的标签", "example": "ip" }, { "name": "Values", "type": "array", "required": false, "description": "机器描述列表。", "example": "[10.1.1.1,10.2.2.2]", "item_type": "string" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "业务A" } ] }, { "name": "AutoUpdate", "type": "boolean", "required": false, "description": "是否开启机器组自动更新", "example": "true" }, { "name": "UpdateStartTime", "type": "string", "required": false, "description": "升级开始时间，建议业务低峰期升级LogListener 时间格式：HH:mm:ss", "example": "\"12:00:00\"" }, { "name": "UpdateEndTime", "type": "string", "required": false, "description": "升级结束时间，建议业务低峰期升级LogListener 时间格式：HH:mm:ss", "example": "\"13:00:00\"" }, { "name": "ServiceLogging", "type": "boolean", "required": false, "description": "是否开启服务日志，用于记录因Loglistener 服务自身产生的log，开启后，会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business，不产生计费", "example": "true" }, { "name": "DelayCleanupTime", "type": "integer", "required": false, "description": "机器组中机器定期离线清理时间。单位：天", "example": "30" }, { "name": "MetaTags", "type": "array", "required": false, "description": "机器组元数据信息列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "元数据key", "example": "buss_key" }, { "name": "Value", "type": "string", "required": false, "description": "元数据value", "example": "buss_value" } ] } ], "required": [ "GroupId" ] }, { "name": "ModifyMetricConfig", "description": "创建指标采集配置", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "指标日志主题id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题（默认值）， 1:指标主题 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题（默认值）， 1:指标主题", "example": "715094e3-01b0-4aeb-91f5-ee9f46a4a13c" }, { "name": "ConfigId", "type": "string", "required": true, "description": "指标采集配置id", "example": "47532156-1731-4163-84ef-50e96bf7c300" }, { "name": "Source", "type": "integer", "required": false, "description": "采集配置来源。支持 ：`0`、`1` - 0:自建k8s - 1:TKE", "example": "0" }, { "name": "GroupIds", "type": "array", "required": false, "description": "机器组id。", "example": "[\"81853bcf-67b4-4a4f-82c7-7882fd004613\"]", "item_type": "string" }, { "name": "Operate", "type": "integer", "required": false, "description": "操作状态,0:应用,1:暂停", "example": "1" }, { "name": "Spec", "type": "object", "required": false, "description": "采集对象, Flag=0时生效", "example": "无", "children": [ { "name": "CustomSpecs", "type": "array", "required": false, "description": "自定义指标采集配置项 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Port", "type": "string", "required": true, "description": "端口。取值范围 [1,65535] 注意：此字段可能返回 null，表示取不到有效值。", "example": "80" }, { "name": "Path", "type": "string", "required": true, "description": "Metric地址。校验格式：`^/[a-zA-Z0-9-_./]*$` 注意：此字段可能返回 null，表示取不到有效值。", "example": "/metric" }, { "name": "Namespaces", "type": "array", "required": false, "description": "命名空间列表。 - 最大支持100个 - namespace 校验格式 `[a-z0-9]([-a-z0-9]*[a-z0-9])?` ， 长度不能超过63 - namespace 不能重复 注意：此字段可能返回 null，表示取不到有效值。", "example": "kebe-system", "item_type": "string" }, { "name": "PodLabel", "type": "array", "required": false, "description": "Pod标签。 - 最大支持100个 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签的键。有效标签键有两个部分：可选前缀和名称，以斜杠 (/) 分隔。名称部分是必需的，并且必须不超过 63 个字符，以字母数字字符 ([a-z0-9A-Z]) 开头和结尾，中间有破折号(-)、下划线(_)、点(.) 和字母数字。前缀是可选的。如果指定，前缀必须是 DNS 子域：一系列以点 (.) 分隔的 DNS 标签，总长度不超过 253 个字符，后跟斜杠 ( /)。 - prefix 格式 `[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([...", "example": "app" }, { "name": "Operate", "type": "string", "required": true, "description": "标签键值直接的比较关系。 不同业务场景支持的比较符不同，具体支持那些参考接口业务描述。 例如：`in`、`notin` 注意：此字段可能返回 null，表示取不到有效值。", "example": "in" }, { "name": "Values", "type": "array", "required": false, "description": "标签的值. - 最大支持63个字符。 - 格式：`([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]` 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"k8s-x\"]", "item_type": "string" } ] } ] } ] }, { "name": "MetricRelabels", "type": "array", "required": false, "description": "标签处理, Flag=0时生效", "example": "无", "item_type": "object", "children": [ { "name": "Action", "type": "string", "required": true, "description": "基于正则表达式匹配执行的动作。 - replace: Label替换, 必填: SourceLabels, Separator, Regex, TargetLabel, Replacement - labeldrop: 丢弃Label, 必填: Regex - labelkeep: 保留Label, 必填: Regex - lowercase: 小写化, 必填: SourceLabels, Separator, TargetLabel - uppercase: 大写化, 必填: SourceLabels, Separator, TargetLabel - dropequal: 丢弃指标-完全匹配, 必填: SourceLabels, Separator, TargetLabel - keepequal: 保留指标-完全匹配, 必填: SourceLabels, ...", "example": "replace" }, { "name": "SourceLabels", "type": "array", "required": false, "description": "原始label 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"__meta_kubernetes_pod_label_app\"]", "item_type": "string" }, { "name": "Separator", "type": "string", "required": false, "description": "原始label连接符。 必填时不能为空串， 长度不能超过256 注意：此字段可能返回 null，表示取不到有效值。", "example": ";" }, { "name": "TargetLabel", "type": "string", "required": false, "description": "目标label。必填时不能为空串，校验格式：`^[a-zA-Z_][a-zA-Z0-9_]*$` ， 长度不能超过256 注意：此字段可能返回 null，表示取不到有效值。", "example": "application" }, { "name": "Replacement", "type": "string", "required": false, "description": "替换值。如果正则表达式匹配，则对其执行替换操作。 - 必填时不能为空串，长度不能超过256 - 当action为LabelMap时， Replacement 校验格式：`^(?:(?:[a-zA-Z_]|\\$(?:\\{\\w+\\}|\\w+))+\\w*)+$` 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Regex", "type": "string", "required": false, "description": "正则表达式。提取与之匹配值。必填时不能为空串，校验必须是一个合法的 RE2 注意：此字段可能返回 null，表示取不到有效值。", "example": "(.*)" }, { "name": "Modulus", "type": "integer", "required": false, "description": "获取源标签值的哈希值。必填时不能为空,不能为0 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "MetricLabel", "type": "object", "required": false, "description": "自定义元数据, Flag=0时生效", "example": "无", "children": [ { "name": "Metadata", "type": "array", "required": false, "description": "元数据。 支持 - `namespace` - `pod_name` - `pod_ip` - `pod_uid` - `container_name` - `container_id` - `image_name` - `cluster_id` - `node_id` - `node_ip` 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"namespace\",\"pod_name\"]", "item_type": "string" }, { "name": "Label", "type": "object", "required": false, "description": "元数据Pod Label信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "指定标签类型。 - 0：所有Pod label，Keys字段无效 - 1：指定Pod label，Keys字段不能为空 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Keys", "type": "array", "required": false, "description": "元数据Pod标签的键。有效标签键有两个部分：可选前缀和名称，以斜杠 (/) 分隔。名称部分是必需的，并且必须不超过 63 个字符，以字母数字字符 ([a-z0-9A-Z]) 开头和结尾，中间有破折号(-)、下划线(_)、点(.) 和字母数字。前缀是可选的。如果指定，前缀必须是 DNS 子域：一系列以点 (.) 分隔的 DNS 标签，总长度不超过 253 个字符，后跟斜杠 ( /)。 - prefix 格式 `[a-z0-9]([-a-z0-9]*[a-z0-9])?(...", "example": "[\"k8s-key\"]", "item_type": "string" } ] }, { "name": "CustomLabels", "type": "array", "required": false, "description": "自定义label信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签的键。 - 必须以字母或下划线开头，但不可以双下划线（__）开头，后面可以跟任意字母，数字或下划线。 - 最大支持256个字符。 - key不能重复 注意：此字段可能返回 null，表示取不到有效值。", "example": "app" }, { "name": "Value", "type": "string", "required": true, "description": "标签的值。 - 最大支持256个字符。 注意：此字段可能返回 null，表示取不到有效值。", "example": "k8s-x" } ] } ] }, { "name": "Scheme", "type": "string", "required": false, "description": "通信协议 `http`、`https`；Flag=0时生效", "example": "http" }, { "name": "ScrapeInterval", "type": "string", "required": false, "description": "采集频率, Flag=0时生效 - 校验格式：`^(((\\d+)y)?((\\d+)w)?((\\d+)d)?((\\d+)h)?((\\d+)m)?((\\d+)s)?((\\d+)ms)?|0)$` - 默认：60s", "example": "60s" }, { "name": "ScrapeTimeout", "type": "string", "required": false, "description": "采集超时时间。 Flag=0时生效 - 校验格式：`^(((\\d+)y)?((\\d+)w)?((\\d+)d)?((\\d+)h)?((\\d+)m)?((\\d+)s)?((\\d+)ms)?|0)$`", "example": "30s" }, { "name": "HonorLabels", "type": "boolean", "required": false, "description": "Prometheus如何处理标签之间的冲突。当Flag=0 \u0026\u0026 Type=1时生效，支持`true`,`false` - `false`:配置数据中冲突的标签重命名 - `true`:忽略冲突的服务器端标签", "example": "false" }, { "name": "YamlSpec", "type": "object", "required": false, "description": "采集配置yaml格式字符串, Flag=1时必填", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "yaml监控类型。 支持： - PodMonitor - ServiceMonitor - ScrapeConfig - ScrapeConfig-prometheus `PodMonitor `,`ServiceMonitor `,`ScrapeConfig ` 属于prometheus-operator `ScrapeConfig-prometheus` 属于prometheus 注意：此字段可能返回 null，表示取不到有效值。", "example": "ServiceMonitor" }, { "name": "Spec", "type": "string", "required": true, "description": "配置yaml格式。 例如：Type: ServiceMonitor ``` apiVersion: monitoring.coreos.com/v1 kind: ServiceMonitor metadata: name: test namespace: test labels: k8s-app1: test k8s-app2: test spec: endpoints: - interval: 15s port: 8080-8080-tcp path: /metrics relabelings: - action: replace sourceLabels: - __meta_kubernetes_pod_label_app targetLabel: application namespaceSelector: matchNames: - test selector: matchLabels: app: test ``` 注意：此字段可能返回 null，表示取不到有效值。", "example": " \"apiVersion: monitoring.coreos.com/v1\\nkind: ServiceMonitor\\nmetadata:\\n name: test\\n namespace: test\\n labels:\\n k8s-app1: test\\n k8s-app2: test\\nspec:\\n endpoints:\\n - interval: 15s\\n port: 8080-8080-tcp\\n path: /metrics\\n relabelings:\\n - action: replace\\n sourceLabels:\\n - __meta_kubernetes_pod_label_app\\n targetLabel: application\\n namespaceSelector:\\n matchNames:\\n - test\\n selector:\\n matchLabels:\\n app: test\"" } ] } ], "required": [ "TopicId", "ConfigId" ] }, { "name": "ModifyMetricSubscribe", "description": "修改指标订阅配置", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "指标采集任务的日志主题id。必填字段", "example": "715094e3-01b0-4aeb-91f5-ee9f46a4a13c" }, { "name": "TaskId", "type": "string", "required": true, "description": "指标采集任务id。必填字段", "example": "5871c48d-219b-4274-829b-5aa7fb24229b" }, { "name": "Name", "type": "string", "required": false, "description": "名称：长度不超过64字符，以字母开头，接受0-9,a-z,A-Z, _,-,中文字符。", "example": "template_1" }, { "name": "Namespace", "type": "string", "required": false, "description": "云产品命名空间。", "example": "QCE/CVM" }, { "name": "Metrics", "type": "array", "required": false, "description": "指标配置信息。", "example": "无", "item_type": "object", "children": [ { "name": "MetricName", "type": "string", "required": true, "description": "指标名称", "example": "metric_name" }, { "name": "Periods", "type": "array", "required": true, "description": "统计周期,单位:秒（s）", "example": "[60,120]", "item_type": "integer" }, { "name": "MetricLabels", "type": "array", "required": false, "description": "自定义指标标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "指标名称", "example": "ErrorMessage" }, { "name": "Value", "type": "string", "required": true, "description": "指标内容", "example": "Unauthorized" } ] } ] }, { "name": "InstanceInfo", "type": "object", "required": false, "description": "实例配置信息。", "example": "无", "children": [ { "name": "InstanceDimension", "type": "array", "required": true, "description": "实例维度", "example": "[\"bucket\",\"appid\"]", "item_type": "string" }, { "name": "Instances", "type": "array", "required": true, "description": "实例值", "example": "无", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "实例信息", "example": "[\"key1-value\",\"key2-value\"]", "item_type": "string" } ] } ] }, { "name": "Enable", "type": "integer", "required": false, "description": "任务状态。 1： 未启用 2： 启用", "example": "1" } ], "required": [ "TopicId", "TaskId" ] }, { "name": "ModifyNetworkApplication", "description": "修改网络应用", "status": "online", "parameters": [ { "name": "NetworkAppId", "type": "string", "required": true, "description": "网络应用id", "example": "638ca7fd-c7d3-492b-bc01-65304426783e" }, { "name": "Name", "type": "string", "required": false, "description": "网络应用名称：长度不超过64字符，名称不能重复。只能包含以下字符：英文字母（大小写）数字下划线连字符（减号）汉字至少包含一个字符不能包含空格不能包含其他特殊字符（如 @、#、$、% 等）", "example": "network_application_demo_update" } ], "required": [ "NetworkAppId" ] }, { "name": "ModifyNoticeContent", "description": "该接口用于修改通知内容配置", "status": "online", "parameters": [ { "name": "NoticeContentId", "type": "string", "required": true, "description": "通知内容模板ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知内容模板ID", "example": "noticetemplate-5b2ea996-4dae-47cc-bbad-5b12888b4c89" }, { "name": "Name", "type": "string", "required": false, "description": "通知内容模板名称。", "example": "内部监控告警专用" }, { "name": "Type", "type": "integer", "required": false, "description": "通知内容语言。 0：中文 1：英文", "example": "0" }, { "name": "NoticeContents", "type": "array", "required": false, "description": "通知内容模板详细信息。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "渠道类型 Email:邮件;Sms:短信;WeChat:微信;Phone:电话;WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调;", "example": "\"Email\"" }, { "name": "TriggerContent", "type": "object", "required": false, "description": "告警触发通知内容模板。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "通知内容模板标题信息。 部分通知渠道类型不支持“标题”，请参照[腾讯云控制台页面](https://console.cloud.tencent.com/cls/alarm/notice-template)。", "example": "这是标题。" }, { "name": "Content", "type": "string", "required": false, "description": "通知内容模板正文信息。", "example": "这是正文。" }, { "name": "Headers", "type": "array", "required": false, "description": "请求头（Request Headers）：在HTTP请求中，请求头包含了客户端向服务器发送的附加信息，如用户代理、授权凭证、期望的响应格式等。 仅“自定义回调”支持该配置。", "example": "[\"Content-Type:application/json\"]", "item_type": "string" } ] }, { "name": "RecoveryContent", "type": "object", "required": false, "description": "告警恢复通知内容模板。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "通知内容模板标题信息。 部分通知渠道类型不支持“标题”，请参照[腾讯云控制台页面](https://console.cloud.tencent.com/cls/alarm/notice-template)。", "example": "这是标题。" }, { "name": "Content", "type": "string", "required": false, "description": "通知内容模板正文信息。", "example": "这是正文。" }, { "name": "Headers", "type": "array", "required": false, "description": "请求头（Request Headers）：在HTTP请求中，请求头包含了客户端向服务器发送的附加信息，如用户代理、授权凭证、期望的响应格式等。 仅“自定义回调”支持该配置。", "example": "[\"Content-Type:application/json\"]", "item_type": "string" } ] } ] } ], "required": [ "NoticeContentId" ] }, { "name": "ModifyScheduledSql", "description": "本接口用于修改定时SQL分析任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID，通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取", "example": "6ef60bec-0242-43af-bb20-270359fxxxx" }, { "name": "SrcTopicId", "type": "string", "required": false, "description": "源日志主题，通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取", "example": "xxxx-0889-4ec0-accc-xxxxxxx" }, { "name": "EnableFlag", "type": "integer", "required": false, "description": "任务启动状态. 1开启, 2关闭", "example": "1" }, { "name": "DstResource", "type": "object", "required": false, "description": "定时SQL分析的目标日志主题", "example": "无", "children": [ { "name": "TopicId", "type": "string", "required": true, "description": "通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。", "example": "xxxxxxxx-0889-4ec0-accc-xxxxxxx" }, { "name": "Region", "type": "string", "required": false, "description": "主题的地域信息，当前不支持跨地域，支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。", "example": "ap-guangzhou" }, { "name": "BizType", "type": "integer", "required": false, "description": "主题类型：0为日志主题，1为指标主题", "example": "0" }, { "name": "MetricName", "type": "string", "required": false, "description": "指标名称。当BizType为1时，MetricName需要填写", "example": "cpu_usage" }, { "name": "MetricNames", "type": "array", "required": false, "description": "指标名称 BizType为1时，优先使用MetricNames字段多指标只能填充到MetricNames字段，单指标建议填充到MetricName字段", "example": "[\"cpu_usage\",\"mem_usage\"]", "item_type": "string" }, { "name": "MetricLabels", "type": "array", "required": false, "description": "指标维度，不接受时间类型。", "example": "[\"cluster\",\"ip\"]", "item_type": "string" }, { "name": "CustomTime", "type": "string", "required": false, "description": "指标时间戳，默认值为SQL查询时间范围的左侧时间点，您也可以指定其他字段（类型为uinx时间、TimeStamp，精度毫秒）为指标时间戳。", "example": "unix_ts,或者TimeStamp 2021-07-15T17:11:56.735+08:00" }, { "name": "CustomMetricLabels", "type": "array", "required": false, "description": "除了MetricLabels，您还可以使用该参数，为指标补充静态的维度。 维度名以字母或下划线开头，后面可以跟字母、数字或下划线，长度小于等于1024 字节", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "指标名称", "example": "ErrorMessage" }, { "name": "Value", "type": "string", "required": true, "description": "指标内容", "example": "Unauthorized" } ] } ] }, { "name": "ScheduledSqlContent", "type": "string", "required": false, "description": "查询语句", "example": "* | select count(*)" }, { "name": "ProcessPeriod", "type": "integer", "required": false, "description": "调度周期(分钟)，1~1440分钟", "example": "2" }, { "name": "ProcessTimeWindow", "type": "string", "required": false, "description": "单次查询的时间窗口. 例子中为近15分钟", "example": "@m-15m,@m" }, { "name": "ProcessDelay", "type": "integer", "required": false, "description": "执行延迟(秒)，0~120秒，默认60秒", "example": "60" }, { "name": "SrcTopicRegion", "type": "string", "required": false, "description": "源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档", "example": "ap-guangzhou" }, { "name": "Name", "type": "string", "required": false, "description": "任务名称，0~255字符", "example": "scheduler_sql任务1" }, { "name": "SyntaxRule", "type": "integer", "required": false, "description": "语法规则。 默认值为0。 0：Lucene语法，1：CQL语法", "example": "0" } ], "required": [ "TaskId" ] }, { "name": "ModifyShipper", "description": "修改现有的投递规则，客户如果使用此接口，需要自行处理CLS对指定bucket的写权限。", "status": "online", "parameters": [ { "name": "ShipperId", "type": "string", "required": true, "description": "投递规则Id。 - 通过 [获取投递任务列表](https://cloud.tencent.com/document/product/614/58745)获取ShipperId。", "example": "3f9562a7-xxxx-xxxx-b32a-d51a927226a7" }, { "name": "Bucket", "type": "string", "required": false, "description": "COS存储桶，详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。 - 通过[GET Service（List Buckets）](https://cloud.tencent.com/document/product/436/8291)获取COS存储桶。", "example": "examplebucket-1250000000" }, { "name": "Prefix", "type": "string", "required": false, "description": "投递规则投递的新的目录前缀。 - 仅支持0-9A-Za-z-_/ - 最大支持256个字符", "example": "var/xxx" }, { "name": "Status", "type": "boolean", "required": false, "description": "投递规则的开关状态。true：开启投递任务；false：关闭投递任务。", "example": "true" }, { "name": "ShipperName", "type": "string", "required": false, "description": "投递规则的名字", "example": "testShipper" }, { "name": "Interval", "type": "integer", "required": false, "description": "投递的时间间隔，单位 秒，默认300，范围 300-900", "example": "300" }, { "name": "MaxSize", "type": "integer", "required": false, "description": "投递的文件的最大值，单位 MB，默认256，范围 5-256", "example": "256" }, { "name": "FilterRules", "type": "array", "required": false, "description": "投递日志的过滤规则，匹配的日志进行投递，各rule之间是and关系，最多5个，数组为空则表示不过滤而全部投递", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "过滤规则Key", "example": "testKey" }, { "name": "Regex", "type": "string", "required": true, "description": "过滤规则", "example": "/w" }, { "name": "Value", "type": "string", "required": true, "description": "过滤规则Value", "example": "testValue" } ] }, { "name": "Partition", "type": "string", "required": false, "description": "投递日志的分区规则，支持strftime的时间格式表示", "example": "%Y%m%d" }, { "name": "Compress", "type": "object", "required": false, "description": "投递日志的压缩配置", "example": "无", "children": [ { "name": "Format", "type": "string", "required": true, "description": "压缩格式，支持gzip、lzop、snappy和none不压缩", "example": "none" } ] }, { "name": "Content", "type": "object", "required": false, "description": "投递日志的内容格式配置", "example": "无", "children": [ { "name": "Format", "type": "string", "required": true, "description": "内容格式，支持json，csv，parquet", "example": "json" }, { "name": "Csv", "type": "object", "required": false, "description": "csv格式内容描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "PrintKey", "type": "boolean", "required": true, "description": "csv首行是否打印key", "example": "true" }, { "name": "Keys", "type": "array", "required": true, "description": "每列key的名字 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"__SOURCE__\",\"__FILENAME__\",\"__HOSTNAME__\"]", "item_type": "string" }, { "name": "Delimiter", "type": "string", "required": true, "description": "各字段间的分隔符", "example": "|" }, { "name": "EscapeChar", "type": "string", "required": true, "description": "若字段内容中包含分隔符，则使用该转义符包裹改字段，只能填写单引号、双引号、空字符串", "example": "'" }, { "name": "NonExistingField", "type": "string", "required": true, "description": "对于上面指定的不存在字段使用该内容填充", "example": "not_exist" } ] }, { "name": "Json", "type": "object", "required": false, "description": "json格式内容描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "EnableTag", "type": "boolean", "required": true, "description": "启用标志", "example": "true" }, { "name": "MetaFields", "type": "array", "required": true, "description": "元数据信息列表, 可选值为 __SOURCE__、__FILENAME__、__TIMESTAMP__、__HOSTNAME__。 - __SOURCE__：日志采集的源 IP，示例：10.0.1.2 - __FILENAME__：日志采集的文件名，示例：/data/log/nginx/access.log - __TIMESTAMP__：日志时间戳（毫秒级别 Unix 时间戳），按时间范围检索日志时，将自动使用该时间对日志进行检索，在控制台显示为“日志时间”，示例：1640005601188 - __HOSTNAME__：日志来源机器名称，需使\ufffd\ufffd...", "example": "[\"__SOURCE__\",\"__FILENAME__\",\"__TIMESTAMP__\",\"__HOSTNAME__\"]", "item_type": "string" }, { "name": "JsonType", "type": "integer", "required": false, "description": "投递Json格式，0：字符串方式投递；1:以结构化方式投递", "example": "1" } ] }, { "name": "Parquet", "type": "object", "required": false, "description": "parquet格式内容描述 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ParquetKeyInfo", "type": "array", "required": true, "description": "ParquetKeyInfo数组", "example": "无", "item_type": "object", "children": [ { "name": "KeyName", "type": "string", "required": true, "description": "键值名称", "example": "content" }, { "name": "KeyType", "type": "string", "required": true, "description": "数据类型，目前支持6种类型：string、boolean、int32、int64、float、double", "example": "string" }, { "name": "KeyNonExistingField", "type": "string", "required": true, "description": "解析失败赋值信息", "example": "NotExist" } ] } ] } ] }, { "name": "FilenameMode", "type": "integer", "required": false, "description": "投递文件命名配置，0：随机数命名，1：投递时间命名。", "example": "0" }, { "name": "StorageType", "type": "string", "required": false, "description": "对象存储类型，默认值为 STANDARD。枚举值请参见[ 存储类型概述](https://cloud.tencent.com/document/product/436/33417) 文档。 参考值有： - STANDARD：标准存储 - STANDARD_IA：低频存储 - ARCHIVE：归档存储 - DEEP_ARCHIVE：深度归档存储 - MAZ_STANDARD：标准存储（多 AZ） - MAZ_STANDARD_IA：低频存储（多 AZ） - INTELLIGENT_TIERING：智能分层存储 - MAZ_INTELLIGENT_TIERING：智能分层存储（多 AZ）", "example": "STANDARD" }, { "name": "RoleArn", "type": "string", "required": false, "description": "角色访问描述名 [创建角色](https://cloud.tencent.com/document/product/598/19381)", "example": "qcs::cam::uin/${uin}:roleName/xxxtest" }, { "name": "ExternalId", "type": "string", "required": false, "description": "外部ID", "example": "external_id_demo" } ], "required": [ "ShipperId" ] }, { "name": "ModifySplunkDeliver", "description": "修改splunk投递任务相关信息", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务id", "example": "111024e3-01b0-4aeb-91f5-ee" }, { "name": "TopicId", "type": "string", "required": true, "description": "日志主题id- 通过获取日志主题列表获取日志主题Id。", "example": "06cc3d03-44a0-4d94-89c2-aeac27a1d9f1" }, { "name": "Name", "type": "string", "required": false, "description": "投递任务名称name有以下限制：- 不能为空- 长度不大于64- 只能包含aA-zZ、下划线、-、0-9", "example": "template-1" }, { "name": "Enable", "type": "integer", "required": false, "description": "投递任务启用状态；0:禁用；1:启用", "example": "1" }, { "name": "NetInfo", "type": "object", "required": false, "description": "splunk投递任务-目标配置", "example": "无", "children": [ { "name": "Host", "type": "string", "required": true, "description": "网络地址", "example": "127.0.0.1" }, { "name": "Port", "type": "integer", "required": true, "description": "端口", "example": "8080" }, { "name": "Token", "type": "string", "required": true, "description": "认证token", "example": "abce" }, { "name": "NetType", "type": "integer", "required": true, "description": "网络类型;1：内网；2:外网", "example": "1" }, { "name": "VpcId", "type": "string", "required": false, "description": "所属网络；如果网络类型为内网，该字段必填", "example": "vpc-ab12" }, { "name": "VirtualGatewayType", "type": "integer", "required": false, "description": "网络服务类型；如果网络类型为内网，该字段必填 - 0:云上cvm - 3:云上专线网关 - 11:云联网 - 1025:云上clb", "example": "0" }, { "name": "IsSSL", "type": "boolean", "required": false, "description": "认证机制，是否使用SSL，默认不使用", "example": "false" } ] }, { "name": "MetadataInfo", "type": "object", "required": false, "description": "splunk投递任务元信息", "example": "无", "children": [ { "name": "Format", "type": "string", "required": true, "description": "数据格式,rawlog/json", "example": "json" }, { "name": "MetaFields", "type": "array", "required": false, "description": "投递字段，包括\\_\\_SOURCE\\_\\_、\\_\\_FILENAME\\_\\_ 、\\_\\_TIMESTAMP\\_\\_、\\_\\_HOSTNAME\\_\\_、\\_\\_PKG\\_ID\\_\\_", "example": "[\"__SOURCE__\",\"__FILENAME__\",\"__TIMESTAMP__\",\"__HOSTNAME__\"]", "item_type": "string" }, { "name": "EnableTag", "type": "boolean", "required": false, "description": "是否投递__TAG__字段", "example": "true" }, { "name": "TagJsonTiled", "type": "boolean", "required": false, "description": "JSON是否平铺，投递__TAG__字段时必填", "example": "false" } ] }, { "name": "HasServiceLog", "type": "integer", "required": false, "description": "是否启用服务日志；1:关闭；2:开启", "example": "1" }, { "name": "IndexAck", "type": "integer", "required": false, "description": "高级配置-是否启用索引器;1-不开启；2-开启；默认为：1", "example": "1" }, { "name": "Source", "type": "string", "required": false, "description": "高级配置-数据来源；不超过64个字符", "example": "client-1" }, { "name": "SourceType", "type": "string", "required": false, "description": "高级配置-数据来源类型；不超过64个字符", "example": "json" }, { "name": "Index", "type": "string", "required": false, "description": "高级配置-Splunk写入的索引；不超过64个字符", "example": "main" }, { "name": "Channel", "type": "string", "required": false, "description": "高级配置-通道。需满足限制：如果启用索引器，该值不能为空", "example": "template-1" }, { "name": "DSLFilter", "type": "string", "required": false, "description": "预过滤处理-对写入 Splunk 原始数据进行预过滤处理", "example": "log_keep(op_str_eq(v(\"type\"), \"kibana_stats\"))" } ], "required": [ "TaskId", "TopicId" ] }, { "name": "ModifyTopic", "description": "本接口用于修改日志或指标主题。", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "主题ID- 通过[获取主题列表](https://cloud.tencent.com/document/product/614/56454)获取主题Id。", "example": "eb9ec10d-1343-4386-9a6e-75fd9d68726e" }, { "name": "TopicName", "type": "string", "required": false, "description": "主题名称 输入限制： - 不能为空字符串 - 不能包含字符'|' - 不能使用以下名称[\"cls_service_log\",\"loglistener_status\",\"loglistener_alarm\",\"loglistener_business\",\"cls_service_metric\"]", "example": "testname" }, { "name": "Tags", "type": "array", "required": false, "description": "标签描述列表，通过指定该参数可以同时绑定标签到相应的主题。最大支持10个标签键值对，并且不能有重复的键值对。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "业务A" } ] }, { "name": "Status", "type": "boolean", "required": false, "description": "主题是否开启采集，true：开启采集；false：关闭采集。 控制台目前不支持修改此参数。", "example": "true" }, { "name": "AutoSplit", "type": "boolean", "required": false, "description": "是否开启自动分裂", "example": "true" }, { "name": "MaxSplitPartitions", "type": "integer", "required": false, "description": "若开启最大分裂，该主题能够允许的最大分区数； 默认为50；必须为正数", "example": "50" }, { "name": "Period", "type": "integer", "required": false, "description": "生命周期，单位天，标准存储取值范围1\\~3600，低频存储取值范围7\\~3600。取值为3640时代表永久保存", "example": "30" }, { "name": "StorageType", "type": "string", "required": false, "description": "存储类型：cold 低频存储，hot 标准存储", "example": "cold" }, { "name": "Describes", "type": "string", "required": false, "description": "主题描述", "example": "xx部门xx业务topic" }, { "name": "HotPeriod", "type": "integer", "required": false, "description": "0：日志主题关闭日志沉降。 非0：日志主题开启日志沉降后标准存储的天数。HotPeriod需要大于等于7，且小于Period。 仅在StorageType为 hot 时生效，指标主题不支持该配置。", "example": "1" }, { "name": "IsWebTracking", "type": "boolean", "required": false, "description": "免鉴权开关。 false：关闭； true：开启。 开启后将支持指定操作匿名访问该日志主题。详情请参见[日志主题](https://cloud.tencent.com/document/product/614/41035)。", "example": "false" }, { "name": "Extends", "type": "object", "required": false, "description": "主题扩展信息", "example": "无", "children": [ { "name": "AnonymousAccess", "type": "object", "required": false, "description": "日志主题免鉴权配置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Operations", "type": "array", "required": false, "description": "操作列表，支持trackLog(JS/HTTP上传日志 )和realtimeProducer(kafka协议上传日志)", "example": "realtimeProducer", "item_type": "string" }, { "name": "Conditions", "type": "array", "required": false, "description": "条件列表", "example": "无", "item_type": "object", "children": [ { "name": "Attributes", "type": "string", "required": false, "description": "条件属性，目前只支持VpcID", "example": "VpcID" }, { "name": "Rule", "type": "integer", "required": false, "description": "条件规则，1:等于，2:不等于", "example": "1" }, { "name": "ConditionValue", "type": "string", "required": false, "description": "对应条件属性的值", "example": "vpc-6jfhit1t" } ] } ] } ] }, { "name": "PartitionCount", "type": "integer", "required": false, "description": "主题分区数量。 默认为1； 取值范围及约束： - 当输入值\u003c=0，系统自动调整为1。 - 如果未传MaxSplitPartitions，需要PartitionCount\u003c=50； - 如果传递了MaxSplitPartitions，需要PartitionCount\u003c=MaxSplitPartitions；", "example": "10" }, { "name": "CancelTopicAsyncTaskID", "type": "string", "required": false, "description": "取消切换存储任务的id - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id【Topics中的TopicAsyncTaskID字段】。", "example": "87b94286-1b33-44df-8568-924eb250ef4e" }, { "name": "Encryption", "type": "integer", "required": false, "description": "加密相关参数。 支持加密地域并且开白用户可以传此参数，其他场景不能传递该参数。 只支持传入1：kms-cls 云产品秘钥加密", "example": "1" }, { "name": "IsSourceFrom", "type": "boolean", "required": false, "description": "开启记录公网来源ip和服务端接收时间", "example": "false" } ], "required": [ "TopicId" ] }, { "name": "ModifyWebCallback", "description": "该接口用于修改告警渠道回调配置。", "status": "online", "parameters": [ { "name": "WebCallbackId", "type": "string", "required": true, "description": "告警渠道回调配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/api/614/115229)获取告警渠道回调配置ID", "example": "webcallback-5b2ea996-xxxx-xxxx-bbad-5b12888b4c89" }, { "name": "Name", "type": "string", "required": false, "description": "告警渠道回调配置名称。最大支持255个字节", "example": "监控告警专用" }, { "name": "Type", "type": "string", "required": false, "description": "渠道类型 WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调;", "example": "Http" }, { "name": "Webhook", "type": "string", "required": false, "description": "回调地址。", "example": "http://www.xxx.com" }, { "name": "Method", "type": "string", "required": false, "description": "请求方式。 支持POST、PUT。 注意：当Type为Http时，必填。", "example": "POST" }, { "name": "Key", "type": "string", "required": false, "description": "秘钥信息。最大支持1024个字节", "example": "HASFUBRINFYAWERNTFGPI" } ], "required": [ "WebCallbackId" ] }, { "name": "OpenKafkaConsumer", "description": "打开Kafka协议消费功能", "status": "online", "parameters": [ { "name": "FromTopicId", "type": "string", "required": true, "description": "日志主题Id。 - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。 - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。", "example": "57f5808c-4a55-11eb-b378-0242ac130002" }, { "name": "Compression", "type": "integer", "required": false, "description": "压缩方式[0:NONE；2:SNAPPY；3:LZ4]，默认：0", "example": "0" }, { "name": "ConsumerContent", "type": "object", "required": false, "description": "kafka协议消费数据格式", "example": "无", "children": [ { "name": "Format", "type": "integer", "required": true, "description": "消费数据格式。 0：原始内容；1：JSON。", "example": "1" }, { "name": "EnableTag", "type": "boolean", "required": true, "description": "是否投递 TAG 信息 Format为0时，此字段不需要赋值", "example": "false" }, { "name": "MetaFields", "type": "array", "required": true, "description": "元数据信息列表, 可选值为：\\_\\_SOURCE\\_\\_、\\_\\_FILENAME\\_\\_ 、\\_\\_TIMESTAMP\\_\\_、\\_\\_HOSTNAME\\_\\_、\\_\\_PKGID\\_\\_ Format为0时，此字段不需要赋值", "example": "[\"\\_\\_HOSTNAME\\_\\_\"]", "item_type": "string" }, { "name": "TagTransaction", "type": "integer", "required": false, "description": "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\"}`", "example": "1" }, { "name": "JsonType", "type": "integer", "required": false, "description": "消费数据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\\\"}\"}`", "example": "1" } ] } ], "required": [ "FromTopicId" ] }, { "name": "PreviewKafkaRecharge", "description": "本接口用于预览Kafka数据订阅任务客户日志信息", "status": "online", "parameters": [ { "name": "PreviewType", "type": "integer", "required": true, "description": "预览类型，1：源数据预览；2：导出结果预览。", "example": "1" }, { "name": "KafkaType", "type": "integer", "required": true, "description": "导入Kafka类型，0：腾讯云CKafka；1：用户自建Kafka。", "example": "1" }, { "name": "UserKafkaTopics", "type": "string", "required": true, "description": "用户需要导入的Kafka相关topic列表，多个topic之间使用半角逗号隔开。 最多支持100个。", "example": "topic_111b1f24-1ce6-45a3-a515-6e293429f111,topic_11161155-0ea3-4e53-9626-72b4837a4111,topic_111f125e-86f6-41c9-9dcc-360594290111" }, { "name": "Offset", "type": "integer", "required": true, "description": "导入数据位置，-2：最早；-1：最晚。", "example": "-1" }, { "name": "KafkaInstance", "type": "string", "required": false, "description": "腾讯云CKafka实例ID，当KafkaType为0时参数KafkaInstance有效且必填。 - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。", "example": "ckafka-k9m5vj11" }, { "name": "ServerAddr", "type": "string", "required": false, "description": "服务地址。 KafkaType为1时ServerAddr必填。", "example": "192.168.0.1:9095或test.cls.tencentyun.com:9095" }, { "name": "IsEncryptionAddr", "type": "boolean", "required": false, "description": "ServerAddr是否为加密连接。 KafkaType为1时有效。", "example": "true" }, { "name": "Protocol", "type": "object", "required": false, "description": "加密访问协议。 KafkaType为1并且IsEncryptionAddr为true时Protocol必填。", "example": "无", "children": [ { "name": "Protocol", "type": "string", "required": false, "description": "协议类型，支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl，此协议会进行连接加密同时需要用户认证。 - 当IsEncryptionAddr为true时，Protocol必填。 - 支持的协议类型如下： - plaintext：纯文本无加密协议 - sasl_ssl：SASL 认证 + SSL 加密 - ssl：纯 SSL/TLS 加密协议 - sasl_plaintext：SASL 认证 + 非加密通道", "example": "sasl_ssl" }, { "name": "Mechanism", "type": "string", "required": false, "description": "加密类型，支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。 - 当Protocol为 `sasl_plaintext` 或 `sasl_ssl` 时 Mechanism 必填。 - 支持加密类型如下 - PLAIN：明文认证 - SCRAM-SHA-256：基于挑战-响应机制，使用PBKDF2-HMAC-SHA256算法 - SCRAM-SHA-512：增强版SCRAM，使用PBKDF2-HMAC-SHA512算法", "example": "PLAIN" }, { "name": "UserName", "type": "string", "required": false, "description": "用户名。 当Protocol为sasl_plaintext或sasl_ssl时必填", "example": "name" }, { "name": "Password", "type": "string", "required": false, "description": "用户密码。 当Protocol为sasl_plaintext或sasl_ssl时必填", "example": "axxxxxx" } ] }, { "name": "ConsumerGroupName", "type": "string", "required": false, "description": "用户Kafka消费组。 - 消费组是 Kafka 提供的可扩展且具有容错性的消费者机制，一个消费组中存在多个消费者，组内的所有消费者共同消费订阅 Topic 中的消息。一个消费者可同时消费多个 Partition，但一个 Partition 只能被消费组内的一个消费者消费。", "example": "webevent_log-group" }, { "name": "LogRechargeRule", "type": "object", "required": false, "description": "日志导入规则", "example": "无", "children": [ { "name": "RechargeType", "type": "string", "required": true, "description": "导入类型，支持json_log：json格式日志，minimalist_log: 单行全文，fullregex_log: 单行完全正则", "example": "json_log" }, { "name": "EncodingFormat", "type": "integer", "required": true, "description": "解析编码格式，0: UTF-8（默认值），1: GBK", "example": "0" }, { "name": "DefaultTimeSwitch", "type": "boolean", "required": true, "description": "使用默认时间状态。true：开启后将使用系统当前时间或 Kafka 消息时间戳作为日志时间戳；false：关闭将使用日志中的时间字段作为日志时间戳。 默认：true", "example": "true" }, { "name": "LogRegex", "type": "string", "required": false, "description": "整条日志匹配规则，只有RechargeType为fullregex_log时有效", "example": "(\\\\w+).*" }, { "name": "UnMatchLogSwitch", "type": "boolean", "required": false, "description": "解析失败日志是否上传，true表示上传，false表示不上传", "example": "true" }, { "name": "UnMatchLogKey", "type": "string", "required": false, "description": "解析失败日志的键名称", "example": "LogParseFailure" }, { "name": "UnMatchLogTimeSrc", "type": "integer", "required": false, "description": "解析失败日志时间来源，0: 系统当前时间，1: Kafka消息时间戳", "example": "1" }, { "name": "DefaultTimeSrc", "type": "integer", "required": false, "description": "默认时间来源，0: 系统当前时间，1: Kafka消息时间戳", "example": "0" }, { "name": "TimeKey", "type": "string", "required": false, "description": "时间字段，日志中代表时间的字段名。 - 当DefaultTimeSwitch为false，且RechargeType数据提取模式为 `json_log` JSON-文件日志 或 `fullregex_log` 单行完全正则-文件日志时， TimeKey不能为空。", "example": "__TIMESTAMP__" }, { "name": "TimeRegex", "type": "string", "required": false, "description": "时间提取正则表达式。 - 当DefaultTimeSwitch为false，且RechargeType数据提取模式为 `minimalist_log` 单行全文-文件日志时， TimeRegex不能为空。 - 仅需输入日志中代表时间的字段的正则表达式即可；若匹配到多个字段，将使用第一个。 例：日志原文为：message with time 2022-08-08 14:20:20，则您可以设置提取时间正则为\\d\\d\\d\\d-\\d\\d-\\d\\d \\d\\d:\\d\\d:\\d\\d", "example": "(\\d{4})-(\\d{2})-(\\d{2}) (\\d{2}):(\\d{2}):(\\d{2})" }, { "name": "TimeFormat", "type": "string", "required": false, "description": "时间字段格式。 - 当DefaultTimeSwitch为false时， TimeFormat不能为空。", "example": "%Y-%m-%d %H:%M:%S" }, { "name": "TimeZone", "type": "string", "required": false, "description": "时间字段时区。 - 当DefaultTimeSwitch为false时， TimeZone不能为空。 - 时区格式规则 ​前缀​：使用 GMT 或 UTC 作为时区基准 ​偏移量​： - `-` 表示西时区（比基准时间晚） - `+` 表示东时区（比基准时间早） - 格式为 ±HH:MM（小时:分钟） - 当前支持： ``` \"GMT-12:00\" \"GMT-11:00\" \"GMT-10:00\" \"GMT-09:30\" \"GMT-09:00\" \"GMT-08:00\" \"GMT-07:00\" \"GMT-06:00\" \"GMT-05:00\" \"GMT-04:00\" \"GMT-03:30\" \"GMT-03:00\" \"GMT-02:00\" \"GMT-01:00\" \"GM...", "example": "UTC+08:00" }, { "name": "Metadata", "type": "array", "required": false, "description": "元数据信息，Kafka导入支持kafka_topic,kafka_partition,kafka_offset,kafka_timestamp", "example": "[\"kafka_topic\",\"kafka_partition\",\"kafka_offset\",\"kafka_timestamp\"]", "item_type": "string" }, { "name": "Keys", "type": "array", "required": false, "description": "日志Key列表，RechargeType为full_regex_log、delimiter_log时必填", "example": "[\"name\",\"address\"]", "item_type": "string" }, { "name": "ParseArray", "type": "boolean", "required": false, "description": "json解析模式，开启首层数据解析", "example": "false" }, { "name": "Delimiter", "type": "string", "required": false, "description": "分隔符解析模式-分隔符 当解析格式为分隔符提取时，该字段必填", "example": "," } ] }, { "name": "UserKafkaMeta", "type": "object", "required": false, "description": "用户kafka拓展信息", "example": "无", "children": [ { "name": "KafkaVersion", "type": "string", "required": true, "description": "用户kafka version 支持如下版本： - 0.10.2.0 - 1.0.0 - 2.0.0 - 2.2.0 - 2.4.0 - 2.6.0 - 2.7.0 - 2.8.0 - 3.0.0 - 3.2.0", "example": "2.0.0" } ] } ], "required": [ "PreviewType", "KafkaType", "UserKafkaTopics", "Offset" ] }, { "name": "QueryMetric", "description": "查询指定时刻指标的最新值。 如果该时刻向前推5分钟内均无指标数据，则无相应的查询结果。", "status": "online", "parameters": [ { "name": "Query", "type": "string", "required": true, "description": "查询语句，使用PromQL语法 - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档", "example": "access_evaluation_duration_bucket" }, { "name": "TopicId", "type": "string", "required": true, "description": "指标主题ID - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "8e7c3bd9-ef13-4981-xxxx-207971e1f80f" }, { "name": "Time", "type": "integer", "required": false, "description": "查询时间，秒级Unix时间戳。为空时代表当前时间戳。", "example": "1695197431" } ], "required": [ "Query", "TopicId" ] }, { "name": "QueryRangeMetric", "description": "查询指定时间范围内指标的变化趋势", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "指标主题ID - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "8e7c3bd9-ef13-4981-xxxx-207971e1f80f" }, { "name": "Query", "type": "string", "required": true, "description": "查询语句，使用PromQL语法 - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档", "example": "access_evaluation_duration_bucket" }, { "name": "Start", "type": "integer", "required": true, "description": "查询起始时间，秒级Unix时间戳", "example": "1695193830" }, { "name": "End", "type": "integer", "required": true, "description": "查询结束时间，秒级Unix时间戳", "example": "1695197431" }, { "name": "Step", "type": "integer", "required": true, "description": "查询时间间隔，单位秒", "example": "15" } ], "required": [ "TopicId", "Query", "Start", "End", "Step" ] }, { "name": "RetryShipperTask", "description": "重试失败的投递任务", "status": "online", "parameters": [ { "name": "ShipperId", "type": "string", "required": true, "description": "投递规则Id。 - 通过 [获取投递任务列表](https://cloud.tencent.com/document/product/614/58745)获取ShipperId。", "example": "57f5808c-4a55-11eb-b378-0242ac130002" }, { "name": "TaskId", "type": "string", "required": true, "description": "投递任务Id。 - 通过 [获取投递任务列表](https://cloud.tencent.com/document/product/614/58745) 获取TaskId。", "example": "6ef60bec-0242-43af-bb20-270359fb54a7" } ], "required": [ "ShipperId", "TaskId" ] }, { "name": "SearchCosRechargeInfo", "description": "本接口用于预览cos导入信息", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题Id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "ae13f7db-00b5-41ac-916e-407802axxxxx" }, { "name": "LogsetId", "type": "string", "required": true, "description": "日志集Id。 - 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。", "example": "0af7e6bb-fc91-4ee8-ad24-1129e9cxxxxx" }, { "name": "Name", "type": "string", "required": true, "description": "COS导入任务名称,最大支持128个字节。", "example": "cos导入任务" }, { "name": "Bucket", "type": "string", "required": true, "description": "COS存储桶，详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。 - 通过[GET Service（List Buckets）](https://cloud.tencent.com/document/product/436/8291)获取COS存储桶。", "example": "examplebucket-1-1250000000" }, { "name": "BucketRegion", "type": "string", "required": true, "description": "COS存储桶所在地域，详见产品支持的[地域列表](https://cloud.tencent.com/document/product/436/6224)。", "example": "ap-guangzhou" }, { "name": "Prefix", "type": "string", "required": false, "description": "COS文件所在文件夹的前缀。默认为空，投递存储桶下所有的文件。", "example": "var/xxx" }, { "name": "Compress", "type": "string", "required": false, "description": "压缩模式: \"\", \"gzip\", \"lzop\", \"snappy\"。 默认：\"\" 不压缩", "example": "gzip" } ], "required": [ "TopicId", "LogsetId", "Name", "Bucket", "BucketRegion" ] }, { "name": "SearchDashboardSubscribe", "description": "此接口用于预览仪表盘订阅", "status": "online", "parameters": [ { "name": "DashboardId", "type": "string", "required": true, "description": "仪表盘id。通过 [获取仪表盘](https://cloud.tencent.com/document/api/614/95636)接口获取DashboardId。", "example": "dashboard-e7497a78-667f-45ee-b785-4ac8fca05dc6" }, { "name": "SubscribeData", "type": "object", "required": true, "description": "仪表盘订阅数据。", "example": "无", "children": [ { "name": "NoticeModes", "type": "array", "required": true, "description": "仪表盘订阅通知方式。", "example": "无", "item_type": "object", "children": [ { "name": "ReceiverType", "type": "string", "required": true, "description": "仪表盘通知方式。 - Uin：腾讯云用户 - Group：腾讯云用户组 - WeCom：企业微信回调 - Email：自定义邮件 - DingTalk：钉钉 - Lark：飞书", "example": "Uin" }, { "name": "Values", "type": "array", "required": false, "description": "知方式对应的值。 - 当ReceiverType为：`WeCom`、`DingTalk`、`Lark` 时，Values必须为空，且Url字段必填。 - 当ReceiverType为：`Uin`、`Group`、`Email` 时，Values必填，且Url字段必须为空。 - 当ReceiverType为：`Uin ` 时，Values为用户id，通过 [拉取子用户](https://cloud.tencent.com/document/product/598/34587) 获取子用户 UID 。 - 当ReceiverType为：`Group` 时，Values为用户组id，通过 [查询用户组列表](https://cloud.tencent.com...", "example": "[\"168053\",\"1\"]", "item_type": "string" }, { "name": "ReceiverChannels", "type": "array", "required": false, "description": "仪表盘通知渠道。 - 支持：[\"Email\",\"Sms\",\"WeChat\",\"Phone\"]。 - 当ReceiverType为 `Email` 或 `WeCom` 时，ReceiverChannels无效。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"Email\",\"Sms\",\"WeChat\",\"Phone\"]", "item_type": "string" }, { "name": "Url", "type": "string", "required": false, "description": "订阅方式 - 回调地址。 - 当ReceiverType为：`WeCom`、`DingTalk`、`Lark` 时，Url字段必填为各渠道的回调地址。 - 为：`WeCom` 时，Url为 企业微信回调地址。 - 为：`DingTalk` 时，Url为 钉钉机器人Webhook地址。 - 为：`Lark` 时，Url为 飞书机器人Webhook地址。 - 当ReceiverType为：`Uin`、`Group`、`Email` 时，Url字段必须为空。", "example": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=ctestea1a5-7xx9-4xx3-8xxb-w5fxxbd6" } ] }, { "name": "DashboardTime", "type": "array", "required": false, "description": "仪表盘订阅时间，为空标识取仪表盘默认的时间。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"now-5m\",\"now\"]", "item_type": "string" }, { "name": "TemplateVariables", "type": "array", "required": false, "description": "仪表盘订阅模板变量。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "key的值", "example": "TopicId" }, { "name": "Values", "type": "array", "required": true, "description": "key对应的values取值values", "example": "[\"xxxx-xxxx-xxxx-xxxx\",\"123414-12341234-12345-3456\"]", "item_type": "string" } ] }, { "name": "Timezone", "type": "string", "required": false, "description": "时区。参考：https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#SHANGHAI", "example": "Asia/Shanghai" }, { "name": "SubscribeLanguage", "type": "string", "required": false, "description": "语言。 zh 中文、en`英文。", "example": "zh" }, { "name": "JumpDomain", "type": "string", "required": false, "description": "调用链接域名。http:// 或者 https:// 开头，不能/结尾", "example": "https://console.cloud.tencent.com" }, { "name": "JumpUrl", "type": "string", "required": false, "description": "自定义跳转链接。", "example": "https://www.xxx.com/getxxx" } ] }, { "name": "Id", "type": "integer", "required": false, "description": "仪表盘订阅Id。通过 [获取仪表盘订阅列表](https://cloud.tencent.com/document/api/614/105779)接口获取Id。", "example": "10001" }, { "name": "Name", "type": "string", "required": false, "description": "仪表盘订阅名称。通过 [获取仪表盘订阅列表](https://cloud.tencent.com/document/api/614/105779)接口获取Name。", "example": "仪表盘-CLS-日报" } ], "required": [ "DashboardId", "SubscribeData" ] }, { "name": "SearchLog", "description": "本接口用于检索分析日志，使用该接口时请注意如下事项： 1. 该接口除受默认接口请求频率限制外，针对单个日志主题，查询并发数不能超过15。 2. 检索语法建议使用日志服务专用检索语法CQL，请使用SyntaxRule参数，将值设置为1，控制台默认也使用该语法规则。 3. API返回数据包最大49MB，建议启用 gzip 压缩（HTTP Request Header Accept-Encoding:gzip）。", "status": "online", "parameters": [ { "name": "From", "type": "integer", "required": true, "description": "要检索分析的日志的起始时间，**Unix时间戳（毫秒）**", "example": "1608794854000" }, { "name": "To", "type": "integer", "required": true, "description": "要检索分析的日志的结束时间，**Unix时间戳（毫秒）**", "example": "1608794855000" }, { "name": "Query", "type": "string", "required": true, "description": "检索分析语句，最大长度为12KB 语句由 [检索条件] | [SQL语句]构成，无需对日志进行统计分析时，可省略其中的管道符 | 及SQL语句 使用*或空字符串可查询所有日志", "example": "http_status:200" }, { "name": "SyntaxRule", "type": "integer", "required": false, "description": "检索语法规则，默认值为0，推荐使用1 。 - 0：Lucene语法 - 1：CQL语法（CLS Query Language，日志服务专用检索语法） ⚠️⚠️ **注意** **该参数值建议设置为 1，使用 CQL 语法规则，控制台日志检索及仪表盘默认均使用该语法规则。** 该参数值未指定或者为 0 时，将使用 Lucene 语法，语法容易报错且查询结果与控制台默认语法规则不一致。详细说明参见检索条件语法规则。", "example": "1" }, { "name": "TopicId", "type": "string", "required": false, "description": "- 要检索分析的日志主题ID，仅能指定一个日志主题。 - 如需同时检索多个日志主题，请使用Topics参数。 - TopicId 和 Topics 不能同时使用，在一次请求中有且只能选择一个。", "example": "682d0718-07bb-4ec0-9fda-f1e9a2767e0b" }, { "name": "Topics", "type": "array", "required": false, "description": "- 要检索分析的日志主题列表，最大支持50个日志主题。 - 检索单个日志主题时请使用TopicId。 - TopicId 和 Topics 不能同时使用，在一次请求中有且只能选择一个。", "example": "无", "item_type": "object", "children": [ { "name": "TopicId", "type": "string", "required": false, "description": "要检索分析的日志主题ID", "example": "682d0718-07bb-4ec0-xxxx-f1e9a2767e0b" }, { "name": "Context", "type": "string", "required": false, "description": "透传上次接口返回的Context值，可获取后续更多日志，总计最多可获取1万条原始日志，过期时间1小时", "example": "Y29udGV4dC04MjMzNWRkMi01YmMxLTQ4NGYtYjQ4MS04MDg0NzAwYjQ1NDUxNjcy" } ] }, { "name": "Sort", "type": "string", "required": false, "description": "原始日志是否按时间排序返回；可选值：asc(升序)、desc(降序)，默认为 desc 注意： * 仅当检索分析语句(Query)不包含SQL时有效 * SQL结果排序方式参考SQL ORDER BY语法", "example": "asc" }, { "name": "Limit", "type": "integer", "required": false, "description": "表示单次查询返回的原始日志条数，默认为100，最大值为1000。 注意： * 仅当检索分析语句(Query)不包含SQL时有效 * SQL结果条数指定方式参考SQL LIMIT语法 可通过两种方式获取后续更多日志： * Context:透传上次接口返回的Context值，获取后续更多日志，总计最多可获取1万条原始日志 * Offset:偏移量，表示从第几行开始返回原始日志，无日志条数限制", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询原始日志的偏移量，表示从第几行开始返回原始日志，默认为0。 注意： * 仅当检索分析语句(Query)不包含SQL时有效 * 不能与Context参数同时使用 * 仅适用于单日志主题检索", "example": "0" }, { "name": "Context", "type": "string", "required": false, "description": "透传上次接口返回的Context值，可获取后续更多日志，总计最多可获取1万条原始日志，过期时间1小时。 注意： * 透传该参数时，请勿修改除该参数外的其它参数 * 仅适用于单日志主题检索，检索多个日志主题时，请使用Topics中的Context * 仅当检索分析语句(Query)不包含SQL时有效，SQL获取后续结果参考SQL LIMIT语法", "example": "Y29udGV4dC04MjMzNWRkMi01YmMxLTQ4NGYtYjQ4MS04MDg0NzAwYjQ1NDUxNjcy" }, { "name": "SamplingRate", "type": "float", "required": false, "description": "执行统计分析（Query中包含SQL）时，是否对原始日志先进行采样，再进行统计分析。 0：自动采样; 0～1：按指定采样率采样，例如0.02; 1：不采样，即精确分析 默认值为1", "example": "0.1" }, { "name": "UseNewAnalysis", "type": "boolean", "required": false, "description": "为true代表使用新的检索结果返回方式，输出参数AnalysisRecords和Columns有效 为false时代表使用老的检索结果返回方式, 输出AnalysisResults和ColNames有效 两种返回方式在编码格式上有少量区别，建议使用true", "example": "false" }, { "name": "HighLight", "type": "boolean", "required": false, "description": "是否高亮符合检索条件的关键词，一般用于高亮显示。仅支持键值检索，不支持全文检索", "example": "false" } ], "required": [ "From", "To", "Query" ] }, { "name": "SendConsumerHeartbeat", "description": "消费组心跳", "status": "online", "parameters": [ { "name": "ConsumerGroup", "type": "string", "required": true, "description": "上报心跳的消费组标识", "example": "无" }, { "name": "Consumer", "type": "string", "required": true, "description": "上报心跳的消费者名称 （字母数字下划线，不允许数字、_开头， 长度小于256）", "example": "无" }, { "name": "LogsetId", "type": "string", "required": true, "description": "日志集ID", "example": "无" }, { "name": "TopicPartitionsInfo", "type": "array", "required": true, "description": "topic 分区信息", "example": "无", "item_type": "object", "children": [ { "name": "TopicID", "type": "string", "required": true, "description": "日志主题ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Partitions", "type": "array", "required": true, "description": "分区id列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "integer" } ] } ], "required": [ "ConsumerGroup", "Consumer", "LogsetId", "TopicPartitionsInfo" ] }, { "name": "SplitPartition", "description": "该接口已废弃，如需修改分区数量，请使用ModifyTopic接口。", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题Id - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "427bba81-e149-4a8b-bd0d-b2a412520d7b" }, { "name": "PartitionId", "type": "integer", "required": true, "description": "待分裂分区Id - 通过[获取分区列表](https://cloud.tencent.com/document/product/614/56470)获取待分裂分区Id。", "example": "1" }, { "name": "SplitKey", "type": "string", "required": false, "description": "分区切分的哈希key的位置，只在Number=2时有意义", "example": "key" }, { "name": "Number", "type": "integer", "required": false, "description": "分区分裂个数(可选)，默认等于2", "example": "2" } ], "required": [ "TopicId", "PartitionId" ] }, { "name": "UploadLog", "description": "## 提示 为了保障您日志数据的可靠性以及更高效地使用日志服务，建议您使用CLS优化后的接口[上传结构化日志](https://cloud.tencent.com/document/product/614/16873)。 同时我们给此接口专门优化定制了多个语言版本的SDK供您选择，SDK提供统一的异步发送、资源控制、自动重试、优雅关闭、感知上报等功能，使上报日志功能更完善，详情请参考[SDK采集](https://cloud.tencent.com/document/product/614/67...", "status": "online", "parameters": [ { "name": "TopicId", "type": "string", "required": true, "description": "日志主题id - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。", "example": "f6c4fa6f-xxxx-xxxx-8289-1ff6f77ed975" }, { "name": "CompressType", "type": "string", "required": false, "description": "压缩方法，目前支持 - lz4 - zstd", "example": "lz4" } ], "required": [ "TopicId" ] } ] }