修改¶

POST /api/v1/pipeline/{pl_uuid}/modify

概述¶

修改一个 Pipeline

当类型 category 为 profiling 时, 空间配置的字段 CentralPLServiceSwitch(/workspace/get 接口返回) 为 true 该规则才会实际生效

路由参数¶

Body 请求参数¶

生成方式： 1. 先准备测试样例数组； 2. 对数组执行 JSON.stringify； 3. 对得到的 UTF-8 字符串做 base64 编码后传入 testData。

常用示例： - 空样例数组：[] -> W10= - 单条 JSON 日志：[{"level":"info","msg":"HTTP"}] -> W3sibGV2ZWwiOiJpbmZvIiwibXNnIjoiSFRUUCJ9XQ== - 单条文本日志：["raw log line"] -> WyJyYXcgbG9nIGxpbmUiXQ==

非法示例：直接把 {"level":"info","msg":"HTTP"} 做 base64 后传入，因为解码后顶层是 object，不是数组。
允许为空: False
允许为空字符串: True
| | dataType | string | | 数据类型 line_protocol-行协议格式; json-JSON 格式; message-Message
例子: line_protocol
允许为空: False
允许为空字符串: True
可选值: ['line_protocol', 'json', 'message']
| | isForce | boolean | | 具体类型存在 default 时, 是否进行替换
允许为空: False
| | asDefault | int | | 是否作为该类型的默认 pipeline, 1为设为默认
允许为空: False
| | enableByLogBackup | int | | 启用 Pipeline 处理转发数据, 1为启用, 0为不启用
允许为空: False
| | category | string | Y | 类别
允许为空: False
允许为空字符串: False
可选值: ['logging', 'object', 'custom_object', 'network', 'tracing', 'rum', 'llm', 'agent_monitor', 'security', 'keyevent', 'metric', 'profiling', 'dialtesting', 'billing', 'keyevent']
| | extend | json | | 类别
允许为空: False
| | extend.appID | array | | appID
允许为空: True
| | extend.measurement | array | | source 来源
允许为空: True
| | extend.loggingIndex | string | | 日志索引
允许为空: True
|

参数补充说明¶

请求例子¶

curl 'https://openapi.guance.com/api/v1/pipeline/pl_xxxx32/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"name":"test_modify","category":"logging","asDefault":0,"content":"YWRkX2tleShjaXR5LCAic2hhbmdoYWkiKQ==","testData":"W3sibGV2ZWwiOiJpbmZvIiwibXNnIjoiSFRUUCJ9XQ==","source":["nsqlookupd"]}' \
--compressed

响应¶

{
    "code": 200,
    "content": {
        "asDefault": 0,
        "category": "logging",
        "content": "YWRkX2tleShjaXR5LCAic2hhbmdoYWkiKQ==\n",
        "createAt": 1678026470,
        "creator": "xxx",
        "deleteAt": -1,
        "extend": {},
        "id": 86,
        "isSysTemplate": 0,
        "name": "test_modify",
        "source": [],
        "status": 0,
        "testData": "W10=\n",
        "updateAt": 1678026808.95266,
        "updator": "xx",
        "uuid": "pl_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-1EA80DD4-EB2C-4A9B-A146-D00606CC50E0"
}