作成¶

POST /api/v1/pipeline/add

概要¶

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
| | category | string | Y | カテゴリ
空を許可: False
空文字列を許可: False
選択可能な値: ['logging', 'object', 'custom_object', 'network', 'tracing', 'rum', 'llm', 'agent_monitor', 'security', 'keyevent', 'metric', 'profiling', 'dialtesting', 'billing', 'keyevent']
| | asDefault | int | | このカテゴリのデフォルト Pipeline とするかどうか。1 はデフォルトに設定、0 はデフォルトではない
空を許可: False
| | enableByLogBackup | int | | 転送データの処理に Pipeline を有効にするかどうか。1 は有効、0 は無効
空を許可: False
| | 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/add' \
-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":"W3sibGV2ZWwiOiJpbmZvIiwibXNnIjoiSFRUUCJ9XQ==","source":["nsqlookupd"]}' \
--compressed

レスポンス¶

{
    "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"
}