接口功能介紹

根據采集配置名稱獲取采集配置

接口約束

無

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 //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 //[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"
    }
}

狀態碼

請參考

錯誤碼

請參考