GetChangeOrderInfo - Enterprise Distributed Application Service

You can call the GetChangeOrderInfo operation to view the details of a change process.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

edas:ReadApplication

get

*Application

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

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
ChangeOrderId	string	Yes	The ID of the change process.	1074f3e2-e974-4a0e-**-**********

Response elements

Element	Type	Description	Example
	object
Code	integer	The status of the API call or a POP error code.	200
Message	string	Additional information.	success
RequestId	string	The request ID.	4JFR-FV9F***************
changeOrderInfo	object	The details of the change process.
Status	integer	The status of the change. 0: ready 1: in progress 2: successful 3: failed 6: stopped 7: partially successful 8: waiting for manual confirmation to proceed with the next batch in manual phased release mode 9: waiting for the next batch to be executed in automatic phased release mode 10: failed due to a system exception	2
ChangeOrderId	string	The ID of the change process.	1074f3e2-e974-4a0e-**-**********
BatchType	string	The execution mode for the next batch in a phased release. Automatic: The next batch is automatically executed. Manual: The next batch is manually executed.	Automatic
CoType	string	The classification of the change process.	Application Scale Out
CreateTime	string	The time when the change process was created.	2019-11-13 14:23:46
ChangeOrderDescription	string	The description of the change process.	应用扩容
BatchCount	integer	The number of batches for the change.	1
CreateUserId	string	The owner of the change process.	edas_com*_@**-*.*
SupportRollback	boolean	Indicates whether rollback is supported. true: Rollback is supported. false: Rollback is not supported.	false
Desc	string	The description of the change process.	IP of Scale-Out Instance: 47.107.XX.XX
PipelineInfoList	object
PipelineInfo	array<object>	The list of tasks for the phased change.
	array<object>
PipelineName	string	The name of the batch.	Batch: 1
StartTime	string	The UNIX timestamp for the start time.	1583911702158
UpdateTime	string	The UNIX timestamp for the update time.	1583911743633
PipelineStatus	integer	The task status. 0: ready 1: in progress 2: successful 3: failed 6: stopped 8: waiting for manual confirmation to proceed with the next batch in manual phased release mode 9: waiting for the next batch to be executed in automatic phased release mode 10: failed due to a system exception	2
PipelineId	string	The ID of the process for each batch in a phased change.	4c4ee320-5e47-4a48-**-**********
StageList	object
StageInfoDTO	array<object>	The list of stages in the change process.
	array<object>
StageId	string	The stage ID.	358a143f-09a0-45e0-**-********@_*****_***
Status	integer	The stage status. 0: ready 1: in progress 2: successful 3: failed 6: stopped 8: waiting for manual confirmation to proceed with the next batch in manual phased release mode 9: waiting for the next batch to be executed in automatic phased release mode 10: failed due to a system exception	2
StageName	string	The stage name.	Scale Out
StageResultDTO	object	The execution result of the stage task.
InstanceDTOList	object
InstanceDTO	array<object>	The execution results of the stage on each ECS instance.
	array<object>
Status	integer	The running status. 0: ready 1: in progress 2: successful 3: failed 6: stopped 8: waiting for manual confirmation to proceed with the next batch in manual phased release mode 9: waiting for the next batch to be executed in automatic phased release mode 10: failed due to a system exception	2
InstanceIp	string	The IP address of the instance.	47.XX.XX.12 (Public) *... (*****)
PodName	string	The node name.	canary-test
InstanceName	string	The instance name.	EDAS-scaled
PodStatus	string	The pod status.	执行中
InstanceStageDTOList	object
InstanceStageDTO	array<object>	The list of stage execution results on each instance.
	object
StageId	string	The stage ID.	5dd4c0f2-d81a-406f-**-**********
Status	integer	The stage status. 0: ready 1: in progress 2: successful 3: failed 6: stopped 8: waiting for manual confirmation to proceed with the next batch in manual phased release mode 9: waiting for the next batch to be executed in automatic phased release mode 10: failed due to a system exception	2
StartTime	string	The start time.	2020-03-11T07:28:49Z
StageMessage	string	The stage information.	Pulling image \"registry-vpc.cn-hangzhou.aliyuncs.com**-user/1172745_shared_repo:428084d6-265f--911a-7eb0d2c3_15839117**\
FinishTime	string	The end time.	2020-03-11T07:28:52Z
StageName	string	The stage name.	scale out
ServiceStage	object	The execution result of the service stage.
StageId	string	The stage ID.	358a143f-09a0-45e0-**-**********
Status	integer	The running status. 0: ready 1: in progress 2: successful 3: failed 6: stopped 8: waiting for manual confirmation to proceed with the next batch in manual phased release mode 9: waiting for the next batch to be executed in automatic phased release mode 10: failed due to a system exception	2
Message	string	The information about the execution result.	Success
StageName	string	The stage name.	Enable Tengine
StageDetailList	object
StageDetailDTO	array<object>	The list of stage execution results.
	array<object>
StageId	string	The stage ID.	d7561440-10a6-452f-8a90-62f6e7ec****
StageStatus	integer	The stage status. 0: ready 1: in progress 2: successful 3: failed 6: stopped 8: waiting for manual confirmation to proceed with the next batch in manual phased release mode 9: waiting for the next batch to be executed in automatic phased release mode 10: failed due to a system exception	2
StageName	string	The stage name.	Process Start
TaskList	object
TaskInfoDTO	array<object>	The list of tasks.
	object
TaskErrorIgnorance	integer	Indicates whether the task can tolerate errors. If the task can tolerate errors, the change process ignores the errors and proceeds to the next task. 0: The task cannot tolerate errors. 1: The task can tolerate errors.	0
ShowManualIgnorance	boolean	Indicates whether the `Ignore Error` button is displayed. true: Ignore errors that occur in the change process. This parameter can be set to true only when a URL health check is performed. false: Do not ignore errors that occur in the change process.	false
TaskStatus	string	The task status. 0: ready 1: in progress 2: successful 3: failed 6: stopped 8: waiting for manual confirmation to proceed with the next batch in manual phased release mode 9: waiting for the next batch to be executed in automatic phased release mode 10: failed due to a system exception	2
TaskMessage	string	The task information.	[CALLBACK] 2020-03-11 15:28:44.781 requestId: c952ab99-8c5b-4ff1-9412-ae3bf9b1****, message: success
TaskName	string	The task name.	Build Image
TaskErrorCode	string	The error code.	400
RetryType	integer	The retry policy. 0 indicates no retries. 1 indicates automatic retries. 2 indicates manual retries.	0
TaskId	string	The task ID.	d6d3b934-90a1-4ae8-8cbd-2446003d****
TaskErrorMessage	string	The error message of the task.	400
Targets	object
Items	array
	string	The list of IP addresses of the associated ECS instances.	["123.250.XX.XX","234.123.XX.XX"]
TrafficControl	object	The throttling rule.
Routes	string	The traffic forwarding rule.	[{"app":"9c8247da-91b6-42bb-8f99-92a0b9c6f****","type":"GROUP"}]
Rules	string	The routing rule for traffic.	[{"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	The description of the traffic rule.	灰度批次发布完毕，已确认继续下一批。

Examples

Success response

JSON format

{
  "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": "灰度批次发布完毕，已确认继续下一批。"
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Edas.errorcode.PermissionDenied.message	No permissions
400	Edas.errorcode.ParameterMissing.ChangeOrderId.message	Change process ID is missing.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.