全部產品
Search

搜尋本產品

    Alibaba Cloud Model Studio：ListCategory - 類目列表

    文件中心

    Alibaba Cloud Model Studio：ListCategory - 類目列表

    更新時間：May 23, 2026

    擷取指定業務空間下一個或多個類目的詳細資料。

    介面說明

    • 暫不支援通過 API 查詢資料表。

    • RAM 使用者（子帳號）需要首先擷取阿里雲百鍊的 API 許可權（需要AliyunBailianDataFullAccess，已包括 sfm:ListCategory 許可權點），並加入一個業務空間後，方可調用本介面。阿里雲帳號（主帳號）可直接調用無須授權。建議您通過最新版阿里雲百鍊 SDK來調用本介面。

    • 分頁查詢首頁時，僅需設定MaxResults以限制返回資訊的條目數，返回結果中的NextToken將作為查詢後續頁的憑證。查詢後續頁時，將NextToken參數設定為上一次返回結果中擷取到的NextToken作為查詢憑證（如果NextToken為空白，表示結果已經完全返回，不需要再請求），並設定MaxResults限制返回條目數。

    • 本介面具有等冪性。

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

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    sfm:ListCategory

    list

    *全部資源

    *

    		 無 無

    請求文法

    POST /{WorkspaceId}/datacenter/categories HTTP/1.1

    路徑參數

    名稱

    類型

    必填

    描述

    樣本值
    WorkspaceId

    string

    是

    業務空間 ID。擷取方式請參見如何使用業務空間。

    llm-3shx2gu255oqxxxx

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ConnectorId

    string

    否

    連接器 Id

    file_conn_xxxxx
    CategoryType

    string

    是

    要查詢的類目類型。取值範圍：

    • UNSTRUCTURED：類目。

    說明

    暫不支援通過 API 查詢結構化資料表。

    UNSTRUCTURED
    ParentCategoryId

    string

    否

    要查詢類目的父類目 ID。

    cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
    NextToken

    string

    否

    查詢憑證（Token），取值為上一次 API 呼叫返回的 NextToken 參數值。

    AAAAAdH70eOCSCKtacdomNzak4U=
    MaxResults

    integer

    否

    分頁查詢時每頁類目數量。最大值為 200。取值範圍[1-200]

    預設值： 當不設定值或設定的值小於 1 時，預設值為 20。當設定的值大於 200 時，預設值為 200。

    20
    CategoryName

    string

    否

    即根據類目名稱對介面返回的類目列表進行精確匹配/過濾。預設值為空白，即不啟用類目名稱過濾。

    產品清單

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    Code

    string

    錯誤狀態代碼。

    success
    Data

    object

    介面業務資料欄位。

    CategoryList

    array<object>

    類目列表。

    object

    類目對象。

    CategoryId

    string

    類目 ID。

    cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
    CategoryName

    string

    類目名稱。

    類目1
    CategoryType

    string

    類目類型，可能值為：

    • UNSTRUCTURED：類目。

    UNSTRUCTURED
    IsDefault

    boolean

    是否為預設類目。可能值為：

    • true：是。

    • false：否。

    預設類目不允許刪除。

    true
    ParentCategoryId

    string

    父類目的類目 ID。

    cate_addd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
    HasNext

    boolean

    符合查詢條件的類目資料是否存在下一頁，可能值為：

    • true：是。

    • false：否。

    true
    MaxResults

    integer

    分頁查詢時每頁類目數量。

    20
    NextToken

    string

    本次調用返回的查詢憑證值。

    AAAAALHWGpGoYCcYMxiFfmlhvh7Z4G8jiXR6IjHYd+M9WQVJ
    TotalCount

    integer

    返回結果的總類目數量。

    20
    Message

    string

    錯誤資訊。

    workspace id is null or invalid.
    RequestId

    string

    請求 ID。

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

    string

    介面返回的狀態代碼。

    200
    Success

    boolean

    介面調用是否成功，可能值為：

    • true：成功。

    • false：失敗。

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "Code": "success",
  "Data": {
    "CategoryList": [
      {
        "CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx",
        "CategoryName": "類目1",
        "CategoryType": "UNSTRUCTURED",
        "IsDefault": true,
        "ParentCategoryId": "cate_addd11b1b79a74e8bbd675c356a91ee3xxxxxxxx"
      }
    ],
    "HasNext": true,
    "MaxResults": 20,
    "NextToken": "AAAAALHWGpGoYCcYMxiFfmlhvh7Z4G8jiXR6IjHYd+M9WQVJ",
    "TotalCount": 20
  },
  "Message": "workspace id is null or invalid.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

    錯誤碼

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

    變更歷史

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