文档

ListJobs - 导出的标注结果列表展示

更新时间:

展示所有导出的标注结果的列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /openapi/api/v1/tenants/{TenantId}/jobs

请求参数

名称类型必填描述示例值
TenantIdstring

租户 ID。如何获取租户 ID,请参见 ListTenants

GA***W134
PageSizeinteger

标注结果列表的页码。起始值为 1,默认为 1。

1
PageNumberinteger

分页查询时设置的每页显示的标注结果数量,默认为 20。

20
JobTypestring

任务类型,暂时只开放:DOWNLOWD_MARKRESULT_FLOW。

DOWNLOWD_MARKRESULT_FLOW

返回参数

名称类型描述示例值
object

项目。

Codeinteger

返回编码,默认为 0,表示执行正常。

0
Messagestring

请求的返回信息。

success
RequestIdstring

请求 ID。

90ABA848-AD74-1F6E-84BC-4182A7F1****
Detailsstring

详情。

null
Successboolean

是否成功,可能值:

  • true:成功。
  • false:失败。
true
PageNumberinteger

返回查询的标注结果列表的页码。

1
PageSizeinteger

返回每页显示的标注结果数量。

20
TotalPageinteger

总页数。

2
TotalCountinteger

标注结果总数。

22
Jobsarray

任务列表。

Job

任务。

ErrorCodestring

错误码。

  • 当 Success 为 false,返回业务错误码。
  • 当 Success 为 true,返回空值。
""

示例

正常返回示例

JSON格式

{
  "Code": 0,
  "Message": "success",
  "RequestId": "90ABA848-AD74-1F6E-84BC-4182A7F1****",
  "Details": "null",
  "Success": true,
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPage": 2,
  "TotalCount": 22,
  "Jobs": [
    {
      "Status": "succ",
      "JobResult": {
        "ResultLink": "oss://****-hz-oss.oss-cn-hangzhou.aliyuncs.com/output/ocr_demo001.manifest"
      },
      "JobType": "DOWNLOWD_MARKRESULT_FLOW",
      "GmtCreateTime": "2021-12-28 11:42:19",
      "GmtModifiedTime": "2021-12-28 11:42:20",
      "Creator": {
        "UserId": 0,
        "AccountType": "ALIYUN",
        "AccountNo": "166***9980757310",
        "UserName": "txdemo@test.aliyunid.com",
        "Role": "ADMIN"
      },
      "JobId": "147***441221943296"
    }
  ],
  "ErrorCode": "\"\""
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史