All Products
Search

This Product

    GetChangeOrderInfoRequest

    Document Center
    Product Details

    GetChangeOrderInfoRequest

    Last Updated: Jan 24, 2019

    Function

    Returns the details of a change process.

    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 process, which is returned for all application life cycle methods once the call is successful.

    Response parameters

    Parameter Type Description
    Code Integer Code
    Message String Message
    ChangeOrderInfo ChangeOrderInfo Details of the change process

    ChangeOrderInfo: Basic information of a change process

    Parameter Type Description
    ChangeOrderId String Unique ID of a change process
    CreateUserId String ID of the user that creates the change process
    Desc String Description of the change process
    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 process
    CreateTime String Creation time
    PipelineInfoList List<PipelineInfo> 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<StageInfoDTO> Stages of each batch. For details, see the definition of StageInfoDTO.

    StageInfoDTO: Execution information in a specific stage of a batch

    Parameter Type Description
    StageId String Stage ID
    StageName Integer Stage name
    Status Integer Stage status (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 details about the meaning 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<InstanceDTO> Stage execution result on each ECS instance. For details, see the definition of 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, online or offline state of SLB

    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-type task is starting an application instance)

    Parameter Type Description
    InstanceName String Instance name
    InstanceIp String IP address of the instance
    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<InstanceStageDTO> 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 String 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
    Free Trial Free Trial