调用GetChangeOrderInfo接口查看变更流程详情。

调试

您可以在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 Object

变更流程详情

Status Integer 2

变更状态

  • 0:准备
  • 1:执行中
  • 2:执行成功
  • 3:执行失败
  • 6:终止
  • 8:手动分批发布模式下,等待手工确认执行下一批
  • 9:自动分批发布模式下,等待下一批执行中
  • 10:系统异常执行失败
ChangeOrderId String 1074f3e2-e974-4a0e-****-************

变更流程ID

BatchType String Automatic

分批发布时,下一批变更的执行方式。

  • Automatic:自动
  • Manual:手动
CoType String Application Scale Out

变更流程分类

CreateTime String 2019-11-13 14:23:46

创建时间

ChangeOrderDescription String 应用扩容

变更流程描述

BatchCount Integer 1

变更分批数

CreateUserId String edas_com***_****@******-*****.***

变更流程的负责人

SupportRollback Boolean false

是否支持回滚。

  • true:支持回滚
  • false:不支持回滚
Desc String IP of Scale-Out Instance: 47.107.XX.XX

变更流程描述

PipelineInfoList Array of PipelineInfo

分批变更任务列表

PipelineInfo
PipelineName String Batch: 1

批次名称

StartTime String 1583911702158

开始时间的时间戳

UpdateTime String 1583911743633

更新时间的时间戳

PipelineStatus Integer 2

任务状态:

  • 0:准备
  • 1:执行中
  • 2:执行成功
  • 3:执行失败
  • 6:终止
  • 8:手动分批发布模式下,等待手工确认执行下一批
  • 9:自动分批发布模式下,等待下一批执行中
  • 10:系统异常执行失败
PipelineId String 4c4ee320-5e47-4a48-****-************

分批变更时各批次流程的ID

StageList Array of StageInfoDTO

变更流程的任务阶段列表

StageInfoDTO
StageId String 358a143f-09a0-45e0-****-************@**_*******_*****

阶段ID

Status Integer 2

阶段状态

  • 0:准备
  • 1:执行中
  • 2:执行成功
  • 3:执行失败
  • 6:终止
  • 8:手动分批发布模式下,等待手工确认执行下一批
  • 9:自动分批发布模式下,等待下一批执行中
  • 10:系统异常执行失败
StageName String Scale Out

阶段名称

StageResultDTO Object

阶段任务的执行结果

InstanceDTOList Array of InstanceDTO

运行在每台ECS实例上阶段执行结果

InstanceDTO
Status Integer 2

运行状态

  • 0:准备
  • 1:执行中
  • 2:执行成功
  • 3:执行失败
  • 6:终止
  • 8:手动分批发布模式下,等待手工确认执行下一批
  • 9:自动分批发布模式下,等待下一批执行中
  • 10:系统异常执行失败
InstanceIp String 47.XX.XX.12 (Public)<br>***.**.*.*** (*******)

实例IP

PodName String canary-test

节点名称

InstanceName String EDAS-scaled

实例名称

PodStatus String 执行中

Pod状态

InstanceStageDTOList Array of InstanceStageDTO

每个实例上阶段执行的结果列表

InstanceStageDTO
StageId String 5dd4c0f2-d81a-406f-****-************

阶段ID

Status Integer 2

阶段状态

  • 0:准备
  • 1:执行中
  • 2:执行成功
  • 3:执行失败
  • 6:终止
  • 8:手动分批发布模式下,等待手工确认执行下一批
  • 9:自动分批发布模式下,等待下一批执行中
  • 10:系统异常执行失败
StartTime String 2020-03-11T07:28:49Z

开始时间

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

阶段信息

FinishTime String 2020-03-11T07:28:52Z

结束时间

StageName String scale out

阶段名称

ServiceStage Object

服务型阶段执行结果

StageId String 358a143f-09a0-45e0-****-************

阶段ID

Status Integer 2

运行状态

  • 0:准备
  • 1:执行中
  • 2:执行成功
  • 3:执行失败
  • 6:终止
  • 8:手动分批发布模式下,等待手工确认执行下一批
  • 9:自动分批发布模式下,等待下一批执行中
  • 10:系统异常执行失败
Message String Success

执行结果信息

StageName String Enable Tengine

阶段名称

StageDetailList Array of StageDetailDTO

阶段执行结果列表

StageDetailDTO
StageId String d7561440-10a6-452f-8a90-62f6e7ec****

阶段ID

StageStatus Integer 2

阶段状态:

  • 0:准备
  • 1:执行中
  • 2:执行成功
  • 3:执行失败
  • 6:终止
  • 8:手动分批发布模式下,等待手工确认执行下一批
  • 9:自动分批发布模式下,等待下一批执行中
  • 10:系统异常执行失败
StageName String Process Start

阶段名称

TaskList Array of TaskInfoDTO

任务列表

TaskInfoDTO
TaskErrorIgnorance Integer 0

表示任务本身是否能容忍错误,如果容忍,则发生错误时,变更流程将忽略错误来继续下一个任务。

  • 0:不容忍错误
  • 1:容忍错误
ShowManualIgnorance Boolean false

是否显示忽略错误按钮

  • true:忽略变更流程中出现的错误。目前只有执行URL健康检查时,该参数的取值可为true。
  • false:不忽略变更流程中出现的错误。
TaskStatus String 2

任务状态

  • 0:准备
  • 1:执行中
  • 2:执行成功
  • 3:执行失败
  • 6:终止
  • 8:手动分批发布模式下,等待手工确认执行下一批
  • 9:自动分批发布模式下,等待下一批执行中
  • 10:系统异常执行失败
TaskMessage String [CALLBACK] 2020-03-11 15:28:44.781 requestId: c952ab99-8c5b-4ff1-9412-ae3bf9b1****, message: success

任务信息

TaskName String Build Image

任务名称

TaskErrorCode String 400

错误码

RetryType Integer 0

重试类型,0 表示不重试,1表示自动重试,2表示手动重试

TaskId String d6d3b934-90a1-4ae8-8cbd-2446003d****

任务ID

TaskErrorMessage String 400

任务错误信息

Targets Array of String ["123.250.124.86","234.123.42.82"]

关联ECS的IP地址列表

TrafficControl Object

流控规则

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?ChangeOrderId=1074f3e2-e974-4a0e-****-************ HTTP/1.1
Host:edas.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetChangeOrderInfoResponse>
    <Code>200</Code>
    <Message>success</Message>
    <RequestId>4JFR-FV9F***************</RequestId>
    <changeOrderInfo>
        <Status>2</Status>
        <ChangeOrderId>1074f3e2-e974-4a0e-****-************</ChangeOrderId>
        <BatchType>Automatic</BatchType>
        <CoType>Application Scale Out</CoType>
        <CreateTime>2019-11-13 14:23:46</CreateTime>
        <ChangeOrderDescription>应用扩容</ChangeOrderDescription>
        <BatchCount>1</BatchCount>
        <CreateUserId>edas_com***_****@******-*****.***</CreateUserId>
        <SupportRollback>false</SupportRollback>
        <Desc>IP of Scale-Out Instance: 47.107.XX.XX</Desc>
        <PipelineInfoList>
            <PipelineName> Batch: 1</PipelineName>
            <StartTime>1583911702158</StartTime>
            <UpdateTime>1583911743633</UpdateTime>
            <PipelineStatus>2</PipelineStatus>
            <PipelineId>4c4ee320-5e47-4a48-****-************</PipelineId>
            <StageList>
                <StageId>358a143f-09a0-45e0-****-************@**_*******_*****</StageId>
                <Status>2</Status>
                <StageName>Scale Out</StageName>
                <StageResultDTO>
                    <InstanceDTOList>
                        <Status>2</Status>
                        <InstanceIp>47.XX.XX.12 (Public)&lt;br&gt;***.**.*.*** (*******)</InstanceIp>
                        <PodName>canary-test</PodName>
                        <InstanceName>EDAS-scaled</InstanceName>
                        <PodStatus>执行中</PodStatus>
                        <InstanceStageDTOList>
                            <StageId>5dd4c0f2-d81a-406f-****-************</StageId>
                            <Status>2</Status>
                            <StartTime>2020-03-11T07:28:49Z</StartTime>
                            <StageMessage>Pulling image \"registry-vpc.cn-hangzhou.aliyuncs.com****-user/1172745****_shared_repo:428084d6-265f-****-911a-7eb0d2c3****_15839117****\</StageMessage>
                            <FinishTime>2020-03-11T07:28:52Z</FinishTime>
                            <StageName> scale out </StageName>
                        </InstanceStageDTOList>
                    </InstanceDTOList>
                    <ServiceStage>
                        <StageId>358a143f-09a0-45e0-****-************</StageId>
                        <Status>2</Status>
                        <Message>Success</Message>
                        <StageName>Enable Tengine</StageName>
                    </ServiceStage>
                </StageResultDTO>
            </StageList>
            <StageDetailList>
                <StageId>d7561440-10a6-452f-8a90-62f6e7ec****</StageId>
                <StageStatus>2</StageStatus>
                <StageName>Process Start</StageName>
                <TaskList>
                    <TaskErrorIgnorance>0</TaskErrorIgnorance>
                    <ShowManualIgnorance>false</ShowManualIgnorance>
                    <TaskStatus>2</TaskStatus>
                    <TaskMessage>[CALLBACK] 2020-03-11 15:28:44.781  requestId: c952ab99-8c5b-4ff1-9412-ae3bf9b1****, message: success</TaskMessage>
                    <TaskName>Build Image</TaskName>
                    <TaskErrorCode>400</TaskErrorCode>
                    <TaskId>d6d3b934-90a1-4ae8-8cbd-2446003d****</TaskId>
                    <TaskErrorMessage>400</TaskErrorMessage>
                </TaskList>
            </StageDetailList>
        </PipelineInfoList>
        <TrafficControl>
            <Routes>[{"app":"9c8247da-91b6-42bb-8f99-92a0b9c6f****","type":"GROUP"}]</Routes>
            <Rules>[{"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"}]</Rules>
            <Tips>灰度批次发布完毕,已确认继续下一批。</Tips>
        </TrafficControl>
    </changeOrderInfo>
</GetChangeOrderInfoResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Code" : 200,
  "Message" : "success",
  "RequestId" : "4JFR-FV9F***************",
  "changeOrderInfo" : {
    "Status" : 2,
    "ChangeOrderId" : "1074f3e2-e974-4a0e-****-************",
    "BatchType" : "Automatic",
    "CoType" : "Application Scale Out",
    "CreateTime" : "2019-11-13 14:23:46",
    "ChangeOrderDescription" : "应用扩容",
    "BatchCount" : 1,
    "CreateUserId" : "edas_com***_****@******-*****.***",
    "SupportRollback" : false,
    "Desc" : "IP of Scale-Out Instance: 47.107.XX.XX",
    "PipelineInfoList" : [ {
      "PipelineName" : " Batch: 1",
      "StartTime" : "1583911702158",
      "UpdateTime" : "1583911743633",
      "PipelineStatus" : 2,
      "PipelineId" : "4c4ee320-5e47-4a48-****-************",
      "StageList" : [ {
        "StageId" : "358a143f-09a0-45e0-****-************@**_*******_*****",
        "Status" : 2,
        "StageName" : "Scale Out",
        "StageResultDTO" : {
          "InstanceDTOList" : [ {
            "Status" : 2,
            "InstanceIp" : "47.XX.XX.12 (Public)<br>***.**.*.*** (*******)",
            "PodName" : "canary-test",
            "InstanceName" : "EDAS-scaled",
            "PodStatus" : "执行中",
            "InstanceStageDTOList" : [ {
              "StageId" : "5dd4c0f2-d81a-406f-****-************",
              "Status" : 2,
              "StartTime" : "2020-03-11T07:28:49Z",
              "StageMessage" : "Pulling image \\\"registry-vpc.cn-hangzhou.aliyuncs.com****-user/1172745****_shared_repo:428084d6-265f-****-911a-7eb0d2c3****_15839117****\\",
              "FinishTime" : "2020-03-11T07:28:52Z",
              "StageName" : " scale out "
            } ]
          } ],
          "ServiceStage" : {
            "StageId" : "358a143f-09a0-45e0-****-************",
            "Status" : 2,
            "Message" : "Success",
            "StageName" : "Enable Tengine"
          }
        }
      } ],
      "StageDetailList" : [ {
        "StageId" : "d7561440-10a6-452f-8a90-62f6e7ec****",
        "StageStatus" : 2,
        "StageName" : "Process Start",
        "TaskList" : [ {
          "TaskErrorIgnorance" : 0,
          "ShowManualIgnorance" : false,
          "TaskStatus" : "2",
          "TaskMessage" : "[CALLBACK] 2020-03-11 15:28:44.781  requestId: c952ab99-8c5b-4ff1-9412-ae3bf9b1****, message: success",
          "TaskName" : "Build Image",
          "TaskErrorCode" : "400",
          "TaskId" : "d6d3b934-90a1-4ae8-8cbd-2446003d****",
          "TaskErrorMessage" : "400"
        } ]
      } ]
    } ],
    "Targets" : [ ],
    "TrafficControl" : {
      "Routes" : "[{\"app\":\"9c8247da-91b6-42bb-8f99-92a0b9c6f****\",\"type\":\"GROUP\"}]",
      "Rules" : "[{\"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" : "灰度批次发布完毕,已确认继续下一批。"
    }
  }
}

错误码

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