すべてのプロダクト
Search

このプロダクト

    Alibaba Cloud Model Studio:ListFile

    ドキュメントセンター

    Alibaba Cloud Model Studio:ListFile

    最終更新日:Oct 11, 2026

    指定されたカテゴリ内の 1 つ以上のドキュメントの詳細を取得します。

    操作説明

    • Resource Access Management (RAM) ユーザーは、この操作を呼び出す前に、まず Alibaba Cloud Model Studio の API 権限 を取得し（AliyunBailianDataFullAccess が必要で、sfm:ListFile 権限を含みます）、ワークスペースに参加 する必要があります。Alibaba Cloud アカウントは権限付与なしでこの操作を直接呼び出せます。最新の Alibaba Cloud Model Studio SDK を使用してこの操作を呼び出してください。
    • 最初のページのページングでは、MaxResults のみを設定して返されるエントリ数を制限します。応答の NextToken は後続ページをクエリするための認証情報として機能します。後続ページをクエリする場合、NextToken パラメーターを前回の応答から取得した NextToken 値に設定し（NextToken が空の場合、すべての結果が返されており、追加のリクエストは不要です）、MaxResults を設定して返されるエントリ数を制限します。
    • この操作はべき等です。

    レート制限: この操作は頻繁に呼び出されるとスロットリングされます。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:ListFile

    list

    *All Resource

    *

    		なしなし

    リクエスト構文 

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

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    WorkspaceId

    string

    必須

    カテゴリが属するワークスペース ID。ワークスペース ID の取得方法については、ワークスペースの使用方法 を参照してください。フォーマットについてはドキュメントをご確認ください。

    llm-3shx2gu255oqxxxx

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    CategoryId

    string

    必須

    カテゴリ ID。AddCategory 操作で返される CategoryId です。Model Studio コンソールの アプリケーションデータ - ファイルタブで、カテゴリ名の横にある ID アイコンをクリックして取得することもできます。

    .

    cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx

    NextToken

    string

    任意

    ページネーショントークン。前回の API 呼び出しで返された NextToken 値を設定してください。

    AAAAAdH70eOCSCKtacdomNzak4U=

    MaxResults

    integer

    任意

    ページングにおける 1 ページあたりのエントリ数。有効な値: 1～200。

    デフォルト値: 値が設定されていないか 1 未満の場合、デフォルト値は 20 です。値が 200 を超える場合、デフォルト値は 200 です。

    20

    FileName

    string

    任意

    ファイル名（拡張子なし）。完全に一致のみサポートされます。あいまい検索はサポートされていません。

    product-overview

    FileIds

    array

    任意

    クエリするファイル ID のリスト。一度に最大 20 ファイルをクエリできます。

    string

    任意

    ファイル ID。

    file_xxxx

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ。

    Code

    string

    エラーコード。

    success

    Data

    object

    操作によって返されるデータフィールド。

    FileList

    array<object>

    カテゴリ内のファイルのリスト。

    object

    ファイルオブジェクト。

    CategoryId

    string

    ファイルが属するカテゴリの ID。

    cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx

    CreateTime

    string

    ファイルが Alibaba Cloud Model Studio に追加された時間のタイムスタンプ。フォーマット: yyyy-MM-dd HH:mm:ss。タイムゾーン: 協定世界時 (UTC)+8。

    2024-09-09 11:03:35

    FileId

    string

    ファイル ID。AddFile 操作で返される FileId です。アプリケーションデータページで、ファイル名の横にあるアイコンをクリックして取得することもできます。Model Studio コンソールのデータセンターから確認できます。

    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: Alibaba Cloud インテリジェントドキュメント解析。

    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

    ページングにおける 1 ページあたりのエントリ数。

    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

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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