変更¶

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

概要¶

Pipeline を変更します

カテゴリが 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 エンコードして渡すと、デコード後のトップレベルがオブジェクトであり配列ではないため、不正となります。
空文字列不可: 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"
}