接口功能介绍

获取采集规则分页列表

接口约束

无

URI

GET /v1/collectorRule/page

路径参数 无

Query参数

参数	是否必填	参数类型	说明	示例
unitCode	是	String	单元ID，可从单元列表获取	d0512b90e44992
ruleCode	否	String	采集规则编码，可从采集规则列表获取	776a7b1c2845a1
ruleName	否	String	可根据采集规则名称和原始名称模糊匹配	test-rule
pageNum	是	Integer	页码	1
pageSize	是	Integer	每页记录数	10

请求参数

请求头header参数

参数	是否必填	参数类型	说明	示例	下级对象
regionId	是	String	资源池编码，请参考资源池列表	20000000***1852

请求体body参数 无

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	响应状态码。0：代表正常；-1：代表严重错误；-2：代表普通错误	0
error	String	业务错误码，仅错误时返回，例LTS_XXXX	LTS_0001
message	String	请求响应信息	成功
requestId	String	请求ID	3e31ebb2-572e5408e
returnObj	Object	规则分页列表		data
表 data

参数	参数类型	说明	示例	下级对象
unitCode	String	单元ID	1b7cd64377bd7
ruleName	String	采集规则原始名称	lmtagent
ruleCode	String	采集规则编码	d9b051ed09467de2
extractMode	Byte	采集类型，1：云主机-文本日志；2：云容器引擎-标准输出；3：云容器引擎-文本日志；4：syslog-协议; 5: 物理机-文本日志	1
logPaths	Array of Strings	采集路径	["/app"]
cuttingMode	String	切割模式，不同模式对应其他参数不同。1：单行正则；2：分隔符；3：多行正则；4：单行全文；5：json；6：多行全文	4
ruleConfig	Object	采集规则高级配置		RuleConfig
accessType	Byte	接入类型。1：ccse；2：msap；3：csm；4：faas；5：msegw；6：ctgcache；7：kafka；8：mq2；9：amqp；10：host；11：mqtt；12：ebm；13：rcc	10
createTime	String	创建时间	2024-08-23 15:55:07
collectPolicy	String	采集策略。all：全量采集；add：增量采集	all
表 RuleConfig

参数	参数类型	说明	示例	下级对象
maxPathDepth	Integer	当采集路径中带""通配符时，该参数用于指定""通配符最大解析深度	5
excludeFilePaths	Array of Strings	文件路径黑名单(排除文件路径符合条件的文件；必须为绝对路径)	["/app/cams/lmtagent/test/out.log"]
excludeFiles	Array of Strings	文件黑名单(排除文件名符合条件的文件；必须为文件名，不包含路径)	["info.log"]
excludeDirs	Array of Strings	目录黑名单(排除文件所在目录符合条件的文件；必须为绝对路径)	["/app/cams/lmtagent/access"]
delimiter	Object	分隔符，当切割模式为分隔符时返回		DelimiterObj
regex	String	正则切割模式：当切割模式为正则时返回		RegexObj
表 DelimiterObj

参数	参数类型	说明	下级对象
delimiter	String	分隔符
logContent	Array of Objects	分割所得类型字段，输入顺序会被使用	DelimiterLogContent
表 RegexObj

参数	参数类型	说明	示例	下级对象
regexStr	String	正则表达式	^\[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\]
logContent	Array of Objects	分割所得类型字段，输入顺序会被使用		RegexLogContent
表 DelimiterLogContent

参数	参数类型	说明	示例
key	String	提取字段	time
type	String	数据类型。text：字符串；double：数字	text
表 RegexLogContent

参数	参数类型	说明	示例	下级对象
key	String	提取字段	time
type	String	数据类型。text：字符串；double：数字	text

枚举参数

无

请求示例

请求url

GET https://[endpoint]/v1/hostGroup/ecsPageList/v1/collectorRule/page?unitCode=d0512b90e44992&pageNum=1&pageSize=10

请求头header

regionId:20000000***1852

请求体body

无

响应示例

{
    "statusCode": 0,
    "requestId": "de71ecda-f722a65cb",
    "error": null,
    "message": null,
    "returnObj": {
        "total": 1,
        "list": [
            {
                "unitCode": "1b7cd64377bd75",
                "ruleName": "lmtagent-plugin",
                "ruleCode": "d9b051ed09467de2",
                "extractMode": 1,
                "logPaths": [
                    "/app/cams/lmtagent/*.LOG"
                ],
                "cuttingMode": "4",
                "ruleConfig": {
                    "maxPathDepth": 5,
                    "delimiter": {

                    },
                    "regex": {

                    },
                    "logFilterVo": {
                        "include": {

                        },
                        "exclude": {

                        }
                    }
                },
                "accessType": 10,
                "createTime": "2024-08-23 15:55:07",
                "collectPolicy": "add"
            }
        ]
    }
}

状态码

请参考状态码

错误码

请参考错误码

智算服务

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

云日志服务

云日志服务

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

智算服务

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

云日志服务

云日志服务

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码