Skip to content

Create Pipeline Rule¶

POST /api/v1/pipeline/add

Overview¶

Create a Pipeline

When the category type is profiling, the rule will only take effect if the field CentralPLServiceSwitch in the space configuration (returned by the /workspace/get interface) is true.

Body Request Parameters¶

Parameter Name	Type	Required	Description
name	string	Y	Pipeline file name Can be empty: False Maximum length: 256 $notSearchRegExp: [^a-zA-Z0-9_\u4e00-\u9fa5-]+
type	string	Y	Pipeline file type Can be empty: False Possible values: ['local', 'central']
source	array		Selected source list Can be empty: False
content	string	Y	Pipeline file content (base64 encoded) Can be empty: False
testData	string		Test data (base64 encoded) Can be empty: False Can be an empty string: True
dataType	string		Data type line_protocol-line protocol format; json-JSON format; message-Message Example: line_protocol Can be empty: False Can be an empty string: True Possible values: ['line_protocol', 'json', 'message']
isForce	boolean		If default exists for the specific type, whether to replace it Can be empty: False
category	string	Y	Category Can be empty: False Can be an empty string: False Possible values: ['logging', 'object', 'custom_object', 'network', 'tracing', 'rum', 'security', 'keyevent', 'metric', 'profiling', 'dialtesting', 'billing', 'keyevent']
asDefault	int		Whether to set this as the default pipeline for the type, 1 to set as default, 0 for not default Can be empty: False
enableByLogBackup	int		Enable Pipeline processing of forwarded data, 1 for enabled, 0 for disabled Can be empty: False
extend	json		Category Can be empty: False
extend.appID	array		appID Can be empty: True
extend.measurement	array		Source origin Can be empty: True
extend.loggingIndex	string		LOG index Can be empty: True

Supplementary Parameter Explanation¶

Request Example¶


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

Response¶


{
    "code": 200,
    "content": {
        "asDefault": 0,
        "category": "logging",
        "content": "YWRkX2tleShjaXR5LCAic2hhbmdoYWkiKQ==\n",
        "createAt": 1678026470,
        "creator": "xxxx",
        "deleteAt": -1,
        "extend": {},
        "id": null,
        "isSysTemplate": null,
        "name": "openapi_test",
        "status": 0,
        "testData": "W10=\n",
        "updateAt": 1678026470,
        "updator": "xxxx",
        "uuid": "pl_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-74509B6F-DE3D-4905-AC9F-4FD96ED78EC3"
}