API standards and multilingual preset SDKs
The OpenAPI of this product (datahub/2024-06-20) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Data read and write
|
API |
Title |
Description |
| GetRecords | Subscribe to data | Reads data from a specified topic. This operation is primarily used for debugging. For high-volume data reading, refer to the SDK documentation. |
| PutRecords | Publish data | Writes data to a specified topic. This operation is primarily intended for debugging. For high-volume data writes, refer to the SDK documentation. |
Synchronization node management
|
API |
Title |
Description |
| ListConnectors | List synchronization tasks | Retrieves a list of synchronization tasks. |
| GetConnector | Query synchronization task information | Queries the information about a synchronization task. |
Subscription management
|
API |
Title |
Description |
| GetSubscription | Query subscription information | Queries subscription information. |
| ListSubscriptions | Retrieve subscription list | Retrieves a list of subscriptions. |
Topic management
|
API |
Title |
Description |
| CreateTopic | Create a topic | A topic is the smallest unit for DataHub subscription and publishing. You can use a topic to represent a type or category of streaming data. |
| UpdateTopic | Update topic information | Updates the description of a topic. |
| DeleteTopic | Delete a topic | Deletes a topic resource. Before deleting a topic resource, delete all subscriptions and sync tasks under the topic. |
| GetTopic | Query topic information | Queries topic information. |
| ListTopics | Retrieve topic list | Retrieves a list of topics. |
| GetSchema | Query schema information | Queries schema information. |
| ListSchemas | List Schemas | Lists schemas. |
Project management
|
API |
Title |
Description |
| CreateProject | Create a project | Creates a project. |
Others
|
API |
Title |
Description |
| GetProject | Query project information | Queries project information. |
| GetSubscription | Query subscription information | Queries subscription information. |
| ListSubscriptions | Retrieve subscription list | Retrieves a list of subscriptions. |
| UpdateProject | Update project information | Updates the description of a project. |