文档

DescribeDocumentImportJob - 查询文档上传任务结果

更新时间:
一键部署

查询文档上传结果。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sfm:DescribeDocumentImportJobRead
  • acs:sfm::{#accountId}:*

请求参数

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

任务 ID

20230718xxxx-146c93bf
AgentKeystring

业务空间 key,具体查看地址

2818xxxx_p_efm

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

35A267BF-xxxx-54DB-8394-AA3B0742D833
JobIdstring

Id of the request

20230718xxxx-146c93bf
Statusstring

任务状态

枚举值:
  • 部分成功部分成功
  • 成功成功
  • 处理失败处理失败
  • 处理中处理中
成功
Docsobject []

文档列表

Namestring

文档名称

文档1
Statusstring

文档状态

枚举值:
  • 导入失败导入失败
  • 导入完成导入完成
  • 导入中导入中
  • 数据不合规数据不合规
  • 删除中删除中
导入完成
DocIdstring

文档 ID

8C8FxxxxC3EE
FailReasonstring

导入失败的原因

导入索引失败

示例

正常返回示例

JSON格式

{
  "RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
  "JobId": "20230718xxxx-146c93bf",
  "Status": "成功",
  "Docs": [
    {
      "Name": "文档1",
      "Status": "导入完成",
      "DocId": "8C8FxxxxC3EE",
      "FailReason": "导入索引失败"
    }
  ]
}

错误码

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

  • 本页导读 (1)
文档反馈