GetPipeline - 查询Pipeline

更新时间:
复制 MD 格式

查询流水线

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

agentloop:GetPipeline

none

*Pipeline

acs:agentloop:{#regionId}:{#accountId}:agentspace/{#AgentSpaceName}/pipeline/{#PipelineName}

无 无

请求语法

GET /agentspace/{agentSpace}/pipeline/{pipelineName} HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

agentSpace

string

否

AgentSpace 名称,定位流水线所在的 AgentSpace

my-agent-space

pipelineName

string

否

待查询的流水线名称

my-pipeline

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称

类型

描述

示例值

object

响应数据

committedWatermark

integer

已提交水位线,unix 秒

1735660800

createTime

string

流水线创建时间,ISO 8601 UTC 格式

2026-01-01T00:00:00Z

description

string

流水线描述

我的流水线

executePolicy

object

调度方式

{"mode":"RunOnce","runOnce":{"fromTime":1735660800,"toTime":1735664400}}

continuous

object

持续执行配置(type 为 trace 时使用;处理频率为服务端管理的固定值)

{"fromTime":1735660800}

fromTime

integer

bootstrap 历史起点,Unix 秒时间戳(与 runOnce/scheduled.fromTime 同精度;≥1e12 的毫秒值自动兼容折算):游标从该时刻网格对齐起步逐窗追平,追平后转分钟间隔;缺省从当前时刻起步只看增量

1735660800

mode

string

调度模式:RunOnce(单次执行)、Scheduled(周期执行)或 Continuous(持续执行,仅 trace 数据源;处理频率为服务端管理的固定值,Trace 完成后分钟级自动处理)

scheduled

runOnce

object

单次执行配置,仅 mode 为 RunOnce 时必填

{"fromTime":1735660800,"toTime":1735664400}

fromTime

integer

数据处理窗口起始时间,Unix 秒,必须小于 toTime

1735660800

toTime

integer

数据处理窗口结束时间,Unix 秒,必须大于 fromTime

1735747200

scheduled

object

周期调度配置,仅 mode 为 Scheduled 时必填

{"interval":"1h","fromTime":1735660800}

fromTime

integer

调度起始时间,Unix 秒时间戳(与 runOnce.fromTime 同精度;≥1e12 的毫秒值自动兼容折算)

1735660800

interval

string

调度间隔,支持 1h / 6h / 12h / 1d

1h

nextTriggerTime

integer

下次调度触发时间,unix 秒

1735661100

pipeline

object

Pipeline 配置(节点编排)

{"nodes":[{"id":"select-fields","type":"project","parameters":{"question":"user_query"}}]}

nodes

array<object>

节点列表

[{"id":"select-fields","type":"project","parameters":{}}]

array<object>

单个节点配置

id

string

节点 Id

node-1

parameters

object

节点参数,键值结构,随节点类型而定

any

节点参数值

value

type

string

节点类型

transform

pipelineName

string

流水线名称

my-pipeline

regionId

string

地域 ID

cn-hangzhou

requestId

string

请求 Id,用于排查问题时定位本次请求

9ACFB10A-1B2C-3D4E-5F6G-7H8I9J0K1L2M

scheduleStatus

string

调度状态:None(无调度)、Active(活跃)、Paused(已暂停)、Terminated(已终止)

Active

scheduleType

string

调度类型:RunOnce(单次执行)、Scheduled(周期调度)或 Continuous(持续执行,trace 源信号驱动)

RunOnce

sink

object

Pipeline 目标(数据写入目标)

condition

object

条件分流配置,仅 sink.type 为 condition 时使用

defaultSink

object

未命中任何条件路由时使用的默认写入目标

dataset

object

默认目标 Dataset

agentSpace

string

默认目标 Dataset 所属 AgentSpace 名称

my-agent-space

dataset

string

默认目标 Dataset 名称

other-result

type

string

默认目标类型,当前仅支持 dataset

dataset

matchMode

string

路由匹配模式,当前仅支持 all

all

routes

array<object>

条件路由列表

array<object>

条件路由

expression

string

路由表达式(SPL),仅支持 where、project、extend

* | where intent = 'refund'

id

string

路由 Id

refund

sink

object

路由写入目标

dataset

object

路由目标 Dataset

agentSpace

string

目标 Dataset 所属 AgentSpace 名称

my-agent-space

dataset

string

目标 Dataset 名称

refund-result

type

string

路由目标类型,当前仅支持 dataset

dataset

dataset

object

Dataset Sink 的目标数据集配置,仅 sink.type 为 dataset 时使用

agentSpace

string

目标数据集所属 AgentSpace 名称

my-agent-space

dataset

string

目标数据集名称

my-dataset

type

string

目标类型,支持 dataset 或 condition

condition

source

object

Pipeline 数据源

{"type":"logstore","logstore":{"project":"my-sls-project","logstore":"agent-logs"},"inputFields":[{"name":"question","type":"text"}]}

dataset

object

当前 AgentSpace 下的 Dataset 数据源配置

{"dataset":"my-dataset","filter":"status = 'pending'"}

dataset

string

源 Dataset 名称

my-dataset

filter

string

Dataset 数据过滤条件

status = 'pending'

inputFields

array<object>

输入字段及字段类型,适用于所有数据源类型

[{"name":"question","type":"text"}]

object

输入字段

name

string

字段名称

question

type

string

字段类型,支持 text、long、double、json

text

logstore

object

SLS Logstore 数据源配置

{"project":"my-sls-project","logstore":"agent-logs"}

logstore

string

SLS Logstore 名称

my-sls-logstore

project

string

SLS Project 名称

my-sls-project

query

string

数据筛选查询语句(SLS 查询/分析语法)

* | SELECT *

trajectory

object

轨迹数据配置(可选,type 为 trace 时生效):从轨迹清洗服务获取 ATIF 标准轨迹数据,按功能扩展

{"enrich":{"enabled":true,"columns":["input","output"]}}

enrich

object

轨迹富化:按 trace_id 将轨迹数据挂载进清洗结果;写入数据集时以固定列 agent_trajectory 承载(列值为轨迹 JSON 内容)

{"enabled":true,"columns":["input","output"]}

columns

array

富化列清单(兼容保留):当前实现固定输出单列 agent_trajectory,本参数不再影响输出

["input","output","session_id"]

string

轨迹列名

input

enabled

boolean

是否开启轨迹富化

false

type

string

数据源类型,支持 logstore、dataset 或 trace(trace 为轨迹信号驱动处理模式;枚举合法性由服务端校验)

dataset

updateTime

string

流水线最近一次更新时间,ISO 8601 UTC 格式

2026-01-02T00:00:00Z

workspace

string

流水线关联的 Workspace

my-workspace

示例

正常返回示例

JSON格式

{
  "committedWatermark": 1735660800,
  "createTime": "2026-01-01T00:00:00Z",
  "description": "我的流水线",
  "executePolicy": {
    "continuous": {
      "fromTime": 1735660800
    },
    "mode": "scheduled",
    "runOnce": {
      "fromTime": 1735660800,
      "toTime": 1735747200
    },
    "scheduled": {
      "fromTime": 1735660800,
      "interval": "1h"
    }
  },
  "nextTriggerTime": 1735661100,
  "pipeline": {
    "nodes": [
      {
        "id": "node-1",
        "parameters": {
          "key": "value"
        },
        "type": "transform"
      }
    ]
  },
  "pipelineName": "my-pipeline",
  "regionId": "cn-hangzhou",
  "requestId": "9ACFB10A-1B2C-3D4E-5F6G-7H8I9J0K1L2M",
  "scheduleStatus": "Active",
  "scheduleType": "RunOnce",
  "sink": {
    "condition": {
      "defaultSink": {
        "dataset": {
          "agentSpace": "my-agent-space",
          "dataset": "other-result"
        },
        "type": "dataset"
      },
      "matchMode": "all",
      "routes": [
        {
          "expression": "* | where intent = 'refund'",
          "id": "refund",
          "sink": {
            "dataset": {
              "agentSpace": "my-agent-space",
              "dataset": "refund-result"
            },
            "type": "dataset"
          }
        }
      ]
    },
    "dataset": {
      "agentSpace": "my-agent-space",
      "dataset": "my-dataset"
    },
    "type": "condition"
  },
  "source": {
    "dataset": {
      "dataset": "my-dataset",
      "filter": "status = 'pending'"
    },
    "inputFields": [
      {
        "name": "question",
        "type": "text"
      }
    ],
    "logstore": {
      "logstore": "my-sls-logstore",
      "project": "my-sls-project",
      "query": "* | SELECT *"
    },
    "trajectory": {
      "enrich": {
        "columns": [
          "input"
        ],
        "enabled": false
      }
    },
    "type": "dataset"
  },
  "updateTime": "2026-01-02T00:00:00Z",
  "workspace": "my-workspace"
}

错误码

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

变更历史

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