Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Obtaining the Step Redirection Link
Updated on 2025-09-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the Step Redirection Link

Function

This API is used to obtain the step redirection link.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipelineRunId}/jobs/{jobRunId}/steps/{stepRunId}/jump-link

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

pipelineRunId

Yes

String

Definition:

Pipeline run ID. The return value of the API for starting a pipeline is the pipeline run ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

jobRunId

Yes

String

Definition:

Pipeline job ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

stepRunId

Yes

String

Definition:

Pipeline step ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

project_id

Yes

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

pipeline_id

Yes

String

Definition:

Pipeline ID. Obtain the ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

jumpLink

String

Definition:

Step redirection link.

Value range:

N/A

Example Requests

GET https://(endpoint)/v5/071112d87d3e4ed49130c691936202e9/api/pipelines/53acae73a3f44b2994f9b20a710721c6/pipeline-runs/13a48f79f7104f9785720cf2c11890ba/jobs/6fd4c34e7b7447c59cbe5762bb3273aa/steps/9fdb1e70927b46708b1870192c9d47e5/jump-link

Example Responses

Status code: 200

Response body.

{
  "jumpLink" : "/cloudtestportal/project/071112d87d3e4ed49130c691936202e9/testsuite?type=1&suite_id=123&detail=result&taskId=456"
}

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.

Parent Topic: Pipeline Management