更新流水线编排和设置
Request method/request path
PUT /ms/openapi/api/apigw/v3/projects/{projectId}/pipelines/{pipelineId}/pipeline_update
Resource description
Update pipelining and setup
Input parameter description
Query parameter
Parameter name | Parameter type | must | Parameter description | Default value |
---|---|---|---|---|
channelCode | string | no | Channel number. The default is BS |
Body parameter
Parameter name | Parameter type | must | Parameter description | Default value |
---|---|---|---|---|
body | is | Pipeline model and setup |
Path parameter
Parameter name | Parameter type | must | Parameter description | Default value |
---|---|---|---|---|
projectId | string | is | Item ID | |
pipelineId | string | is | Pipeline ID |
response
HTTP code | description | Parameter type |
---|---|---|
200 | successful operation |
Request sample
HEADER example
Return example -200
PipelineModelAndSetting
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
model | is | Pipeline model | |
setting | no | Pipeline setting |
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 |
PipelineSetting
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
successSubscription | no | successSubscription | |
runLockType | ENUM(MULTIPLE, SINGLE, SINGLE_LOCK, LOCK, ) | no | runLockType |
maxPipelineResNum | integer | no | maxPipelineResNum |
version | integer | no | version |
pipelineId | string | no | pipelineId |
labels | List | no | labels |
pipelineName | string | no | pipelineName |
maxConRunningQueueSize | integer | no | maxConRunningQueueSize |
maxQueueSize | integer | no | maxQueueSize |
hasPermission | boolean | no | hasPermission |
waitQueueTimeMinute | integer | no | waitQueueTimeMinute |
failSubscription | no | failSubscription | |
buildNumRule | string | no | buildNumRule |
projectId | string | no | projectId |
desc | string | no | desc |
Settings - Subscribe to messages
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
types | List | is | Notification method (email, rtx) |
wechatGroupMarkdownFlag | boolean | no | The enterprise wechat group notification is converted to Markdown format |
groups | List | no | grouping |
detailFlag | boolean | no | Notification pipeline details connection switch |
users | string | no | Notifying officer |
wechatGroupFlag | boolean | no | Enterprise wechat group notification switch |
content | string | no | Customize notification content |
wechatGroup | string | no | Enterprise wechat group notification group ID |
The data returns the result of the packaging model configuration pipeline
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
data | no | data | |
message | string | no | Error message |
status | integer | is | Status code |
Configuration pipeline result
Parameter name | Parameter type | must | Parameter description |
---|---|---|---|
version | integer | is | Pipeline version number |
pipelineId | string | is | Pipeline ID |
Last updated