Querying Template Details

Updated on 2025-03-25 GMT+08:00

Online Debugging

CLI Examples

View PDF

Function

This API is used to query template details.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{tenant_id}/api/pipeline-templates/{template_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
tenant_id	Yes	String	Parameter description: Tenant ID. Constraints: None. Value range: 32 characters. Default value: None.
template_id	Yes	String	Parameter description: Template ID. Constraints: None. Value range: 32 characters. Default value: None.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
id	String	Parameter description: Template ID. Value range: 32 characters.
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	Parameter description: Template language. Value range: The options include Java, Python, Node.js, Go, .NET, CPP, PHP, other, and none.
description	String	Parameter description: Template description. Value range: None.
is_system	Boolean	Parameter description: Whether the template is a system template. Value Range: The value can be "true" or "false".
region	String	Parameter description: Template region. Value range: None.
domain_id	String	Parameter description: ID of the tenant to which the template belongs. Value range: 32 characters.
variables	Array of CustomVariable objects	Custom parameter.
creator_id	String	Parameter description: Template creator ID. Value range: 32 characters.
updater_id	String	Parameter description: ID of the user who updates the template. Value range: 32 characters.
create_time	Integer	Parameter description: Creation time. Value range: None.
update_time	Integer	Parameter description: Update time. Value range: None.
is_collect	String	Parameter description: Whether to add a template to favorites. Value Range: The value can be "true" or "false".
is_show_source	Boolean	Parameter description: Whether to display the pipeline source. Value Range: The value can be "true" or "false".
definition	String	Parameter description: Template orchestration JSON file, including stages. Value Range: The value can be "true" or "false".

**Table 3** CustomVariable
Parameter	Type	Description
pipeline_id	String	Parameter description: Pipeline ID. Constraints: None. Value range: 32 characters. Default value: None.
name	String	Parameter description: Custom parameter name. Constraints: None. Value range: 32 characters. Default value: None.
sequence	Integer	Parameter description: Parameter sequence number, which starts from 1. Constraints: None. Value range: None. Default value: None.
type	String	Parameter description: Custom parameter type. Constraints: None. Value range: autoIncrement: auto-increment parameter; enum: enumeration parameter; string: character string parameter. Default value: None.
value	String	Parameter description: Default value of a custom parameter. Constraints: None. Value range: Up to 8192 characters. Default value: None.
is_secret	Boolean	Parameter description: Whether the parameter is private. Constraints: None. Value range: true: private parameter; false: non-private parameter. Default value: false.
description	String	Parameter description: Parameter description. Constraints: None. Value range: Up to 1024 characters. Default value: None.
is_runtime	Boolean	Parameter description: Whether the parameter can be set during runtime. Constraints: None. Value range: true: the parameter can be set during runtime; false: the parameter cannot be set during 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	Parameter description: 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: Uses the edited parameter value. false: Uses the auto-increment parameter. Default value: false.
latest_value	String	Parameter description: Latest parameter value. Constraints: None. Value range: Up to 8192 characters. Default value: None.
runtime_value	String	Parameter description: Runtime input value. Constraints: None. Value range: None. Default value: None.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A
error_code	String	Parameter description: Error code. Value range: N/A

Example Requests

Querying Pipeline Template Details

GET https://{endpoint}/v5/a5f63758220947b7821e70ae2734c01d/api/pipeline-templates/deb18013bb6c4659b160b15fd7468644

Example Responses

Status code: 200

{
  "id" : "deb18013bb6c4659b160b15fd7468644",
  "name" : "Creating a Pipeline Template-20230112115711",
  "icon" : null,
  "manifest_version" : "3.0",
  "language" : "none",
  "description" : "",
  "is_system" : false,
  "region" : "region01",
  "domain_id" : "70ffec613024477bbaf266128bd9778d",
  "variables" : [ ],
  "creator_id" : "5ffd41c9df9d4506862ce27e209bb106",
  "updater_id" : "5ffd41c9df9d4506862ce27e209bb106",
  "create_time" : 1673495851000,
  "update_time" : 1673495851000,
  "is_collect" : null,
  "is_show_source" : true,
  "definition" : "{\"stages\":[{\"name\":\"Phase _1\",\"sequence\":\"0\",\"jobs\":[{\"stage_id\":1673495831907,\"identifier\":\"16734958501367554c26c-561b-4831-a906-e88316c8e674\",\"name\": \"New Task\",\"depends_on\":[] ,\"timeout\":\"\",\"timeout_unit\":\"\",\"steps\":[],\"exec_type\":\"AGENTLESS_JOB\",\"sequence\":0}],\"identifier\":\"0\",\"pre\":[{\"task\":\"official_devcloud_autoTrigger\",\"sequence\":0}],\"post\":null,\"depends_on\":[],\"run_always\":false}]}"
}