UpdateDataPipeline - 更新数据流水线-云监控(CMS)-阿里云帮助中心

更新DataPipeline

接口说明

使用完整候选配置修改指定的数据流水线。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

PUT /workspace/{workspace}/datapipeline/{pipelineName} HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
workspace	string	是	工作空间名称	workspace-source
pipelineName	string	是	流水线名称	export-traces-to-prod

请求参数

名称	类型	必填	描述	示例值
body	object	否	更新配置
expectedVersion	integer	否	期望版本	3
kind	string	否	流水线类型	export
description	string	否	流水线描述	Export selected trace services to the target workspace.
source	object	否	数据源
type	string	否	数据源类型	traces-default
config	object	否	数据源配置
runMode	string	否	运行模式	continuous
startFrom	string	否	读取起点	latest
timeRange	object	否	回填时间范围
from	integer	否	开始时间	1722844800
to	integer	否	结束时间	1722848400
processors	array<object>	否	公共处理器
	array<object>	否	处理器
name	string	否	处理器名称	drop-health-check
type	string	否	处理器类型	filter
config	object	否	处理器配置
expression	string	否	过滤表达式	attributes["http.route"] != "/health"
fields	array	否	字段列表
	string	否	字段路径	attributes.password
script	string	否	SPL 脚本	* \| extend latency_ms = duration / 1000000
applications	array	否	应用列表
	string	否	应用名称	checkout-service
rules	array<object>	否	脱敏规则列表
	object	否	脱敏规则
mode	string	否	脱敏模式	keyword
types	array	否	内置敏感类型
	string	否	敏感类型	EMAIL
keys	array	否	敏感关键词
	string	否	关键词	password
maskChar	string	否	掩码字符	*
keepPrefix	integer	否	保留前缀长度	2
keepSuffix	integer	否	保留后缀长度	2
target	object	否	处理目标
workspace	string	否	目标工作空间	target-checkout-ws
selector	object	否	服务选择器
serviceNames	array	否	服务名称列表	["checkout-*","order-service"]
	string	否	服务名称模式	checkout-*
outputs	array<object>	否	命名输出
	array<object>	否	命名输出
name	string	否	输出名称	checkout_route
processors	array<object>	否	分支处理器
	array<object>	否	处理器
name	string	否	处理器名称	drop-health-check
type	string	否	处理器类型	filter
config	object	否	处理器配置
expression	string	否	过滤表达式	attributes["http.route"] != "/health"
fields	array	否	字段列表
	string	否	字段路径	attributes.password
script	string	否	SPL 脚本	* \| extend latency_ms = duration / 1000000
applications	array	否	应用列表
	string	否	应用名称	checkout-service
rules	array<object>	否	脱敏规则列表
	object	否	脱敏规则
mode	string	否	脱敏模式	keyword
types	array	否	内置敏感类型
	string	否	敏感类型	EMAIL
keys	array	否	敏感关键词
	string	否	关键词	password
maskChar	string	否	掩码字符	*
keepPrefix	integer	否	保留前缀长度	2
keepSuffix	integer	否	保留后缀长度	2
target	object	否	处理目标
workspace	string	否	目标工作空间	target-checkout-ws
selector	object	否	服务选择器
serviceNames	array	否	服务名称列表	["checkout-*","order-service"]
	string	否	服务名称模式	checkout-*
sinks	array<object>	否	输出目标
	object	否	输出目标
name	string	否	输出目标名称	error-archive
type	string	否	输出目标类型	logstore
project	string	否	SLS Project	customer-project
logstore	string	否	SLS Logstore	error-spans
datasets	array	否	Dataset 列表
	string	否	Dataset 名称	__UNNAMED__

返回参数

名称	类型	描述	示例值
	object	修改数据流水线响应
requestId	string	请求标识	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
pipeline	object	数据流水线
pipelineName	string	流水线名称	export-traces-to-prod
kind	string	流水线类型	export
description	string	流水线描述	Export selected trace services to the target workspace.
signalType	string	信号类型	traces
source	object	数据源
type	string	数据源类型	traces-default
config	object	数据源配置
runMode	string	运行模式	continuous
startFrom	string	读取起点	latest
timeRange	object	回填时间范围
from	integer	开始时间	1722844800
to	integer	结束时间	1722848400
processors	array<object>	公共处理器
	array<object>	处理器
name	string	处理器名称	drop-health-check
type	string	处理器类型	filter
config	object	处理器配置
expression	string	过滤表达式	attributes["http.route"] != "/health"
fields	array	字段列表
	string	字段路径	attributes.password
script	string	SPL 脚本	* \| extend latency_ms = duration / 1000000
applications	array	应用列表
	string	应用名称	checkout-service
rules	array<object>	脱敏规则列表
	object	脱敏规则
mode	string	脱敏模式	keyword
types	array	内置敏感类型
	string	敏感类型	EMAIL
keys	array	敏感关键词
	string	关键词	password
maskChar	string	掩码字符	*
keepPrefix	integer	保留前缀长度	2
keepSuffix	integer	保留后缀长度	2
target	object	处理目标
workspace	string	目标工作空间	target-checkout-ws
selector	object	服务选择器
serviceNames	array	服务名称列表	["checkout-*","order-service"]
	string	服务名称模式	checkout-*
outputs	array<object>	命名输出
	array<object>	命名输出
name	string	输出名称	checkout_route
processors	array<object>	分支处理器
	array<object>	处理器
name	string	处理器名称	drop-health-check
type	string	处理器类型	filter
config	object	处理器配置
expression	string	过滤表达式	attributes["http.route"] != "/health"
fields	array	字段列表
	string	字段路径	attributes.password
script	string	SPL 脚本	* \| extend latency_ms = duration / 1000000
applications	array	应用列表
	string	应用名称	checkout-service
rules	array<object>	脱敏规则列表
	object	脱敏规则
mode	string	脱敏模式	keyword
types	array	内置敏感类型
	string	敏感类型	EMAIL
keys	array	敏感关键词
	string	关键词	password
maskChar	string	掩码字符	*
keepPrefix	integer	保留前缀长度	2
keepSuffix	integer	保留后缀长度	2
target	object	处理目标
workspace	string	目标工作空间	target-checkout-ws
selector	object	服务选择器
serviceNames	array	服务名称列表	["checkout-*","order-service"]
	string	服务名称模式	checkout-*
sinks	array<object>	输出目标
	object	输出目标
name	string	输出目标名称	error-archive
type	string	输出目标类型	logstore
project	string	SLS Project	customer-project
logstore	string	SLS Logstore	error-spans
datasets	array	Dataset 列表
	string	Dataset 名称	__UNNAMED__
version	integer	配置版本	3
status	string	运行状态	Running
statusMessage	string	状态消息	Pipeline is running.
createTime	string	创建时间	2026-08-10T05:00:00Z
updateTime	string	更新时间	2026-08-10T05:10:00Z

示例

正常返回示例

JSON格式

{
  "requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "pipeline": {
    "pipelineName": "export-traces-to-prod",
    "kind": "export",
    "description": "Export selected trace services to the target workspace.",
    "signalType": "traces",
    "source": {
      "type": "traces-default",
      "config": {
        "runMode": "continuous",
        "startFrom": "latest",
        "timeRange": {
          "from": 1722844800,
          "to": 1722848400
        }
      }
    },
    "processors": [
      {
        "name": "drop-health-check",
        "type": "filter",
        "config": {
          "expression": "attributes[\"http.route\"] != \"/health\"",
          "fields": [
            "attributes.password"
          ],
          "script": "* | extend latency_ms = duration / 1000000",
          "applications": [
            "checkout-service"
          ],
          "rules": [
            {
              "mode": "keyword",
              "types": [
                "EMAIL"
              ],
              "keys": [
                "password"
              ],
              "maskChar": "*",
              "keepPrefix": 2,
              "keepSuffix": 2
            }
          ],
          "target": {
            "workspace": "target-checkout-ws"
          },
          "selector": {
            "serviceNames": [
              "checkout-*"
            ]
          }
        }
      }
    ],
    "outputs": [
      {
        "name": "checkout_route",
        "processors": [
          {
            "name": "drop-health-check",
            "type": "filter",
            "config": {
              "expression": "attributes[\"http.route\"] != \"/health\"",
              "fields": [
                "attributes.password"
              ],
              "script": "* | extend latency_ms = duration / 1000000",
              "applications": [
                "checkout-service"
              ],
              "rules": [
                {
                  "mode": "keyword",
                  "types": [
                    "EMAIL"
                  ],
                  "keys": [
                    "password"
                  ],
                  "maskChar": "*",
                  "keepPrefix": 2,
                  "keepSuffix": 2
                }
              ],
              "target": {
                "workspace": "target-checkout-ws"
              },
              "selector": {
                "serviceNames": [
                  "checkout-*"
                ]
              }
            }
          }
        ]
      }
    ],
    "sinks": [
      {
        "name": "error-archive",
        "type": "logstore",
        "project": "customer-project",
        "logstore": "error-spans",
        "datasets": [
          "__UNNAMED__"
        ]
      }
    ],
    "version": 3,
    "status": "Running",
    "statusMessage": "Pipeline is running.",
    "createTime": "2026-08-10T05:00:00Z",
    "updateTime": "2026-08-10T05:10:00Z"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。