Queries the information of a change order.
Debugging
Request headers
This operation uses only common request headers. For more information, see Common request parameters and common response parameters.
Request syntax
GET /pop/v1/sam/changeorder/DescribeChangeOrder HTTP/1.1
Request parameters
Parameter | Type | Position | Required | Example | Description |
---|---|---|---|---|---|
ChangeOrderId | String | Query | Yes | 76fa5c0-9ebb-4bb4-b383-1f885447**** | The ID of the change order. You can call the ListChangeOrders operation to obtain the ID. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 91F93257-7A4A-4BD3-9A7E-2F6EAE6D**** | The ID of the request. |
Message | String | success | The returned message. |
TraceId | String | 0a98a02315955564772843261e**** | The ID of the trace. It is used to query the details of a request. |
Data | Object | The details of the change order. |
|
Status | Integer | 2 | The status of the change order. Valid values:
|
SubStatus | Integer | 0 | The substatus of the change order. This parameter indicates whether an exception occurred while the change order was being executed. Valid values:
|
ApprovalId | String | 67de0b39-a9d4-4c09-a170-cf438208**** | The approval ID of the change order. |
ErrorMessage | String | success | The error message. |
BatchWaitTime | Integer | 0 | The interval between batches when SAE automatically determines the release batches in a phased release. Unit: minutes. |
CreateTime | String | 2020-12-17 21:06:45 | The time when the change order was created. |
BatchCount | Integer | 1 | The number of release batches. |
CoTypeCode | String | CoRestartInstances | The code of the change type. Valid values:
|
SupportRollback | Boolean | false | Indicates whether the application can be rolled back. Valid values:
|
ChangeOrderId | String | 765fa5c0-9ebb-4bb4-b383-1f885447** | The ID of the change order. |
AppName | String | app-test | The name of the application. |
BatchType | String | auto | The mode in which the release batches are determined. Valid values:
|
Description | String | description | The description of the change order. |
CoType | String | Restart multiple instances at a time. | The description about the change type, which corresponds to the CoTypeCode parameter. |
Auto | Boolean | true | Indicates whether SAE automatically determines the release batches. Valid values:
|
CurrentPipelineId | String | 0e4acf82-c9b1-4c1e-ac28-55776338**** | The ID of the current batch. |
Pipelines | Array of Pipeline | The batch information. |
|
Status | Integer | 2 | The status of the batch. Valid values:
|
StartTime | Long | 1562831689704 | The time when the batch processing starts. |
UpdateTime | Long | 1562847178007 | The time when the batch information is last modified. |
BatchType | Integer | 0 | The batch type. |
ParallelCount | Integer | 0 | The number of parallel tasks in a batch. |
PipelineName | String | Batch 1 Change | The name of the batch. |
PipelineId | String | 0e4acf82-c9b1-4c1e-ac28-55776338**** | The ID of the batch. |
AppId | String | bbbbb-3fd370b2-3646-4ba6-91f9-9423e19ab0cd-***** | The ID of the application. |
ErrorCode | String | This parameter is left empty. | The error code.
|
Code | String | 200 | The HTTP status code. Valid values:
|
Success | Boolean | true | Indicates whether the information of a change order was obtained. Valid values:
|
Examples
Sample requests
GET /pop/v1/sam/changeorder/DescribeChangeOrder?ChangeOrderId=76fa5c0-9ebb-4bb4-b383-1f885447**** HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeChangeOrderResponse>
<RequestId>91F93257-7A4A-4BD3-9A7E-2F6EAE6D****</RequestId>
<Message>success</Message>
<TraceId>0a98a02315955564772843261e****</TraceId>
<Data>
<Status>2</Status>
<SubStatus>0</SubStatus>
<ApprovalId>67de0b39-a9d4-4c09-a170-cf438208****</ApprovalId>
<ErrorMessage>success</ErrorMessage>
<BatchWaitTime>0</BatchWaitTime>
<CreateTime>2020-12-17 21:06:45</CreateTime>
<BatchCount>1</BatchCount>
<CoTypeCode>CoRestartInstances</CoTypeCode>
<SupportRollback>false</SupportRollback>
<ChangeOrderId>765fa5c0-9ebb-4bb4-b383-1f885447**</ChangeOrderId>
<AppName>app-test</AppName>
<BatchType>auto</BatchType>
<Description>description</Description>
<CoType> Restart multiple instances concurrently. </CoType>
<Auto>true</Auto>
<CurrentPipelineId>0e4acf82-c9b1-4c1e-ac28-55776338****</CurrentPipelineId>
<Pipelines>
<Status>2</Status>
<StartTime>1562831689704</StartTime>
<UpdateTime>1562847178007</UpdateTime>
<BatchType>0</BatchType>
<ParallelCount>0</ParallelCount>
<PipelineName>Batch 1 Change</PipelineName>
<PipelineId>0e4acf82-c9b1-4c1e-ac28-55776338****</PipelineId>
</Pipelines>
<AppId>bbbbb-3fd370b2-3646-4ba6-91f9-9423e19ab0cd-*****</AppId>
</Data>
<Code>200</Code>
<Success>true</Success>
</DescribeChangeOrderResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
"Message" : "success",
"TraceId" : "0a98a02315955564772843261e****",
"Data" : {
"Status" : 2,
"SubStatus" : 0,
"ApprovalId" : "67de0b39-a9d4-4c09-a170-cf438208****",
"ErrorMessage" : "success",
"BatchWaitTime" : 0,
"CreateTime" : "2020-12-17 21:06:45",
"BatchCount" : 1,
"CoTypeCode" : "CoRestartInstances",
"SupportRollback" : false,
"ChangeOrderId" : "765fa5c0-9ebb-4bb4-b383-1f885447**",
"AppName" : "app-test",
"BatchType" : "auto",
"Description" : "description",
"CoType": "Restart multiple instances concurrently.",
"Auto" : true,
"CurrentPipelineId" : "0e4acf82-c9b1-4c1e-ac28-55776338****",
"Pipelines" : [ {
"Status" : 2,
"StartTime" : 1562831689704,
"UpdateTime" : 1562847178007,
"BatchType" : 0,
"ParallelCount" : 0,
"PipelineName" : "Batch 1 Change",
"PipelineId" : "0e4acf82-c9b1-4c1e-ac28-55776338****"
} ],
"AppId" : "bbbbb-3fd370b2-3646-4ba6-91f9-9423e19ab0cd-*****"
},
"Code" : "200",
"Success" : true
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | InvalidParameter.NotEmpty | You must specify the parameter %s. | The error message returned because the value of the %s parameter is invalid. This parameter cannot be left empty. |
400 | Resouce.no.permission | You are not authorized to operate on the specified resources. | The error message returned because you do not have the required permissions on the resources. |
400 | InvalidChangeOrder.NotFound | The current change order does not exist. | The error message returned because the change order cannot be found. |
404 | InvalidAppId.NotFound | The specified AppId does not exist. | The error message returned because the specified application ID cannot be found. |
For a list of error codes, visit the API Error Center.