Queries the details about a change process.
Debugging
Request headers
This operation uses only the common request header. For more information, see Common request parameters.
Request syntax
POST /pop/v5/changeorder/change_order_info HTTP/1.1Request parameters
| Parameter | Type | Position | Required | Example | Description |
|---|---|---|---|---|---|
| ChangeOrderId | String | Query | Yes | 1074f3e2-e974-4a0e-****-************ |
The ID of the change process. |
Response parameters
| Parameter | Type | Example | Description |
|---|---|---|---|
| Code | Integer | 200 |
The HTTP status code. |
| Message | String | success |
The returned message that indicates whether the request is successful. |
| RequestId | String | 4JFR-FV9F*************** |
The ID of the request. |
| changeOrderInfo | Struct |
The details about a change process. |
|
| BatchCount | Integer | 1 |
The number of batches for the change. |
| BatchType | String | Automatic |
Specifies whether to automatically or manually trigger the change for the next batch when phased release is performed. Valid values:
|
| ChangeOrderDescription | String | Application scale-out |
The description of the change process. |
| ChangeOrderId | String | 1074f3e2-e974-4a0e-****-************ |
The ID of the change process. |
| CoType | String | Application Scale Out |
The type of the change process. |
| CreateTime | String | 2019-11-13 14:23:46 |
The time when the change process was created. |
| CreateUserId | String | edas_com***_****@******-*****.*** |
The person in charge of the change process. |
| Desc | String | IP of Scale-Out Instance: 47.107.XX.XX |
The description of the change process. |
| PipelineInfoList | Array of PipelineInfo |
The batches for the change task. |
|
| PipelineInfo | |||
| PipelineId | String | 4c4ee320-5e47-4a48-****-************ |
The ID of each batch for the change when phased release is performed. |
| PipelineName | String | Batch: 1 |
The name of the batch. |
| PipelineStatus | Integer | 2 |
The status of the task. Valid values:
|
| StageDetailList | Array of StageDetailDTO |
The execution results of each stage. |
|
| StageDetailDTO | |||
| StageId | String | d7561440-10a6-452f-8a90-62f6e7ec**** |
The ID of the stage. |
| StageName | String | Process Start |
The name of the stage. |
| StageStatus | Integer | 2 |
The status of the stage. Valid values:
|
| TaskList | Array of TaskInfoDTO |
The information about each task. |
|
| TaskInfoDTO | |||
| ShowManualIgnorance | Boolean | false |
Indicates whether
|
| TaskErrorCode | String | 400 |
The error code. |
| TaskErrorIgnorance | Integer | 0 |
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.
|
| TaskErrorMessage | String | 400 |
The error message for the task. |
| TaskId | String | d6d3b934-90a1-4ae8-8cbd-2446003d**** |
The ID of the task. |
| TaskMessage | String | [CALLBACK] 2020-03-11 15:28:44.781 requestId: c952ab99-8c5b-4ff1-9412-ae3bf9b1****, message: success |
The information about the task. |
| TaskName | String | Build Image |
The name of the task. |
| TaskStatus | String | 2 |
The status of the task. Valid values:
|
| StageList | Array of StageInfoDTO |
The stages of the change process. |
|
| StageInfoDTO | |||
| StageId | String | 358a143f-09a0-45e0-****-************@**_*******_***** |
The ID of the stage. |
| StageName | String | Scale Out |
The name of the stage. |
| StageResultDTO | Struct |
The results of the task executed in the stage. |
|
| InstanceDTOList | Array of InstanceDTO |
The results of the task executed on each ECS instance in each stage. |
|
| InstanceDTO | |||
| InstanceIp | String | 47.XX.XX.12 (Public)<br>***.**.*.*** (*******) |
The IP address of the ECS instance. |
| InstanceName | String | EDAS-scaled |
The name of the ECS instance. |
| InstanceStageDTOList | Array of InstanceStageDTO |
The results of the task executed on the ECS instance in each stage. |
|
| InstanceStageDTO | |||
| FinishTime | String | 2020-03-11T07:28:52Z |
The time for the end of the stage. |
| StageId | String | 5dd4c0f2-d81a-406f-****-************ |
The ID of the stage. |
| StageMessage | String | Pulling image \"registry-vpc.cn-hangzhou.aliyuncs.com****-user/1172745****_shared_repo:428084d6-265f-****-911a-7eb0d2c3****_15839117****\ |
The information about the stage. |
| StageName | String | scale out |
The name of the stage. |
| StartTime | String | 2020-03-11T07:28:49Z |
The time for the beginning of the stage. |
| Status | Integer | 2 |
The status of the stage. Valid values:
|
| PodName | String | canary-test |
The name of the node. |
| PodStatus | String | In progress |
The status of the pod. |
| Status | Integer | 2 |
The status of the task. Valid values:
|
| ServiceStage | Struct |
The results of tasks executed in each service-oriented stage. |
|
| Message | String | Success |
The execution result of the stage. |
| StageId | String | 358a143f-09a0-45e0-****-************ |
The ID of the stage. |
| StageName | String | Enable Tengine |
The name of the stage. |
| Status | Integer | 2 |
The status of the task. Valid values:
|
| Status | Integer | 2 |
The status of the stage. Valid values:
|
| StartTime | String | 1583911702158 |
The time when the task was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC. |
| UpdateTime | String | 1583911743633 |
The time when the task was updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC. |
| Status | Integer | 2 |
The change status. Valid values:
|
| SupportRollback | Boolean | false |
Indicates whether the task can be rolled back.
|
| TrafficControl | Struct |
The throttling rules. |
|
| Routes | String | [{"app":"9c8247da-91b6-42bb-8f99-92a0b9c6f****","type":"GROUP"}] |
The route forwarding policy. |
| 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"}] |
The traffic routing rules. |
| Tips | String | The release for the canary batch is complete, and the user confirms to continue to next batch. |
The description of throttling rules. |
Examples
Sample requests
POST /pop/v5/changeorder/change_order_info HTTP/1.1
Common request header
{
"ChangeOrderId": ""
}Sample success responses
XML format
<Message>success</Message>
<changeOrderInfo>
<Status>2</Status>
<BatchCount>1</BatchCount>
<CreateTime>2019-11-13 14:23:46</CreateTime>
<BatchType>Automatic</BatchType>
<CoType>Application Scale Out</CoType>
<CreateUserId>edas_com***_****@******-*****.***</CreateUserId>
<ChangeOrderId>1074f3e2-e974-4a0e-****-************</ChangeOrderId>
<PipelineInfoList>
<PipelineInfo>
<StageList>
<StageInfoDTO>
<StageId>316641fc-69a7-4cc4-****-************</StageId>
<Status>2</Status>
<StageName>Process Start </StageName>
<StageResultDTO>
<ServiceStage>
<StageId>316641fc-69a7-4cc4-****-************</StageId>
<Status>2</Status>
<StageName>Process Start </StageName>
<Message>Success</Message>
</ServiceStage>
<InstanceDTOList>
</InstanceDTOList>
</StageResultDTO>
</StageInfoDTO>
<StageInfoDTO>
<StageId>358a143f-09a0-45e0-****-************@**_*******_*****</StageId>
<Status>2</Status>
<StageName>Scale Out</StageName>
<StageResultDTO>
<ServiceStage/>
<InstanceDTOList>
<InstanceDTO>
<Status>2</Status>
<InstanceStageDTOList>
<InstanceStageDTO>
<StageId>5dd4c0f2-d81a-406f-****-************</StageId>
<Status>2</Status>
<StageName> scale out </StageName>
</InstanceStageDTO>
</InstanceStageDTOList>
<InstanceIp>47.XX.XX.27 (Public)<br>***.**.*.*** (*******)</InstanceIp>
<InstanceName>EDAS-scaled-cluster: default cluster</InstanceName>
</InstanceDTO>
</InstanceDTOList>
</StageResultDTO>
</StageInfoDTO>
<StageInfoDTO>
<StageId>358a143f-09a0-45e0-****-************</StageId>
<Status>2</Status>
<StageName>Enable Tengine</StageName>
<StageResultDTO>
<ServiceStage>
<StageId>358a143f-09a0-45e0-****-************</StageId>
<Status>2</Status>
<StageName>Enable Tengine</StageName>
<Message>Success</Message>
</ServiceStage>
<InstanceDTOList>
</InstanceDTOList>
</StageResultDTO>
</StageInfoDTO>
<StageInfoDTO>
<StageId>628acb11-09dd-4709-****-************@**_*******_*****</StageId>
<Status>2</Status>
<StageName>Health Check</StageName>
<StageResultDTO>
<ServiceStage/>
<InstanceDTOList>
<InstanceDTO>
<Status>2</Status>
<InstanceStageDTOList>
<InstanceStageDTO>
<StageId>70fcced7-9b99-409f-****-************</StageId>
<Status>2</Status>
<StageName>Health Check</StageName>
</InstanceStageDTO>
</InstanceStageDTOList>
<InstanceIp>47.XX.XX.27 (Public)<br>***.**.*.*** (*******)</InstanceIp>
</InstanceName>EDAS-scaled-cluster: default cluster<</InstanceName>
</InstanceDTO>
</InstanceDTOList>
</StageResultDTO>
</StageInfoDTO>
<StageInfoDTO>
<StageId>628acb11-09dd-4709-****-************</StageId>
<Status>2</Status>
<StageName>Enable SLB</StageName>
<StageResultDTO>
<ServiceStage>
<StageId>628acb11-09dd-4709-****-************</StageId>
<Status>2</Status>
<StageName>Enable SLB</StageName>
<Message>Success</Message>
</ServiceStage>
<InstanceDTOList>
</InstanceDTOList>
</StageResultDTO>
</StageInfoDTO>
<StageInfoDTO>
<StageId>bf15f2b1-e7b2-4069-****-************</StageId>
<Status>2</Status>
<StageName>Process Complete</StageName>
<StageResultDTO>
<ServiceStage>
<StageId>bf15f2b1-e7b2-4069-****-************</StageId>
<Status>2</Status>
<StageName>Process Complete</StageName>
<Message>Success</Message>
</ServiceStage>
<InstanceDTOList>
</InstanceDTOList>
</StageResultDTO>
</StageInfoDTO>
</StageList>
<PipelineName> Batch: 1</PipelineName>
<PipelineStatus>2</PipelineStatus>
<PipelineId>4c4ee320-5e47-4a48-****-************</PipelineId>
</PipelineInfo>
</PipelineInfoList>
<Desc>IP of Scale-Out Instance: 47.XX.XX.27 (Public)</Desc>
</changeOrderInfo>
<Code>200</Code>JSON format
{
"Message": "success",
"changeOrderInfo": {
"Status": 2,
"BatchCount": 1,
"CreateTime": "2019-11-13 14:23:46",
"BatchType": "Automatic",
"CoType": "Application Scale Out",
"CreateUserId": "edas_com***_****@******-*****.***",
"ChangeOrderId": "1074f3e2-e974-4a0e-****-************",
"PipelineInfoList": {
"PipelineInfo": [
{
"StageList": {
"StageInfoDTO": [
{
"StageId": "316641fc-69a7-4cc4-****-************",
"Status": 2,
"StageName": "Process Start ",
"StageResultDTO": {
"ServiceStage": {
"StageId": "316641fc-69a7-4cc4-****-************",
"Status": 2,
"StageName": "Process Start ",
"Message": "Success"
},
"InstanceDTOList": {
"InstanceDTO": []
}
}
},
{
"StageId": "358a143f-09a0-45e0-****-************@**_*******_*****",
"Status": 2,
"StageName": "Scale Out",
"StageResultDTO": {
"ServiceStage": {},
"InstanceDTOList": {
"InstanceDTO": [
{
"Status": 2,
"InstanceStageDTOList": {
"InstanceStageDTO": [
{
"StageId": "5dd4c0f2-d81a-406f-****-************",
"Status": 2,
"StageName": " scale out "
}
]
},
"InstanceIp": "47.XX.XX.27 (Public)<br>***.**.*.*** (*******)",
"InstanceName": <Name>EDAS-scaled-cluster: default cluster</Name>
}
]
}
}
},
{
"StageId": "358a143f-09a0-45e0-****-************",
"Status": 2,
"StageName": "Enable Tengine",
"StageResultDTO": {
"ServiceStage": {
"StageId": "358a143f-09a0-45e0-****-************",
"Status": 2,
"StageName": "Enable Tengine",
"Message": "Success"
},
"InstanceDTOList": {
"InstanceDTO": []
}
}
},
{
"StageId": "628acb11-09dd-4709-****-************@**_*******_*****",
"Status": 2,
"StageName": "Health Check",
"StageResultDTO": {
"ServiceStage": {},
"InstanceDTOList": {
"InstanceDTO": [
{
"Status": 2,
"InstanceStageDTOList": {
"InstanceStageDTO": [
{
"StageId": "70fcced7-9b99-409f-****-************",
"Status": 2,
"StageName": "Health Check"
}
]
},
"InstanceIp": "47.XX.XX.27 (Public)<br>***.**.*.*** (*******)",
"InstanceName": <Name>EDAS-scaled-cluster: default cluster</Name>
}
]
}
}
},
{
"StageId": "628acb11-09dd-4709-****-************",
"Status": 2,
"StageName": "Enable SLB",
"StageResultDTO": {
"ServiceStage": {
"StageId": "628acb11-09dd-4709-****-************",
"Status": 2,
"StageName": "Enable SLB",
"Message": "Success"
},
"InstanceDTOList": {
"InstanceDTO": []
}
}
},
{
"StageId": "bf15f2b1-e7b2-4069-****-************",
"Status": 2,
"StageName": "Process Complete",
"StageResultDTO": {
"ServiceStage": {
"StageId": "bf15f2b1-e7b2-4069-****-************",
"Status": 2,
"StageName": "Process Complete",
"Message": "Success"
},
"InstanceDTOList": {
"InstanceDTO": []
}
}
}
]
},
"PipelineName": " Batch: 1",
"PipelineStatus": 2,
"PipelineId": "4c4ee320-5e47-4a48-****-************"
}
]
},
"Desc": "IP of Scale-Out Instance: 47.XX.XX.27 (Public)"
},
"Code": 200
}Error codes
For a list of error codes, visit the API Error Center.