全部产品
Search
文档中心

企业级分布式应用服务 EDAS:GetChangeOrderInfo - 查看变更流程详情

更新时间:Mar 01, 2024

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
edas:ReadApplicationRead
  • Application
    acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}

请求语法

POST /pop/v5/changeorder/change_order_info

请求参数

名称类型必填描述示例值
ChangeOrderIdstring

变更流程 ID

1074f3e2-e974-4a0e-****-************

返回参数

名称类型描述示例值
object
Codeinteger

接口状态或 POP 错误码

200
Messagestring

附加信息

success
RequestIdstring

请求 ID

4JFR-FV9F***************
changeOrderInfoobject

变更流程详情

Statusinteger

变更状态

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

变更流程 ID

1074f3e2-e974-4a0e-****-************
BatchTypestring

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

  • Automatic:自动
  • Manual:手动
Automatic
CoTypestring

变更流程分类

Application Scale Out
CreateTimestring

创建时间

2019-11-13 14:23:46
ChangeOrderDescriptionstring

变更流程描述

应用扩容
BatchCountinteger

变更分批数

1
CreateUserIdstring

变更流程的负责人

edas_com***_****@******-*****.***
SupportRollbackboolean

是否支持回滚。

  • true:支持回滚
  • false:不支持回滚
false
Descstring

变更流程描述

IP of Scale-Out Instance: 47.107.XX.XX
PipelineInfoListobject []

分批变更任务列表

PipelineNamestring

批次名称

Batch: 1
StartTimestring

开始时间的时间戳

1583911702158
UpdateTimestring

更新时间的时间戳

1583911743633
PipelineStatusinteger

任务状态:

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

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

4c4ee320-5e47-4a48-****-************
StageListobject []

变更流程的任务阶段列表

StageIdstring

阶段 ID

358a143f-09a0-45e0-****-************@**_*******_*****
Statusinteger

阶段状态

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

阶段名称

Scale Out
StageResultDTOobject

阶段任务的执行结果

InstanceDTOListobject []

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

Statusinteger

运行状态

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

实例 IP

47.XX.XX.12 (Public)<br>***.**.*.*** (*******)
PodNamestring

节点名称

canary-test
InstanceNamestring

实例名称

EDAS-scaled
PodStatusstring

Pod 状态

执行中
InstanceStageDTOListobject []

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

StageIdstring

阶段 ID

5dd4c0f2-d81a-406f-****-************
Statusinteger

阶段状态

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

开始时间

2020-03-11T07:28:49Z
StageMessagestring

阶段信息

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

结束时间

2020-03-11T07:28:52Z
StageNamestring

阶段名称

scale out
ServiceStageobject

服务型阶段执行结果

StageIdstring

阶段 ID

358a143f-09a0-45e0-****-************
Statusinteger

运行状态

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

执行结果信息

Success
StageNamestring

阶段名称

Enable Tengine
StageDetailListobject []

阶段执行结果列表

StageIdstring

阶段 ID

d7561440-10a6-452f-8a90-62f6e7ec****
StageStatusinteger

阶段状态:

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

阶段名称

Process Start
TaskListobject []

任务列表

TaskErrorIgnoranceinteger

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

  • 0:不容忍错误
  • 1:容忍错误
0
ShowManualIgnoranceboolean

是否显示忽略错误按钮

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

任务状态

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

任务信息

[CALLBACK] 2020-03-11 15:28:44.781 requestId: c952ab99-8c5b-4ff1-9412-ae3bf9b1****, message: success
TaskNamestring

任务名称

Build Image
TaskErrorCodestring

错误码

400
RetryTypeinteger

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

0
TaskIdstring

任务 ID

d6d3b934-90a1-4ae8-8cbd-2446003d****
TaskErrorMessagestring

任务错误信息

400
Targetsarray
string

关联 ECS 的 IP 地址列表

["123.250.XX.XX","234.123.XX.XX"]
TrafficControlobject

流控规则

Routesstring

路由转发策略

[{"app":"9c8247da-91b6-42bb-8f99-92a0b9c6f****","type":"GROUP"}]
Rulesstring

流量的路由规则

[{"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"}]
Tipsstring

流量规则的提示说明文案

灰度批次发布完毕,已确认继续下一批。

示例

正常返回示例

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": {
      "PipelineInfo": [
        {
          "PipelineName": " Batch: 1",
          "StartTime": "1583911702158",
          "UpdateTime": "1583911743633",
          "PipelineStatus": 2,
          "PipelineId": "4c4ee320-5e47-4a48-****-************",
          "StageList": {
            "StageInfoDTO": [
              {
                "StageId": "358a143f-09a0-45e0-****-************@**_*******_*****",
                "Status": 2,
                "StageName": "Scale Out",
                "StageResultDTO": {
                  "InstanceDTOList": {
                    "InstanceDTO": [
                      {
                        "Status": 2,
                        "InstanceIp": "47.XX.XX.12 (Public)<br>***.**.*.*** (*******)",
                        "PodName": "canary-test",
                        "InstanceName": "EDAS-scaled",
                        "PodStatus": "执行中",
                        "InstanceStageDTOList": {
                          "InstanceStageDTO": [
                            {
                              "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": {
            "StageDetailDTO": [
              {
                "StageId": "d7561440-10a6-452f-8a90-62f6e7ec****",
                "StageStatus": 2,
                "StageName": "Process Start",
                "TaskList": {
                  "TaskInfoDTO": [
                    {
                      "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",
                      "RetryType": 0,
                      "TaskId": "d6d3b934-90a1-4ae8-8cbd-2446003d****",
                      "TaskErrorMessage": "400"
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    },
    "Targets": {
      "Items": [
        "[\"123.250.XX.XX\",\"234.123.XX.XX\"]"
      ]
    },
    "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": "灰度批次发布完毕,已确认继续下一批。"
    }
  }
}

错误码

HTTP status code错误码错误信息
400Edas.errorcode.PermissionDenied.messageNo permissions
400Edas.errorcode.ParameterMissing.ChangeOrderId.messageChange process ID is missing.

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