Skip to content

导出任务状态查询 OpenAPI

查询任务状态

1
GET /v1/job/{job_id}/status

将任务id替换掉路径中{job_id}，如/v1/job/1516699638068035584/status。

接口响应

HTTP 状态码 类型 说明
200 JobResponse JobResponse对象
400 ErrorResult 请求参数不合法
500 ErrorResult 系统错误

JobResponse对象字段：

名称 类型 说明
jobId * string 任务id
jobType * string 任务类型(trip, user, ,)
status * string 任务状态(WAITING: 等待被创建;CREATED: 已创建; RUNNING: 运行中, FAILURE:失败; SUCCESS: 成功)
param string 任务相关的参数，包含导出请求的参数和导出成功后的文件路径
startTime * string 任务开始时间
endTime * string 任务结束时间

HTTP状态码等于200时的返回示例：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
    "jobId": "1490972048820932608",
    "jobType": "trip",
    "status": "SUCCESS",
    "param": 
    {
        "bucket": "test-haochezhu-club",
        "path": "ubi/export/110852088/trips/20220208/1490972048820932608",
        "endpoint": "oss-cn-beijing.aliyuncs.com",
        "detailsType": "2",
        "startTime": "2022-01-01"
    },
    "startTime": "2022-02-08 16:53:33",
    "endTime": "2022-02-08 16:53:53"
}

其中param字段涵盖了文件导出所在的oss的配置(endpoint, bucket, path)。

获取导出任务列表

1
GET /v1/jobs

暂不支持自定义时间段查询，默认查询最近一周的导出任务列表。

接口响应

HTTP 状态码 类型 说明
200 JobsResponse 行程详情
400 ErrorResult 请求参数不合法
500 ErrorResult 系统错误

JobsResponse对象字段：

名称 类型 说明
appId * string 应用id
jobList * JobResponse对象列表 最近一周导出任务列表

HTTP状态码等于200时的返回示例： 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
    "appId": "110858840",
    "jobList": [
        {
            "jobId": "1490972048820932608",
            "jobType": "trip",
            "status": "SUCCESS",
            "param": 
            {
                "bucket":"test-haochezhu-club",
                "path":"ubi/export/110852088/trips/20220208/1490972048820932608",
                "endpoint":"oss-cn-beijing.aliyuncs.com",
                "detailsType":"2",
                "startTime":"2022-01-01"
            },
            "startTime": "2022-02-08 16:53:33",
            "endTime": "2022-02-08 16:53:53"
        },
        {
            "jobId": "1490974857997979648",
            "jobType": "safetyScore",
            "status": "SUCCESS",
            "param": 
            {
                "bucket":"test-haochezhu-club",
                "path":"ubi/export/110852088/safety-score/20220208/1490974857997979648",
                "endpoint":"oss-cn-beijing.aliyuncs.com",
                "detailsType":"2",
                "startTime":"2022-01-01"
            },
            "startTime": "2022-02-08 17:04:42",
            "endTime": "2022-02-08 17:04:58"
        }
    ]
}