数据采集OpenAPI

最近更新时间:2020-02-28 12:18:39

1. 数据采集OpenAPI概览

服务英文缩写 API名称 ACTION API功能描述
dgmanageservice agent配置文件初始化 initConf 提供agent获取初始化配置的api
canel配置文件初始化 initCanalConf 提供canel获取初始化配置的api
getTenantId getTenantId 根据appID查询对应的租户id
dataoperation 上报服务 slareport 上报统计信息的接口
datacloud 更新服务 upgrade agent上报心跳获取更新信息的api
日志服务 dglogtest 流式采集接收数据的服务
查询cos信息 queryCosInfo 查询cos相关物理信息的服务
通知调度 noticeSchedulerSys 向调度发送事件的服务
上报历史记录 saveHis 批量采集上报历史记录的服务
日志服务生产 dglogonline 流式采集接收数据的服务(生产环境)

2. 请求结构

客户调用金山云云解析服务的openAPI接口是通过向指定服务地址发送请求,并按照openAPI文档说明在请求中添加相应的公共参数和接口参数来完成的。

云解析openAPI的请求结构组成如下:

服务地址

数据采集的服务接入地址为:

datacloud.api.ksyun.com

dataoperation.api.ksyun.com

dgmanageservice.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)请求完整示例

数据采集OpenAPI

金山云,开启您的云计算之旅

免费注册