CreatePipelineRun - 创建发布流程

调用此接口,可以对新版数据开发中的实体创建一个发布流程。

接口说明

注意 该接口目前不支持批量操作,参数中填写多个发布实体时,除第一个以外的部分会被直接忽略。
注意 低版本的 SDK 中可能无该接口,此时请使用 CreateDeployment 接口,参数与该文档一致。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
ProjectIdlong

DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间配置页面获取工作空间 ID。 该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。

10000
Typestring

表示发布流程是上线还是下线

  • Online:上线

  • Offline:下线

Online
ObjectIdsarray

本次发布流程希望发布的实体 Id 列表。

注意 目前只支持对于单个实体及其子实体的发布,因此只有该 array 的第一个实体及其子实体会被发布成功。请确保该 array 的长度为 1,超出 1 的部分会被忽略。

string

希望发布的实体 Id,如 Node、WorkflowDefinition 等实体的 Id。

注意 WorkflowDefinition 只允许作为整体发布,目前不支持单独发布 Workflow 内部的单个节点

476506242076571XXXX
Descriptionstring

对于发布流程的描述信息

This is a OdpsSQL-node publishing process. The function is XXXX.

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。用于定位日志,排查问题。

7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX
Idstring

发布流程的唯一标识符

a7ef0634-20ec-4a7c-a214-54020f91XXXX

示例

正常返回示例

JSON格式

{
  "RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX",
  "Id": "a7ef0634-20ec-4a7c-a214-54020f91XXXX\n"
}

错误码

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