Obtaining Custom Parameters Required for Pipeline Running

project_id

Yes

String

Parameter description:

CodeArts project ID.

Constraints:

N/A.

Value Range:

The value contains 32 characters.

Default value:

N/A.

pipeline_id

Yes

String

Parameter description:

Pipeline ID.

Constraints:

N/A.

Value Range:

The value contains 32 characters.

Default value:

N/A.

offset

No

Integer

Offset.

limit

No

Integer

Number of records of each query.

X-Auth-Token

Yes

String

Parameter description:

User token.

It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Constraints:

None.

Value range:

None.

Default value:

None.

X-Language

No

String

Language. The value can be zh-cn (Chinese) or en-us (English). The default value is en-us.

offset

Integer

Offset.

limit

Integer

Size.

total

Integer

Total number of records.

variables

Array of PipelineVariable objects

Customized pipeline parameters

name

String

Parameter description:

Parameter name.

Value range:

N/A

sequence

Integer

Parameter description:

Sequence number.

Value range:

1–2147483647

type

String

Parameter description:

Type.

Value range:

N/A

value

String

Parameter description:

Default value.

Value range:

N/A

is_secret

Boolean

Parameter description:

Whether the parameter is private.

Value range:

true: private; false: not private.

description

String

Parameter description:

Description.

Value range:

N/A

is_runtime

Boolean

Parameter description:

Whether a parameter can be set during runtime.

Value range:

true: The parameter can be set during runtime; false: The parameter cannot be set during runtime.

limits

Array of strings

Parameter description:

List of limited enumerated values.

Value range:

N/A

is_reset

Boolean

Parameter description:

Whether an auto-increment parameter is reset.

Value range:

true: reset; false: not reset.

latest_value

String

Parameter description:

The latest value of an auto-increment parameter.

Value range:

N/A

200

OK

401

Unauthorized

403

Forbidden

404

Not Found