すべてのプロダクト
Search

このプロダクト

    Alibaba Cloud Model Studio:ListCategory

    ドキュメントセンター

    Alibaba Cloud Model Studio:ListCategory

    最終更新日:May 22, 2026

    指定されたワークスペースにある、1 つ以上のカテゴリの詳細を取得します。

    操作説明

    • この API は、データテーブルのクエリに対応していません。

    • この API を呼び出すには、RAM ユーザーは事前に Model Studio で必要なAPI 権限を取得し、ワークスペースに参加する必要があります。これには、AliyunBailianDataFullAccess 権限が必要です。この権限には sfm:ListCategory 権限が含まれています。Alibaba Cloud アカウントは、この API を直接呼び出すことができます。最新バージョンのModel Studio SDK を使用してください。

    • この操作はページネーションに対応しています。最初のリクエストを行う際は、MaxResults パラメーターを設定して、返される項目の最大数を指定します。さらに項目がある場合、レスポンスには NextToken が含まれます。次のページの結果を取得するには、前回のレスポンスの値を NextToken パラメーターに設定し、MaxResults を再度指定します。NextToken が空の場合、これ以上取得できる結果はありません。

    • この操作はべき等です。

    レート制限：この API にはレート制限があります。1 秒あたり 5 リクエストを超えないでください。システムがリクエストをスロットリングした場合は、短い間隔を空けてリトライしてください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    sfm:ListCategory

    list

    *All Resource

    *

    		 なし なし

    リクエスト構文

    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

    任意

    ページネーショントークン。次のページの結果を取得するには、前回のレスポンスの NextToken の値を渡します。

    AAAAAdH70eOCSCKtacdomNzak4U=
    MaxResults

    integer

    任意

    1 ページあたりに返されるカテゴリの最大数。有効範囲は 1 ～ 200 です。

    デフォルト値： 20。このパラメーターを指定しない場合、または 1 未満の値に設定した場合は、デフォルト値が使用されます。200 を超える値を指定した場合は、最大値の 200 が使用されます。

    20
    CategoryName

    string

    任意

    この名前と完全に一致するカテゴリのみを含むように、結果をフィルタリングします。このパラメーターを省略した場合、フィルターは適用されません。

    产品清单

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスオブジェクト。

    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

    1 ページあたりに返される結果の最大数。

    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

    例

    成功レスポンス

    JSONJSON

    {
  "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
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。