DetailDocument - 获取文档信息

更新时间:
复制为 MD 格式

通过任务id获取文档的详细信息。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

energy:DetailDocument

get

*全部资源

*

请求语法

GET /api/v1/aidoc/document/detail HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

taskId

string

任务 id,可从产品前端界面或其他接口获取

74ec62f4f4e74e5882d4086a40f2b9c6

返回参数

名称

类型

描述

示例值

object

Schema of Response

requestId

string

Id of the request

83A5A7DD-8974-5769-952E-590A97BEA34E

data DocumentDetailItem

返回数据

true

示例

正常返回示例

JSON格式

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": {
    "id": 6731,
    "folderId": "adafb91d4e014e2eb4d0a5375b547115",
    "folderName": "123/abc/ 文件夹1",
    "jobId": "74ec62f4f4e74e5882d4086a40f2b9c6",
    "jobStatus": "PARSING_COMPLETED",
    "docName": "123/abc/ 文档1.pdf",
    "originDocName": "123/abc/ 文档1.pdf/.doc/docx/csv/xlsx/txt",
    "docUrl": "https://carbon-aidoc.oss-cn-hangzhou.aliyuncs.com/jobs/jobid/document/documentid/docName",
    "originDocUrl": "https://carbon-aidoc.oss-cn-hangzhou.aliyuncs.com/jobs/jobid/document/documentid/originDocName",
    "docHash": "5335c8828ccf735a500ed636590c713a94daf6cdacc90237733035cc5a152afb_1760513801010",
    "createTime": "2025-09-08T17:04:28.000+08:00",
    "updateTime": "2025-09-08T17:04:28.000+08:00"
  }
}

错误码

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

变更历史

更多信息,参考变更详情