ListFiles - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ListFiles	L'opération que vous souhaitez effectuer.
FileFolderPath	String	No	Workflow/My first workflow/MaxCompute/ods	Le chemin du dossier auquel appartiennent les fichiers.
ProjectId	Long	No	10000	L'ID de l'espace de travail DataWorks. Connectez-vous à la console DataWorks et accédez à la page Workspace pour obtenir l'ID. Vous devez configurer ce paramètre ou le paramètre ProjectIdentifier pour déterminer l'espace de travail DataWorks auquel l'opération s'applique.
Keyword	String	No	ods	Le mot-clé présent dans les noms de fichiers. Ce mot-clé permet d'effectuer une correspondance floue. Vous pouvez spécifier un mot-clé pour interroger tous les fichiers dont le nom contient ce mot-clé.
ProjectIdentifier	String	No	dw_project	Le nom de l'espace de travail DataWorks. Connectez-vous à la console DataWorks et accédez à la page Workspace pour obtenir le nom de l'espace de travail. Vous devez configurer ce paramètre ou le paramètre ProjectId pour déterminer l'espace de travail DataWorks auquel l'opération s'applique.
PageNumber	Integer	No	1	Le numéro de page.
PageSize	Integer	No	10	Le nombre d'entrées par page. Valeurs valides : 1 à 100. Valeur par défaut : 10.
UseType	String	No	NORMAL	Le module auquel appartient le fichier. Valeurs valides : NORMAL : Le fichier est utilisé pour DataStudio. MANUAL : Le fichier est utilisé pour un nœud déclenché manuellement. MANUAL_BIZ : Le fichier est utilisé pour un workflow déclenché manuellement. SKIP : Le fichier est utilisé pour un nœud de test à blanc dans DataStudio. ADHOCQUERY : Le fichier est utilisé pour une requête ad hoc. COMPONENT : Le fichier est utilisé pour un extrait de code.
FileTypes	String	No	10,23	Le type de code du fichier. Valeurs valides : 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 97 (PAI), 98 (node group), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1002 (PAI inner node), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), 1106 (for-each) et 1221 (PyODPS 3).
Owner	String	No	3726346****	Le propriétaire du fichier.
NodeId	Long	No	123541234	L'ID du nœud planifié. Vous pouvez appeler l'opération ListNodes pour interroger l'ID du nœud.
NeedContent	Boolean	No	false	Indique si le contenu du fichier doit être inclus dans les résultats de la requête. Un fichier contenant une grande quantité de données peut entraîner un long délai de transmission réseau.
NeedAbsoluteFolderPath	Boolean	No	false	Indique si le chemin du dossier auquel appartient le fichier doit être inclus dans les résultats de la requête.
ExactFileName	String	No	ods_create.sql	Le nom exact du fichier. Le nom du fichier dans les résultats de la requête doit être strictement identique à la valeur de ce paramètre.
FileIdIn	String	No	78237,816123	La liste des ID de fichiers. L'ensemble des ID de fichiers dans les résultats de la requête ne peut être qu'un sous-ensemble de la liste spécifiée par ce paramètre. Vous pouvez spécifier jusqu'à 50 ID de fichiers à la fois.

Paramètres de réponse

Paramètre	Type	Exemple	Description
HttpStatusCode	Integer	200	Code d'état HTTP.
ErrorMessage	String	The connection does not exist.	Message d'erreur.
RequestId	String	0000-ABCD-EFG	ID de la requête.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	Code d'erreur.
Success	Boolean	true	Indique si la requête a abouti. Valeurs possibles : true false
Data	Object		Fichiers renvoyés.
PageNumber	Integer	1	Numéro de page.
PageSize	Integer	10	Nombre d'entrées par page.
TotalCount	Integer	13	Nombre total d'entrées renvoyées.
Files	Array of File		Détails des fichiers.
CommitStatus	Integer	1	Indique si le dernier code du fichier a été validé (committed). Valeurs possibles : 0 et 1. La valeur 0 indique que le dernier code du fichier n'a pas été validé. La valeur 1 indique que le dernier code du fichier a été validé.
AutoParsing	Boolean	true	Indique si la fonctionnalité d'analyse automatique est activée pour le fichier. Valeurs possibles : true false Ce paramètre correspond au paramètre Automatic Parsing From Code Before Node Committing affiché après avoir sélectionné Same Cycle dans la section Dependencies de l'onglet Properties de la console DataWorks.
Owner	String	3872572****	ID du compte Alibaba Cloud utilisé par le propriétaire du fichier.
CreateTime	Long	1593950832000	Heure de création du fichier. Cette valeur est un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970 à 00:00:00 UTC.
FileType	Integer	10	Type de code du fichier. Valeurs possibles : 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment) et 1221 (PyODPS 3).
CurrentVersion	Integer	2	Numéro de la dernière version du fichier.
BizId	Long	300000	ID du workflow auquel appartient le fichier. Ce paramètre est obsolète et remplacé par le paramètre BusinessId.
LastEditUser	String	38748246285727	ID du compte Alibaba Cloud utilisé pour la dernière modification du fichier.
FileName	String	ods_user_info_d	Nom du fichier.
ConnectionName	String	odps_source	Nom de la source de données utilisée pour exécuter le nœud correspondant au fichier.
UseType	String	NORMAL	Module auquel appartient le fichier. Valeurs possibles : NORMAL : Le fichier est utilisé pour DataStudio. MANUAL : Le fichier est utilisé pour un nœud déclenché manuellement. MANUAL_BIZ : Le fichier est utilisé pour un workflow déclenché manuellement. SKIP : Le fichier est utilisé pour un nœud de test à blanc (dry-run) dans DataStudio. ADHOCQUERY : Le fichier est utilisé pour une requête ponctuelle. COMPONENT : Le fichier est utilisé pour un extrait de code.
FileFolderId	String	2735c2****	ID du dossier auquel appartient le fichier.
FileId	Long	10000001	ID du fichier.
ParentId	Long	-1	ID du fichier de groupe de nœuds auquel appartient le fichier actuel. Ce paramètre n'est renvoyé que si le fichier actuel est un fichier interne du fichier de groupe de nœuds.
CreateUser	String	382762****	ID du compte Alibaba Cloud utilisé pour créer le fichier.
IsMaxCompute	Boolean	false	Indique si le fichier doit être téléchargé vers MaxCompute s'il s'agit d'un fichier de ressource MaxCompute. Ce paramètre n'est renvoyé que si le fichier est un fichier de ressource MaxCompute.
BusinessId	Long	300000	ID du workflow auquel appartient le fichier.
FileDescription	String	my test datastudio file	Description du fichier.
LastEditTime	Long	1593950832000	Heure de la dernière modification du fichier. Cette valeur est un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970 à 00:00:00 UTC.
Content	String	SHOW TABLES;	Ce paramètre est obsolète. Vous pouvez appeler l'opération GetFile pour interroger les détails du fichier.
NodeId	Long	300001	ID du nœud planifié généré dans le système d'ordonnancement après la validation du fichier.
AbsoluteFolderPath	String	Workflow/My first workflow/MaxCompute/ods	Chemin d'accès au dossier auquel appartient le fichier.

Exemples

Exemple de requête

http(s)://[Endpoint]/?Action=ListFiles
&FileFolderPath=Workflow/My first workflow/MaxCompute/ods
&ProjectId=10000
&Keyword=ods
&ProjectIdentifier=dw_project
&PageNumber=1
&PageSize=10
&UseType=NORMAL
&FileTypes=10,23
&Owner=3726346****
&NodeId=123541234
&<Common request parameters>

Exemple de réponse en cas de succès

Format XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ListFilesResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <RequestId>0000-ABCD-EFG</RequestId>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Success>true</Success>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>13</TotalCount>
        <Files>
            <CommitStatus>1</CommitStatus>
            <AutoParsing>true</AutoParsing>
            <Owner>3872572****</Owner>
            <CreateTime>1593950832000</CreateTime>
            <FileType>10</FileType>
            <CurrentVersion>2</CurrentVersion>
            <BizId>300000</BizId>
            <LastEditUser>38748246285727</LastEditUser>
            <FileName>ods_user_info_d</FileName>
            <ConnectionName>odps_source</ConnectionName>
            <UseType>NORMAL</UseType>
            <FileFolderId>2735c2****</FileFolderId>
            <FileId>10000001</FileId>
            <ParentId>-1</ParentId>
            <CreateUser>382762****</CreateUser>
            <IsMaxCompute>false</IsMaxCompute>
            <BusinessId>300000</BusinessId>
            <FileDescription>my test datastudio file</FileDescription>
            <LastEditTime>1593950832000</LastEditTime>
            <Content>SHOW TABLES;</Content>
            <NodeId>300001</NodeId>
        </Files>
    </Data>
</ListFilesResponse>

Format JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HttpStatusCode" : 200,
  "ErrorMessage" : "The connection does not exist.",
  "RequestId" : "0000-ABCD-EFG",
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists",
  "Success" : true,
  "Data" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 13,
    "Files" : {
      "CommitStatus" : 1,
      "AutoParsing" : true,
      "Owner" : "3872572****",
      "CreateTime" : 1593950832000,
      "FileType" : 10,
      "CurrentVersion" : 2,
      "BizId" : 300000,
      "LastEditUser" : 38748246285727,
      "FileName" : "ods_user_info_d",
      "ConnectionName" : "odps_source",
      "UseType" : "NORMAL",
      "FileFolderId" : "2735c2****",
      "FileId" : 10000001,
      "ParentId" : -1,
      "CreateUser" : "382762****",
      "IsMaxCompute" : false,
      "BusinessId" : 300000,
      "FileDescription" : "my test datastudio file",
      "LastEditTime" : 1593950832000,
      "Content" : "SHOW TABLES;",
      "NodeId" : 300001
    }
  }
}

Codes d'erreur

Code d'état HTTP	Code d'erreur	Message d'erreur	Description
429	Throttling.Api	The request for this resource has exceeded your available limit.	Le nombre de requêtes pour la ressource a dépassé la limite supérieure.
429	Throttling.System	The DataWorks system is busy. Try again later.	Le système DataWorks est occupé. Veuillez réessayer ultérieurement.
429	Throttling.User	Your request is too frequent. Try again later.	Un nombre excessif de requêtes a été soumis sur une courte période. Veuillez réessayer ultérieurement.
500	InternalError.System	An internal system error occurred. Try again later.	Une erreur interne s'est produite. Veuillez réessayer ultérieurement.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	Une erreur interne s'est produite. Veuillez réessayer ultérieurement.

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur du service.