# Alibaba Cloud EMR Serverless Spark API

> Alibaba Cloud EMR Serverless Spark API on Apizie: 89 endpoints (Activates the AI center, Adds a Resource Access Management (RAM) user or a RAM role to a workspace as a member, Terminates a Spark job, Cancels a Kyuubi Spark application, …) 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://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-emr-serverless-spark`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/emr-serverless-spark
- Page: https://zieapi.vercel.app/api/cloud/aliyun-emr-serverless-spark
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-emr-serverless-spark/openapi.json

Alibaba Cloud OpenAPI for EMR Serverless Spark (emr-serverless-spark, version 2023-08-08). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Activates the AI center
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/activate-aicenter` (byok)

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

### Adds a Resource Access Management (RAM) user or a RAM role to a workspace as a member
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/add-members` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| memberArns | array | yes | The memberArns |
| workspaceId | string | yes | The workspace ID |
| regionId | string | no | The region ID |

### Terminates a Spark job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/cancel-job-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| jobRunId | string | yes | The job ID |
| regionId | string | no | The region ID |

### Cancels a Kyuubi Spark application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/cancel-kyuubi-spark-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| kyuubiServiceId | string | yes | The Kyuubi service ID |
| applicationId | string | yes | The ID of the Spark application submitted by Kyuubi |
| regionId | string | no | The region ID |

### Stops a RayJob
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/cancel-ray-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| submissionId | string | yes | rayjob ID |

### Moves an instance to a different resource group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| resourceType | string | no | The resource type. Set this to `Workspace` |
| resourceId | string | yes | The ID of the resource to move |
| regionId | string | yes | The ID of the region where the resource is located |
| resourceGroupId | string | yes | The ID of the destination resource group |

### Creates a Kyuubi gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/create-kyuubi-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| computeInstance | string | no | The specifications of the Kyuubi service |
| kyuubiConfigs | string | no | The Kyuubi service configuration |
| kyuubiReleaseVersion | string | no | The Kyuubi service database engine version |
| name | string | no | The Kyuubi service name |
| publicEndpointEnabled | string | no | Specifies whether to enable public network access |
| queue | string | no | The queue where the Kyuubi service runs |
| releaseVersion | string | no | The Spark database engine version |
| replica | integer | no | The number of replicas for high availability (HA) |
| sparkConfigs | string | no | The Spark configuration |

### Creates a Kyuubi Gateway authentication token
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/create-kyuubi-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| kyuubiServiceId | string | yes | The Kyuubi service ID |
| autoExpireConfiguration | object | no | The auto-expiration configuration struct |
| memberArns | array | no | The list of ARNs of authorized users |
| name | string | no | The token name |
| sparkRole | array | no | The list of Spark roles associated with the token |
| token | string | no | The token content, which must be 32 characters in length and contain only lowercase letters and digits |
| regionId | string | no | The region ID |

### Creates a Livy compute
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/create-livy-compute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceBizId | string | yes | The workspace ID |
| authType | string | no | The authentication method |
| autoStartConfiguration | object | no | The automatic startup configuration |
| autoStopConfiguration | object | no | The automatic stop configuration |
| cpuLimit | string | no | The number of CPU cores for the Livy server |
| displayReleaseVersion | string | no | The version number of the Spark engine |
| enablePublic | string | no | Specifies whether to enable the public endpoint |
| environmentId | string | no | The ID of the runtime environment |
| fusion | string | no | Specifies whether to enable acceleration with the Fusion engine |
| livyServerConf | string | no | The configuration of the Livy Gateway. This parameter is in JSON format and supports the following files: sparkDefaultsConf… |
| livyVersion | string | no | The Livy version |
| memoryLimit | string | no | The memory size of the Livy server |
| name | string | no | The name of the Livy Gateway |
| networkName | string | no | The name of the network connection |
| queueName | string | no | The name of the submission queue |
| releaseVersion | string | no | The version number of the Spark engine. This parameter is deprecated. Use displayReleaseVersion instead |
| regionId | string | no | The region ID |

### Creates a token for a Livy Gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/create-livy-compute-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceBizId | string | yes | The workspace ID |
| livyComputeId | string | yes | The ID of the Livy Gateway |
| autoExpireConfiguration | object | no | The token expiration information struct |
| name | string | no | The token name |
| token | string | no | The token content. The length must be 16 or more characters |
| regionId | string | no | The region ID |

### Creates a network service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/create-network-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| clientToken | string | no | A token to ensure the idempotency of the request |
| name | string | no | The name of the network service |
| securityGroupId | string | no | The ID of the security group |
| type | string | no | The type of the network service |
| vpcId | string | no | The ID of the VPC |
| vswitchIds | array | no | A list of vSwitch IDs |
| workspaceId | string | yes | The ID of the workspace |
| regionId | string | no | The region ID |

### Creates a workflow definition
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/create-process-definition-with-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| productNamespace | string | yes | The product code |
| bizId | string | yes | The workspace ID |
| name | string | yes | The workflow name |
| description | string | yes | The workflow description |
| timeout | integer | no | The default timeout period for workflow execution, in seconds |
| taskRelationJson | string | yes | The JSON array of task dependencies. It contains the dependencies among all tasks in the workflow. preTaskCode specifies the upstream task… |
| taskDefinitionJson | string | yes | The JSON array of task definitions. It contains the description information of all tasks in the workflow (JSON-encoded) |
| executionType | string | yes | The execution strategy |
| alertEmailAddress | string | no | The email address for alert notifications |
| schedule | string | no | The schedule structure (JSON-encoded) |
| retryTimes | integer | no | The number of retries |
| taskParallelism | integer | no | The task concurrency |
| resourceQueue | string | no | The resource queue |
| tags | string | no | The tags (JSON-encoded) |
| publish | string | no | Specifies whether to publish the workflow |
| regionId | string | no | The region ID |
| runAs | string | no | The Alibaba Cloud UID of the execution user |
| globalParams | string | no | The list of global parameters for the workflow (JSON-encoded) |

### Creates a Ray cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/create-ray-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| description | string | no | The description |
| displayReleaseVersion | string | no | The Ray DPI engine version |
| extraParam | string | no | The extra parameters. The value must be in JSON format |
| headSpec | object | no | The parameters of the Ray cluster head node |
| name | string | no | The name of the Ray cluster. The name must be 1 to 64 characters in length |
| networkServiceName | string | no | The network connectivity name |
| volumeIds | array | no | The list of managed directory IDs to mount |
| workerSpec | array | no | The parameters of the Ray cluster worker nodes. A maximum of 50 groups are supported |

### Creates a session
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/create-session-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| applicationConfigs | array | no | The Spark application configurations |
| autoStartConfiguration | object | no | Specifies whether to enable automatic startup. Valid values: true: Enabled. false: Disabled |
| autoStopConfiguration | object | no | The automatic stop configuration |
| clientToken | string | no | The client token that is used to ensure the idempotence of the request |
| displayReleaseVersion | string | no | The version displayed in the console |
| envId | string | no | The Python environment ID. This parameter takes effect only for Notebook sessions |
| fusion | string | no | Specifies whether to enable Fusion engine acceleration |
| kind | string | no | The session type. Valid values: SQL: SQL session. NOTEBOOK: NOTEBOOK session |
| name | string | no | The node name |
| publicEndpointEnabled | string | no | Specifies whether to enable the public network access endpoint |
| queueName | string | no | The queue name |
| releaseVersion | string | no | The Spark DPI engine version number |
| workspaceId | string | yes | The workspace ID |
| regionId | string | no | The region ID |

### Creates an SQL query
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/create-sql-statement` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| codeContent | string | no | The SQL code. You can specify one or more SQL statements to execute |
| defaultCatalog | string | no | The default DLF catalog ID |
| defaultDatabase | string | no | The default database name |
| limit | integer | no | The limit value. Valid values: 1 to 10000 |
| sqlComputeId | string | no | The SQL session ID. Create the session in the session management module of the EMR Serverless Spark workspace |
| taskBizId | string | no | The data development node ID |
| regionId | string | no | The region ID |

### Creates a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/create-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| autoRenew | string | no | Specifies whether to enable auto-renewal. This parameter is required if you set `paymentType` to `Pre` |
| autoRenewPeriod | string | no | The auto-renewal duration. This parameter is required if `autoRenew` is set to `true` |
| autoRenewPeriodUnit | string | no | The unit of the auto-renewal duration. This parameter is required if `autoRenew` is set to `true` |
| autoStartSessionCluster | string | no | Specifies whether to automatically start a session cluster when the workspace is created |
| clientToken | string | no | A token that ensures the idempotency of the request |
| dlfCatalogId | string | no | The DLF Catalog ID |
| dlfType | string | no | The DLF type |
| duration | string | no | The subscription duration. This parameter is required if you set `paymentType` to `Pre` |
| gpuSpec | array | no | The specifications for the GPU resources |
| ossBucket | string | no | The OSS bucket for the workspace. The path must be in the `oss:// /` format |
| paymentDurationUnit | string | no | The unit of the subscription duration. This parameter is required if you set `paymentType` to `Pre` |
| paymentType | string | no | The billing method. Valid values: `PayAsYouGo`: pay-as-you-go `Pre`: subscription |
| ramRoleName | string | no | The name of the RAM role used to run Spark jobs |
| releaseType | string | no | The release type |
| resourceGroupId | string | no | The resource group ID |
| resourceSpec | object | no | The resource specifications |
| tag | array | no | The tags to add to the workspace |
| workspaceName | string | no | The workspace name |
| regionId | string | no | The region ID |

### Creates a workspace queue
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/create-workspace-queue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| description | string | no | The description |
| gpuSpec | array | no | The list of GPU models |
| instanceId | string | no | The Ray cluster instance ID |
| paymentType | string | no | The billing method of the instance. Valid values: PayAsYouGo: pay-as-you-go Pre: subscription |
| preheat | string | no | Indicates whether resource prefetch is enabled |
| queueCategory | string | no | The queue type. Valid values: CPU and GPU |
| resourceSpec | object | no | The resource specifications |
| workspaceId | string | no | The workspace ID |
| workspaceQueueName | string | no | The workspace queue name |
| regionId | string | no | The region ID |

### Deletes a Kyuubi gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/delete-kyuubi-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| kyuubiServiceId | string | yes | The Kyuubi service ID |

### Deletes a Kyuubi Gateway authentication token
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/delete-kyuubi-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| kyuubiServiceId | string | yes | The Kyuubi service ID |
| tokenId | string | yes | The token ID |
| regionId | string | no | The region ID |

### Deletes a Livy gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/delete-livy-compute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceBizId | string | yes | The workspace ID |
| livyComputeId | string | yes | The ID of the Livy gateway |
| regionId | string | no | The region ID |

### Deletes a token for a Livy Gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/delete-livy-compute-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceBizId | string | yes | The workspace ID |
| livyComputeId | string | yes | The ID of the Livy Gateway |
| tokenId | string | yes | The token ID |
| regionId | string | no | The region ID |

### Deletes a Ray cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/delete-ray-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| clusterId | string | yes | The Ray cluster ID |

### Deletes a workspace queue
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/delete-workspace-queue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| workspaceQueueName | string | yes | The workspace queue name |
| regionId | string | no | The region ID |

### Edits a workspace queue
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/edit-workspace-queue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| description | string | no | The description |
| environments | array | no | The environment type of the queue |
| gpuSpec | array | no | The list of GPU models |
| instanceId | string | no | The instanceId |
| resourceSpec | object | no | The resource quota |
| workspaceId | string | no | The workspace ID |
| workspaceQueueName | string | no | The name of the workspace queue |
| regionId | string | no | The region ID |

### Publishes a workflow and its scheduling configuration
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/generate-task-codes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| bizId | string | yes | The workspace ID |
| genNum | integer | yes | The number of codes to generate |
| productNamespace | string | yes | The product namespace |
| regionId | string | no | The region ID |

### Retrieves the status of AI Hub
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/get-aicenter-state` (byok)

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

### Retrieves the details of a Cache cluster
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/get-cache-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| cacheClusterId | string | yes | The Cache cluster ID |
| regionId | string | no | The region ID |

### Queries the number of CU-hours consumed by a queue during a specified cycle
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/get-cu-hours` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| queue | string | yes | The name of the queue |
| startTime | string | yes | The start time of the query time range |
| endTime | string | yes | The end time of the query time range |

### Retrieves the diagnostic information for a Serverless Spark job
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/get-doctor-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| runId | string | yes | The run ID |
| queryTime | string | no | The query date in the YYYY-MM-DD format |
| locale | string | no | The language of the diagnostic information |
| regionId | string | no | The region ID |

### Retrieves the details of a Spark job run by calling GetJobRun
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/get-job-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| jobRunId | string | yes | The job run ID |
| regionId | string | no | The region ID |

### Retrieves a Kyuubi Gateway
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/get-kyuubi-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| kyuubiServiceId | string | yes | The Kyuubi service ID |

### Retrieves the Kyuubi Gateway authentication token
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/get-kyuubi-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| kyuubiServiceId | string | yes | The Kyuubi service ID |
| tokenId | string | yes | The token ID |
| regionId | string | no | The region ID |

### Retrieves the Livy Gateway information
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/get-livy-compute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceBizId | string | yes | The workspace ID |
| livyComputeId | string | yes | The ID of the Livy Gateway |
| regionId | string | no | The region ID |

### Retrieves the token for a Livy Gateway
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/get-livy-compute-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceBizId | string | yes | The workspace ID |
| livyComputeId | string | yes | The ID of the Livy Gateway |
| tokenId | string | yes | Token ID |
| regionId | string | no | The region ID |

### Retrieves a Ray cluster
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/get-ray-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| clusterId | string | yes | The cluster ID |

### Retrieves Ray Job information
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/get-ray-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| submissionId | string | yes | The ID of the Ray Job |

### Retrieves the log of a Ray job
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/get-ray-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| instanceId | string | yes | The ID of the Ray job |
| bucketName | string | no | The bucket name |
| path | string | no | The log file path |

### Retrieves the configuration of a Spark job
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/get-run-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| runId | string | yes | The job instance ID |
| regionId | string | no | The region ID |

### Retrieves the details of a session
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/get-session-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| sessionClusterId | string | yes | The job name |
| regionId | string | no | The region ID |

### Retrieves the details of an SQL query
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/get-sql-statement` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| statementId | string | yes | The statement ID |
| regionId | string | no | The region ID |

### Retrieves a task template
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/get-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceBizId | string | yes | The workspace ID |
| templateType | string | no | The template type |
| regionId | string | no | The region ID |
| templateBizId | string | no | The templateBizId |

### Retrieves the details of a workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/get-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| regionId | string | no | The region ID |

### Assigns a specified role to users
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/grant-role-to-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| roleArn | string | no | The Alibaba Cloud Resource Name (ARN) of the RAM role |
| userArns | array | no | The user ARNs |
| regionId | string | no | The region ID |

### View the list of data catalogs
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-catalogs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| environment | string | no | The environment type |
| regionId | string | no | The region ID |

### Lists the log files of a job executor
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-executor-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| jobRunId | string | yes | The job run ID |
| executorId | string | yes | The job executor ID |
| nextToken | string | no | The next token |
| maxResults | integer | no | The maximum number of records to return in a single request |
| logType | string | no | The log type |
| regionId | string | no | The region ID |

### Lists the executors of a job
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-job-executors` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| jobRunId | string | yes | The job run ID |
| nextToken | string | no | The token for the next page of results |
| maxResults | integer | no | The maximum number of records to return in a single request |
| status | string | no | The executor status |
| executorType | string | no | The executor type |
| regionId | string | no | The region ID |

### Retrieves a list of Spark job runs
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-job-runs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| nextToken | string | no | The pagination token that marks the starting position for the query |
| maxResults | integer | no | The maximum number of records to return in a single request. The maximum value is 100 |
| workspaceId | string | yes | The ID of the workspace |
| name | string | no | The name of the job |
| creator | string | no | The UID of the creator |
| jobRunId | string | no | The ID of the job run |
| tags | string | no | The list of tags (JSON-encoded) |
| states | string | no | The states of the job runs (JSON-encoded) |
| startTime | string | no | The time range for the start time of the job run (JSON-encoded) |
| endTime | string | no | The time range for the end time of the job run (JSON-encoded) |
| resourceQueueId | string | no | The name of the resource queue where the Spark job runs |
| jobRunDeploymentId | string | no | The job ID of the streaming job deployment |
| regionId | string | no | The region ID |
| minDuration | integer | no | The minimum execution duration of the job run, in milliseconds |
| isWorkflow | string | no | Specifies whether the job is a workflow job |
| runtimeConfigs | string | no | The runtime configurations |
| applicationConfigs | string | no | The Spark configurations |
| groupByState | string | no | Specifies whether to aggregate and return statistical results by job state |

### Lists Kyuubi Gateways
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-kyuubi-services` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| token | string | no | The Kyuubi Gateway token |

### Queries the Spark applications submitted by Kyuubi
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-kyuubi-spark-applications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| nextToken | string | no | The token for the next page |
| maxResults | integer | no | The maximum number of records to retrieve at a time |
| workspaceId | string | yes | The workspace ID |
| kyuubiServiceId | string | yes | The Kyuubi service ID |
| applicationId | string | no | The ID of the Spark application submitted by Kyuubi, used for search |
| applicationName | string | no | The name of the Spark application submitted by Kyuubi, used for search |
| startTime | string | no | The start time range of the task (JSON-encoded) |
| resourceQueueId | string | no | The resource queue ID used to filter Spark applications |
| minDuration | integer | no | The minimum execution duration of the application, in milliseconds |
| orderBy | string | no | The list of sort fields (JSON-encoded) |
| sort | string | no | The sort order. A value of asc indicates ascending order, and desc indicates descending order |
| endTime | string | no | The end time range of the task (JSON-encoded) |
| states | string | no | The list of Spark application states used for filtering |
| latestSqlStatementStatuses | string | no | The list of statuses of the latest SQL statement used for filtering |

### Lists the authentication tokens for Kyuubi Server
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-kyuubi-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| kyuubiServiceId | string | yes | The Kyuubi service ID |
| regionId | string | no | The region ID |

### Lists Livy gateways
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-livy-compute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceBizId | string | yes | The workspace ID |
| environmentId | string | no | The runtime environment ID |
| regionId | string | no | The region ID |

### Retrieves the historical sessions of a Livy Gateway
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-livy-compute-sessions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| livyComputeId | string | yes | The ID of the Livy Gateway |
| pageNum | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The number of entries per page. Default value: 20. Minimum value: 1. Maximum value: 100 |
| regionId | string | no | The region ID |

### Lists the tokens of a Livy gateway
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-livy-compute-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceBizId | string | yes | The workspace ID |
| livyComputeId | string | yes | The ID of the Livy gateway |
| regionId | string | no | The region ID |

### Get Log Content
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-log-contents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| fileName | string | no | Full path of the file |
| offset | integer | no | Start line for query |
| length | integer | no | Length of the log |
| workspaceId | string | yes | Workspace ID |
| regionId | string | no | Region ID |

### Queries the list of members in a workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-members` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| nextToken | string | no | The pagination token that specifies the starting position for the query |
| maxResults | integer | no | The maximum number of records to return per request |
| workspaceId | string | yes | The ID of the workspace |
| regionId | string | no | The region ID |

### Lists network connections
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-network-services` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| regionId | string | no | The region ID |

### Queries the jobs with the highest CU usage in a queue
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-queue-top-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| queueName | string | yes | The name of the queue |
| topN | integer | no | The maximum number of jobs to return. The maximum value is 10 |
| regionId | string | no | The region ID |

### Lists Ray clusters
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-ray-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| pageSize | integer | no | The number of entries to return on each page. Default value: 20. Minimum value: 1. Maximum value: 100 |
| pageNum | integer | no | The page number |

### Lists Ray job information
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-ray-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| pageSize | integer | no | The number of entries to return on each page. Default value: 20 |
| pageNum | integer | no | The page number. Default value: 1 |
| submissionId | string | no | The submission ID of the Ray job |
| name | string | no | The name of the Ray job. Exact match is supported |
| submitTime | string | no | The submission time range (JSON-encoded) |
| taskBizId | string | no | The ID of the data development node |

### Lists Ray logs
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-ray-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| instanceId | string | yes | The ID of the Ray job |
| bucketName | string | no | The bucket name |
| prefix | string | no | The prefix that the keys of the returned files must start with |
| marker | string | no | The marker after which the returned objects are listed in alphabetical order |
| delimiter | string | no | The character used to group object names. All objects whose names contain the specified prefix and between which the delimiter character… |
| maxKeys | integer | no | The maximum number of objects to return. If the listing cannot be completed in a single request due to the max-keys setting, a NextMarker… |

### Retrieves the list of release versions
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-release-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| serviceFilter | string | no | Filters available versions by service type. Valid values: kyuubi and ray |
| releaseVersion | string | no | The Serverless Spark version |
| releaseVersionStatus | string | no | The version status |
| releaseType | string | no | The version type |
| workspaceId | string | no | The workspace ID |
| regionId | string | no | The region ID |

### Retrieves a list of sessions
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-session-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| nextToken | string | no | The token that indicates the position from which to start reading |
| maxResults | integer | no | The maximum number of records to return in a single request |
| workspaceId | string | yes | The workspace ID |
| sessionClusterId | string | no | The job name |
| queueName | string | no | The queue name |
| kind | string | no | The session type |
| regionId | string | no | The region ID |

### Retrieves the execution results of an SQL statement
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-sql-statement-contents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| fileName | string | no | The full path of the file |
| workspaceId | string | yes | The workspace ID |
| nextToken | string | no | The token that specifies the position from which to start reading the results |
| maxResults | integer | no | The maximum number of records to return for a single request |

### Lists job templates
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceBizId | string | yes | The workspace ID |
| regionId | string | no | The region ID |

### Queries the queues in a workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-workspace-queues` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| environment | string | no | The environment type |
| regionId | string | no | The region ID |

### Queries a list of workspaces
`GET https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/list-workspaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| nextToken | string | no | The pagination token that specifies the starting position for the current read operation |
| maxResults | integer | no | The maximum number of results to return in a single request |
| name | string | no | The name of the workspace. Fuzzy search is supported |
| state | string | no | The state of the workspace. Valid values: Starting: The workspace is starting. Running: The workspace is running. Stopping: The workspace… |
| regionId | string | no | The region ID |
| tag | string | no | The list of tags used to filter workspaces (JSON-encoded) |
| resourceGroupId | string | no | The resource group ID |

### Queries APM Grafana panel data for Serverless Spark
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/query-apm-grafana-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| componentName | string | no | The name of the monitoring dashboard |
| provider | string | no | The datasource provider |
| queryUrl | string | yes | The Grafana datasource proxy path |
| query | string | no | The PromQL query expression |
| start | string | no | The start time of the query. The value is a UNIX timestamp in seconds |
| end | string | no | The end time of the query. The value is a UNIX timestamp in seconds |
| step | string | no | The query step, in seconds |
| time | string | no | The time point for an instant query. The value is a UNIX timestamp in seconds |
| dashboardId | string | no | The dashboard ID |
| queryParams | string | no | The panel-level query parameters (JSON-encoded) |
| workspaceId | string | yes | The workspace ID |
| variables | string | no | The dashboard variables, as a JSON string |
| regionId | string | no | The region ID |

### Refreshes the token for a Livy Gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/refresh-livy-compute-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceBizId | string | yes | The workspace ID |
| livyComputeId | string | yes | The ID of the Livy Gateway |
| tokenId | string | yes | The token ID |
| autoExpireConfiguration | object | no | The information about token expiration |
| name | string | no | The name |
| token | string | no | The token must be 16 or more characters in length |
| regionId | string | no | The region ID |

### Start CacheCluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/start-cache-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| cacheClusterId | string | yes | Cache cluster ID |
| regionId | string | no | Region ID |

### Starts a Spark Job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/start-job-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| clientToken | string | no | The idempotence token |
| codeType | string | no | The job type. Valid values: SQL JAR PYTHON |
| configurationOverrides | object | no | The advanced Spark configurations |
| displayReleaseVersion | string | no | The version that is displayed in the console |
| executionTimeoutSeconds | integer | no | The timeout period for the job |
| fusion | string | no | Specifies whether to enable the Fusion engine for acceleration |
| jobDriver | object | no | The information about the Spark driver |
| jobId | string | no | The job ID |
| name | string | no | The job name |
| releaseVersion | string | no | The version of the Spark engine |
| resourceQueueId | string | no | The resource queue on which the Spark job runs |
| tags | array | no | The list of job tags |
| workspaceId | string | yes | The workspace ID |
| regionId | string | no | The region ID |

### Starts the Kyuubi Gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/start-kyuubi-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| kyuubiServiceId | string | yes | The Kyuubi service ID |

### Starts a Livy gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/start-livy-compute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceBizId | string | yes | The workspace ID |
| livyComputeId | string | yes | The ID of the Livy gateway |
| regionId | string | no | The region ID |

### Manually runs a workflow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/start-process-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| productNamespace | string | yes | The product code |
| bizId | string | yes | The workspace ID |
| processDefinitionCode | integer | yes | The workflow definition ID |
| versionNumber | integer | no | The workflow definition version number |
| isProd | string | no | Specifies whether the workflow runs in the production environment |
| runtimeQueue | string | no | The runtime queue |
| versionHashCode | string | no | The version hash code |
| regionId | string | no | The region ID |
| interval | string | no | The interval |
| action | string | no | The action |
| comments | string | no | The comments |
| email | string | no | The email |
| runMode | string | no | The execution policy |
| expectedParallelismNumber | integer | no | The expected concurrency |

### Starts a Ray cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/start-ray-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| clusterId | string | yes | The Ray cluster ID |
| clientToken | string | no | The token used to ensure idempotence |

### Starts a session cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/start-session-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| queueName | string | no | The queue name |
| sessionClusterId | string | no | The session cluster ID |
| workspaceId | string | yes | The workspace ID |
| regionId | string | no | The region ID |

### Stops a CacheCluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/stop-cache-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| cacheClusterId | string | yes | The ID of the Cache cluster |
| regionId | string | no | The region ID |

### Stops a Kyuubi Gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/stop-kyuubi-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| kyuubiServiceId | string | yes | The Kyuubi service ID |

### Stops a Livy Gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/stop-livy-compute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceBizId | string | yes | The workspace ID |
| livyComputeId | string | yes | The ID of the Livy Gateway |
| regionId | string | no | The region ID |

### Stops a Ray cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/stop-ray-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| clusterId | string | yes | The Ray cluster ID |
| instanceId | string | no | The ID of the Ray cluster instance |

### Stops a session
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/stop-session-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| queueName | string | no | The queue name |
| sessionClusterId | string | no | The session ID |
| workspaceId | string | yes | The workspace ID |
| regionId | string | no | The region ID |

### Submits a Ray job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/submit-ray-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| activeDeadlineSeconds | integer | no | The job timeout period, which includes the cluster creation and job execution time. The job is canceled if it exceeds this period |
| clusterId | string | no | The ID of the existing Ray cluster |
| displayReleaseVersion | string | no | The Ray DPI engine database engine version number |
| entrypoint | string | no | The entrypoint command |
| entrypointMemory | string | no | The memory size requested by the entrypoint job |
| entrypointNumCpus | string | no | The number of CPUs requested by the entrypoint job |
| entrypointNumGpus | string | no | The number of GPUs requested by the entrypoint job |
| entrypointResources | string | no | The custom resource request JSON string for the entrypoint job |
| extraParam | string | no | The JSON string for additional parameters |
| headSpec | object | no | The parameters of the Ray cluster head node |
| metadataJson | string | no | The job metadata JSON string |
| name | string | no | The job name |
| networkServiceName | string | no | The network connectivity name |
| runtimeEnvJson | string | no | The Ray runtime environment JSON string |
| shutdownAfterJobFinishes | string | no | Specifies whether to automatically destroy the temporary cluster after the job finishes. Default value: true |
| submissionMode | string | no | The job submission mode |
| tags | array | no | The tags |
| ttlSecondsAfterFinished | integer | no | The wait time in seconds before the cluster is destroyed. This parameter takes effect only when shutdownAfterJobFinishes is set to true |
| volumeIds | array | no | The list of mounted volume IDs |
| workerSpec | array | no | The Ray cluster worker node parameters |
| workingDir | string | no | The URL of the working directory for the job code |

### Terminates an SQL query task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/terminate-sql-statement` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| statementId | string | yes | The interactive query ID |
| regionId | string | no | The region ID |

### Updates a Kyuubi Gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/update-kyuubi-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| kyuubiServiceId | string | yes | The Kyuubi service ID |
| computeInstance | string | no | The specifications of the Kyuubi service |
| kyuubiConfigs | string | no | The Kyuubi service configuration |
| kyuubiReleaseVersion | string | no | The Kyuubi service engine version |
| name | string | no | The name |
| publicEndpointEnabled | string | no | Specifies whether to enable public network access |
| queue | string | no | The queue in which the Kyuubi service runs |
| releaseVersion | string | no | The version of the Spark engine |
| replica | integer | no | The number of replicas for high availability (HA) |
| restart | string | no | Specifies whether to restart the service |
| sparkConfigs | string | no | The Spark configuration |

### Updates the Kyuubi Gateway authentication token
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/update-kyuubi-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| kyuubiServiceId | string | yes | The Kyuubi service ID |
| tokenId | string | yes | The token ID |
| autoExpireConfiguration | object | no | The auto-expiration configuration struct |
| memberArns | array | no | The list of ARNs of authorized users |
| name | string | no | The token name |
| sparkRole | array | no | The list of Spark roles associated with the token |
| token | string | no | The token content, which must be 32 characters in length and contain only lowercase letters and digits |
| regionId | string | no | The region ID |

### Updates a Livy Gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/update-livy-compute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceBizId | string | yes | The workspace ID |
| livyComputeId | string | yes | The ID of the Livy Gateway |
| authType | string | no | The authentication method |
| autoStartConfiguration | object | no | The auto-start configuration |
| autoStopConfiguration | object | no | The auto-stop configuration |
| cpuLimit | string | no | The number of vCPUs for the Livy server. 1 2 4 |
| displayReleaseVersion | string | no | The version number of the Spark engine |
| enablePublic | string | no | The status of the switch for the Internet endpoint |
| environmentId | string | no | The environment ID |
| fusion | string | no | Specifies whether to enable the Fusion engine for acceleration |
| livyServerConf | string | no | The configurations of the Livy Gateway. This parameter is in JSON format and supports the following files: sparkDefaultsConf… |
| livyVersion | string | no | The Livy version |
| memoryLimit | string | no | The memory size of the Livy server |
| name | string | no | The name |
| networkName | string | no | The name of the network connection |
| queueName | string | no | The queue name |
| releaseVersion | string | no | The version number of the Spark engine. This parameter is deprecated. Use displayReleaseVersion instead |
| regionId | string | no | The region ID |

### Updates a workflow definition and scheduling
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/update-process-definition-with-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| productNamespace | string | yes | The product code |
| bizId | string | yes | The workspace ID |
| name | string | yes | The workflow name |
| code | string | yes | The task definition ID |
| description | string | no | The workflow description |
| timeout | integer | no | The default timeout period for workflow execution |
| taskDefinitionJson | string | yes | The JSON array of task definitions, which contains the description of all tasks in the workflow (JSON-encoded) |
| taskRelationJson | string | yes | The JSON array of task dependencies, which contains the dependencies among all tasks in the workflow. preTaskCode specifies the upstream… |
| executionType | string | yes | The execution strategy |
| alertEmailAddress | string | no | The email address for alert notifications |
| schedule | string | no | The schedule structure (JSON-encoded) |
| retryTimes | integer | no | The number of retries |
| taskParallelism | integer | no | The concurrency level for workflow node execution |
| tags | string | no | The tags (JSON-encoded) |
| resourceQueue | string | no | The resource queue |
| releaseState | string | no | The online status of the workflow |
| runAs | string | no | The execution user |
| publish | string | no | Specifies whether to publish the workflow |
| regionId | string | no | The region ID |
| globalParams | string | no | The list of global parameters for the workflow (JSON-encoded) |

### Updates a Ray cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/update-ray-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| clusterId | string | yes | The cluster ID |
| description | string | no | The description |
| displayReleaseVersion | string | no | The Ray DPI engine version |
| extraParam | string | no | The extra parameters. The value must be in JSON format |
| headSpec | object | no | The head node information for the Ray cluster |
| name | string | no | The name of the Ray cluster. The name must be 1 to 64 characters in length |
| networkServiceName | string | no | The network connection name |
| volumeIds | array | no | The list of managed directory IDs to mount |
| workerSpec | array | no | The worker node information for the Ray cluster. A maximum of 50 worker groups are supported |

### Updates the attributes of a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/update-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://emr-serverless-spark.ap-southeast-1.aliyuncs.com |
| cu | integer | no | The resource limit for the workspace |
| gpu | integer | no | The number of GPUs |
| gpuSpec | array | no | The GPU instance type |
| gpuSubscription | object | no | The GPU subscription |
| ipWhiteList | array | no | The IP address whitelist of the workspace |
| resourceGroupId | string | no | The resource group ID |
| subscription | object | no | The information about switching the billing method from pay-as-you-go to subscription |
| workspaceId | string | no | The workspace ID |
| workspaceName | string | no | The workspace name |
| regionId | string | no | The region ID |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/version` (byok)

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

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/activate-aicenter" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud EMR Serverless Spark API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-emr-serverless-spark/activate-aicenter with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud EMR Serverless Spark 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 Serverless Spark itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud EMR Serverless Spark API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-emr-serverless-spark.

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