Get the Latest Pipeline Run via GetLatestPipelineRun API - Alibaba Cloud DevOps

Use OpenAPI to retrieve the latest pipeline run information.

Endpoint and authorization information

Get the endpoint: Replace {domain} in the API request syntax.
Get a personal access token.

Product	Resource	Required permission
Pipeline	Pipeline run instance	Read-only

Request syntax

GET https://{domain}/oapi/v1/flow/organizations/pipelines/{pipelineId}/runs/latestPipelineRun

Request headers

Parameter	Type	Required	Description	Example value
x-yunxiao-token	string	Yes	Your personal access token.	pt-0fh3**0fbG_35af**0484

Request parameters

Parameter	Type	Location	Required	Description	Example value
pipelineId	string	path	Yes	Your pipeline ID.	123

Request examples

curl -X 'GET' \
  'https://{domain}/oapi/v1/flow/organizations/pipelines/123/runs/latestPipelineRun' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Response parameters

Parameter	Type	Description	Example value
-	object
createTime	integer	Start time.	1590730400000
creatorAccountId	string	Creator	1222222222
globalParams	array
-	object
encrypted	boolean	Whether the parameter is encrypted.	false
key	string	The parameter key.	key
value	string	The parameter value.	value
groups	array
-	object
id	integer	ID.	1
name	string	Name.	Run command
modifierAccountId	string	Updated by	1222222222
pipelineId	integer	The pipeline ID.	123
pipelineRunId	integer	Your pipeline run ID. You can get this ID by calling ListPipelineRuns.	1
pipelineType	string	Your pipeline type.	default
sources	array
-	object
data	object
branch	string	Default branch.	master
cloneDepth	integer	Clone depth.	1
credentialId	integer	Your service certificate ID.	222
credentialLabel	string	Certificate display name.	Enterprise public key
credentialType	string	Certificate type.	region-ssh
events	array[string]	Triggering events.
isBranchMode	boolean	Trigger filter condition.	false
isCloneDepth	boolean	Whether clone depth is set.	true
isSubmodule	boolean	Whether it is a submodule.	false
isTrigger	boolean	Whether commit-triggered execution is enabled.	true
label	string	Display name.	cdup/ss
namespace	string	GitHub namespace.	asasasas
repo	string	Repository URL.	https://codeup.aliyun.com/test.git
serviceConnectionId	integer	Your service connection ID.	12
triggerFilter	string	Trigger filter condition.	.*
webhook	string	Webhook URL.	https://flow.aliyun/webhook/asassasa
name	string	Source name.	Sample source
sign	string	Source code identifier.	assaaaaaasasasa
type	string	Source type. Valid values: aliyunGit, customGitlab, giteeGit, codeup, git, gitlab, bitbucket, githubOAuth.	Codeup
stageGroup	array[string]
stages	array	Stage details.
-	object
index	string	Stage ordinal number.	Group0-Stage0
name	string	Stage name.	Java build
stageInfo	object
endTime	integer	End time.	1729178040000
jobs	array	Task list
-	object
actions	array	Next steps. For more information, see the referenced document.
-	object
data	string	Data.
disable	boolean	Whether you have permission to call this action. For more information, see the referenced document.	true
displayType	string	Display type.	LOG
name	string	Name.	Build log
order	integer	Order.	1
params	object	Parameters. For more information, see the referenced document.
key	string	Parameter name.
title	string	Title.	Build log
type	string	Action type. For more information, see the referenced document.	GetVMDeployOrder
endTime	integer	End time.	1729178040000
id	integer	Job ID.	21212
jobSign	string	The unique ID of the task.	job-1
name	string	Job name.	Java build
params	string	Runtime parameters.	{}
result	string	Result.	{"data":{"RELEASE_INFO":"[]","ARTIFACTSV2":"[]","ARTIFACTS":"[]"},"requestId":"8bf5e28c-a58b-498e-a205-1c0ff5465c3c","successful":true}
startTime	integer	Start time.	1729178040000
status	string	Status. Valid values: FAIL, SUCCESS, RUNNING.	RUNNING
name	string	Stage name.	Java build
startTime	integer	Start time.	1729178040000
status	string	Status. Valid values: FAIL, SUCCESS, RUNNING.	RUNNING
status	string	Status. Valid values: FAIL, SUCCESS, RUNNING.	RUNNING
triggerMode	integer	Trigger mode. Valid values: 1 (manual), 2 (scheduled), 3 (code commit), 5 (pipeline), 6 (webhook).	1
updateTime	integer	Update time.	1590730400000

Response example

{
    "createTime": 1590730400000,
    "creatorAccountId": "1222222222",
    "globalParams": [
        {
            "encrypted": false,
            "key": "key",
            "value": "value"
        }
    ],
    "groups": [
        {
            "id": 1,
            "name": "Run command"
        }
    ],
    "modifierAccountId": "1222222222",
    "pipelineId": 123,
    "pipelineRunId": 1,
    "pipelineType": "default",
    "sources": [
        {
            "data": {
                "branch": "master",
                "cloneDepth": 1,
                "credentialId": 222,
                "credentialLabel": "Enterprise public key",
                "credentialType": "region-ssh",
                "events": [
                    
                ],
                "isBranchMode": false,
                "isCloneDepth": true,
                "isSubmodule": false,
                "isTrigger": true,
                "label": "cdup/ss",
                "namespace": "asasasas",
                "repo": "https://codeup.aliyun.com/test.git",
                "serviceConnectionId": 12,
                "triggerFilter": ".*",
                "webhook": "https://flow.aliyun/webhook/asassasa"
            },
            "name": "Sample source",
            "sign": "assaaaaaasasasa",
            "type": "Codeup"
        }
    ],
    "stageGroup": [
        
    ],
    "stages": [
        {
            "index": "Group0-Stage0",
            "name": "Java build",
            "stageInfo": {
                "endTime": 1729178040000,
                "jobs": [
                    {
                        "actions": [
                            {
                                "data": "",
                                "disable": true,
                                "displayType": "LOG",
                                "name": "Build log",
                                "order": 1,
                                "params": {
                                    "key": ""
                                },
                                "title": "Build log",
                                "type": "GetVMDeployOrder"
                            }
                        ],
                        "endTime": 1729178040000,
                        "id": 21212,
                        "jobSign": "job-1",
                        "name": "Java build",
                        "params": "{}",
                        "result": "{"data":{"RELEASE_INFO":"[]","ARTIFACTSV2":"[]","ARTIFACTS":"[]"},"requestId":"8bf5e28c-a58b-498e-a205-1c0ff5465c3c","successful":true}",
                        "startTime": 1729178040000,
                        "status": "RUNNING"
                    }
                ],
                "name": "Java build",
                "startTime": 1729178040000,
                "status": "RUNNING"
            }
        }
    ],
    "status": "RUNNING",
    "triggerMode": 1,
    "updateTime": 1590730400000
}

Error codes

Go to the Error Code Center to view error codes for this API.