ExecPipelineRunStage - 执行发布流程的指定阶段

更新时间:
复制为 MD 格式

调用此接口,可以执行发布流程的指定阶段。

接口说明

注意 发布流程的阶段是有顺序的,详见 GetPipelineRun 返回值。不允许跳过或重复执行某一阶段。
注意 执行过程是异步的,返回值只表示触发成功,不表示阶段执行成功。执行结果以 GetPipelineRun 返回值为准。
注意 低版本的 SDK 中可能无该接口,此时请使用 ExecDeploymentStage 接口,参数与该文档一致。

调试

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

授权信息

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

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

请求参数

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

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

10000
Idstring

发布流程的唯一标识符

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

表示发布流程阶段的代码,具体以 GetPipelineRun 接口的返回值为准

DEV_CHECK

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

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

AFBB799F-8578-51C5-A766-E922EDB8XXXX
Successboolean

调用是否成功。取值如下:

  • true:调用成功。
  • false:调用失败。
    注意 只表示触发阶段执行是否成功,不代表发布阶段执行结果
true

示例

正常返回示例

JSON格式

{
  "RequestId": "AFBB799F-8578-51C5-A766-E922EDB8XXXX\n",
  "Success": true
}

错误码

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