DescribePipeline - Serverless App Engine - Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

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: false: indicates that the next batch cannot be processed yet. true: indicates that the next batch can be processed now.
PipelineStatus	Integer	2	The batch status. Valid values: 0: The batch is prepared for processing. 1: The batch is being processed. 2: The batch was processed. 3: The batch could not be processed. 6: The batch processing was terminated. 10: The batch could not be processed due to a system exception.
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: 0: The batch is prepared for this processing stage. 1: The processing stage is in progress. 2: The processing stage was complete. 3: The processing failed in this stage. 6: The processing stage was terminated.
StageId	String	c3a55592-4c30-4d84-ac2d-e98c18ec****	The ID of the stage.
ExecutorType	Integer	0	The execution type of the stage. Valid values: 0: in sequence. 1: in parallel.
TaskList	Array of Task		The list of task statuses.
Status	Integer	2	The task status. Valid values: 0: The task is prepared for execution. 1: The task is being executed. 2: The task was executed. 3: The task could not be executed. 5: The task is pending retry. 6: The task was terminated.
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: 0: The subsequent tasks cannot be executed. 1: The subsequent tasks can be executed.
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: true: The running task can be skipped. false: The running task cannot be skipped.
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. The ErrorCode parameter is not returned when the request succeeds. The ErrorCode parameter is returned when the request fails. For more information, see Error codes in this topic.
Code	String	200	The HTTP status code. Valid values: 2xx: indicates that the request was successful. 3xx: indicates that the request was redirected. 4xx: indicates that the request was invalid. 5xx: indicates that a server error occurred.
Success	Boolean	true	Indicates whether the batch information was obtained. Valid values: true: indicates that the information was obtained. false: indicates that the information could not be obtained.

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  &lt;a target='_blank' href='https://help.aliyun.com/knowledge_detail/106573.html#EDAS-10022'&gt; The application failed the readiness check during startup. &lt;/a&gt;</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.