# Alibaba Cloud EMR Workbench API

> Alibaba Cloud EMR Workbench API on Apizie: 25 endpoints (Creates a workflow, Deletes a workflow, Based on the encoding ID provided by the User, automatically detect the ID Type and return associated…, Retrieves the details of a manual task, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:aliyun-emrstudio/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-emrstudio`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/emrstudio
- Page: https://www.apizie.tech/api/cloud/aliyun-emrstudio
- OpenAPI: https://www.apizie.tech/api/cloud/aliyun-emrstudio/openapi.json

Alibaba Cloud OpenAPI for EMR Workbench (emrstudio, version 2024-04-30). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Creates a workflow
`POST https://www.apizie.tech/v1/cloud:aliyun-emrstudio/create-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| projectId | string | yes | The project ID |
| workspaceId | string | yes | The workspace ID |
| name | string | yes | The name of the workflow |
| taskRelationJson | string | yes | The JSON string of task dependencies, which contains the dependencies among all tasks in the workflow. preTaskId indicates the ID of the… |
| taskDefinitionJson | string | yes | The JSON string of task definitions, which contains the description information of all tasks in the workflow |
| description | string | no | The description |
| workflowParams | string | no | The workflow parameters |
| parentDirectoryId | string | no | The folder ID |
| timeout | integer | no | The timeout period. Unit: minutes |
| executionType | string | no | The execution strategy |
| scheduleState | string | no | The scheduling status |
| scheduleStartTime | string | no | The start time of scheduling. Format: YYYY-MM-DD HH:mm:ss. The time zone is specified by the timeZone parameter |
| scheduleEndTime | string | no | The end time of scheduling. Format: YYYY-MM-DD HH:mm:ss. The time zone is specified by the timeZone parameter |
| cronExpr | string | no | The cron expression for scheduling |
| timeZone | string | no | The time zone |
| failureStrategy | string | no | The failure strategy |
| alertStrategy | string | no | The alert strategy |
| alertGroupId | string | no | The alert group ID |
| workflowInstancePriority | string | no | The priority of the workflow instance |
| resourceGroupId | string | no | The resource group ID |
| taskDefinitionJsonValue | string | no | The JSON string of task definitions, which contains the description information of all tasks in the workflow |
| taskRelationJsonValue | string | no | The JSON string of task dependencies, which contains the dependencies among all tasks in the workflow. preTaskId indicates the ID of the… |

### Deletes a workflow
`POST https://www.apizie.tech/v1/cloud:aliyun-emrstudio/delete-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| projectId | string | yes | The project ID |
| workflowId | string | yes | The workflow ID |

### Based on the encoding ID provided by the User, automatically detect the ID Type and return associated…
`GET https://www.apizie.tech/v1/cloud:aliyun-emrstudio/describe-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| id | string | yes | id |
| workspaceId | string | yes | Workspace ID |

### Retrieves the details of a manual task
`GET https://www.apizie.tech/v1/cloud:aliyun-emrstudio/describe-manual-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| projectId | string | yes | The project ID |
| manualTaskId | string | yes | The manual task ID |

### Retrieves the details of a manual node instance
`GET https://www.apizie.tech/v1/cloud:aliyun-emrstudio/describe-manual-task-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| manualTaskInstanceId | string | yes | The manual node instance ID |
| projectId | string | yes | The project ID |

### Retrieves the details of a project
`GET https://www.apizie.tech/v1/cloud:aliyun-emrstudio/describe-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| projectId | string | yes | The project ID |

### Retrieves the details of a node
`GET https://www.apizie.tech/v1/cloud:aliyun-emrstudio/describe-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| workflowId | string | yes | The workflow ID |
| projectId | string | yes | The project ID |
| taskId | string | yes | The node ID |

### Retrieves the details of a task instance
`GET https://www.apizie.tech/v1/cloud:aliyun-emrstudio/describe-task-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| projectId | string | yes | The project ID |
| workflowInstanceId | string | yes | The workflow instance ID |
| taskInstanceId | string | yes | The task instance ID |

### Get workflow details
`GET https://www.apizie.tech/v1/cloud:aliyun-emrstudio/describe-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| projectId | string | yes | The project ID |
| workflowId | string | yes | The workflow ID |

### Retrieves the details of a workflow instance
`GET https://www.apizie.tech/v1/cloud:aliyun-emrstudio/describe-workflow-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| projectId | string | yes | The project ID |
| workflowInstanceId | string | yes | The workflow instance ID |

### Retrieves the logs of an instance
`GET https://www.apizie.tech/v1/cloud:aliyun-emrstudio/get-instance-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| projectId | string | yes | The project ID |
| instanceId | string | yes | The instance ID |
| skipLineNum | integer | no | The number of lines to skip |
| limit | integer | no | The number of entries to return per query |

### Queries the list of alert groups
`GET https://www.apizie.tech/v1/cloud:aliyun-emrstudio/list-alert-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| nextToken | string | no | The pagination token for the request |
| maxResults | integer | no | The maximum number of records to retrieve in a single request |
| searchVal | string | no | The search keyword |
| projectId | string | yes | The project ID |

### Retrieves a list of manual task instances
`GET https://www.apizie.tech/v1/cloud:aliyun-emrstudio/list-manual-task-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| projectId | string | yes | The project ID |
| workspaceId | string | yes | The workspace ID |
| searchVal | string | no | The search value |
| nextToken | string | no | The pagination token for the next request |
| maxResults | integer | no | The maximum number of records to retrieve in a single request |
| status | string | no | The status |
| startTime | string | no | The start time |
| endTime | string | no | The end time |

### Retrieves a list of manual tasks
`GET https://www.apizie.tech/v1/cloud:aliyun-emrstudio/list-manual-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| projectId | string | yes | The project ID |
| workspaceId | string | yes | The workspace ID |
| nextToken | string | no | The pagination token for the next request |
| maxResults | integer | no | The maximum number of records to retrieve in a single request |
| searchVal | string | no | The search value |
| taskType | string | no | The task type |

### Retrieves a list of projects
`GET https://www.apizie.tech/v1/cloud:aliyun-emrstudio/list-projects` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| nextToken | string | no | The pagination token for the next request |
| searchVal | string | no | The search value |
| maxResults | integer | no | The maximum number of records to retrieve in a single request |
| workspaceId | string | yes | The workspace ID |

### Queries a list of schedule resource groups
`GET https://www.apizie.tech/v1/cloud:aliyun-emrstudio/list-resource-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| nextToken | string | no | The pagination token that marks the current reading position |
| maxResults | integer | no | The maximum number of records to retrieve in a single request |
| resourceGroupName | string | no | The name of the schedule resource group |
| resourceGroupType | string | no | The type of the schedule resource group. Valid values: CLUSTER_RESOURCE_GROUP: cluster resource group. CLUSTER_TEMPLATE_RESOURCE_GROUP:… |

### Get the list of task instances
`GET https://www.apizie.tech/v1/cloud:aliyun-emrstudio/list-task-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| projectId | string | yes | The project ID |
| workflowInstanceId | string | no | The workflow instance ID |
| searchVal | string | no | The search value |
| status | string | no | The status |
| startTime | string | no | The start time |
| endTime | string | no | The end time |
| nextToken | string | no | The pagination token for the next request |
| maxResults | integer | no | The maximum number of records to retrieve at a time |

### Retrieves a list of tasks
`GET https://www.apizie.tech/v1/cloud:aliyun-emrstudio/list-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| projectId | string | yes | The project ID |
| nextToken | string | no | The pagination token for the next request |
| maxResults | string | no | The maximum number of records to retrieve in a single request |
| searchVal | string | no | The search value |
| taskType | string | no | The task type |
| workflowId | string | no | The workflow ID |

### Query the list of workflow directories
`GET https://www.apizie.tech/v1/cloud:aliyun-emrstudio/list-workflow-directories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| projectId | string | yes | Project ID |
| workspaceId | string | yes | Workspace ID |
| nextToken | string | no | The pagination token for the request |
| maxResults | integer | no | The maximum number of records to retrieve at a time |
| parentDirectoryId | string | no | Parent directory ID |
| directoryId | string | no | Directory ID |

### Retrieves a list of workflow instances
`GET https://www.apizie.tech/v1/cloud:aliyun-emrstudio/list-workflow-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| projectId | string | yes | The project ID |
| nextToken | string | no | The pagination token for the next request |
| maxResults | integer | no | The maximum number of records to retrieve in a single request |
| startTime | string | no | The start time |
| endTime | string | no | The end time |
| status | string | no | The status |
| workflowId | string | no | The workflow ID |

### Obtains a list of workflows
`GET https://www.apizie.tech/v1/cloud:aliyun-emrstudio/list-workflows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| projectId | string | yes | The project ID |
| nextToken | string | no | The pagination token for the next request |
| maxResults | integer | no | The maximum number of records to retrieve at a time |
| searchVal | string | no | The search value |

### Operates on a workflow instance
`POST https://www.apizie.tech/v1/cloud:aliyun-emrstudio/operate-workflow-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| projectId | string | yes | The project ID |
| execType | string | no | The execution type. Valid values: REPEAT_RUNNING: reruns the workflow. RECOVER_SUSPENDED_PROCESS: resumes a paused workflow.… |
| workflowInstanceId | string | no | The workflow instance ID |
| workspaceId | string | no | The workspace ID |

### Runs a workflow
`POST https://www.apizie.tech/v1/cloud:aliyun-emrstudio/run-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| projectId | string | yes | The project ID |
| workflowId | string | yes | The workflow ID |
| resourceGroupId | string | yes | The resource group ID |
| execType | string | no | The execution type |
| failureStrategy | string | no | The failure strategy |
| alertStrategy | string | no | The notification strategy |
| alertGroupId | string | no | The alert group ID |
| workflowInstancePriority | string | no | The priority of the workflow instance |
| startParams | string | no | The startup parameters |
| dryRun | string | no | The dry run flag |
| complementDependentMode | string | no | The data backfill dependency mode |
| runMode | string | no | The data backfill execution mode |
| expectedParallelismNumber | string | no | The parallelism for data backfill. Valid values: 1 to 7 |
| scheduleTime | string | no | The scheduling date range for data backfill |

### Updates a workflow
`POST https://www.apizie.tech/v1/cloud:aliyun-emrstudio/update-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |
| projectId | string | yes | The project ID |
| workflowId | string | yes | The workflow ID |
| workspaceId | string | yes | The workspace ID |
| name | string | no | The workflow name |
| taskRelationJson | string | no | The JSON string of task dependencies, which includes the dependencies among all tasks in the workflow. preTaskId indicates the upstream… |
| taskDefinitionJson | string | no | The JSON string of task definitions, which includes the description information of all tasks in the workflow |
| description | string | no | The description |
| workflowParams | string | no | The workflow parameters |
| parentDirectoryId | string | no | The directory ID |
| timeout | integer | no | The timeout period, in minutes |
| executionType | string | no | The execution policy |
| scheduleState | string | no | The scheduling status |
| scheduleStartTime | string | no | The start time of the schedule, in the YYYY-MM-DD HH:mm:ss format. The time zone is specified by the timeZone parameter |
| scheduleEndTime | string | no | The end time of the schedule, in the YYYY-MM-DD HH:mm:ss format. The time zone is specified by the timeZone parameter |
| cronExpr | string | no | The cron expression for scheduling |
| timeZone | string | no | The time zone |
| failureStrategy | string | no | The failure policy |
| alertStrategy | string | no | The notification policy |
| alertGroupId | string | no | The alert group ID |
| workflowInstancePriority | string | no | The priority of the workflow instance |
| resourceGroupId | string | no | The resource group ID |
| taskDefinitionJsonValue | string | no | The JSON string of task definitions, which includes the description information of all tasks in the workflow |
| taskRelationJsonValue | string | no | The JSON string of task dependencies, which includes the dependencies among all tasks in the workflow. preTaskId indicates the upstream… |

### version
`POST https://www.apizie.tech/v1/cloud:aliyun-emrstudio/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emrstudio.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://www.apizie.tech/v1/cloud:aliyun-emrstudio/create-workflow" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud EMR Workbench API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/cloud:aliyun-emrstudio/create-workflow with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud EMR Workbench API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud EMR Workbench itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud EMR Workbench API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-emrstudio.

### What is the status of the Alibaba Cloud EMR Workbench API?
Needs your own provider key (bring your own key)