Automate Deployment Pipelines via CreatePipelineRun - DataWorks - Alibaba Cloud - DataWorks

Operation description

Important This API does not support batch operations. If you specify multiple entities to be published, all entities except the first one are ignored.

Important This API may not be available in earlier versions of the SDK. In that case, use the CreateDeployment API, which accepts the same parameters.

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

dataworks:*

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	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	No	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 elements

Element	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

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.