Tous les produits
Search

Ce produit

    Alibaba Cloud Model Studio:ListFile

    Centre de documentation

    Alibaba Cloud Model Studio:ListFile

    Dernière mise à jour :Oct 11, 2026

    Obtient les détails d'un ou plusieurs documents dans une catégorie spécifiée.

    Description de l'opération

    • Les utilisateurs de Resource Access Management (RAM) doivent d'abord obtenir les autorisations d'API pour Alibaba Cloud Model Studio (nécessite AliyunBailianDataFullAccess, qui inclut l'autorisation sfm:ListFile), et rejoindre un espace de travail avant d'appeler cette opération. Les comptes Alibaba Cloud peuvent appeler cette opération directement sans autorisation. Appelez cette opération en utilisant la dernière version du SDK Alibaba Cloud Model Studio.
    • Pour la pagination de la première page, définissez uniquement MaxResults pour limiter le nombre d'entrées renvoyées. Le NextToken dans la réponse sert d'identifiant pour interroger les pages suivantes. Lors de l'interrogation des pages suivantes, définissez le paramètre NextToken sur la valeur NextToken obtenue dans la réponse précédente (si NextToken est vide, tous les résultats ont été renvoyés et aucune autre requête n'est nécessaire), et définissez MaxResults pour limiter le nombre d'entrées renvoyées.
    • Cette opération est idempotente.

    Limite de fréquence : Cette opération est limitée si elle est appelée trop fréquemment. Ne dépassez pas 5 appels par seconde. En cas de limitation, réessayez ultérieurement.

    Testez maintenant

    Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

    Autorisation RAM

    Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

    • Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.

    • API : l'API que vous pouvez appeler pour exécuter l'action.

    • Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.

    • Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.

      • Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
      • Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.

    • Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.

    • Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

    Action

    Niveau d'accès

    Type de ressource

    Clé de condition

    Action dépendante

    sfm:ListFile

    list

    *All Resource

    *

    		AucuneAucune

    Syntaxe de la requête 

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

    Paramètres de chemin

    Paramètre

    Type

    Requis

    Description

    Exemple

    WorkspaceId

    string

    Oui

    L'identifiant de l'espace de travail auquel la catégorie appartient. Pour plus d'informations sur la façon d'obtenir l'identifiant de l'espace de travail, consultez Comment utiliser un espace de travail.

    llm-3shx2gu255oqxxxx

    Paramètres de requête

    Paramètre

    Type

    Requis

    Description

    Exemple

    CategoryId

    string

    Oui

    L'identifiant de la catégorie, qui correspond au CategoryId renvoyé par l'opération AddCategory. Vous pouvez également l'obtenir dans l'onglet Données de l'application - Fichiers en cliquant sur l'icône d'identifiant à côté du nom de la catégorie.

    .

    cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx

    NextToken

    string

    Non

    Le jeton de pagination. Définissez-le sur la valeur NextToken renvoyée par l'appel d'API précédent.

    AAAAAdH70eOCSCKtacdomNzak4U=

    MaxResults

    integer

    Non

    Le nombre d'entrées par page pour la pagination. Valeurs valides : 1 à 200.

    Valeur par défaut : Si aucune valeur n'est définie ou si la valeur est inférieure à 1, la valeur par défaut est 20. Si la valeur est supérieure à 200, la valeur par défaut est 200.

    20

    FileName

    string

    Non

    Le nom du fichier (sans extension). Seule la correspondance exacte est prise en charge. La recherche approximative n'est pas prise en charge.

    product-overview

    FileIds

    array

    Non

    La liste des identifiants de fichiers à interroger. Un maximum de 20 fichiers peut être interrogé à la fois.

    string

    Non

    L'identifiant du fichier.

    file_xxxx

    Éléments de réponse

    ÉlémentTypeDescriptionExemple

    object

    Schéma de la réponse.

    Code

    string

    Le code d'erreur.

    success

    Data

    object

    Le champ de données renvoyé par l'opération.

    FileList

    array<object>

    La liste des fichiers dans la catégorie.

    object

    L'objet fichier.

    CategoryId

    string

    The ID of the category to which the file belongs.

    cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx

    CreateTime

    string

    The timestamp when the file was added to Alibaba Cloud Model Studio. Format: yyyy-MM-dd HH:mm:ss. Time zone: UTC+8.

    2024-09-09 11:03:35

    FileId

    string

    The file ID, which is the FileId returned by the AddFile operation. You can also obtain it on the Application Data page by clicking the icon next to the file name.

    file_5ff599b3455a45db8c41b0054b361518_xxxxxxxx

    FileName

    string

    The file name.

    product-overview.pdf

    FileType

    string

    The file format type. Valid values: pdf, docx, doc, txt, md, pptx, ppt, xlsx, xls, html, png, jpg, jpeg, bmp, and gif.

    docx

    Parser

    string

    The document parser. Valid values:

    • DASHSCOPE_DOCMIND: Alibaba Cloud intelligent document parsing.

    DASHSCOPE_DOCMIND

    SizeInBytes

    integer

    The file size in bytes.

    512

    Status

    string

    The file parsing status. Valid values:

    • INIT: Initialization state. Waiting to be scheduled.
    • PARSING: Parsing in progress.
    • PARSE_SUCCESS: Parsing completed.
    • PARSE_FAILED: Parsing failed.

    PARSE_SUCCESS

    ParseErrorMessage

    string

    The reason for parsing failure.

    Error Message

    Tags

    array

    The list of tags associated with the file. A document can be associated with multiple tags.

    string

    The file tag.

    tag-A

    HasNext

    boolean

    Indique s'il existe une page suivante de données de catégorie correspondant aux conditions de requête. Valeurs valides :

    • true : Oui.
    • false : Non.

    true

    MaxResults

    integer

    Le nombre d'entrées par page pour la pagination.

    20

    NextToken

    string

    Le jeton de pagination renvoyé par cet appel.

    4jzbJk9J6lNeuXD9hP0viA==

    TotalCount

    integer

    Le nombre total d'entrées dans les résultats renvoyés.

    48

    Message

    string

    Le message d'erreur.

    Limitation des requêtes déclenchée

    RequestId

    string

    L'identifiant de la requête.

    8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1

    Status

    string

    Le code d'état renvoyé par l'opération.

    200

    Success

    boolean

    Indique si l'opération a réussi. Valeurs valides :

    • true : Réussie.
    • false : Échouée.

    true

    Exemples

    正常返回示例

    JSON format

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

    Codes d'erreur

    Consultez Codes d'erreur pour la liste complète.

    Notes de version

    Consultez Notes de version pour la liste complète.