AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 企业级分布式应用服务 开发参考 API参考 API目录 应用管理 ECS集群和K8s集群通用 GetChangeOrderInfo - 查看变更流程详情

GetChangeOrderInfo - 查看变更流程详情

更新时间：
产品详情
我的收藏

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

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

edas:ReadApplication

get

*Application

acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}

 无 无

请求语法

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

请求参数

名称

类型

必填

描述

示例值
ChangeOrderId

string

是

变更流程 ID

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

返回参数

名称

类型

描述

示例值

object

Code

integer

接口状态或 POP 错误码

200
Message

string

附加信息

success
RequestId

string

请求 ID

4JFR-FV9F***************
changeOrderInfo

object

变更流程详情

Status

integer

变更状态

  • 0：准备

  • 1：执行中

  • 2：执行成功

  • 3：执行失败

  • 6：终止

  • 7：部分成功

  • 8：手动分批发布模式下，等待手工确认执行下一批

  • 9：自动分批发布模式下，等待下一批执行中

  • 10：系统异常执行失败

2
ChangeOrderId

string

变更流程 ID

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

string

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

  • Automatic：自动

  • Manual：手动

Automatic
CoType

string

变更流程分类

Application Scale Out
CreateTime

string

创建时间

2019-11-13 14:23:46
ChangeOrderDescription

string

变更流程描述

应用扩容
BatchCount

integer

变更分批数

1
CreateUserId

string

变更流程的负责人

edas_com***_****@******-*****.***
SupportRollback

boolean

是否支持回滚。

  • true：支持回滚

  • false：不支持回滚

false
Desc

string

变更流程描述

IP of Scale-Out Instance: 47.107.XX.XX
PipelineInfoList

object

PipelineInfo

array<object>

分批变更任务列表

array<object>

PipelineName

string

批次名称

Batch: 1
StartTime

string

开始时间的时间戳

1583911702158
UpdateTime

string

更新时间的时间戳

1583911743633
PipelineStatus

integer

任务状态：

  • 0：准备

  • 1：执行中

  • 2：执行成功

  • 3：执行失败

  • 6：终止

  • 8：手动分批发布模式下，等待手工确认执行下一批

  • 9：自动分批发布模式下，等待下一批执行中

  • 10：系统异常执行失败

2
PipelineId

string

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

4c4ee320-5e47-4a48-****-************
StageList

object

StageInfoDTO

array<object>

变更流程的任务阶段列表

array<object>

StageId

string

阶段 ID

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

integer

阶段状态

  • 0：准备

  • 1：执行中

  • 2：执行成功

  • 3：执行失败

  • 6：终止

  • 8：手动分批发布模式下，等待手工确认执行下一批

  • 9：自动分批发布模式下，等待下一批执行中

  • 10：系统异常执行失败

2
StageName

string

阶段名称

Scale Out
StageResultDTO

object

阶段任务的执行结果

InstanceDTOList

object

InstanceDTO

array<object>

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

array<object>

Status

integer

运行状态

  • 0：准备

  • 1：执行中

  • 2：执行成功

  • 3：执行失败

  • 6：终止

  • 8：手动分批发布模式下，等待手工确认执行下一批

  • 9：自动分批发布模式下，等待下一批执行中

  • 10：系统异常执行失败

2
InstanceIp

string

实例 IP

47.XX.XX.12 (Public)
***.**.*.*** (*******)
PodName

string

节点名称

canary-test
InstanceName

string

实例名称

EDAS-scaled
PodStatus

string

Pod 状态

执行中
InstanceStageDTOList

object

InstanceStageDTO

array<object>

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

object

StageId

string

阶段 ID

5dd4c0f2-d81a-406f-****-************
Status

integer

阶段状态

  • 0：准备

  • 1：执行中

  • 2：执行成功

  • 3：执行失败

  • 6：终止

  • 8：手动分批发布模式下，等待手工确认执行下一批

  • 9：自动分批发布模式下，等待下一批执行中

  • 10：系统异常执行失败

2
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

阶段 ID

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

integer

运行状态

  • 0：准备

  • 1：执行中

  • 2：执行成功

  • 3：执行失败

  • 6：终止

  • 8：手动分批发布模式下，等待手工确认执行下一批

  • 9：自动分批发布模式下，等待下一批执行中

  • 10：系统异常执行失败

2
Message

string

执行结果信息

Success
StageName

string

阶段名称

Enable Tengine
StageDetailList

object

StageDetailDTO

array<object>

阶段执行结果列表

array<object>

StageId

string

阶段 ID

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

integer

阶段状态：

  • 0：准备

  • 1：执行中

  • 2：执行成功

  • 3：执行失败

  • 6：终止

  • 8：手动分批发布模式下，等待手工确认执行下一批

  • 9：自动分批发布模式下，等待下一批执行中

  • 10：系统异常执行失败

2
StageName

string

阶段名称

Process Start
TaskList

object

TaskInfoDTO

array<object>

任务列表

object

TaskErrorIgnorance

integer

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

  • 0：不容忍错误

  • 1：容忍错误

0
ShowManualIgnorance

boolean

是否显示忽略错误按钮。

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

  • false：不忽略变更流程中出现的错误。

false
TaskStatus

string

任务状态

  • 0：准备

  • 1：执行中

  • 2：执行成功

  • 3：执行失败

  • 6：终止

  • 8：手动分批发布模式下，等待手工确认执行下一批

  • 9：自动分批发布模式下，等待下一批执行中

  • 10：系统异常执行失败

2
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 表示不重试，1 表示自动重试，2 表示手动重试

0
TaskId

string

任务 ID

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

string

任务错误信息

400
Targets

object

Items

array

string

关联 ECS 的 IP 地址列表

["123.250.XX.XX","234.123.XX.XX"]
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

流量规则的提示说明文案

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

示例

正常返回示例

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)***.**.*.*** (*******)",
                        "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

错误码

错误信息

描述
400 Edas.errorcode.PermissionDenied.message No permissions
400 Edas.errorcode.ParameterMissing.ChangeOrderId.message Change process ID is missing.

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

变更历史

更多信息，参考变更详情。

上一篇：UpdateHealthCheckUrl - 设置健康检查 URL下一篇：GetSecureToken - 获取命名空间SecureToken信息