Document Center
edit-icon download-icon

GetChangeOrderInfoRequest

Last Updated: Jan 16, 2018

Function

Returns the details of a change order.

Request URL

/pop/v5/changeorder/change_order_info

Request method

POST

Request parameters

Parameter Type Required? Description
changeOrderId String Yes Unique ID of a change order, which is returned for all successfully called application life cycle methods.

Response parameters

Parameter Type Description
Code Integer Response code
Message String Response message
ChangeOrderInfo ChangeOrderInfo Details of the change order

ChangeOrderInfo: Basic information of a change order

Parameter Type Description
ChangeOrderId String Unique ID of a change order
CreateUserId String ID of the user that creates the change order
Desc String Description of the change order
BatchCount Integer Number of executed batches
BatchType String Deployment mode
Status Integer 0: Preparation; 1: Execution in progress; 2: Execution successful; 3: Execution failed; 6: Ended; 10: Execution failed due to a system exception
CoType Integer Type of the change order
CreateTime String Creation time
PipelineInfoList List Batch execution details. See PipelineInfo.

PipelineInfo: Execution information per batch

Parameter Type Description
PipelineId String Unique ID of a batch
PipelineName String Batch name
PipelineStatus Integer 0: Preparation; 1: Execution in progress; 2: Execution successful; 3: Execution failed; 6: Ended; 10: Execution failed due to a system exception
StageList List Stages of each batch. for more information, see StageInfoDTO.

StageInfoDTO: Execution information in a specific stage of a batch

Parameter Type Description
StageId String Batch name
StageName Integer Batch status
Status Integer 0: Preparation; 1: Execution in progress; 2: Execution successful; 3: Execution failed; 6: Ended; 10: Execution failed due to a system exception
StageResultDTO StageResultDTO For the definition of each stage, see StageResultDTO.

StageResultDTO: Stage execution details, including the service-type task stage and agent-type task stage

Parameter Type Description
InstanceDTOList List Stage execution result on each ECS instance. For more information, see InstanceDTO.
ServiceStage ServiceStage Result of service-type stage execution

ServiceStage: In the service-type stage, corresponding services are called to process instances in batches, for example, the online/offline state of Server Load Balancer

Parameter Type Description
StageId String Stage ID
StageName String Stage name
Status Integer Running status (0: Preparation; 1: Execution in progress; 2: Execution successful; 3: Execution failed; 6: Ended; 10: Execution failed due to a system exception)
Message String Execution result

InstanceDTO: General result of agent-type task execution on a specific instance (a common agent task is starting an application instance)

Parameter Type Description
InstanceName String Instance name
InstanceIp ServiceStage Instance IP address
Status Integer 0: Preparation; 1: Execution in progress; 2: Execution successful; 3: Execution failed; 6: Ended; 10: Execution failed due to a system exception
InstanceStageDTOList List A list of stage execution results on each instance

InstanceStageDTO: Execution details of a stage on a specific instance

Parameter Type Description
StageId String Stage ID
StageName ServiceStage Stage name
Status Integer 0: Preparation; 1: Execution in progress; 2: Execution successful; 3: Execution failed; 6: Ended; 10: Execution failed due to a system exception
Thank you! We've received your feedback.
Free Trial Free Trial