1. 数据采集OpenAPI概览
| 服务英文缩写 | API名称 | ACTION | API功能描述 |
|---|---|---|---|
| cbr-datagather | agent配置文件初始化 | initConf | 提供agent获取初始化配置的api |
| canel配置文件初始化 | initCanalConf | 提供canel获取初始化配置的api | |
| getTenantId | getTenantId | 根据appID查询对应的租户id | |
| cbr-opscenter | 上报服务 | slareport | 上报统计信息的接口 |
| cubricks | 更新服务 | upgrade | agent上报心跳获取更新信息的api |
| 日志服务 | dglogtest | 流式采集接收数据的服务 | |
| 查询KS3信息 | queryCosInfo | 查询KS3相关物理信息的服务 | |
| 通知调度 | noticeSchedulerSys | 向调度发送事件的服务 | |
| 上报历史记录 | saveHis | 批量采集上报历史记录的服务 | |
| 日志服务生产 | dglogonline | 流式采集接收数据的服务（生产环境） |
2. 请求结构
客户调用金山云云解析服务的openAPI接口是通过向指定服务地址发送请求，并按照openAPI文档说明在请求中添加相应的公共参数和接口参数来完成的。
云解析openAPI的请求结构组成如下：
服务地址
数据采集的服务接入地址为：
cubricks.api.ksyun.com
cbr-opscenter.api.ksyun.com
cbr-datagather.api.ksyun.com
通信协议
支持通过 HTTP方式进行请求通信。
请求方法
数据采集的openAPI同时支持POST请求。
请求参数
金山云openAPI请求包含两类参数：公共请求参数和接口请求参数。其中，公共请求参数是每个接口都要用到的请求参数，具体可参见公共参数小节；接口请求参数是各个接口所特有的，具体见各个接口的“请求参数”描述。
字符编码
请求及返回结果都使用UTF-8字符集进行编码。
3. 采集相关接口
请求参数
(1)Headers
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| tenantId | 是 | 1 | 租户id，前端查看 |
| userId | 是 | 1 | 用户id，前端查看 |
| Env | 是 | test | toipc所在环境 test/online |
| projectId | 是 | 1 | 项目id，前端查看 |
| ownerProjectId | 是 | 2 | topic所属项目id，前端查看 |
| topicName | 是 | topic01 | 采集数据写到哪个topic，前端查看 |
| kafkaSourceId | 是 | 73 | topic所在数据源id，前端查看 |
| requestMethod | 是 | API | 表示通过接口采集，值为API |
| Authorization | 是 | AWS v4签名头，签名算法请参考第二章签名算法 | |
| X-Amz-Date | 是 | 20190831T071321Z | 与Authorization中计算签名的日期一致 |
| Content-Type | 是 | text/plain |
(2)Body
Body中的数据为需要采集的数据，格式为数组格式
示例： [{“id”:1,“name”:“2”}]
(3)返回码说明
| 返回码 | 说明 |
|---|---|
| 200 | 成功 |
| 400 | Kop鉴权不通过或服务网关异常 |
| 401 | 用户权限校验不通过 |
| 404 | 请求地址错误或服务不存在 |
| 500 | 服务器内部错误 |
(4)请求完整示例
文档内容是否对您有帮助？
根本没帮助
文档较差
文档一般
文档不错
文档很好
在文档使用中是否遇到以下问题
内容不全，不深入
内容更新不及时
描述不清晰，比较混乱
系统或功能太复杂，缺乏足够的引导
内容冗长
更多建议
0/200
评价建议不能为空
提交成功！
非常感谢您的反馈，我们会继续努力做到更好！