获取流水线模板详情
Request method/request path
GET /ms/openapi/api/apigw/v3/projects/{projectId}/templates/{templateId}
Resource description
Get pipeline template details
Input parameter description
Query parameter
Parameter name | Parameter type | must | Parameter description | Default value |
---|---|---|---|---|
version | integer | no | Template version |
Path parameter
Parameter name | Parameter type | must | Parameter description | Default value |
---|---|---|---|---|
projectId | string | is | Item ID | |
templateId | string | is | Template ID |
response
HTTP code | description | Parameter type |
---|---|---|
200 | successful operation |
Request sample
HEADER example
Return example -200
The data is returned to the wrapper model TemplateModelDetail
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
data | no | data | |
message | string | no | Error message |
status | integer | is | Status code |
TemplateModelDetail
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
template | no | template | |
templateType | string | no | templateType |
creator | string | no | creator |
versions | List<TemplateVersion> | no | versions |
latestVersion | no | latestVersion | |
templateName | string | no | templateName |
hasPermission | boolean | no | hasPermission |
description | string | no | description |
templateParams | no | templateParams | |
params | no | params | |
currentVersion | no | currentVersion | |
logoUrl | string | no | logoUrl |
Pipeline model - Create information
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
latestVersion | integer | no | Latest version of pipeline at submission time |
pipelineCreator | string | no | founder |
name | string | is | name |
stages | List< pipeline model-phase > | is | Stage set |
templateId | string | no | Template ID |
srcTemplateId | string | no | ID of the source template |
tips | string | no | prompt |
desc | string | no | description |
labels | List | no | label |
instanceFromTemplate | boolean | no | Whether it is instantiated from the template |
Pipeline model - Phase
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
canRetry | boolean | no | Whether retries can be made at the current Stage |
checkIn | no | Whether retries can be made at the current Stage | |
customBuildEnv | object | no | User-defined environment variables |
finally | boolean | no | Identifies whether it is FinallyStage. Each Model can contain only one FinallyStage and is in the last position |
name | string | is | Stage name |
containers | is | Container set | |
id | string | no | Phase ID |
stageControlOption | is | Flow control options | |
checkOut | no | Whether retries can be made at the current Stage | |
fastKill | boolean | no | Whether to enable the container failure quick termination phase |
StagePauseCheck
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
ruleIds | List | no | ruleIds |
reviewParams | List< Manual audit - Custom parameters > | no | reviewParams |
manualTrigger | boolean | no | manualTrigger |
checkTimes | integer | no | checkTimes |
reviewDesc | string | no | reviewDesc |
reviewGroups | no | reviewGroups | |
timeout | integer | no | timeout |
status | string | no | status |
Manual audit - Customize parameters
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
valueType | ENUM(STRING, TEXTAREA, BOOLEAN, ENUM, MULTIPLE, ) | no | Parameter type |
options | no | Drop-down list | |
chineseName | string | no | Chinese name |
value | object | is | Parameter content |
key | string | is | Parameter name |
required | boolean | is | Is it required? |
desc | string | no | Parameter description |
Manual Audit - Custom Parameters - Drop down box list sword
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
value | string | is | Parameter content |
key | string | is | Parameter name |
Stage Audit group information
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
name | string | is | Audit group name |
id | string | no | Audit team ID(background generation) |
suggest | string | no | Audit suggestion |
params | List< Manual audit - Custom parameters > | no | Audit incoming variables |
reviewers | List | is | auditor |
operator | string | no | Audit operator |
reviewTime | integer | no | Audit operation time |
status | string | no | Audit results (enumeration) |
Pipeline Model - polymorphic base class
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
canRetry | boolean | no | canRetry |
elementElapsed | integer | no | elementElapsed |
startEpoch | integer | no | startEpoch |
executeCount | integer | no | executeCount |
jobId | string | no | jobId |
containPostTaskFlag | boolean | no | containPostTaskFlag |
systemElapsed | integer | no | systemElapsed |
elements | no | elements | |
name | string | no | name |
id | string | no | id |
startVMStatus | string | no | startVMStatus |
containerId | string | no | containerId |
classType | string | no | classType |
status | string | no | status |
Element
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
canRetry | boolean | no | canRetry |
errorType | string | no | errorType |
errorCode | integer | no | errorCode |
canSkip | boolean | no | canSkip |
startEpoch | integer | no | startEpoch |
version | string | no | version |
executeCount | integer | no | executeCount |
templateModify | boolean | no | templateModify |
elementEnable | boolean | no | elementEnable |
errorMsg | string | no | errorMsg |
elapsed | integer | no | elapsed |
atomCode | string | no | atomCode |
additionalOptions | no | additionalOptions | |
taskAtom | string | no | taskAtom |
name | string | no | name |
id | string | no | id |
classType | string | no | classType |
status | string | no | status |
ElementAdditionalOptions
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
enableCustomEnv | boolean | no | enableCustomEnv |
continueWhenFailed | boolean | no | continueWhenFailed |
manualRetry | boolean | no | manualRetry |
pauseBeforeExec | boolean | no | pauseBeforeExec |
retryCount | integer | no | retryCount |
manualSkip | boolean | no | manualSkip |
timeout | integer | no | timeout |
customVariables | List<NameAndValue> | no | customVariables |
otherTask | string | no | otherTask |
customEnv | List<NameAndValue> | no | customEnv |
retryWhenFailed | boolean | no | retryWhenFailed |
enable | boolean | no | enable |
subscriptionPauseUser | string | no | subscriptionPauseUser |
customCondition | string | no | customCondition |
runCondition | ENUM(PRE_TASK_SUCCESS, PRE_TASK_FAILED_BUT_CANCEL, PRE_TASK_FAILED_EVEN_CANCEL, PRE_TASK_FAILED_ONLY, OTHER_TASK_RUNNING, CUSTOM_VARIABLE_MATCH, CUSTOM_VARIABLE_MATCH_NOT_RUN, CUSTOM_CONDITION_MATCH, PARENT_TASK_CANCELED_OR_TIMEOUT, PARENT_TASK_FINISH, ) | no | runCondition |
elementPostInfo | no | elementPostInfo |
NameAndValue
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
value | string | no | value |
key | string | no | key |
Element post message
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
parentElementId | string | no | Parent element ID |
postCondition | string | no | Execution condition |
parentElementJobIndex | integer | no | The position of the parent element in the job |
parentElementName | string | no | Parent element name |
postEntryParam | string | no | Entry parameter |
StageControlOption
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
triggered | boolean | no | triggered |
reviewParams | List< Manual audit - Custom parameters > | no | reviewParams |
manualTrigger | boolean | no | manualTrigger |
enable | boolean | no | enable |
customCondition | string | no | customCondition |
triggerUsers | List | no | triggerUsers |
reviewDesc | string | no | reviewDesc |
runCondition | ENUM(AFTER_LAST_FINISHED, CUSTOM_VARIABLE_MATCH, CUSTOM_VARIABLE_MATCH_NOT_RUN, CUSTOM_CONDITION_MATCH, ) | no | runCondition |
timeout | integer | no | timeout |
customVariables | List<NameAndValue> | no | customVariables |
TemplateVersion
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
creator | string | no | creator |
updateTime | integer | no | updateTime |
versionName | string | no | versionName |
version | integer | no | version |
Build Model - Form element attributes
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
defaultValue | object | is | Default value |
containerType | no | Builder type drop-down | |
glob | string | no | Custom warehouse wildcards |
replaceKey | string | no | Replace the search keyword in the search url |
readOnly | boolean | no | Whether to read only |
label | string | no | Element tag |
type | ENUM(STRING, TEXTAREA, ENUM, DATE, LONG, BOOLEAN, SVN_TAG, GIT_REF, MULTIPLE, CODE_LIB, CONTAINER_TYPE, ARTIFACTORY, SUB_PIPELINE, CUSTOM_FILE, PASSWORD, TEMPORARY, ) | is | Element type |
required | boolean | is | Whether it is necessary |
repoHashId | string | no | repoHashId |
scmType | ENUM(CODE_SVN, CODE_GIT, CODE_GITLAB, GITHUB, CODE_TGIT, ) | no | Code base type drop-down |
relativePath | string | no | relativePath |
propertyType | string | no | Element module |
options | no | Drop-down list | |
searchUrl | string | no | Search for the url. When it is a drop-down option, the list value is obtained from the url and not from Option |
id | string | is | Element ID- Identifier |
placeholder | string | no | Element placeholder |
properties | object | no | File metadata |
desc | string | no | description |
BuildContainerType
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
os | ENUM(MACOS, WINDOWS, LINUX, ) | no | os |
buildType | ENUM(ESXi, MACOS, DOCKER, IDC, PUBLIC_DEVCLOUD, TSTACK, THIRD_PARTY_AGENT_ID, THIRD_PARTY_AGENT_ENV, THIRD_PARTY_PCG, THIRD_PARTY_DEVCLOUD, GIT_CI, AGENT_LESS, ) | no | buildType |
Build Model - Drop down box form element values
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
value | string | is | Element value Name - for display |
key | string | is | Element value ID- identifier |
Last updated