PreviewDataPipeline - 预览流水线-云监控(CMS)-阿里云帮助中心

预览数据流水线

接口说明

编译候选配置，并查询指定时间窗口内按 Dataset 分组的只读样例。

调试

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

调试

授权信息

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

请求语法

POST /workspace/{workspace}/datapipeline/preview HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
workspace	string	是	工作空间名称	workspace-source

请求参数

名称	类型	必填	描述	示例值
body	object	否	预览配置
pipelineName	string	否	流水线名称	trace-archive-routing
kind	string	否	流水线类型	custom
description	string	否	流水线描述	Preview error span routing.
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__
fromTime	integer	否	预览开始时间	1784563200
toTime	integer	否	预览结束时间	1784566800

返回参数

名称	类型	描述	示例值
	object	预览数据流水线响应
requestId	string	请求标识	req-01j2example
effectiveScript	string	实际 SPL	* \| where status_code == "ERROR"
datasets	array<object>	Dataset 预览结果
	array<object>	Dataset 预览
name	string	Dataset 名称	error_spans
sampleCount	integer	样例数量	1
meta	array<object>	字段元数据
	object	字段元数据
name	string	字段名称	trace_id
type	string	字段类型	string
data	array<object>	预览数据
	object	预览样例行	{"trace_id":"4bf92f3577b34da6a3ce929d0e0e4736","status_code":"ERROR"}

示例

正常返回示例

JSON格式

{
  "requestId": "req-01j2example",
  "effectiveScript": "* | where status_code == \"ERROR\"",
  "datasets": [
    {
      "name": "error_spans",
      "sampleCount": 1,
      "meta": [
        {
          "name": "trace_id",
          "type": "string"
        }
      ],
      "data": [
        {
          "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
          "status_code": "ERROR"
        }
      ]
    }
  ]
}

错误码

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

变更历史

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