GetDataPipeline - 查询数据流水线

更新时间:
复制 MD 格式

查询DataPipeline

接口说明

查询指定工作空间中一条数据流水线的配置与运行状态。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cms:GetDataPipeline

get

*DataPipeline

acs:cms:{#regionId}:{#accountId}:workspace/{#Workspace}/datapipeline/{#PipelineName}

无 无

请求语法

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

路径参数

名称

类型

必填

描述

示例值

workspace

string

是

工作空间名称

workspace-source

pipelineName

string

是

流水线名称

export-traces-to-prod

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称

类型

描述

示例值

object

查询数据流水线响应

pipeline

object

数据流水线

createTime

string

创建时间,采用 ISO 8601 格式的 UTC 时间,例如 2026-08-10T05:00:00Z。

2026-08-10T05:00:00Z

description

string

流水线描述

Export selected trace services to the target workspace.

kind

string

流水线类型

枚举值:

  • default :

    默认流水线

  • custom :

    自定义流水线

  • export :

    导出流水线

export

outputs

array<object>

命名输出

array<object>

命名输出

name

string

输出名称

checkout_route

processors

array<object>

分支处理器

array<object>

处理器

config

object

处理器配置

applications

array

应用列表

string

应用名称

checkout-service

assignments

array<object>

字段赋值列表

object

流水线字段赋值

expression

string

赋值表达式

duration / 1000000.0

field

string

输出字段

latency_ms

expression

string

过滤表达式

attributes["http.route"] != "/health"

fields

array

字段列表

string

字段路径

attributes.password

parameters

object

扩展参数

any

参数

{}

projections

array<object>

字段投影列表

object

流水线字段投影

source

string

源字段

serviceName

target

string

目标字段

service

rules

array<object>

脱敏规则列表

object

脱敏规则

keepPrefix

integer

保留前缀长度

2

keepSuffix

integer

保留后缀长度

2

keys

array

敏感关键词

string

关键词

password

maskChar

string

掩码字符

*

mode

string

脱敏模式

keyword

types

array

内置敏感类型

string

敏感类型

EMAIL

scope

object

流水线处理器生效范围

conditions

array<object>

额外字段条件

array<object>

字段条件

field

object

字段引用

container

string

JSON 对象容器

{}

kind

string

引用类型

枚举值:

  • field :

    普通字段

  • json :

    JSON 对象键路径

  • label :

    指标标签

label

name

string

字段或维度名称

azone

path

array

JSON 字面键路径

string

JSON 对象键

service.name

matchType

string

匹配方式

枚举值:

  • GLOB :

    通配符匹配

  • EXACT :

    精确匹配

EXACT

values

array

匹配值

string

匹配值

['cn-shanghai-a']

metricName

object

指标名称范围

matchType

string

匹配方式

EXACT

values

array

指标名称

["http_requests_total"]

string

对象值

['ECS']

serviceName

object

服务名称范围

matchType

string

匹配方式

枚举值:

  • GLOB :

    通配符匹配

  • EXACT :

    精确匹配

EXACT

values

array

匹配值

string

匹配值

['a','b']

script

string

SPL 脚本

* | extend latency_ms = duration / 1000000

selector

object

服务选择器

serviceNames

array

服务名称列表

["checkout-*","order-service"]

string

服务名称模式

checkout-*

target

object

处理目标

workspace

string

目标工作空间

target-checkout-ws

name

string

处理器名称

drop-health-check

type

string

处理器类型

filter

pipelineName

string

流水线名称

export-traces-to-prod

processors

array<object>

公共处理器

array<object>

处理器

config

object

处理器配置

applications

array

应用列表

string

应用名称

checkout-service

assignments

array<object>

字段赋值列表

object

流水线字段赋值

expression

string

赋值表达式

duration / 1000000.0

field

string

输出字段

latency_ms

expression

string

过滤表达式

attributes["http.route"] != "/health"

fields

array

字段列表

string

字段路径

attributes.password

parameters

object

扩展参数

any

参数

{}

projections

array<object>

字段投影列表

object

流水线字段投影

source

string

源字段

serviceName

target

string

目标字段

service

rules

array<object>

脱敏规则列表

object

脱敏规则

keepPrefix

integer

保留前缀长度

2

keepSuffix

integer

保留后缀长度

2

keys

array

敏感关键词

string

关键词

password

maskChar

string

掩码字符

*

mode

string

脱敏模式

keyword

types

array

内置敏感类型

string

敏感类型

EMAIL

scope

object

流水线处理器生效范围

conditions

array<object>

额外字段条件

array<object>

字段条件

field

object

字段引用

container

string

JSON 对象容器

{}

kind

string

引用类型

枚举值:

  • field :

    普通字段

  • json :

    JSON 对象键路径

  • label :

    指标标签

explorer_link

name

string

字段或维度名称

site_check_monitor

path

array

JSON 字面键路径

string

JSON 对象键

site.check.monitor

matchType

string

匹配方式

枚举值:

  • GLOB :

    通配符匹配

  • EXACT :

    精确匹配

EXACT

values

array

匹配值

string

匹配值

['E-MapReduce', 'ECS', 'HBR', 'kafka', 'tag']

metricName

object

指标名称范围

matchType

string

匹配方式

EXACT

values

array

指标名称

["http_requests_total"]

string

值

['admit']

serviceName

object

服务名称范围

matchType

string

匹配方式

枚举值:

  • GLOB :

    通配符匹配

  • EXACT :

    精确匹配

EXACT

values

array

匹配值

string

匹配值

['ECS']

script

string

SPL 脚本

* | extend latency_ms = duration / 1000000

selector

object

服务选择器

serviceNames

array

服务名称列表

["checkout-*","order-service"]

string

服务名称模式

checkout-*

target

object

处理目标

workspace

string

目标工作空间

target-checkout-ws

name

string

处理器名称

drop-health-check

type

string

处理器类型

filter

signalType

string

信号类型

traces

sinks

array<object>

输出目标

object

输出目标

datasets

array

Dataset 列表

string

Dataset 名称

__UNNAMED__

logstore

string

SLS Logstore

error-spans

name

string

输出目标名称

error-archive

project

string

SLS Project

customer-project

type

string

输出目标类型

logstore

source

object

数据源

config

object

数据源配置

runMode

string

运行模式

continuous

startFrom

string

读取起点

latest

timeRange

object

回填时间范围

from

integer

开始时间

1722844800

to

integer

结束时间

1722848400

type

string

数据源类型

traces-default

status

string

运行状态

枚举值:

  • Stopped :

    已停止

  • Running :

    运行中

  • Error :

    运行错误

  • Pending :

    处理中

Running

statusMessage

string

状态消息

Pipeline is running.

updateTime

string

更新时间,采用 ISO 8601 格式的 UTC 时间,例如 2026-08-10T05:10:00Z。

2026-08-10T05:10:00Z

version

integer

配置版本

3

requestId

string

请求标识

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

{
  "pipeline": {
    "createTime": "2026-08-10T05:00:00Z",
    "description": "Export selected trace services to the target workspace.",
    "kind": "export",
    "outputs": [
      {
        "name": "checkout_route",
        "processors": [
          {
            "config": {
              "applications": [
                "checkout-service"
              ],
              "assignments": [
                {
                  "expression": "duration / 1000000.0",
                  "field": "latency_ms"
                }
              ],
              "expression": "attributes[\"http.route\"] != \"/health\"",
              "fields": [
                "attributes.password"
              ],
              "parameters": {
                "key": "{}"
              },
              "projections": [
                {
                  "source": "serviceName",
                  "target": "service"
                }
              ],
              "rules": [
                {
                  "keepPrefix": 2,
                  "keepSuffix": 2,
                  "keys": [
                    "password"
                  ],
                  "maskChar": "*",
                  "mode": "keyword",
                  "types": [
                    "EMAIL"
                  ]
                }
              ],
              "scope": {
                "conditions": [
                  {
                    "field": {
                      "container": "{}",
                      "kind": "label",
                      "name": "azone",
                      "path": [
                        "service.name"
                      ]
                    },
                    "matchType": "EXACT",
                    "values": [
                      "['cn-shanghai-a']"
                    ]
                  }
                ],
                "metricName": {
                  "matchType": "EXACT",
                  "values": [
                    "['ECS']"
                  ]
                },
                "serviceName": {
                  "matchType": "EXACT",
                  "values": [
                    "['a','b']"
                  ]
                }
              },
              "script": "* | extend latency_ms = duration / 1000000",
              "selector": {
                "serviceNames": [
                  "checkout-*"
                ]
              },
              "target": {
                "workspace": "target-checkout-ws"
              }
            },
            "name": "drop-health-check",
            "type": "filter"
          }
        ]
      }
    ],
    "pipelineName": "export-traces-to-prod",
    "processors": [
      {
        "config": {
          "applications": [
            "checkout-service"
          ],
          "assignments": [
            {
              "expression": "duration / 1000000.0",
              "field": "latency_ms"
            }
          ],
          "expression": "attributes[\"http.route\"] != \"/health\"",
          "fields": [
            "attributes.password"
          ],
          "parameters": {
            "key": "{}"
          },
          "projections": [
            {
              "source": "serviceName",
              "target": "service"
            }
          ],
          "rules": [
            {
              "keepPrefix": 2,
              "keepSuffix": 2,
              "keys": [
                "password"
              ],
              "maskChar": "*",
              "mode": "keyword",
              "types": [
                "EMAIL"
              ]
            }
          ],
          "scope": {
            "conditions": [
              {
                "field": {
                  "container": "{}",
                  "kind": "explorer_link",
                  "name": "site_check_monitor",
                  "path": [
                    "site.check.monitor"
                  ]
                },
                "matchType": "EXACT",
                "values": [
                  "['E-MapReduce', 'ECS', 'HBR', 'kafka', 'tag']"
                ]
              }
            ],
            "metricName": {
              "matchType": "EXACT",
              "values": [
                "['admit']"
              ]
            },
            "serviceName": {
              "matchType": "EXACT",
              "values": [
                "['ECS']"
              ]
            }
          },
          "script": "* | extend latency_ms = duration / 1000000",
          "selector": {
            "serviceNames": [
              "checkout-*"
            ]
          },
          "target": {
            "workspace": "target-checkout-ws"
          }
        },
        "name": "drop-health-check",
        "type": "filter"
      }
    ],
    "signalType": "traces",
    "sinks": [
      {
        "datasets": [
          "__UNNAMED__"
        ],
        "logstore": "error-spans",
        "name": "error-archive",
        "project": "customer-project",
        "type": "logstore"
      }
    ],
    "source": {
      "config": {
        "runMode": "continuous",
        "startFrom": "latest",
        "timeRange": {
          "from": 1722844800,
          "to": 1722848400
        }
      },
      "type": "traces-default"
    },
    "status": "Running",
    "statusMessage": "Pipeline is running.",
    "updateTime": "2026-08-10T05:10:00Z",
    "version": 3
  },
  "requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

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

变更历史

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