Queries the information of a batch.
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/DescribePipeline HTTP/1.1
Request parameters
Parameter | Type | Position | Required | Example | Description |
---|---|---|---|---|---|
PipelineId | String | Query | Yes | 917660ba-5092-44ca-b8e0-80012c96**** | The ID of the batch. You can call the DescribeChangeOrder operation to obtain the ID. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 559B4247-C41C-4D9E-B866-B55D360B**** | The ID of the request. |
Message | String | success | The returned message. |
TraceId | String | 0be3e0c316390414649128666e**** | The ID of the trace. It is used to query the details of a request. |
Data | Object | The batch information. |
|
ShowBatch | Boolean | false | Indicates whether to start processing the next batch. Valid values:
|
PipelineStatus | Integer | 2 | The batch status. Valid values:
|
CurrentStageId | String | c3a55592-4c30-4d84-ac2d-e98c18ec**** | The ID of the batch processing stage. |
PipelineName | String | First batch | The name of the batch. |
StageList | Array of Stage | The list of batch processing stages. |
|
Status | Integer | 2 | The status of the batch processing stage. Valid values:
|
StageId | String | c3a55592-4c30-4d84-ac2d-e98c18ec**** | The ID of the stage. |
ExecutorType | Integer | 0 | The execution type of the stage. Valid values:
|
TaskList | Array of Task | The list of task statuses. |
|
Status | Integer | 2 | The task status. Valid values:
|
StageId | String | c3a55592-4c30-4d84-ac2d-e98c18ec**** | The ID of the stage. |
ErrorMessage | String | EDAS-10022 <a target='_blank' href='https://help.aliyun.com/knowledge_detail/106573.html#EDAS-10022'>The application failed the READINESS check during startup.</a> | The error message returned when the task could not be executed. If the task is successfully executed, this parameter is not returned. |
ErrorCode | String | EDAS-10022 | The error code returned when the task could not be executed. If the task is successfully executed, this parameter is not returned. |
TaskName | String | Initialize the environment | The name of the task. |
ErrorIgnore | Integer | 0 | Indicates whether to execute the subsequent tasks when the task failed. Valid values:
|
Message | String | init Namespace success | The returned message indicating the task execution result. |
ShowManualIgnore | Boolean | false | Indicates whether a running task can be manually skipped. Valid values:
|
TaskId | String | bef0122f-de9a-4ab0-8223-b88bf8ad**** | The ID of the task. |
StageName | String | Deploy the application | The name of the stage. |
NextPipelineId | String | b77b1c98-5772-4f05-95fc-c7bee5fa**** | The ID of the next batch. |
PipelineId | String | 917660ba-5092-44ca-b8e0-80012c96**** | The ID of the batch. |
CoStatus | String | Successful | The status of the change order for the batch. |
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 batch information was obtained. Valid values:
|
Examples
Sample requests
GET /pop/v1/sam/changeorder/DescribePipeline?PipelineId=e2e-vds-feh-*** 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
<DescribePipelineResponse>
<RequestId>559B4247-C41C-4D9E-B866-B55D360B****</RequestId>
<Message>success</Message>
<TraceId>1344643016148440313321061f****</TraceId>
<Data>
<ShowBatch>false</ShowBatch>
<PipelineStatus>2</PipelineStatus>
<CurrentStageId>c3a55592-4c30-4d84-ac2d-e98c18ec****</CurrentStageId>
<PipelineName>First batch</PipelineName>
<StageList>
<Status>2</Status>
<StageId>c3a55592-4c30-4d84-ac2d-e98c18ec****</StageId>
<ExecutorType>0</ExecutorType>
<TaskList>
<Status>2</Status>
<StageId>c3a55592-4c30-4d84-ac2d-e98c18ec****</StageId>
<ErrorMessage>EDAS-10022 <a target='_blank' href='https://help.aliyun.com/knowledge_detail/106573.html#EDAS-10022'> The application failed the readiness check during startup. </a></ErrorMessage>
<ErrorCode>EDAS-10022</ErrorCode>
<TaskName>Initialize the environment</TaskName>
<ErrorIgnore>0</ErrorIgnore>
<Message>init Namespace success</Message>
<ShowManualIgnore>false</ShowManualIgnore>
<TaskId>bef0122f-de9a-4ab0-8223-b88bf8ad****</TaskId>
</TaskList>
<StageName>Deploy the application</StageName>
</StageList>
<NextPipelineId>b77b1c98-5772-4f05-95fc-c7bee5fa****</NextPipelineId>
<PipelineId>917660ba-5092-44ca-b8e0-80012c96****</PipelineId>
<CoStatus>Successful</CoStatus>
</Data>
<Code>200</Code>
<Success>true</Success>
</DescribePipelineResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "559B4247-C41C-4D9E-B866-B55D360B****",
"Message" : "success",
"TraceId" : "1344643016148440313321061f****",
"Data" : {
"ShowBatch" : false,
"PipelineStatus" : 2,
"CurrentStageId" : "c3a55592-4c30-4d84-ac2d-e98c18ec****",
"PipelineName" : "First batch",
"StageList" : [ {
"Status" : 2,
"StageId" : "c3a55592-4c30-4d84-ac2d-e98c18ec****",
"ExecutorType" : 0,
"TaskList" : [ {
"Status" : 2,
"StageId" : "c3a55592-4c30-4d84-ac2d-e98c18ec****",
"ErrorMessage" : "EDAS-10022 <a target='_blank' href='https://help.aliyun.com/knowledge_detail/106573.html#EDAS-10022'> The application failed the readiness check during startup. </a>",
"ErrorCode" : "EDAS-10022",
"TaskName" : "Initialize the environment",
"ErrorIgnore" : 0,
"Message" : "init Namespace success",
"ShowManualIgnore" : false,
"TaskId" : "bef0122f-de9a-4ab0-8223-b88bf8ad****"
} ],
"StageName" : "Deploy the application"
} ],
"NextPipelineId" : "b77b1c98-5772-4f05-95fc-c7bee5fa****",
"PipelineId" : "917660ba-5092-44ca-b8e0-80012c96****",
"CoStatus" : "Successful"
},
"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 | InvalidParameter.NoPermission | Resource no permission | The error message returned because you have no permissions on the requested resources. |
For a list of error codes, visit the API Error Center.