全部产品
Search

搜索本产品

    大模型服务平台百炼：DescribeFile - 查询文件状态

    文档中心

    大模型服务平台百炼：DescribeFile - 查询文件状态

    更新时间：Jun 24, 2026

    查询应用数据中文件的基本信息，包括文件名称、类型、状态等。

    接口说明

    • RAM 用户（子账号）需要首先获取阿里云百炼的 API 权限（AliyunBailianDataFullAccess或AliyunBailianDataReadOnlyAccess均可，已包括 sfm:DescribeFile 权限点），并加入一个业务空间后，方可调用本接口。阿里云账号（主账号）可直接调用无须授权。建议您通过最新版阿里云百炼 SDK来调用本接口。

    • 本接口具有幂等性。

    限流说明： 本接口频繁调用会被限流，频率请勿超过 10 次/秒。如遇限流，请稍后重试。

    调试

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

    调试

    授权信息

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

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

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

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

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

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

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

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

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    sfm:DescribeFile

    none

    *全部资源

    *

    		 无 无

    请求语法

    GET /{WorkspaceId}/datacenter/file/{FileId}/ HTTP/1.1

    路径参数

    名称

    类型

    必填

    描述

    示例值
    WorkspaceId

    string

    是

    文件所属的业务空间 ID。获取方式请参见如何使用业务空间。

    llm-3shx2gu255oqxxxx
    FileId

    string

    是

    文件 ID，即 AddFile 接口返回的FileId。您也可以在应用数据-文件页签，单击文件名称旁的 ID 图标获取。

    file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx

    请求参数

    名称

    类型

    必填

    描述

    示例值

    当前API无需请求参数

    返回参数

    名称

    类型

    描述

    示例值

    object

    Schema of Response

    Code

    string

    错误状态码。

    Success
    Data

    object

    接口业务数据字段。

    CategoryId

    string

    文件所属类目 ID。

    cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
    CreateTime

    string

    文件实际添加到阿里云百炼中的时间戳，格式: yyyy-MM-dd HH:mm:ss，时区：UTC + 8。

    2024-09-09 12:45:43
    FileId

    string

    文件 ID。

    file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
    FileName

    string

    文件名称。

    XXX产品介绍.pdf
    FileType

    string

    文件类型，扩展名。可能值为： pdf、docx、doc、txt、md、pptx、ppt、xlsx、xls、html、png、jpg、jpeg、bmp、gif。

    pdf
    Parser

    string

    解析该文件使用的解析器类型。可能值为：

    • DASHSCOPE_DOCMIND：默认文档解析器。

    DASHSCOPE_DOCMIND
    SizeInBytes

    integer

    文件大小，单位字节 Byte。

    1234
    Status

    string

    用于非结构化知识库的文件（类型为 UNSTRUCTURED），状态可能值为：

    • INIT: 待解析。

    • IN_PARSE_QUEUE：解析队列排队中。

    • PARSING: 解析中。

    • PARSE_SUCCESS：解析完成。
      说明 必须等到状态为 PARSE_SUCCESS 才能将文档导入知识库。

    • PARSE_FAILED：解析失败。

    PARSE_SUCCESS
    Tags

    array

    文件关联的标签列表，一个文件支持关联多个标签。

    string

    文件的标签。

    产品介绍
    ParseResultDownloadUrl

    string

    ParseErrorMessage

    string

    解析失败原因

    Error Message
    Message

    string

    错误信息。

    Requests throttling triggered.
    RequestId

    string

    请求 ID。

    17204B98-xxxx-4F9A-8464-2446A84821CA
    Status

    string

    接口返回的状态码。

    200
    Success

    boolean

    接口调用是否成功，可能值为：

    • true：成功。

    • false：失败。

    true

    示例

    正常返回示例

    JSON格式

    {
  "Code": "Success",
  "Data": {
    "CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx",
    "CreateTime": "2024-09-09 12:45:43",
    "FileId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx",
    "FileName": "XXX产品介绍.pdf",
    "FileType": "pdf",
    "Parser": "DASHSCOPE_DOCMIND",
    "SizeInBytes": 1234,
    "Status": "PARSE_SUCCESS",
    "Tags": [
      "产品介绍"
    ],
    "ParseResultDownloadUrl": "",
    "ParseErrorMessage": "Error Message"
  },
  "Message": "Requests throttling triggered.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

    错误码

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

    变更历史

    更多信息，参考变更详情。