GetChangeOrderInfo - API参考| 阿里云

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

请求语法

POST /pop/v5/changeorder/change_order_info HTTP/1.1

请求参数


名称	类型	位置	是否必选	示例值	描述
ChangeOrderId	String	Query	是	1074f3e2-e974-4a0e-**-**********	变更流程ID

返回数据


名称	类型	示例值	描述
Code	Integer	200	接口状态或POP错误码
Message	String	success	附加信息
RequestId	String	4JFR-FV9F***************	请求ID
changeOrderInfo	Struct		变更流程详情
BatchCount	Integer	1	变更分批数
BatchType	String	Automatic	分批发布时，下一批变更的执行方式。 Automatic：自动 Manual：手动
ChangeOrderDescription	String	应用扩容	变更流程描述
ChangeOrderId	String	1074f3e2-e974-4a0e-**-**********	变更流程ID
CoType	String	Application Scale Out	变更流程分类
CreateTime	String	2019-11-13 14:23:46	创建时间
CreateUserId	String	edas_com*_@**-*.*	变更流程的负责人
Desc	String	IP of Scale-Out Instance: 47.107.XX.XX	变更流程描述
PipelineInfoList	Array of PipelineInfo		分批变更任务列表
PipelineInfo
PipelineId	String	4c4ee320-5e47-4a48-**-**********	分批变更时各批次流程的ID
PipelineName	String	Batch: 1	批次名称
PipelineStatus	Integer	2	任务状态： 0：准备 1：执行中 2：执行成功 3：执行失败 6：终止 8：手动分批发布模式下，等待手工确认执行下一批 9：自动分批发布模式下，等待下一批执行中 10：系统异常执行失败
StageDetailList	Array of StageDetailDTO		阶段执行结果列表
StageDetailDTO
StageId	String	d7561440-10a6-452f-8a90-62f6e7ec****	阶段ID
StageName	String	Process Start	阶段名称
StageStatus	Integer	2	阶段状态： 0：准备 1：执行中 2：执行成功 3：执行失败 6：终止 8：手动分批发布模式下，等待手工确认执行下一批 9：自动分批发布模式下，等待下一批执行中 10：系统异常执行失败
TaskList	Array of TaskInfoDTO		任务列表
TaskInfoDTO
ShowManualIgnorance	Boolean	false	是否显示`忽略错误按钮`。 true：忽略变更流程中出现的错误。目前只有执行URL健康检查时，该参数的取值可为true。 false：不忽略变更流程中出现的错误。
TaskErrorCode	String	400	错误码
TaskErrorIgnorance	Integer	0	表示任务本身是否能容忍错误，如果容忍，则发生错误时，变更流程将忽略错误来继续下一个任务。 0：不容忍错误 1：容忍错误
TaskErrorMessage	String	400	任务错误信息
TaskId	String	d6d3b934-90a1-4ae8-8cbd-2446003d****	任务ID
TaskMessage	String	[CALLBACK] 2020-03-11 15:28:44.781 requestId: c952ab99-8c5b-4ff1-9412-ae3bf9b1****, message: success	任务信息
TaskName	String	Build Image	任务名称
TaskStatus	String	2	任务状态 0：准备 1：执行中 2：执行成功 3：执行失败 6：终止 8：手动分批发布模式下，等待手工确认执行下一批 9：自动分批发布模式下，等待下一批执行中 10：系统异常执行失败
StageList	Array of StageInfoDTO		变更流程的任务阶段列表
StageInfoDTO
StageId	String	358a143f-09a0-45e0-**-********@_*****_***	阶段ID
StageName	String	Scale Out	阶段名称
StageResultDTO	Struct		阶段任务的执行结果
InstanceDTOList	Array of InstanceDTO		运行在每台ECS实例上阶段执行结果
InstanceDTO
InstanceIp	String	47.XX.XX.12 (Public)<br>*... (*****)	实例IP
InstanceName	String	EDAS-scaled	实例名称
InstanceStageDTOList	Array of InstanceStageDTO		每个实例上阶段执行的结果列表
InstanceStageDTO
FinishTime	String	2020-03-11T07:28:52Z	结束时间
StageId	String	5dd4c0f2-d81a-406f-**-**********	阶段ID
StageMessage	String	Pulling image \"registry-vpc.cn-hangzhou.aliyuncs.com**-user/1172745_shared_repo:428084d6-265f--911a-7eb0d2c3_15839117**\	阶段信息
StageName	String	scale out	阶段名称
StartTime	String	2020-03-11T07:28:49Z	开始时间
Status	Integer	2	阶段状态 0：准备 1：执行中 2：执行成功 3：执行失败 6：终止 8：手动分批发布模式下，等待手工确认执行下一批 9：自动分批发布模式下，等待下一批执行中 10：系统异常执行失败
PodName	String	canary-test	节点名称
PodStatus	String	执行中	Pod状态
Status	Integer	2	运行状态 0：准备 1：执行中 2：执行成功 3：执行失败 6：终止 8：手动分批发布模式下，等待手工确认执行下一批 9：自动分批发布模式下，等待下一批执行中 10：系统异常执行失败
ServiceStage	Struct		服务型阶段执行结果
Message	String	Success	执行结果信息
StageId	String	358a143f-09a0-45e0-**-**********	阶段ID
StageName	String	Enable Tengine	阶段名称
Status	Integer	2	运行状态 0：准备 1：执行中 2：执行成功 3：执行失败 6：终止 8：手动分批发布模式下，等待手工确认执行下一批 9：自动分批发布模式下，等待下一批执行中 10：系统异常执行失败
Status	Integer	2	阶段状态 0：准备 1：执行中 2：执行成功 3：执行失败 6：终止 8：手动分批发布模式下，等待手工确认执行下一批 9：自动分批发布模式下，等待下一批执行中 10：系统异常执行失败
StartTime	String	1583911702158	开始时间的时间戳
UpdateTime	String	1583911743633	更新时间的时间戳
Status	Integer	2	变更状态 0：准备 1：执行中 2：执行成功 3：执行失败 6：终止 8：手动分批发布模式下，等待手工确认执行下一批 9：自动分批发布模式下，等待下一批执行中 10：系统异常执行失败
SupportRollback	Boolean	false	是否支持回滚。 true：支持回滚 false：不支持回滚
TrafficControl	Struct		流控规则
Routes	String	[{"app":"9c8247da-91b6-42bb-8f99-92a0b9c6f****","type":"GROUP"}]	路由转发策略
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"}]	流量的路由规则
Tips	String	灰度批次发布完毕，已确认继续下一批。	流量规则的提示说明文案

示例

请求示例

POST /pop/v5/changeorder/change_order_info HTTP/1.1
公共请求头
{
  "ChangeOrderId": ""
}

正常返回示例

XML格式

<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.XX.XX.27 (Public)&lt;br&gt;***.**.*.*** (*******)</InstanceIp>
                                <InstanceName>EDAS-scaled-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.XX.XX.27 (Public)&lt;br&gt;***.**.*.*** (*******)</InstanceIp>
                                <InstanceName>EDAS-scaled-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.XX.XX.27 (Public)</Desc>
</changeOrderInfo>
<Code>200</Code>

JSON格式

{
	"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.XX.XX.27 (Public)<br>***.**.*.*** (*******)",
                                        "InstanceName": "EDAS-scaled-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.XX.XX.27 (Public)<br>***.**.*.*** (*******)",
                                        "InstanceName": "EDAS-scaled-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.XX.XX.27 (Public)"
	},
	"Code": 200
}

错误码

访问错误中心查看更多错误码。