接口功能介绍

根据采集配置名称获取采集配置

接口约束

无

URI

GET /v1/collectorRule/getRuleConfigByName

路径参数 无

Query参数

请求参数

请求头header参数

请求体body参数 无

响应参数

| {env2: value2} | | | containers | Object | 容器场景下，配置容器过滤等配置 | | ContainerCollectRuleSchema | | topicType | String | 日志主题类型。none: 无，如果定义了类型，但是TopicFormat格式错误，会忽略日志主题，使用none；filepath: 从日志采集路径里正则匹配提取；custom：自定义，TopicFormat为定义的值 | | | | topicFormat | String | 当TopicType为filepath，需定义为日志路径提取的正则表达式； 当TopicType为custom，则允许自定义字符串。 | | | | enableStdout | Boolean | 是否开启标准输出，默认true | true | | | enableStderr | Boolean | 是否开启标准错误，默认true | true | | | tailSize | String | 回采日志大小，单位KB；最小值为0，最大值为10485760 | 1024 | | | keepSourceWhenParseFail | Boolean | 解析失败是否保留日志原文，默认true | | | | keepSourceWhenParseSucceed | String | 解析成功时是否保留源字段，默认true | | | | logFilterVo | Object | 日志过滤信息 | | LogFilterVo | 表 LogFilterVo

        '$status $bytes_sent $body_bytes_sent $http_referer ' aa
        '$http_user_agent $http_transfer_encoding $http_x_forwarded_for'; |  |

| regexStr | String | 提取正则 | (\S+)\s*-\s*(\S+)\s*[(\d+\S+\d+:\d+:\d+:\d+)\s+\S+]\s*(\S+)\s+(\S+)\s+\S+\s*(\S+)\s*(\S+)\s*(\S+)\s*([^])\s([^])\s(\S+)\s*([0-9a-zA-Z.:, -]). | | | eg | String | 日志原文示例 | 192.168.1.100 - - [27/Nov/2024:12:00:00 +0000] GET /index.html HTTP/1.1 200 1234 1234 http://www.example.com/ Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36 chunked 192.168.2.1 | | | logContent | Array of Objects | 日志提取内容。参考 TypeContent | | TypeContent | 表 TypeContent

枚举参数

无

请求示例

请求url

GET https://[endpoint]/v1/collectorRule/getRuleConfigByName?ruleName=rule001&unitCode=b0d0e6d887611c

请求头header

regionId:20000000***1852

请求体body

无

响应示例

{
    "statusCode": 0,
    "error": null,
    "requestId": "83382a7d-28624ff77",
    "message": "成功",
    "returnObj": {
		"enable": true,
        "unitCode": "9725******b0ce",
        "ruleName": "servicerule,
        "ruleAliasName": "servicerule",
        "ruleCode": "0eced******ac205",
        "extractMode": 1,
        "logPaths": [
            "/root/zhl/testjson.log"
        ],
        "cuttingMode": "5",
        "ruleConfig": {
            "excludeFilePaths": [],
            "excludeFiles": [],
            "excludeDirs": [],
            "maxPathDepth": 5,
            "fileEncoding": "UTF8",
            "delimiter": {},
            "regex": {},
            "nginxTemplate": {
                "nginxLogConf": "",
                "regexStr": "",
                "eg": "",
                "logContent": []
            },
            "dynamicK8sLabels": {},
            "dynamicK8sEnv": {},
            "logFilterVo": {
                "include": {},
                "exclude": {}
            },
            "topicType": "none",
            "topicFormat": "",
            "enableStdout": true,
            "enableStderr": true,
            "tailSize": 1024,
            "keepSourceWhenParseFail": true,
            "keepSourceWhenParseSucceed": false
        },
        "accessType": 10,
        "createTime": "2025-06-18 19:14:35"
    }
}

状态码

请参考 状态码

错误码

请参考 错误码