# Alibaba Cloud Datahub API

> Alibaba Cloud Datahub API on Apizie: 23 endpoints (Creates a project, Creates subscription information, A topic is the smallest unit for subscription and publishing in DataHub. You can use a topic to represent a…, Deletes a project. Before deleting a project, you must delete all resources under the project, including…, …) 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://apizie.tech/v1/cloud:aliyun-datahub/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for Datahub (datahub, version 2024-06-20). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Creates a project
`POST https://apizie.tech/v1/cloud:aliyun-datahub/create-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| Comment | string | yes | The description of the workspace |

### Creates subscription information
`POST https://apizie.tech/v1/cloud:aliyun-datahub/create-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| TopicName | string | yes | The topic name |
| SubscriptionId | string | no | The subscription ID that you manually specify. If you do not specify this parameter, the server automatically generates one. Can contain… |
| Application | string | yes | The description of the new application. The description can be up to 256 characters in length |
| Comment | string | yes | The description of the subscription |

### A topic is the smallest unit for subscription and publishing in DataHub. You can use a topic to represent a…
`POST https://apizie.tech/v1/cloud:aliyun-datahub/create-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The name of the project |
| TopicName | string | yes | The name of the topic |
| ShardCount | integer | yes | The number of shards |
| Lifecycle | integer | yes | The lifecycle of the topic. Unit: days |
| RecordType | string | yes | The type of the topic. Valid values: Blob: supports writing a block of binary data as a single record. Tuple: supports database-like… |
| RecordSchema | string | no | The schema table structure |
| Comment | string | yes | The description of the topic |
| ExpandMode | string | no | The expansion mode of the topic. After the expansion mode is enabled, shards support horizontal scaling and no longer support merge or… |
| EnableSchemaRegistry | string | no | Specifies whether to enable multi-version schema. After this feature is enabled, a topic can have multiple schemas simultaneously. You can… |

### Deletes a project. Before deleting a project, you must delete all resources under the project, including…
`POST https://apizie.tech/v1/cloud:aliyun-datahub/delete-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |

### Deletes a subscription task
`POST https://apizie.tech/v1/cloud:aliyun-datahub/delete-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| TopicName | string | yes | The topic name |
| SubscriptionId | string | yes | The subscription ID |

### Deletes a topic resource. Before deleting a topic resource, you must delete all subscriptions and sync tasks…
`POST https://apizie.tech/v1/cloud:aliyun-datahub/delete-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| TopicName | string | yes | The name of the topic to delete |

### Queries the information about a synchronization task
`POST https://apizie.tech/v1/cloud:aliyun-datahub/get-connector` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| TopicName | string | yes | The topic name |
| ConnectorId | string | yes | The synchronization task ID |

### Queries consumer group information
`POST https://apizie.tech/v1/cloud:aliyun-datahub/get-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| GroupName | string | yes | The consumer group name |

### Queries project information
`POST https://apizie.tech/v1/cloud:aliyun-datahub/get-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |

### Reads data from a specified topic. This operation is primarily used for debugging. For high-volume data…
`POST https://apizie.tech/v1/cloud:aliyun-datahub/get-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| TopicName | string | yes | The topic name |
| ShardId | string | no | The shard ID from which to read data |
| StartTime | integer | no | The start time for reading data. By default, data is read starting from 5 minutes before the current time |

### Queries schema information
`POST https://apizie.tech/v1/cloud:aliyun-datahub/get-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| TopicName | string | yes | The topic name |
| VersionId | string | yes | The schema version number |

### Queries subscription information
`POST https://apizie.tech/v1/cloud:aliyun-datahub/get-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| TopicName | string | yes | The topic name |
| SubscriptionId | string | yes | The subscription ID |

### Queries topic information
`POST https://apizie.tech/v1/cloud:aliyun-datahub/get-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| TopicName | string | yes | The topic name |

### Retrieves a list of synchronization tasks
`POST https://apizie.tech/v1/cloud:aliyun-datahub/list-connectors` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| TopicName | string | yes | The topic name |
| Skip | integer | no | The number of records to skip in a paged query |
| MaxResults | integer | no | The maximum number of records to return in a paged query |
| NextToken | string | no | The pagination token. If NextToken is empty, paged query starts from the beginning. Otherwise, paged query starts from the end of the… |
| Keyword | string | no | The filter keyword for the paged query |
| Pure | string | no | Specifies whether to return only primary key information |

### Retrieves a list of consumer groups
`POST https://apizie.tech/v1/cloud:aliyun-datahub/list-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| Skip | integer | no | The number of records to skip in a paged query |
| MaxResults | integer | no | The maximum number of records to return in a paged query |
| NextToken | string | no | The pagination token. If NextToken is empty, paged query starts from the beginning. Otherwise, paged query starts from where the previous… |
| Keyword | string | no | The keyword used to filter results in a paged query |
| Pure | string | no | Specifies whether to return only primary key information |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| Skip | integer | no | The number of records to skip in a paged query |
| MaxResults | integer | no | The maximum number of records to return in a paged query |
| NextToken | string | no | The pagination token. If NextToken is empty, paged query starts from the beginning. Otherwise, paged query starts from the end of the… |
| Keyword | string | no | The filter keyword for a paged query |
| Pure | string | no | Specifies whether to return only primary key information |

### Retrieves a list of schemas
`POST https://apizie.tech/v1/cloud:aliyun-datahub/list-schemas` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| TopicName | string | yes | The topic name |
| Skip | integer | no | The number of records to skip in a paged query |
| MaxResults | integer | no | The maximum number of records to return in a paged query |
| NextToken | string | no | The pagination token. If NextToken is empty, paged query starts from the beginning. Otherwise, paged query starts from where the previous… |

### Retrieves a list of subscriptions
`POST https://apizie.tech/v1/cloud:aliyun-datahub/list-subscriptions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| TopicName | string | yes | The topic name |
| Skip | integer | no | The number of records to skip in a paged query |
| MaxResults | integer | no | The maximum number of records to return in a paged query |
| NextToken | string | no | The pagination token. If NextToken is empty, paged query starts from the beginning. Otherwise, paged query starts from where the previous… |
| Keyword | string | no | The filter keyword for a paged query |

### Retrieves a list of topics
`POST https://apizie.tech/v1/cloud:aliyun-datahub/list-topics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| Skip | integer | no | The number of records to skip in a paged query |
| MaxResults | integer | no | The maximum number of records to return in a paged query |
| NextToken | string | no | The pagination token. If NextToken is empty, paged query starts from the beginning. Otherwise, paged query starts from where the previous… |
| Keyword | string | no | The filter keyword for a paged query |
| Pure | string | no | Specifies whether to return only primary key information |

### Writes data to a specified topic. This operation is primarily used for debugging. For high-volume data…
`POST https://apizie.tech/v1/cloud:aliyun-datahub/put-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| TopicName | string | yes | The topic name |
| ShardId | string | no | The ID of the shard to which data is written. If this parameter is not specified, data is randomly written to a shard |
| Records | string | yes | The data to be written (JSON-encoded) |

### Updates the description of a project
`POST https://apizie.tech/v1/cloud:aliyun-datahub/update-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| Comment | string | no | The project description |

### Updates the description of a topic
`POST https://apizie.tech/v1/cloud:aliyun-datahub/update-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://datahub.ap-southeast-1.aliyuncs.com |
| ProjectName | string | yes | The project name |
| TopicName | string | yes | The topic name |
| Lifecycle | integer | no | The data retention period in the topic. Unit: days. Valid values: 1 to 7. If this parameter is not specified, the property is not updated |
| Comment | string | no | The remarks |
| RecordSchema | string | no | The schema definition of the topic. The value is a JSON string. This parameter is used to append new fields to the existing schema.… |

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

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

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

## FAQ

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

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

### Can AI agents use the Alibaba Cloud Datahub API?
Yes. Add the Apizie MCP server (https://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-datahub.

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