ExecPipelineRunStage - DataWorks - Alibaba Cloud Documentation Center

Executes a stage in a process.

Operation description

Note The stages in a process are sequential. For more information, see the GetDeployment operation. Skipping or repeating a stage is not allowed.

Note The execution of a stage is asynchronous. The response of this operation indicates only whether a stage is triggered but does not indicate whether the execution of the stage is successful. You can call the GetDeployment operation to check whether the execution is successful.

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:*	none	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.	10000
Id	string	Yes	The ID of the process.	a7ef0634-20ec-4a7c-a214-54020f91XXXX
Code	string	Yes	The code of the stage in the process. You can call the GetDeployment operation to query the code.	DEV_CHECK

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	AFBB799F-8578-51C5-A766-E922EDB8XXXX
Success	boolean	Indicates whether the request was successful. Valid values: true false Note:** The value of this parameter indicates only whether the stage is triggered but does not indicate whether the execution of the stage is successful.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "AFBB799F-8578-51C5-A766-E922EDB8XXXX\n",
  "Success": true
}

Error codes

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