StartProcessInstance - E-MapReduce - Alibaba Cloud Documentation Center

Starts a workflow manually.

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

emr-serverless-spark:StartProcessInstance

none

*All Resource

*

None

Request syntax

POST /dolphinscheduler/projects/{bizId}/executors/start-process-instance HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
bizId	string	Yes	The workspace ID.	w-d8********

Request parameters

Parameter	Type	Required	Description	Example
productNamespace	string	Yes	The product code.	SS
processDefinitionCode	integer	Yes	The workflow definition ID.	12***********
versionNumber	integer	No	The version number of the workflow definition.	1
isProd	boolean	No	Specifies whether the workflow runs in a production environment.	false
runtimeQueue	string	No	The runtime queue.	root_queue
versionHashCode	string	No	The hash code of the version.	dh*********
regionId	string	No	The region ID.	cn-hangzhou
interval	string	No
action	string	No
comments	string	No
email	string	No

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	Id of the request	DD6B1B2A-5837-5237-ABE4-FF0C8944****
code	integer	The return code from the backend.	1400009
msg	string	The detailed description of the return code.	No permission for resource action
data	any	The returned data.	null
success	boolean	Indicates whether the request was successful.	true
failed	boolean	Indicates whether the manual workflow run failed.	false
httpStatusCode	integer	The HTTP status code.	200

Examples

Success response

JSON format

{
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "code": 1400009,
  "msg": "No permission for resource action",
  "data": "null",
  "success": true,
  "failed": false,
  "httpStatusCode": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.