# Alibaba Cloud ApsaraMQ for Kafka API

> Alibaba Cloud ApsaraMQ for Kafka API on Apizie: 19 endpoints (Validates a specified Flink SQL statement, Creates a compute instance. This operation only completes the purchase phase. After the instance is created,…, Creates a Flink SQL job on a running compute instance, Deletes a compute instance that is in the pending deployment, stopped, or released state, …) 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-alikafkastreaming/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for ApsaraMQ for Kafka (alikafkastreaming, version 2026-02-02). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Validates a specified Flink SQL statement
`POST https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/check-sql-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The compute instance ID |
| JobName | string | yes | The compute job name |
| SqlContent | string | yes | The Flink SQL statement to be validated |

### Creates a compute instance. This operation only completes the purchase phase. After the instance is created,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/create-compute-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| PaidType | integer | yes | The billing method. Only 5 (pay-as-you-go) is supported |
| ResourceGroupId | string | no | The resource group ID |

### Creates a Flink SQL job on a running compute instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/create-compute-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The compute instance ID |
| JobName | string | yes | The compute job name |
| CuLimit | number | yes | The CU limit for the job |
| CuReserved | number | yes | The reserved CUs for the job. The reserved CUs must not exceed the CU limit |
| Remark | string | no | The job remarks |

### Deletes a compute instance that is in the pending deployment, stopped, or released state
`POST https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/delete-compute-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The compute instance ID |

### Deletes a specified compute job. A successful request indicates that the deletion request has been accepted
`POST https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/delete-compute-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The ID of the compute instance, excluding the region name |
| JobName | string | yes | The name of the compute job |

### Queries the details of a specified compute instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/get-compute-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The compute instance ID |

### Queries the details of a compute job in AlikafkaStreaming by specifying parameters in a parameter query
`POST https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/get-compute-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The ID of the compute instance |
| JobName | string | yes | The name of the compute job |

### This topic describes how to call ListComputeInstances to perform a paging query of compute instances under…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/list-compute-instances-in-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| InstanceIds | string | no | The IDs of the compute instances (JSON-encoded) |
| CurrentPage | integer | no | The current page number. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10 |
| ResourceGroupId | string | no | The ID of the resource group |

### Queries information about all jobs under a specified compute instance by using paging
`POST https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/list-compute-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The compute instance ID |
| Search | string | no | The keyword used to search for jobs by name or remark |
| SortField | string | no | The sort field. Valid values: `createTime`, `cuReserved`, `cuLimit`, `cuUsed`, `status`, and `jobName` |
| SortDirection | string | no | The sort direction. The value is not case-sensitive. Valid values: `ASC` and `DESC` |
| NextToken | string | no | The pagination token. Do not specify this parameter in the first request. For subsequent requests, specify the `NextToken` value returned… |
| MaxResults | integer | no | The maximum number of jobs to return in the current request. Default value: 10. Maximum value: 1000. If you set this parameter to 0, the… |

### Reactivates a stopped pay-as-you-go compute instance. A successful response indicates that the reactivation…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/reopen-compute-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The ID of the compute instance |

### Configures the network and initiates the deployment for a compute instance in the pending deployment state
`POST https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/start-compute-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The ID of the instance |
| VpcId | string | yes | The ID of the VPC where the instance is deployed |
| VSwitchIds | string | yes | The list of vSwitch IDs (JSON-encoded) |
| InstanceName | string | no | The name of the compute instance |

### Starts, resumes, or tests a compute job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/start-compute-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The compute instance ID |
| JobName | string | yes | The name of the compute job |
| RecoveryMode | string | no | The recovery mode, such as savepoint or stateless |
| DraftSql | string | no | The Flink SQL draft, which must be a self-contained and complete DDL and DML statement |
| CuLimit | number | no | The maximum number of CUs for the job. You can enter an integer or a decimal |
| CuReserved | number | no | The number of reserved CUs for the job. You can enter an integer or a decimal. The number of reserved CUs cannot exceed the maximum number… |

### Stops a running pay-as-you-go compute instance. A successful response indicates that the stop request has…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/stop-compute-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The ID of the compute instance |

### Stops a compute job in the specified region and instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/stop-compute-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The compute instance ID, excluding the region name |
| JobName | string | yes | The name of the compute job |

### Updates the name of a compute instance. The instance must be in the deployment preparation or running state
`POST https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/update-compute-instance-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The ID of the compute instance |
| InstanceName | string | yes | The name of the compute instance |

### Modifies the remarks of a specified compute job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/update-compute-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The compute instance ID |
| JobName | string | yes | The name of the compute job |
| Remark | string | no | The job remarks |

### Modifies the CU limit and reserved CUs for a specified computing job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/update-compute-job-cu` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The computing instance ID |
| JobName | string | yes | The name of the computing job |
| CuLimit | number | yes | The CU limit for the job |
| CuReserved | number | yes | The reserved CUs for the job. The reserved CUs must not exceed the CU limit |

### Updates the Flink SQL draft saved for a specified compute job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/update-compute-job-draft-sql` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The compute instance ID |
| JobName | string | yes | The name of the compute job |
| DraftSql | string | yes | The Flink SQL draft |

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

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/check-sql-content" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud ApsaraMQ for Kafka API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-alikafkastreaming/check-sql-content with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud ApsaraMQ for Kafka 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-alikafkastreaming.

### What is the status of the Alibaba Cloud ApsaraMQ for Kafka API?
Needs your own provider key (bring your own key)