All Products
Search
Document Center

Enterprise Distributed Application Service:GetChangeOrderInfo

Last Updated:Mar 01, 2024

Queries the details about a change process.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
edas:ReadApplicationRead
  • Application
    acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}
    none
none

Request syntax

POST /pop/v5/changeorder/change_order_info

Request parameters

ParameterTypeRequiredDescriptionExample
ChangeOrderIdstringYes

The ID of the change process.

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

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The HTTP status code that is returned.

200
Messagestring

The additional information that is returned.

success
RequestIdstring

The ID of the request.

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

The details about the change process.

Statusinteger

The state of the change process. Valid values:

  • 0: ready
  • 1: in progress
  • 2: successful
  • 3: failed
  • 6: terminated
  • 7: partially executed
  • 8: wait for manual confirmation to trigger the next batch during a manual phased release
  • 9: wait to trigger the next batch during an automatic phased release
  • 10: failed due to a system exception
2
ChangeOrderIdstring

The ID of the change process.

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

Indicates whether the change for the next batch is automatically or manually triggered when phased release is performed. Valid values:

  • Automatic: The change for the next batch is automatically triggered.
  • Manual: The change for the next batch is manually triggered.
Automatic
CoTypestring

The type of the change process.

Application Scale Out
CreateTimestring

The time when the change process is created.

2019-11-13 14:23:46
ChangeOrderDescriptionstring

The description of the change process.

Application scale-out
BatchCountinteger

The number of batches for the change.

1
CreateUserIdstring

The person in charge of the change process.

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

Indicates whether rollbacks are allowed. Valid values:

  • true: Rollbacks are allowed.
  • false: Rollbacks are not allowed.
false
Descstring

The description of the change process.

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

The information about the batches of the change task.

PipelineNamestring

The name of the batch.

Batch: 1
StartTimestring

The time when the change task was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1583911702158
UpdateTimestring

The time when the change task was updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1583911743633
PipelineStatusinteger

The state of the change task. Valid values:

  • 0: ready
  • 1: in progress
  • 2: successful
  • 3: failed
  • 6: terminated
  • 8: wait for manual confirmation to trigger the next batch during a manual phased release
  • 9: wait to trigger the next batch during an automatic phased release
  • 10: failed due to a system exception
2
PipelineIdstring

The ID of each batch for the change during the phased release.

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

The stages of the change process.

StageIdstring

The ID of the stage.

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

The state of the stage. Valid values:

  • 0: ready
  • 1: in progress
  • 2: successful
  • 3: failed
  • 6: terminated
  • 8: wait for manual confirmation to trigger the next batch during a manual phased release
  • 9: wait to trigger the next batch during an automatic phased release
  • 10: failed due to a system exception
2
StageNamestring

The name of the stage.

Scale Out
StageResultDTOobject

The results of the task executed in the stage.

InstanceDTOListobject []

The results of the task executed on each Elastic Compute Service (ECS) instance in each stage.

Statusinteger

The running state. Valid values:

  • 0: ready
  • 1: in progress
  • 2: successful
  • 3: failed
  • 6: terminated
  • 8: wait for manual confirmation to trigger the next batch during a manual phased release
  • 9: wait to trigger the next batch during an automatic phased release
  • 10: failed due to a system exception
2
InstanceIpstring

The IP address of the ECS instance.

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

The name of the node.

canary-test
InstanceNamestring

The name of the ECS instance.

EDAS-scaled
PodStatusstring

The state of the pod.

In progress
InstanceStageDTOListobject []

The results of the task executed on the ECS instance in each stage.

StageIdstring

The ID of the stage.

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

The state of the stage. Valid values:

  • 0: ready
  • 1: in progress
  • 2: successful
  • 3: failed
  • 6: terminated
  • 8: wait for manual confirmation to trigger the next batch during a manual phased release
  • 9: wait to trigger the next batch during an automatic phased release
  • 10: failed due to a system exception
2
StartTimestring

The time when the execution was started.

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

The information about the stage.

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

The time when the execution stopped.

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

The name of the stage.

scale out
ServiceStageobject

The results of tasks executed in each service-oriented stage.

StageIdstring

The ID of the stage.

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

The running state. Valid values:

  • 0: ready
  • 1: in progress
  • 2: successful
  • 3: failed
  • 6: terminated
  • 8: wait for manual confirmation to trigger the next batch during a manual phased release
  • 9: wait to trigger the next batch during an automatic phased release
  • 10: failed due to a system exception
2
Messagestring

The execution result in the stage.

Success
StageNamestring

Phase Name

Enable Tengine
StageDetailListobject []

The execution results in each stage.

StageIdstring

The ID of the stage.

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

The status of the stage. Valid values:

  • 0: ready
  • 1: in progress
  • 2: successful
  • 3: failed
  • 6: terminated
  • 8: wait for manual confirmation to trigger the next batch during a manual phased release
  • 9: wait to trigger the next batch during an automatic phased release
  • 10: failed due to a system exception
2
StageNamestring

The name of the stage.

Process Start
TaskListobject []

The information about the task.

TaskErrorIgnoranceinteger

Indicates whether the task is error-tolerant. If the task can tolerate errors, the errors that occur in the change process are ignored and the next task is executed.

  • 0: The task is not error-tolerant.
  • 1: The task is error-tolerant.
0
ShowManualIgnoranceboolean

Indicates whether errors that occur in the change process are ignored. Valid values:``

  • true: Errors that occur in the change process are ignored. This parameter can be set to true only when URL health checks are performed.
  • false: Errors that occur in the change process are not ignored.
false
TaskStatusstring

The state of the task. Valid values:

  • 0: ready
  • 1: in progress
  • 2: successful
  • 3: failed
  • 6: terminated
  • 8: wait for manual confirmation to trigger the next batch during a manual phased release
  • 9: wait to trigger the next batch during an automatic phased release
  • 10: failed due to a system exception
2
TaskMessagestring

Task information

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

The name of the task.

Build Image
TaskErrorCodestring

Error codes

400
RetryTypeinteger

The type of the retry policy. Value 0 indicates no retry, value 1 indicates automatic retry, and value 2 indicates manual retry.

0
TaskIdstring

The ID of the task.

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

The error message for the task.

400
Targetsarray
string

The IP addresses for the associated ECS instances.

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

The throttling rules.

Routesstring

The route forwarding policy.

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

The traffic routing 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"}]
Tipsstring

The description of throttling rules.

This canary release batch is complete, and the user has confirmed to proceed to the next batch.

Examples

Sample success responses

JSONformat

{
  "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": "Application scale-out\n",
    "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": "In progress\n",
                        "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": "This canary release batch is complete, and the user has confirmed to proceed to the next batch.\n"
    }
  }
}

Error codes

HTTP status codeError codeError message
400Edas.errorcode.PermissionDenied.messageNo permissions
400Edas.errorcode.ParameterMissing.ChangeOrderId.messageChange process ID is missing.

For a list of error codes, visit the Service error codes.