DescribePipeline - - Alibaba Cloud Documentation Center

View batch information

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
sae:DescribePipeline	get	All Resources *	none	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 parameters

Parameter	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.
Stage	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.
Task	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.	Deploy an application
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.	Successful
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

Sample success responses

JSONformat

{
  "RequestId": "559B4247-C41C-4D9E-B866-B55D360B****",
  "Message": "success",
  "TraceId": "0be3e0c316390414649128666e****",
  "Data": {
    "ShowBatch": false,
    "PipelineStatus": 2,
    "CurrentStageId": "c3a55592-4c30-4d84-ac2d-e98c18ec****",
    "PipelineName": "First batch\n",
    "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\n",
            "ErrorIgnore": 0,
            "Message": "init Namespace success",
            "ShowManualIgnore": false,
            "TaskId": "bef0122f-de9a-4ab0-8223-b88bf8ad****"
          }
        ],
        "StageName": "Deploy an application\n"
      }
    ],
    "NextPipelineId": "b77b1c98-5772-4f05-95fc-c7bee5fa****",
    "PipelineId": "917660ba-5092-44ca-b8e0-80012c96****",
    "CoStatus": "Successful\n"
  },
  "ErrorCode": "Null\n",
  "Code": "200",
  "Success": true
}

Error codes

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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history