DescribeJobDataParsingTaskProgress - 返回一个作业的进度信息

更新时间:
复制 MD 格式

获取上传的作业文件解析进度。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

outboundbot:DescribeJobDataParsingTaskProgress

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

JobDataParsingTaskId

string

作业数据分析任务 ID

说明

该参数值通过 CreateJobDataParsingTask 接口拿到

50d5e164-9365-4261-980e-3d979c2c948c

InstanceId

string

实例 ID

c209abb3-6804-4a75-b2c7-dd55c8c61b6a

返回参数

名称

类型

描述

示例值

object

HttpStatusCode

integer

HTTP 状态码

200

Code

string

响应码

OK

Message

string

接口提示信息

Success

RequestId

string

请求 ID

254EB995-DEDF-48A4-9101-9CA5B72FFBCC

Success

boolean

是否成功

true

Progress

object

进度

{}

FailErrorCode

string

失败错误码

Permission.JobStatus

Status

string

作业状态

  • Pending:待办的

  • InProgress:进行中

  • Finished:完成的

  • PartialFinished:部分完成

  • Failed:失败

Pending

HandledJobCount

integer

处理中作业数量

2

TotalJobCount

integer

总计作业数量

3

FailReason

string

失败原因

CreateCorpus

FeedbackUrl

string

解析失败记录文件的下载地址【废弃】

xxxx

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Progress": {
    "FailErrorCode": "Permission.JobStatus",
    "Status": "Pending",
    "HandledJobCount": 2,
    "TotalJobCount": 3,
    "FailReason": "CreateCorpus",
    "FeedbackUrl": "xxxx"
  }
}

错误码

HTTP status code

错误码

错误信息

描述

500 InternalError An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. 内部错误。建议重试,如果多次重试报错请提交工单。

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

变更历史

更多信息,参考变更详情