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

查看报告PDF状态

功能介绍

根据任务ID查看报告PDF状态

URI

GET /v1/{project_id}/sbc/report/pdf/status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

用户project_id

最小长度:32

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

id

String

任务ID,创建任务时返回的ID

最小长度:36

最大长度:36

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

Content-Type

String

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

data

data object

响应内容

表5 data

参数

参数类型

描述

id

String

任务ID,创建任务时返回的ID

最小长度:36

最大长度:36

status

String

任务状态(W:等待中,B:运行中,R:已结束,F:已失败,S:已停止)

枚举值:

  • W

  • B

  • R

  • F

  • S

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 429

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

请求示例

GET https://{endpoint}/v1/{project_id}/sbc/report/pdf/status?id={id}

响应示例

状态码: 200

查看报告PDF状态响应对象

{
  "data" : {
    "id" : "00000000-0000-0000-0000-000000000000",
    "status" : "R"
  }
}

状态码

状态码

描述

200

查看报告PDF状态响应对象

400

错误响应体

401

错误响应体

429

错误响应体

错误码

请参见错误码

相关文档