更新时间:2024-12-10 GMT+08:00
分享

查询任务状态

功能

查询任务状态。

注意事项

调用方法

GET

URI

/meter/v1/{domain_id}/query-jobs/{job_id}

路径参数

表1 路径参数

参数

是否必选

类型

值域

说明

job_id

string

正则表达式为^[-_0-9a-zA-Z]{0,36}$

任务id。

domain_id

string

正则表达式为^[-_0-9a-zA-Z]{0,36}$

ESM服务的租户id。

查询参数

请求

  • 请求header参数

    请参见请求示例中header描述。

  • 请求body参数

  • 请求示例
    GET /meter/v1/{domain_id}/query-jobs/{job_id} HTTP/1.1
    Host: example.com
    Content-Type: application/json
    Accept: application/json
    X-Auth-Token: xxx

响应

  • 响应参数
    • 响应状态码200:返回QueryJobVo。
      表2 QueryJobVo对象属性

      参数

      是否必选

      类型

      值域

      说明

      id

      string

      任务id

      status

      string

      任务状态:success(任务成功,可以查询数据),failure(任务失败),running(任务运行中),pending(任务等待执行)

      progress

      int32

      任务进度,0-100表示百分比

  • 响应示例
    HTTP/1.1 200 OK
    Date:Tue,18 Jul 2023 09:58:01 GMT
    Server: example.com
    Content-Type: application/json;charset=UTF8
    {
        "id": "xxx",
        "status": "success",
        "progress": 100
    }

状态码

表3 状态码

状态码

说明

200

操作成功。

400

参数错误。

401

token鉴权失败。

403

鉴权失败。

404

rest接口未找到。

500

内部错误。

操作危险级别

Minor

相关文档