API-V5 接口说明-数据流相关接口

数据流相关接口

4.1 平台DB数据获取接口

POST https://api.hylanda.com/v5/data_stream/get_from_db

测试地址：https://api.hylanda.com/v5/help/util/try/#!/data95stream/DataStream_GetFromDB

接口描述
  • 对海量大数据分析平台中的中指定数据库进行获取的接口
  • 请注意：该接口所关联数据库必须是通过海量运维服务团队订购的，处于海量平台同一网络环境内的DB才可使用此接口
  • 该接口与v4接口的取数据服务内部是一致的，仅接口形式改为了postjson，原v4使用的密钥也可在v5内使用
接口参数

海量APIv5接口参数统一使用POST JSON 方式传递

参数名 位置 类型 描述 默认值
hl_appkey
必需		 HEADERS string 鉴权用，海量分配的appkey，参考《通用接口标准》
hl_time
必需		 HEADERS string 鉴权用，当前时间，参考《通用接口标准》
hl_sign
必需		 HEADERS string 鉴权用，签名校验码，参考《通用接口标准》
link_code
必需		 BODY-JSON string 指定数据集的连接码，由海量统一分配
id
可选		 BODY-JSON integer 要查询的起始键值，服务将使用键值升序输出数据大于此值的数据，可填入上次查询结果的next_id以达到遍历数据的效果 ""
num
可选		 BODY-JSON integer 本次要输出的条数，范围 (0,100]，默认20条，超出按默认值处理 20
query_extra
可选		 BODY-JSON object 查询用的额外参数，为特殊的取数据需求提供客户端定制查询功能，JsonObject格式，默认为空 {}
BODY-JSON样例
{
    "id": 0,
    "link_code": "填入海量分配的连接码",
    "num": 20,
    "query_extra": {
        "额外参数xxx": "有额外参数则按专属文档填写，若没有则不用传query_extra"
    }
}
其他参数细节

暂无

正常响应的返回数据

接口正常响应数据格式如下

{
    "res": 0 ,                         //正常返回均为0
    "msg": "成功",
    "data": [{                        //data字段内为JsonArray,包含多条数据
            "url": "http://abcd1",    //每条数据是一个JsonObject,字段列表由业务负责人提供
            "title": "abcd1"
        }, {
            "url": "http://abcd2",
            "title": "abcd2"
        }
    ],
    "next_id": ""                    //next_id字段，将此值作为下次请求的id参数以遍历数据
}

错误返回信息说明

通用错误信息，请参考《通用接口标准》 下面为本服务特有的错误反馈说明

HTTP Code HTTP Response Body Description
200 {
"res": -1,
"msg": "无 link_code"
}		 请求参数中没有链接码
200 {
"res": -1,
"msg": "link_code 连接失败"
}		 链接码所对应DB连接失败，错误信息会在msg后追加，一般这种错误请联系接口负责人协助解决
200 {
"res": -1,
"msg": "数据查询失败"
}		 查询过程出错，错误信息会在msg后追加，请联系接口负责人
200 {
"res": -1,
"msg": "结果解析错误"
}		 查询结果数据不符合规范，可能存在不可解析的数据，需要联系接口负责人排查
200 {
"res": -1,
"msg": "未知错误"
}		 请联系接口负责人排查

4.2 流式数据输入接口

POST https://api.hylanda.com/v5/data_stream/send_to_queue

测试地址：https://api.hylanda.com/v5/help/util/try/#!/data95stream/DataStream_SendToQueue

接口描述

发送数据到缓存队列，在ADP平台上通过【流式数据输入接口】能力读取数据

接口参数

海量APIv5接口参数统一使用POST JSON 方式传递

参数名 位置 类型 描述 默认值
hl_appkey
必需		 HEADERS string 鉴权用，海量分配的appkey，参考《通用接口标准》
hl_time
必需		 HEADERS string 鉴权用，当前时间，参考《通用接口标准》
hl_sign
必需		 HEADERS string 鉴权用，签名校验码，参考《通用接口标准》
BODY-JSON
required		 BODY-JSON object 需要输入平台的数据(JSON)，每次请求数据不大于1M
BODY-JSON样例
{
    "url":"http://www.abc.com/1234.html",
    "title":"标题文字",
    "content":"正文文字"
}
其他参数细节

注意：该接口所post的json整体，即为ADP平台能力输出的完整内容，平台能力会将post-body的json 内容完整输出

正常响应的返回数据
HTTP Code Description
200 接收数据完成 
{
    "res": 0 ,                          //正常返回均为0
    "msg": "接收数据完成"    
}

错误返回信息说明

通用错误信息，请参考《通用接口标准》

下面为本服务特有的错误反馈说明

HTTP Code HTTP Response Body Description
200 {
"res": -1,
"msg": "具体错误信息"
}

results matching ""

    No results matching ""