AbolishPipelineRun - 终止发布流程

调用该接口,会将指定发布流程的状态变更为终止状态,但不会删除这个发布流程,仍然可以通过查询接口查询到。

接口说明

注意 低版本的 SDK 中可能无该接口,此时请使用 AbolishDeployment 接口,参数与该文档一致。

调试

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

授权信息

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

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

请求参数

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

DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间管理页面获取 ID。

该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。

10000
Idstring

发布流程的唯一标识

1606087c-9ac4-43f0-83a8-0b5ced21XXXX

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

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

55D786C9-DD57-524D-884C-C5239278XXXX
Successboolean

请求是否成功。取值如下:

  • true:成功。
  • false:失败。
true

示例

正常返回示例

JSON格式

{
  "RequestId": "55D786C9-DD57-524D-884C-C5239278XXXX\n",
  "Success": true
}

错误码

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