GetPipeline - 查询流水线-云监控(CMS)-阿里云帮助中心

查询流水线

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cms:GetPipeline

none

*Pipeline

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

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
workspace	string	否	工作空间 ID	workspace-test
pipelineName	string	否	流水线名称	pipeline-name-1

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object	响应数据
requestId	string	请求 Id	3430AE20-AFFF-597C-B553-2DF04B2933AA
pipelineName	string	流水线名称	pipeline-name-1
description	string	描述	workspace test
createTime	string	创建时间	2025-03-11T08:21:58Z
updateTime	string	更新时间	2026-02-06T14:09:11Z
workspace	string	工作空间 ID	workspace-test
regionId	string	地域 ID	cn-hangzhou
source	object	数据源
type	string	数据源类型	logstore
logstore	object	日志服务 Logstore 信息
project	string	日志服务 Project 名称	test-project
logstore	string	日志服务 Logstore 名称	test-logstore
query	string
pipeline	object	流水线信息
nodes	array<object>	节点
	array<object>	节点
id	string	节点 Id	node_1
type	string	节点类型	dedup-fuzzy
parameters	object	参数
	any	参数	{ "output": "ID,key_0,key_2,key_3,key_4", "workspace": "workspace-test-dataset", "field": "key_0", "global": true, "dataset": "dataset_1" }
sink	object	输出目标
type	string	输出目标类型	dataset
dataset	object	数据集信息
workspace	string	工作空间 ID	workspace-test
dataset	string	数据集	dataset_1
executePolicy	object	执行策略
mode	string	执行模式	runOnce
runOnce	object	只执行一次时的配置
fromTime	integer	开始时间时间戳	1772519013
toTime	integer	结束时间时间戳	1772519013
scheduled	object	定时执行时的配置
interval	string	时间间隔	86400
fromTime	integer	开始时间时间戳	1772519013

示例

正常返回示例

JSON格式

{
  "requestId": "3430AE20-AFFF-597C-B553-2DF04B2933AA",
  "pipelineName": "pipeline-name-1",
  "description": "workspace test",
  "createTime": "2025-03-11T08:21:58Z",
  "updateTime": "2026-02-06T14:09:11Z",
  "workspace": "workspace-test",
  "regionId": "cn-hangzhou",
  "source": {
    "type": "logstore",
    "logstore": {
      "project": "test-project",
      "logstore": "test-logstore",
      "query": ""
    }
  },
  "pipeline": {
    "nodes": [
      {
        "id": "node_1",
        "type": "dedup-fuzzy",
        "parameters": {
          "key": "{\n\t\t\t\t\"output\": \"ID,key_0,key_2,key_3,key_4\",\n\t\t\t\t\"workspace\": \"workspace-test-dataset\",\n\t\t\t\t\"field\": \"key_0\",\n\t\t\t\t\"global\": true,\n\t\t\t\t\"dataset\": \"dataset_1\"\n\t\t\t}"
        }
      }
    ]
  },
  "sink": {
    "type": "dataset",
    "dataset": {
      "workspace": "workspace-test",
      "dataset": "dataset_1"
    }
  },
  "executePolicy": {
    "mode": "runOnce",
    "runOnce": {
      "fromTime": 1772519013,
      "toTime": 1772519013
    },
    "scheduled": {
      "interval": "86400",
      "fromTime": 1772519013
    }
  }
}

错误码

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

变更历史

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