调用GetReleaseStagePipelineRun获取研发阶段流水线运行实例-云效-阿里云

可以获取研发阶段流水线运行实例相关信息。

调试

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

授权信息

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

请求语法

GET /appstack/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}/executions/{executionNumber}:getPipelineRun

请求参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业标识，也称企业 id	66c0c9fffeb86b450c199fcd
appName	string	是	应用名	testApp
releaseWorkflowSn	string	是	研发流程 sn	ce51b31b996246ecaf8747368383****
releaseStageSn	string	是	研发阶段 sn	e173f3c11db5445eb426ca33c922****
executionNumber	string	是	研发阶段的执行记录编号	1

返回参数

名称	类型	描述	示例值
	object	GetPipelineRunResponse
pipelineRun	object	流水线运行实例
creatorAccountId	string	创建者阿里云账号 id	1111111111
createTime	long	创建时间	1586863220000
updateTime	long	更新时间	1586863220000
modifierAccountId	string	更新人阿里云账号 id	11111111111
pipelineId	long	流水线 Id	1234
pipelineRunId	long	流水线运行实例 id	1
status	string	状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中	SUCCESS
triggerMode	integer	触发模式 1 人工触发 2 定时触发 3 代码提交触发 5 流水线触发 6WEBHOOK 触发	1
stageGroup	array	阶段拓扑信息
	array	Group
	string	阶段	阶段名称
stages	array<object>	阶段信息
	object
name	string	阶段名称	Java构建
stageInfo	object	阶段详情
startTime	long	开始时间	1586863220000
endTime	long	结束时间	1586863220000
name	string	阶段名称	Java构建
status	string	状态	RUNNING
jobs	array<object>	任务
	object
id	long	任务 Id	21212
name	string	任务名称	Java构建
startTime	long	开始时间	1586863220000
endTime	long	结束时间	1586863220000
status	string	状态 FAIL 运行失败 SUCCESS 运行成功 RUNNING 运行中	RUNNING
params	string	触发参数	{}
actions	array<object>	后续操作,具体参考文档 https://help.aliyun.com/document_detail/2360596.html
	object
type	string	参考文档 https://help.aliyun.com/document_detail/2360596.html	PassPipelineValidate
disable	boolean	参考文档 https://help.aliyun.com/document_detail/2360596.html	true
params	any	参考文档 https://help.aliyun.com/document_detail/2360596.html	{}
sources	array<object>	代码源
	object
type	string	代码库类型 Codeup codeup 代码源 aliyunGit 阿里云 code giteeGit 码云	Codeup
sign	string	代码源唯一标识	assaaaaaasasasa
data	object	代码源信息
branch	string	代码分支	master
commit	string	提交信息 JSON 数据	{}
repo	string	代码库地址	http://codeup.aliyun.com/a.git

示例

正常返回示例

JSON格式

{
  "pipelineRun": {
    "creatorAccountId": "1111111111",
    "createTime": 1586863220000,
    "updateTime": 1586863220000,
    "modifierAccountId": "11111111111",
    "pipelineId": 1234,
    "pipelineRunId": 1,
    "status": "SUCCESS",
    "triggerMode": 1,
    "stageGroup": [
      [
        "阶段名称"
      ]
    ],
    "stages": [
      {
        "name": "Java构建",
        "stageInfo": {
          "startTime": 1586863220000,
          "endTime": 1586863220000,
          "name": "Java构建",
          "status": "RUNNING",
          "jobs": [
            {
              "id": 21212,
              "name": "Java构建",
              "startTime": 1586863220000,
              "endTime": 1586863220000,
              "status": "RUNNING",
              "params": "{}",
              "actions": [
                {
                  "type": "PassPipelineValidate",
                  "disable": true,
                  "params": "{}"
                }
              ]
            }
          ]
        }
      }
    ],
    "sources": [
      {
        "type": "Codeup",
        "sign": "assaaaaaasasasa",
        "data": {
          "branch": "master",
          "commit": "{}",
          "repo": "http://codeup.aliyun.com/a.git"
        }
      }
    ]
  }
}

错误码

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