CancelExecutionReleaseStage - 取消执行研发阶段流水线_云效(Apsara Devops)-阿里云帮助中心

取消执行研发阶段流水线。

适用版本

企业标准版

服务接入点与授权信息

获取服务接入点，替换 API 请求语法中的 <domain> ：服务接入点（domain）。
获取个人访问令牌，具体操作，请参见获取个人访问令牌。
产品
资源
所需权限
应用交付
发布阶段
读写

请求语法

POST https://{domain}/oapi/v1/appstack/organizations/{organizationId}/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}/executions/{executionNumber}:cancel

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
appName	string	path	是	应用名。	my-web-service
releaseWorkflowSn	string	path	是	发布流程唯一序列号。	3f472a12b15d4f418ad6227bb85f787c
releaseStageSn	string	path	是	发布流程阶段唯一序列号。	6b4c53eee9a842c6a11235b29d002a81
executionNumber	string	path	是	发布流程阶执行序号。	123
organizationId	string	path	是	组织 ID。	ec766e63aee3437d9a51f334d6exe671

请求示例

curl -X 'POST' \
  'https://test.rdc.aliyuncs.com/oapi/v1/appstack/organizations/ec766e63aee3437d9a51f334d6exe671/apps/my-web-service/releaseWorkflows/3f472a12b15d4f418ad6227bb85f787c/releaseStages/6b4c53eee9a842c6a11235b29d002a81/executions/123:cancel' \
  -H 'accept: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数	类型	描述	示例值
-	object	取消流水线返回结果。
success	boolean	是否取消成功。	true

返回示例

{
    "success": true
}

错误码

访问错误码中心查看 API 相关错误码。

产品	资源	所需权限
应用交付	发布阶段	读写