GetPipelineRun - DataWorks - Alibaba Cloud Documentation Center

Queries the information about a process for deploying or undeploying an entity.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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
dataworks:*	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	Yes	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.	10000
Id	string	Yes	The ID of the process.	a7ef0634-20ec-4a7c-a214-54020f****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	08468352-032C-5262-AEDC-68C9FA05XXXX
Pipeline	object	The information about the process.
Id	string	The process ID.	a7ef0634-20ec-4a7c-a214-54020f91XXXX
ProjectId	long	The DataWorks workspace ID.	56160
CreateTime	long	The time when the process was created. This value is a UNIX timestamp.	1724984066000
ModifyTime	long	The time when the process was modified. This value is a UNIX timestamp.	1724984066000
Creator	string	The creator of the process.	137946317766XXXX
Status	string	The status of the process. Valid values: Init Running Success Fail Termination Cancel	Running
Message	string	The error message returned when the process fails.	Error message
Stages	array<object>	The information about stages in the process.
stage	object	The information about a stage in the process.
Code	string	The code of the stage.	DEV_CHECK
Step	integer	The step number of the stage.	1
Type	string	The type of the stage. Valid values: Deploy Check Offline Build Delete	Check
Name	string	The name of the stage.	Publish package build
Description	string	The description of the stage.	Phase description
Message	string	The error message returned for the stage.	Exception information XXX
Status	string	The status of the stage. Valid values: Init Running Success Fail Termination Cancel	Running
Detail	object	The details of the stage.
	any	The additional information about the stage.	"checkerList": [ { "code": "BuildPackageChecker", "name": "Build_Package_Checker" }, { "code": "NodeParentDependency", "name": "Downstream_Dependency_Checker" }, { "code": "NodeInProcess", "name": "Decommissioning_Process_Checker" } ]

Examples

Sample success responses

JSONformat

{
  "RequestId": "08468352-032C-5262-AEDC-68C9FA05XXXX",
  "Pipeline": {
    "Id": "a7ef0634-20ec-4a7c-a214-54020f91XXXX\n",
    "ProjectId": 56160,
    "CreateTime": 1724984066000,
    "ModifyTime": 1724984066000,
    "Creator": "137946317766XXXX",
    "Status": "Running",
    "Message": "Error message",
    "Stages": [
      {
        "Code": "DEV_CHECK",
        "Step": 1,
        "Type": "Check",
        "Name": "Publish package build",
        "Description": "Phase description",
        "Message": "Exception information XXX",
        "Status": "Running",
        "Detail": {
          "key": "\"checkerList\": [\n    {\n        \"code\": \"BuildPackageChecker\",\n        \"name\": \"Build_Package_Checker\"\n    },\n    {\n        \"code\": \"NodeParentDependency\",\n        \"name\": \"Downstream_Dependency_Checker\"\n    },\n    {\n        \"code\": \"NodeInProcess\",\n        \"name\": \"Decommissioning_Process_Checker\"\n    }\n]\n"
        }
      }
    ]
  }
}

Error codes

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