CreatePipelineRun - DataWorks - Alibaba Cloud Documentation Center

Creates a deployment process for entities in the Data Studio (new version).

Operation description

Note Batch operations are not currently supported. If you specify multiple entities in the parameters, only the first entity takes effect, and the rest are ignored.

Note This operation may not be available in earlier versions of the SDK. In this case, use the CreateDeployment operation. The parameters for CreateDeployment are the same as those described in this topic.

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:*	create	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
Type	string	Yes	Specifies whether to deploy or undeploy the entity. Valid values: Online: deploys the entity. Offline: undeploys the entity.	Online
ObjectIds	array	Yes	The IDs of entities to which you want to apply the process. Note A process can be applied to only a single entity and its child entities. If you specify multiple entities in the array, the process is applied only to the first entity in the array and its child entities. Make sure that the array in your request contains only one element. Extra elements will be ignored.
	string	Yes	The ID of the entity to which you want to apply the process, such as the ID of a node or a workflow. Note A process can be applied to a workflow as a whole. The process cannot be applied to a single node of the workflow.	476506242076571XXXX
Description	string	No	The description of the process.	This is a OdpsSQL-node publishing process. The function is XXXX.

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX
Id	string	The ID of the process.	a7ef0634-20ec-4a7c-a214-54020f91XXXX

Examples

Sample success responses

JSONformat

{
  "RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX",
  "Id": "a7ef0634-20ec-4a7c-a214-54020f91XXXX\n"
}

Error codes

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