全部產品
Search

搜尋本產品

    Alibaba Cloud Model Studio：DescribeFile

    文件中心

    Alibaba Cloud Model Studio：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

    *All Resource

    *

    		 無 無

    請求文法

    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
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。