Running a YAML-based Pipeline Using YAML

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

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API forobtaining a user token.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

X-Language

No

String

Definition:

Language type.

Constraints:

N/A

Value range:

• zh-cn: Chinese.

• en-us: English.

Default value:

en-us.

repository

Yes

Repository object

Definition:

Code repository information.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

description

No

String

Definition:

Pipeline running description.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

configuration

Yes

String

Definition:

YAML content.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

type

Yes

String

Definition:

Code repository type.

Constraints:

N/A

Value range:

• CodeArts Repo.

• Gitee.

• GitHub.

• GitCode.

• GitLab.

Default value:

N/A

git_http_url

Yes

String

Definition:

HTTPS address of the code repository.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

branch

Yes

String

Definition:

Code repository branch.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

pipeline_id

String

ID of the pipeline temporarily created during a dry-run execution.

pipeline_run_id

String

Pipeline run ID.

200

Response body for running a YAML-based pipeline in dry-run mode.

401

Unauthorized

403

Forbidden

404

Not Found