修改 Pipeline 规则¶

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

概述¶

修改一个Pipeline

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

路由参数¶

参数名	类型	必选	说明
pl_uuid	string	Y	Pipeline的ID

Body 请求参数¶

参数名	类型	必选	说明
name	string	Y	Pipeline文件名称，也是其source类型值允许为空: False 最大长度: 256 $notSearchRegExp: [^a-zA-Z0-9_\u4e00-\u9fa5-]+
type	string	Y	Pipeline文件类型允许为空: False 可选值: ['local', 'central']
source	array		选取的source列表允许为空: False
content	string	Y	pipeline文件内容(base64编码) 允许为空: False
testData	string		测试数据(base64编码) 允许为空: False 允许为空字符串: True
isForce	boolean		具体类型存在default时, 是否进行替换允许为空: False
asDefault	int		是否作为该类型的默认pipeline, 1为设为默认允许为空: False
category	string	Y	类别允许为空: False 允许为空字符串: False 可选值: ['logging', 'object', 'custom_object', 'network', 'tracing', 'rum', 'security', 'keyevent', 'metric', 'profiling', 'dialtesting', 'billing']
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":"W10=","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"
}