最近更新时间:2024.03.14 14:41:02
首次发布时间:2022.04.13 17:53:21
配合同步接口(write)使用。
数据预同步、历史数据同步、增量天级数据同步都是以天为单位导入数据,导入完成后必须调用done接口(done接口传输的数据日期与write接口上传数据的日期保持一致写入传输完成标识),服务端接收到该标识才会开启数据入库+归档。
HTTP POST
部署方式 | Region | URL |
---|---|---|
SaaS | 国内通用 | https://api.byteair.volces.com/data/api/{application_id}/done?topic={topic}&stage={stage} |
新加坡 | https://byteair-api-sg1.byteintlapi.com/data/api/{application_id}/done?topic={topic}&stage={stage} | |
出海1 | http://api-oversea1.byteair.volces.com/data/api/{application_id}/{topic}?method=write&stage={stage} | |
出海2 | https://byteair-overseas-2.byteintlapi.com/data/api/{application_id}/{topic}?method=write&stage={stage} | |
私有化 | /data/api/{application_id}/done?topic={topic}&stage={stage}(协议、域名等根据实际情况补充) |
公共请求头部分详见《公共请求头说明》。
参数
类型 | 描述 |
---|---|
array[object] | array中的一个object代表某一天数据的传输完成标识。object的key固定为partition_date,value为具体日期。 |
示例
//标识多天数据传完,请求格式list[map<string, object>],如20210411、20210412日期天级离线数据传输完成,done接口请求参数如下: [ { //标识20210411数据传输完成 "partition_date":"20210411",//必传,格式为YYYYMMDD标识20210411天级数据已传完,未传partition_date字段的那条数据会被过滤掉 }, { //标识20210412数据传输完成 "partition_date":"20210412",//必传 } ] //标识单天数据传完,如通知服务端20210412数据传完了 [ { //标识20210412数据传输完成 "partition_date":"20210412",//必传 } ]
参数
参数 | 类型 | 描述 |
---|---|---|
status | object | 任务执行结果,当status.code为0或不存在时,执行过程未发生任何异常,全部写入成功 |
示例
//done接口执行成功 { "status":{ "code":0, "message":"OK" } } //done执行失败 { "status":{ "code":400, "message":"parse partition_date(2006010) error, format should be YYYYMMDD, reqBody:[map[partition_date:2006010]]" } }