API标准及多语言预置SDK
本产品（datahub/2024-06-20）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
数据读写
|
API |
标题 |
API概述 |
| GetRecords | 订阅数据 | 读取指定topic的数据，主要是调试使用，大流量的读取请参考官方文档的SDK介绍。 |
| PutRecords | 发布数据 | 向指定的topic写入数据，主要是调试使用，大流量的写入请参考官方文档的SDK介绍。 |
同步任务管理
|
API |
标题 |
API概述 |
| ListConnectors | 获取同步任务列表 | 获取同步任务列表。 |
| GetConnector | 查询同步任务信息 | 查询同步任务信息。 |
订阅管理
|
API |
标题 |
API概述 |
| CreateSubscription | 创建订阅 | 创建订阅信息 |
| GetSubscription | 查询订阅信息 | 查询订阅信息。 |
| ListSubscriptions | 获取订阅列表 | 获取订阅列表。 |
| DeleteSubscription | 删除订阅 | 删除订阅任务 |
| GetGroup | 查询消费组信息 | 查询消费组信息。 |
| ListGroups | 获取消费组列表 | 获取消费组列表。 |
Topic 管理
|
API |
标题 |
API概述 |
| CreateTopic | 创建topic | Topic是 DataHub 订阅和发布的最小单位，用户可以用Topic来表示一类或者一种流数据 |
| UpdateTopic | 更新Topic信息 | 更新Topic描述信息 |
| DeleteTopic | 删除topic | 删除topic资源，删除topic资源前需要删除对应topic下的所有订阅和同步任务 |
| GetTopic | 查询Topic信息 | 查询Topic信息。 |
| ListTopics | 获取Topic列表 | 获取Topic列表。 |
| GetSchema | 查询Shema信息 | 查询Schema信息。 |
| ListSchemas | 获取Schema列表 | 获取Schema列表。 |
Project 管理
|
API |
标题 |
API概述 |
| CreateProject | 创建项目 | 创建project空间 |
| ListProjects | 获取项目列表 | 获取项目列表。 |
| GetProject | 查询项目信息 | 查询Project信息。 |
| UpdateProject | 更新项目信息 | 更新Project描述信息 |
| DeleteProject | 删除项目 | 删除project，删除前需要删除project下的所有资源(Topic、同步任务、订阅任务) |
该文章对您有帮助吗？