DescribePipeline API Reference for Batch Pipeline Status - Serverless App Engine - Alibaba Cloud - Serverless App Engine

View batch information

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sae:DescribePipeline

get

*All Resource

*

None

Request syntax

GET /pop/v1/sam/changeorder/DescribePipeline HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
PipelineId	string	Yes	The ID of the batch. You can call the DescribeChangeOrder operation to obtain the ID.	917660ba-5092-44ca-b8e0-80012c96****

Response elements

Element	Type	Description	Example
	object	The response body of the batch information.
RequestId	string	The ID of the request.	559B4247-C41C-4D9E-B866-B55D360B****
Message	string	The message returned for the operation.	success
TraceId	string	The trace ID that is used to query the details of the request.	0be3e0c316390414649128666e****
Data	object	The batch information.
ShowBatch	boolean	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.	false
PipelineStatus	integer	The batch status. Valid values: 0: The batch is prepared for processing. 1: The task is being executed. 2: successful 3: The processing failed in this stage. 6: The batch processing was terminated. 10: The batch could not be processed due to a system exception.	2
CurrentStageId	string	The ID of the batch processing stage.	c3a55592-4c30-4d84-ac2d-e98c18ec****
PipelineName	string	The name of the batch.	First batch
StageList	array<object>	The list of batch processing stages.
	array<object>	The information about the stage.
Status	integer	The status of the batch processing stage. Valid values: 0: The batch is prepared for this processing stage. 1: The task is being executed. 2: successful 3: The processing failed in this stage. 6: The processing stage was terminated.	2
StageId	string	The ID of the stage.	c3a55592-4c30-4d84-ac2d-e98c18ec****
ExecutorType	integer	The execution type of the stage. Valid values: 0: in sequence. 1: in parallel.	0
TaskList	array<object>	The list of task statuses.
	object	The information about the task status.
Status	integer	The task status. Valid values: 0: The task is prepared for execution. 1: The task is being executed. 2: successful 3: The task could not be executed. 5: The task is pending retry. 6: The task was terminated.	2
StageId	string	The ID of the stage.	c3a55592-4c30-4d84-ac2d-e98c18ec****
ErrorMessage	string	The error message returned when the task could not be executed. If the task is successfully executed, this parameter is not returned.	EDAS-10022
ErrorCode	string	The error code returned when the task could not be executed. If the task is successfully executed, this parameter is not returned.	EDAS-10022
TaskName	string	The name of the task.	Environment initialization
ErrorIgnore	integer	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.	0
Message	string	The returned message indicating the task execution result.	init Namespace success
ShowManualIgnore	boolean	Indicates whether a running task can be manually skipped. Valid values: true: The running task can be skipped. false: The zone does not allow you to change the network type of an ApsaraDB for Redis instance from classic network to VPC.	false
TaskId	string	The ID of the task.	bef0122f-de9a-4ab0-8223-b88bf8ad****
StageName	string	The name of the stage.	Application Deployment
NextPipelineId	string	The ID of the next batch.	b77b1c98-5772-4f05-95fc-c7bee5fa****
PipelineId	string	The ID of the batch.	917660ba-5092-44ca-b8e0-80012c96****
CoStatus	string	The status of the change order for the batch.	Executed successfully
ErrorCode	string	The error code returned if the request failed. Take note of the following rules: The ErrorCode parameter is not returned if the request succeeds. If the call fails, the ErrorCode parameter is returned. For more information, see the "Error codes" section of this topic.	Null
Code	string	The HTTP status code. Valid values: 2xx: The call was successful. 3xx: The call was redirected. 4xx: The call failed. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the batch information was obtained. Valid values: true: The information was queried. false: The image failed to be found.	true

Examples

Success response

JSON format

{
  "RequestId": "559B4247-C41C-4D9E-B866-B55D360B****",
  "Message": "success",
  "TraceId": "0be3e0c316390414649128666e****",
  "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 ",
            "ErrorCode": "EDAS-10022",
            "TaskName": "Environment initialization",
            "ErrorIgnore": 0,
            "Message": "init Namespace success",
            "ShowManualIgnore": false,
            "TaskId": "bef0122f-de9a-4ab0-8223-b88bf8ad****"
          }
        ],
        "StageName": "Application Deployment"
      }
    ],
    "NextPipelineId": "b77b1c98-5772-4f05-95fc-c7bee5fa****",
    "PipelineId": "917660ba-5092-44ca-b8e0-80012c96****",
    "CoStatus": "Executed successfully"
  },
  "ErrorCode": "Null\n",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.NoPermission	Resource no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.