Call GetChangeOrderInfo to view the change process details.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request header

This operation only uses common request headers. For more information, see the Common request parameters topic.

Request syntax

POST /pop/v5/changeorder/change_order_info HTTPS|HTTP

Request parameters

Parameter Type Required Example Description
ChangeOrderId String Yes 1074f3e2-e974-4a0e-****-************

The ID of the change process.

Response parameters

Parameter Type Example Description
Code Integer 200

The returned code.
Message String success

The returned message.
RequestId String 4JFR-FV9F algorithm

The ID of the request.
changeOrderInfo Struct

Change Details
BatchCount Integer 1

The number of batches for the most recent change.
BatchType String Automatic

Deployment methods
ChangeOrderDescription String Scale out an application

The description of the change record.
ChangeOrderId String 1074f3e2-e974-4a0e-****-************

The ID of the most recent change process returned.
CoType String Application Scale Out

Change Process category
CreateTime String 2019-11-13 14:23:46

The time when the most recent change process was created.
CreateUserId String edas_com***_****@******-*****. ***

The ID of the user who created the most recent change process.
Desc String IP of Scale-Out Instance: 47.107. **. * (Public)

Change Process Description
PipelineInfoList Array

Batch execution details
PipelineInfo:
PipelineId String 4c4ee320-5e47-4a48-****

The unique ID of a batch.
PipelineName String Batch: 1

The name of the batch.
PipelineStatus Integer 2

Valid values: 0 (preparation), 1 (execution in progress), 2 (execution successful), 3 (execution failed), 6 (ended), and 10 (execution failed due to a system error).

StageDetailList Array

The list of stage execution results.
StageDetailDTO
StageId String d7561440-10a6-452 f-8a90-62f6e7ec****

The ID of the stage.
StageName String Process Start

The name of the stage.
StageStatus Integer 2

Phase status:

  • 0: Ready
  • 1: Execution in progress
  • 2: execution successful
  • 3: execution failed
  • 6: Terminated
  • 10: abnormal system execution failed
TaskList Array

Node list
TaskInfoDTO
ShowManualIgnorance Boolean false

Indicates whether the ignore error button is displayed. Currently, only URLs health check and the task is running. The value is true.

  • Ignore change order task: true
  • Do not ignore change order tasks: false
TaskErrorCode String ""

Error code
TaskErrorIgnorance Integer 0

Indicates whether the task itself can tolerate errors. If so, an error occurs, and the system releases a single ignore task.

  • 0: intolerance
  • 1: error tolerance
TaskErrorMessage String ""

Task error information
TaskId String d6d3b934-90a1-4ae8-8cbd-2446003d

The ID of the task.
TaskMessage String [CALLBACK] 2020-03-11 15:28:44.781 requestId: c952ab99-8c5b-4ff1-9412-ae3bf9b1****, message: success

Task information
TaskName String Build Image

Task name
TaskStatus String 2

The status of the task.

  • 0: Ready
  • 1: Execution in progress
  • 2: execution successful
  • 3: execution failed
  • 6: Terminated
  • 10: abnormal system execution failed
StageList Array

The stages of each batch. For more information, see the definition of StageInfoDTO.
StageInfoDTO:
StageId String 358 a143 f-09a0-45e0-******************* @ **_*******

The ID of the stage.
StageName String Scale Out

The name of the stage.
StageResultDTO: Struct

For more information about the definition of each stage, see StageResultDTO.
InstanceDTOList Array

The stage execution results in each ECS instance. For more information, see the definition of InstanceDTO.

InstanceDTO:
InstanceIp String 47.XX.XX.12 (Public)<br>****

The IP address of the instance.
Instance name String EDAS-scaled-cluster:default cluster

Instance Name
InstanceStageDTOList Array

The list of stage execution results in each instance.
InstanceStageDTO:
FinishTime String 2020-03-11T07:28:52Z

End Time
StageId String 5dd4c0f2-d81a-406f-****

The ID of the stage.
StageMessage String Pulling image \"registry-vpc.cn-hangzhou.aliyuncs.com****-user/1172745****_shared_repo:428084d6-265f-****-911a-7eb0d2c3****_1583911707325\

Stage Information
StageName String scale out

The name of the stage.
StartTime String 2020-03-11T07:28:49Z

Start Time
Status Integer 2

Phase state

  • 0: Ready
  • 1: Execution in progress
  • 2: execution successful
  • 3: execution failed
  • 6: Terminated
  • 10: abnormal system execution failed
PodName String canary-test

Node Name
PodStatus String Task Running

Pod status
Status Integer 2
  • 0: Ready
  • 1: Execution in progress
  • 2: execution successful
  • 3: execution failed
  • 6: Terminated
  • 10 system exception execution failure
ServiceStage: Struct

The execution result of a service-type stage.
Message String success

The execution result of the stage.
StageId String 358 a143 f-09a0-45e0-*****-**************

The ID of a stage.
StageName String Enable Tengine

The name of the stage.
Status Integer 2

Running status(0: Preparation 1: Execution in Progress 2: execution successful 3: execution failed 6: Ended 10: execution failed due to a system error)

Status Integer 2

The status of the stage. Valid values: 0 (preparation), 1 (execution in progress), 2 (execution successful), 3 (execution failed), 6 (ended), and 10 (execution failed due to a system error).

StartTime String 1583911702158

Start Time
UpdateTime String 1583911743633

The time when the returned instance group was updated.
Status Integer 2

Valid values: 0 (preparation), 1 (execution in progress), 2 (execution successful), 3 (execution failed), 6 (ended), and 10 (execution failed due to a system error).

SupportRollback Boolean false
  • Supports rollback: true
  • Does not support rollback: false
TrafficControl Struct

Rate limiting rule
Routes String [{"app":"9c8247da-91b6-42bb-8f99-92a0b9c6f****","type":"GROUP"}]

Definition
Rules String [{"conditionType":"content","conditions":[{"key":"name","operator":"EQ","strategy":"PARAM","values":["jim"]},{"key":"name","operator":"EQ","strategy":"COOKIE","values":["jim"]}],"percent":100,"protocol":"SPRINGCLOUD","triggerPolicy":"AND"}]

Traffic Routing rules
Tips String The phased batch has been published and is confirmed to be in the next batch.

Text prompt description of traffic rule

Examples

Sample requests

POST /pop/v5/changeorder/change_order_info HTTP/1.1
Common request header
{
  "ChangeOrderId": ""
}

Sample success responses

XML format 

<Message>success</Message>
<changeOrderInfo>
    <Status>2</Status>
    <BatchCount>1</BatchCount>
    <CreateTime>2019-11-13 14:23:46</CreateTime>
    <BatchType>Automatic</BatchType>
    <CoType>Application Scale Out</CoType>
    <CreateUserId>edas_com***_****@******-*****. ***</CreateUserId>
    <ChangeOrderId>1074f3e2-e974-4a0e-****-************</ChangeOrderId>
    <PipelineInfoList>
        <PipelineInfo>
            <StageList>
                <StageInfoDTO>
                    <StageId>316641fc-69a7-4cc4-****-************</StageId>
                    <Status>2</Status>
                    <StageName>Process Start </StageName>
                    <StageResultDTO>
                        <ServiceStage>
                            <StageId>316641fc-69a7-4cc4-****-************</StageId>
                            <Status>2</Status>
                            <StageName>Process Start </StageName>
                            <Message>Success</Message>
                        </ServiceStage>
                        <InstanceDTOList>
                        </InstanceDTOList>
                    </StageResultDTO>
                </StageInfoDTO>
                <StageInfoDTO>
                    <StageId>358a143f-09a0-45e0-****-************@**_*******_*****</StageId>
                    <Status>2</Status>
                    <StageName>Scale Out</StageName>
                    <StageResultDTO>
                        <ServiceStage/>
                        <InstanceDTOList>
                            <InstanceDTO>
                                <Status>2</Status>
                                <InstanceStageDTOList>
                                    <InstanceStageDTO>
                                        <StageId>5dd4c0f2-d81a-406f-****-************</StageId>
                                        <Status>2</Status>
                                        <StageName> scale out </StageName>
                                    </InstanceStageDTO>
                                </InstanceStageDTOList>
                                <InstanceIp>47.107.50.27 (Public)<br>***. **. *. *** (*******)</InstanceIp>
                                <InstanceName>EDAS-scaled-cluster: the default cluster. </InstanceName>
                            </InstanceDTO>
                        </InstanceDTOList>
                    </StageResultDTO>
                </StageInfoDTO>
                <StageInfoDTO>
                    <StageId>358a143f-09a0-45e0-****-************</StageId>
                    <Status>2</Status>
                    <StageName>Enable Tengine</StageName>
                    <StageResultDTO>
                        <ServiceStage>
                            <StageId>358a143f-09a0-45e0-****-************</StageId>
                            <Status>2</Status>
                            <StageName>Enable Tengine</StageName>
                            <Message>Success</Message>
                        </ServiceStage>
                        <InstanceDTOList>
                        </InstanceDTOList>
                    </StageResultDTO>
                </StageInfoDTO>
                <StageInfoDTO>
                    <StageId>628acb11-09dd-4709-****-************@**_*******_*****</StageId>
                    <Status>2</Status>
                    <StageName>Health Check</StageName>
                    <StageResultDTO>
                        <ServiceStage/>
                        <InstanceDTOList>
                            <InstanceDTO>
                                <Status>2</Status>
                                <InstanceStageDTOList>
                                    <InstanceStageDTO>
                                        <StageId>70fcced7-9b99-409f-****-************</StageId>
                                        <Status>2</Status>
                                        <StageName>Health Check</StageName>
                                    </InstanceStageDTO>
                                </InstanceStageDTOList>
                                <InstanceIp>47.107.50.27 (Public)<br>***. **. *. *** (*******)</InstanceIp>
                                <InstanceName>EDAS-scaled-cluster: the default cluster. </InstanceName>
                            </InstanceDTO>
                        </InstanceDTOList>
                    </StageResultDTO>
                </StageInfoDTO>
                <StageInfoDTO>
                    <StageId>628acb11-09dd-4709-****-************</StageId>
                    <Status>2</Status>
                    <StageName>Enable SLB</StageName>
                    <StageResultDTO>
                        <ServiceStage>
                            <StageId>628acb11-09dd-4709-****-************</StageId>
                            <Status>2</Status>
                            <StageName>Enable SLB</StageName>
                            <Message>Success</Message>
                        </ServiceStage>
                        <InstanceDTOList>
                        </InstanceDTOList>
                    </StageResultDTO>
                </StageInfoDTO>
                <StageInfoDTO>
                    <StageId>bf15f2b1-e7b2-4069-****-************</StageId>
                    <Status>2</Status>
                    <StageName>Process Complete</StageName>
                    <StageResultDTO>
                        <ServiceStage>
                            <StageId>bf15f2b1-e7b2-4069-****-************</StageId>
                            <Status>2</Status>
                            <StageName>Process Complete</StageName>
                            <Message>Success</Message>
                        </ServiceStage>
                        <InstanceDTOList>
                        </InstanceDTOList>
                    </StageResultDTO>
                </StageInfoDTO>
            </StageList>
            <PipelineName> Batch: 1</PipelineName>
            <PipelineStatus>2</PipelineStatus>
            <PipelineId>4c4ee320-5e47-4a48-****-************</PipelineId>
        </PipelineInfo>
    </PipelineInfoList>
    <Desc>IP of Scale-Out Instance: 47.107. **. **(Public)</Desc>
</changeOrderInfo>
<Code>200</Code>

JSON format 

{
    "Message": "success",
    "changeOrderInfo": {
        "Status": 2,
    "BatchCount": 1,
    "CreateTime": "2019-11-13 14:23:46",
    "BatchType": "Automatic",
    "CoType": "Application Scale Out",
    "CreateUserId": "edas_com***_****@******-*****. ***",
    "ChangeOrderId": "1074f3e2-e974-4a0e-****-************",
        "PipelineInfoList": {
    "PipelineInfo": [
        {
            "StageList": {
                "StageInfoDTO": [
                    {
                        "StageId": "316641fc-69a7-4cc4-****-************",
                        "Status": 2,
                        "StageName": "Process Start ",
                        "StageResultDTO": {
                            "ServiceStage": {
                                "StageId": "316641fc-69a7-4cc4-****-************",
                                "Status": 2,
                                "StageName": "Process Start ",
                                "Message": "Success"
                            },
                            "InstanceDTOList": {
                                "InstanceDTO": []
                            }
                        }
                    },
                    {
                        "StageId": "358a143f-09a0-45e0-****-************@**_*******_*****",
                        "Status": 2,
                        "StageName": "Scale Out",
                        "StageResultDTO": {
                            "ServiceStage": {},
                            "InstanceDTOList": {
                                "InstanceDTO": [
                                    {
                                        "Status": 2,
                                        "InstanceStageDTOList": {
                                            "InstanceStageDTO": [
                                                {
                                                    "StageId": "5dd4c0f2-d81a-406f-****-************",
                                                    "Status": 2,
                                                    "StageName": "scale out"
                                                }
                                            ]
                                        },
                                        "InstanceIp": "47.107.50.27 (Public)<br>***. **. *. *** (********) ",
                                        "InstanceName": "EDAS-scaled-cluster: the default cluster"
                                    }
                                ]
                            }
                        }
                    },
                    {
                        "StageId": "358a143f-09a0-45e0-****-************",
                        "Status": 2,
                        "StageName": "Enable Tengine",
                        "StageResultDTO": {
                            "ServiceStage": {
                                "StageId": "358a143f-09a0-45e0-****-************",
                                "Status": 2,
                                "StageName": "Enable Tengine",
                                "Message": "Success"
                            },
                            "InstanceDTOList": {
                                "InstanceDTO": []
                            }
                        }
                    },
                    {
                        "StageId": "628acb11-09dd-4709-****-************@**_*******_*****",
                        "Status": 2,
                        "StageName": "Health Check",
                        "StageResultDTO": {
                            "ServiceStage": {},
                            "InstanceDTOList": {
                                "InstanceDTO": [
                                    {
                                        "Status": 2,
                                        "InstanceStageDTOList": {
                                            "InstanceStageDTO": [
                                                {
                                                    "StageId": "70fcced7-9b99-409f-****-************",
                                                    "Status": 2,
                                                    "StageName": "Health Check"
                                                }
                                            ]
                                        },
                                        "InstanceIp": "47.107.50.27 (Public)<br>***. **. *. *** (********) ",
                                        "InstanceName": "EDAS-scaled-cluster: the default cluster"
                                    }
                                ]
                            }
                        }
                    },
                    {
                        "StageId": "628acb11-09dd-4709-****-************",
                        "Status": 2,
                        "StageName": "Enable SLB",
                        "StageResultDTO": {
                            "ServiceStage": {
                                "StageId": "628acb11-09dd-4709-****-************",
                                "Status": 2,
                                "StageName": "Enable SLB",
                                "Message": "Success"
                            },
                            "InstanceDTOList": {
                                "InstanceDTO": []
                            }
                        }
                    },
                    {
                        "StageId": "bf15f2b1-e7b2-4069-****-************",
                        "Status": 2,
                        "StageName": "Process Complete",
                        "StageResultDTO": {
                            "ServiceStage": {
                                "StageId": "bf15f2b1-e7b2-4069-****-************",
                                "Status": 2,
                                "StageName": "Process Complete",
                                "Message": "Success"
                            },
                            "InstanceDTOList": {
                                "InstanceDTO": []
                            }
                        }
                    }
                ]
            },
            "PipelineName": "Batch: 1",
            "PipelineStatus": 2,
            "PipelineId": "4c4ee320-5e47-4a48-****-************"
        }
    ]
},
        "Desc": "IP of Scale-Out Instance: 47.107. **. **(Public)"
    },
    "Code": 200
}

Error codes

For a list of error codes, visit the API Error Center.