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

Operation description

Important This operation does not support batch operations. If you specify multiple publish entities in the parameters, all entities except the first one are ignored.

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

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 ID of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to obtain the workspace ID. This parameter specifies the DataWorks workspace for this API call.	10000
Type	string	Yes	Specifies whether the publish process is used to bring an entity online or offline. Online: online Offline: offline	Online
ObjectIds	array	Yes	The list of entity IDs that you want to publish in this publish process. Important Only a single entity and its child entities can be published at a time. Only the first entity in this array and its child entities are published. Make sure that the length of this array is 1. Entities beyond the first one are ignored.
	string	No	The ID of the entity that you want to publish, such as the ID of a Node or WorkflowDefinition entity. Important A WorkflowDefinition can only be published as a whole. Publishing a single node within a workflow is not supported.	476506242076571XXXX
Description	string	No	The description of the publish process.	This is a OdpsSQL-node publishing process. The function is XXXX.
RunMode	string	No	The run mode of the publish process. Default value: Normal. If you set this parameter to Auto, the publish process is automatically driven to the specified stage. This parameter is used together with the AutoRunUntilStage parameter. Valid values: Normal Auto	Normal
AutoRunUntilStage	string	No	The code of the stage in the publish process. This parameter takes effect only when RunMode is set to Auto. After the publish process is created, it automatically runs to the specified stage. Important The specified stage is automatically completed. For example, if you set this parameter to DEV, the automatic run stops after the DEV stage reaches the desired state.	DEV

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID. You can use the ID to locate logs and troubleshoot issues.	7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX
Id	string	The unique identifier of the publish 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.