目录

回调数据导出任务状态

功能介绍

由您实现,用于接受导出任务的执行状态。当分析服务导出任务完成后,通过该接口将导出的结果和文件的下载路径通过此接口返回。

场景描述

您的应用服务器在调用创建数据导出任务接口后,Analytics Kit服务端异步导出数据,当分析服务导出任务完成后,通过该接口通知您的应用服务器导出任务的执行状态和文件下载路径,您需要提供接收通知的服务端接口,并根据通知及时下载已导出的数据。

使用约束

接口原型

承载协议

HTTPS POST

接口方向

分析服务服务器->开发者回调接口服务器

接口URL

由您提供在AGC上配置完成的URL

数据格式

请求消息:Content-Type: application/json

响应消息:Content-Type: application/json

请求参数

Request Header

参数

是否必选

参数类型

描述

x-product-id

是

String

用户在AppGallery Connect上的Product ID。

x-app-id

是

String

用户在AppGallery Connect上的App ID。

Authorization

是

String

请参见基于OAuth 2.0开放鉴权。

说明:

Bearer后面拼接空格,再拼接获取的access_token。

Request Body

参数

是否必选

参数类型

描述

request_id

是

String

请求编号,由创建数据导出任务接口返回。

app_id

是

String

用户在AppGallery Connect上的App ID。

status

是

String

任务状态。

  • EXPORTED:成功导出。

  • NO_DATA:没有符合条件的数据。

  • EXPORT_FAILED:导出失败,建议重试。

  • TOO_MANY_RECORDS:一次导出数据量太多,建议缩小数据导出范围后重新发起请求。

file_path

否

String

导出文件下载路径,该字段只有在任务状态是“EXPORTED”才会有值。

status_time

否

DateTime

状态最后更新时间。

请求示例

POST /data/export/notification HTTP/1.1
User -Agent: Jakarta Commons - HttpClient / 3.1
Host: 10.137.165.233:8566
Content-Type: application/json; charset=UTF-8
Content-Length: xxxx
Accept: application/json
 
{
    "request_id": "sample-req-id", 
    "app_id": "sample-appid", 
    "status": "EXPORTED", 
    "file_path": "https://sample.com/sample_path/"
}

响应参数

状态码为200时:

Response Header

参数

是否必选

参数类型

描述

Content-Type

是

application/json

响应消息的数据格式。

Response Body

参数

是否必选

参数类型

描述

result_code

是

String

服务端返回的处理结果状态。

result_msg

是

String

服务器处理结果的描述信息。

响应示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Connection:  Close
Content-Length: xxxx                       
 
 
{
  "result_code":"0",
  "result_msg":"success",
}