調用ListFile API擷取指定類目下的檔案清單-大模型服務平台百鍊-阿里雲 - Alibaba Cloud Model Studio

取得指定類目下一個或多個文件的詳細資訊。

介面說明

RAM 使用者（子帳號）需要首先取得阿里雲百煉的 API 權限（需要AliyunBailianDataFullAccess，已包括 sfm:ListFile 權限點），並加入一個業務空間後，方可呼叫本介面。阿里雲帳號（主帳號）可直接呼叫無須授權。建議您透過最新版阿里雲百煉 SDK來呼叫本介面。
分頁查詢首頁時，僅需設定MaxResults以限制返回資訊的條目數，返回結果中的NextToken將作為查詢後續頁的憑證。查詢後續頁時，將NextToken參數設定為上一次返回結果中取得到的NextToken作為查詢憑證（如果NextToken為空，表示結果已經完全返回，不需要再請求），並設定MaxResults限制返回條目數。
本介面具有冪等性。

限流說明： 本介面頻繁呼叫會被限流，頻率請勿超過 5 次/秒。如遇限流，請稍後重試。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

sfm:ListFile

list

*All Resource

*

無

請求文法

GET /{WorkspaceId}/datacenter/files HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
WorkspaceId	string	是	類目所屬的業務空間 ID。取得方式請參見如何使用業務空間。	llm-3shx2gu255oqxxxx

請求參數

名稱	類型	必填	描述	樣本值
CategoryId	string	是	類目 ID，即 AddCategory 介面返回的`CategoryId`。您也可以在應用資料-文件頁籤，按一下類目名稱旁的 ID 圖示取得。。	cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx
NextToken	string	否	查詢憑證（Token），取值為上一次 API 呼叫返回的 NextToken 參數值。	AAAAAdH70eOCSCKtacdomNzak4U=
MaxResults	integer	否	分頁查詢時每頁行數。取值範圍[1-200]。預設值：當不設定值或設定的值小於 1 時，預設值為 20。當設定的值大於 200 時，預設值為 200。	20
FileName	string	否	文件名稱（不含後綴），僅支援按照文件名精準查找，不支援模糊搜尋。	product-overview
FileIds	array	否	需要查詢的文件 id 列表，單次查詢最多支援 20 個文件。
	string	否	文件 id。	file_xxxx

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
Code	string	錯誤狀態碼。	success
Data	object	介面業務資料欄位。
FileList	array<object>	類目下的文件列表。
	object	文件物件。
CategoryId	string	文件所屬類目 ID。	cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx
CreateTime	string	文件實際添加到阿里雲百煉中的時間戳記，格式: yyyy-MM-dd HH:mm:ss，時區：UTC + 8。	2024-09-09 11:03:35
FileId	string	文件 ID，即 AddFile 介面返回的`FileId`。您也可以在應用資料頁面，按一下文件名稱旁的圖示取得。	file_5ff599b3455a45db8c41b0054b361518_xxxxxxxx
FileName	string	文件名稱。	product-overview.pdf
FileType	string	文件格式類型。可能值為：pdf、docx、doc、txt、md、pptx、ppt、xlsx、xls、html、png、jpg、jpeg、bmp、gif。	docx
Parser	string	文件解析器。可能值為： DASHSCOPE_DOCMIND：阿里雲文件智慧解析。	DASHSCOPE_DOCMIND
SizeInBytes	integer	文件大小，單位位元組。	512
Status	string	文件解析狀態，可能值為： INIT: 初始化狀態，等待排程中。 PARSING: 解析中。 PARSE_SUCCESS：解析完成。 PARSE_FAILED：解析失敗。	PARSE_SUCCESS
ParseErrorMessage	string		Error Message
Tags	array	文件關聯的標籤列表，一個文件支援關聯多個標籤。
	string	文件的標籤。	tag-A
HasNext	boolean	符合查詢條件的類目資料是否存在下一頁，可能值為： true：是。 false：否。	true
MaxResults	integer	分頁查詢時每頁行數。	20
NextToken	string	本次呼叫返回的查詢憑證值。	4jzbJk9J6lNeuXD9hP0viA==
TotalCount	integer	返回結果的總條數。	48
Message	string	錯誤資訊。	Requests throttling triggered.
RequestId	string	請求 ID。	8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1
Status	string	介面返回的狀態碼。	200
Success	boolean	介面呼叫是否成功，可能值為： true：成功。 false：失敗。	true

樣本

正常返回樣本

JSON格式

{
  "Code": "success",
  "Data": {
    "FileList": [
      {
        "CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx",
        "CreateTime": "2024-09-09 11:03:35",
        "FileId": "file_5ff599b3455a45db8c41b0054b361518_xxxxxxxx",
        "FileName": "product-overview.pdf",
        "FileType": "docx",
        "Parser": "DASHSCOPE_DOCMIND",
        "SizeInBytes": 512,
        "Status": "PARSE_SUCCESS",
        "ParseErrorMessage": "Error Message",
        "Tags": [
          "tag-A"
        ]
      }
    ],
    "HasNext": true,
    "MaxResults": 20,
    "NextToken": "4jzbJk9J6lNeuXD9hP0viA==",
    "TotalCount": 48
  },
  "Message": "Requests throttling triggered.",
  "RequestId": "8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1",
  "Status": "200",
  "Success": true
}

錯誤碼

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

變更歷史

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