› 推特 ›阿里云技术文档›正文

GetDocIndexTask_文档索引请求_文档管理操作_API手册_智能媒体管理

admin 阿里云技术文档 2020-02-11 222 0
阿里云服务器优惠

GetDocIndexTask

GetDocIndexTask

查询索引任务状态。（当前只支持上海 Region）

请求参数

名称 类型 是否必填 描述
Action String 是 GetDocIndexTask
Project String 是 项目名
TaskId String 是 任务 ID

返回参数

名称 类型 描述
RequestId String 用户发送的每次接口调用请求，无论成功与否，系统都会返回一个唯一识别码 RequestId 给用户
TaskId String 任务 ID
Status String 任务状态：
  • Running
  • Finished
  • Failed
CreateTime String 任务创建时间
FinishTime String 任务完成时间
FailDetail Object 任务执行结果
Code String 任务执行结果

示例

请求示例

  1. POST https://imm.cn-shanghai.aliyuncs.com
  2. ?Action=GetDocIndexTask
  3. &Project=test
  4. &TaskId=86f452bb-4380-4c1f-bcd1-2ffcb447bc8a

此处的示例，目的是展示关键参数，还需要其他的公共参数才能正常调用，推荐使用 SDK 来发送 API。

成功返回示例

  1. 任务运行
  2. {
  3.     "Status": "Running",
  4.     "FinishTime": "",
  5.     "FailDetail": {
  6.         "Code": ""
  7.     },
  8.     "CreateTime": "2018-11-27T12:45:35.975Z",
  9.     "RequestId": "2A91800E-77EE-4723-9D16-0727EC715A9B",
  10.     "TaskId": "788ecc15-8b3f-495d-9346-50e94b073cba"
  11. }
  13. 成功完成
  14. {
  15.     "Status": "Finished",
  16.     "FinishTime": "2018-11-27T12:45:45.752Z",
  17.     "FailDetail": {
  18.         "Code": "NoError"
  19.     },
  20.     "CreateTime": "2018-11-27T12:45:35.975Z",
  21.     "RequestId": "2A91800E-77EE-4723-9D16-0727EC715A9B",
  22.     "TaskId": "788ecc15-8b3f-495d-9346-50e94b073cba"
  23. }
  25. 任务失败
  26. {
  27.     "Status": "Failed",
  28.     "FinishTime": "2018-11-27T12:45:45.752Z",
  29.     "FailDetail": {
  30.         "Code": "FailedToDownloadSrcFile"
  31.     },
  32.     "CreateTime": "2018-11-27T12:45:35.975Z",
  33.     "RequestId": "2A91800E-77EE-4723-9D16-0727EC715A9B",
  34.     "TaskId": "788ecc15-8b3f-495d-9346-50e94b073cba"
  35. }

若在使用中有疑问，请参考 FAQ，或者进入 钉钉用户群 实时交流。

版权声明

本文仅代表作者观点，不代表本站立场。
本文系作者授权发表，未经许可，不得转载。

评论

-----