Querying Template Details

tenant_id

Yes

String

Definition:

Tenant ID.

Constraints:

N/A

Value range:

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

Default value:

N/A

template_id

Yes

String

Definition:

Template ID, which is the unique identifier of a template. Obtain the template ID by calling the API for querying templates. templates.id indicates the template ID.

Constraints:

N/A

Value range:

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

Default value:

N/A

id

String

Definition:

Template ID.

Value range:

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

name

String

Parameter description:

Template name.

Value range:

None.

icon

String

Parameter description:

Template icon.

Value range:

None.

manifest_version

String

Parameter description:

Version.

Value range:

The default value is 3.0.

language

String

Definition:

Template language.

Value range:

• Java.

• Python.

• Node.js.

• Go.

• .NET.

• cpp.

• PHP.

• Other.

• None.

description

String

Parameter description:

Template description.

Value range:

None.

is_system

Boolean

Definition:

Whether the template is a system template.

Value range:

• true: The template is a system template.

• false: The template is not a system template.

region

String

Parameter description:

Template region.

Value range:

None.

domain_id

String

Definition:

ID of the tenant to which the template belongs.

Value range:

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

variables

Array of CustomVariable objects

Definition:

Custom parameter.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

creator_id

String

Definition:

Template creator ID.

Value range:

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

updater_id

String

Definition:

Template updater ID.

Value range:

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

create_time

Integer

Parameter description:

Creation time.

Value range:

None.

update_time

Integer

Parameter description:

Update time.

Value range:

None.

is_collect

String

Definition:

Whether to add the object to favorites.

Value range:

• true: Add the object to favorites.

• false: Do not add the object to favorites.

is_show_source

Boolean

Definition:

Whether to display the pipeline source.

Value range:

• true: The pipeline source is displayed.

• false: The pipeline source is not displayed.

definition

String

Definition:

Template orchestration JSON file, including stages.

Value range:

N/A

pipeline_id

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

name

String

Definition:

Custom parameter name.

Constraints:

N/A

Value range:

Enter a maximum of 128 characters. Only letters, digits, and underscores (_) are supported.

Default value:

N/A

sequence

Integer

Parameter description:

Parameter sequence number, which starts from 1.

Constraints:

None.

Value range:

None.

Default value:

None.

type

String

Definition:

Custom parameter type.

Constraints:

N/A

Value range:

• autoIncrement: auto-increment parameter.

• enum: enumerated parameter.

• string: string parameter.

Default value:

N/A

value

String

Parameter description:

Default value of a custom parameter.

Constraints:

None.

Value range:

Up to 8192 characters.

Default value:

None.

is_secret

Boolean

Definition:

Private parameter or not.

Constraints:

N/A

Value range:

• true: The parameter is private.

• false: The parameter is not private.

Default value:

false.

description

String

Parameter description:

Parameter description.

Constraints:

None.

Value range:

Up to 1024 characters.

Default value:

None.

is_runtime

Boolean

Definition:

Whether a parameter can be set at runtime.

Constraints:

N/A

Value range:

• true: The parameter can be set at runtime.

• false: The parameter cannot be set at runtime.

Default value:

false.

limits

Array of objects

Parameter description:

List of enumerated values.

Constraints:

None.

Value range:

Up to 1,024 characters.

Default value:

None.

is_reset

Boolean

Definition:

Whether to reset. If the auto-increment parameter is edited, the edited value is used. Otherwise, the last digit increases.

Constraints:

N/A

Value range:

• true: Use the edited parameter value.

• false: Use the auto-increment parameter.

Default value:

false.

latest_value

String

Definition:

Value of the parameter in the last run.

Constraints:

N/A

Value range:

Max. 8,192 characters.

Default value:

N/A

runtime_value

String

Definition:

Input value of a parameter when the pipeline is executed.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

error_msg

String

Parameter description:

Error message.

Value range:

N/A

error_code

String

Parameter description:

Error code.

Value range:

N/A

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found