GetFile - - 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

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	GetFile	L'opération que vous souhaitez effectuer.
ProjectId	Long	Non	10000	L'ID de l'espace de travail DataWorks. Connectez-vous à la console DataWorks et accédez à la page Espace de travail pour obtenir l'ID de l'espace de travail. Vous devez configurer ce paramètre ou le paramètre ProjectIdentifier afin de déterminer l'espace de travail DataWorks auquel l'opération s'applique.
ProjectIdentifier	String	Non	dw_project	Le nom de l'espace de travail DataWorks. Connectez-vous à la console DataWorks et accédez à la page Espace de travail pour obtenir le nom de l'espace de travail. Vous devez configurer ce paramètre ou le paramètre ProjectId afin de déterminer l'espace de travail DataWorks auquel l'opération s'applique.
FileId	Long	Non	100000001	L'ID du fichier. Appelez l'opération ListFiles pour obtenir l'ID du fichier.
NodeId	Long	Non	200000001	L'ID du nœud planifié. Appelez l'opération ListFiles pour obtenir l'ID du nœud.

Paramètres de réponse

Parameter	Type	Example	Description
HttpStatusCode	Integer	200	Le code d'état HTTP.
ErrorMessage	String	The connection does not exist.	Le message d'erreur.
RequestId	String	0000-ABCD-EFG****	L'ID de la requête.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	Le code d'erreur.
Success	Boolean	true	Indique si la requête a abouti. Valeurs possibles : true false
Data	Object		Les détails du fichier.
File	Object		Les informations de base sur le fichier.
CommitStatus	Integer	0	Indique si le dernier code du fichier est validé (commit). Valeurs possibles : 0 et 1. La valeur 0 signifie que le dernier code du fichier n'est pas validé. La valeur 1 signifie que le dernier code du fichier est 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 Analyze Code affiché après la sélection de Same Cycle dans la section Dependencies de l'onglet Properties de la console DataWorks.
Owner	String	7775674356****	L'ID du compte Alibaba Cloud utilisé par le propriétaire du fichier.
CreateTime	Long	1593879116000	L'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	Le 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	3	Le numéro de la dernière version du fichier.
BizId	Long	1000001	L'ID du workflow auquel appartient le fichier. Ce paramètre est obsolète et remplacé par le paramètre BusinessId.
LastEditUser	String	62465892****	L'ID du compte Alibaba Cloud utilisé pour la dernière modification du fichier.
FileName	String	ods_user_info_d	Le nom du fichier.
ConnectionName	String	odps_source	Le nom de la source de données utilisée pour exécuter le nœud correspondant au fichier.
UseType	String	NORMAL	Le 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 DataStudio en mode simulation (dry-run). ADHOCQUERY : Le fichier est utilisé pour une requête ponctuelle. COMPONENT : Le fichier est utilisé pour un extrait de code (snippet).
FileFolderId	String	2735c2****	L'ID du dossier auquel appartient le fichier.
ParentId	Long	-1	L'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	424732****	L'ID du compte Alibaba Cloud utilisé pour créer le fichier.
IsMaxCompute	Boolean	true	Indique si le fichier doit être téléchargé vers MaxCompute. Ce paramètre n'est renvoyé que si le fichier est une ressource MaxCompute.
BusinessId	Long	1000001	L'ID du workflow auquel appartient le fichier.
FileDescription	String	My first DataWorks file	La description du fichier.
DeletedStatus	String	RECYCLE	Statut du fichier. Valeurs possibles : NORMAL : le fichier n'est pas supprimé. RECYCLE_BIN : le fichier est stocké dans la corbeille. DELETED : le fichier est supprimé.
LastEditTime	Long	1593879116000	Date de dernière modification du fichier. Cette valeur correspond à un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970, 00:00:00 UTC.
Content	String	SHOW TABLES;	Code contenu dans le fichier.
NodeId	Long	300001	ID du nœud planifié généré par le système d'ordonnancement après validation du fichier.
AdvancedSettings	String	{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}	Paramètres avancés du nœud. Ce paramètre s'applique uniquement aux nœuds EMR Spark Streaming et EMR Streaming SQL. Il correspond à l'onglet Advanced Settings du nœud dans la console DataWorks. La valeur de ce paramètre doit être au format JSON.
FileId	Long	100000001	ID du fichier.
NodeConfiguration	Object		Paramètres d'ordonnancement du fichier.
RerunMode	String	ALL_ALLOWED	Indique si le nœud associé au fichier peut être réexécuté. Valeurs possibles : ALL_ALLOWED : le nœud peut être réexécuté, qu'il ait réussi ou échoué. FAILURE_ALLOWED : le nœud ne peut être réexécuté qu'en cas d'échec. ALL_DENIED : le nœud ne peut pas être réexécuté, qu'il ait réussi ou échoué. Ce paramètre correspond au paramètre Rerun de la section Schedule de l'onglet Properties dans la console DataWorks.
SchedulerType	String	NORMAL	Type d'ordonnancement du nœud. Valeurs possibles : NORMAL : le nœud est déclenché automatiquement. MANUAL : le nœud est déclenché manuellement. Les nœuds manuels ne peuvent pas être déclenchés automatiquement. Ils correspondent aux nœuds présents dans le volet Manually Triggered Workflows. PAUSE : le nœud est en pause. SKIP : le nœud est un nœud de test à blanc (dry-run). Ces nœuds démarrent selon la planification, mais le système définit leur statut comme réussi dès le début de l'exécution.
Stop	Boolean	false	Indique si l'ordonnancement du nœud est suspendu. Valeurs possibles : true false Ce paramètre correspond au paramètre Recurrence de la section Schedule de l'onglet Properties dans la console DataWorks.
ParaValue	String	a=x b=y	Paramètres d'ordonnancement du nœud. Ce paramètre correspond à la section Scheduling Parameter de l'onglet Properties dans la console DataWorks. Pour plus d'informations sur la configuration des paramètres d'ordonnancement, consultez la rubrique Configurer les paramètres d'ordonnancement.
StartEffectDate	Long	936923400000	Début de la plage de temps pour l'ordonnancement automatique. Cette valeur correspond à un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970, 00:00:00 UTC. La configuration de ce paramètre équivaut à spécifier une heure de début pour le paramètre Validity Period dans la section Schedule de l'onglet Properties dans la console DataWorks.
EndEffectDate	Long	4155787800000	Fin de la plage de temps pour l'ordonnancement automatique. Cette valeur correspond à un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970, 00:00:00 UTC. La configuration de ce paramètre équivaut à spécifier une heure de fin pour le paramètre Validity Period dans la section Schedule de l'onglet Properties dans la console DataWorks.
CycleType	String	DAY	Type de cycle d'ordonnancement. Valeurs possibles : NOT_DAY et DAY. La valeur NOT_DAY indique que le nœud est planifié pour une exécution par minute ou par heure. La valeur DAY indique que le nœud est planifié pour une exécution par jour, par semaine ou par mois. Ce paramètre correspond au paramètre Scheduling Cycle de la section Schedule de l'onglet Properties dans la console DataWorks.
DependentNodeIdList	String	5,10,15,20	ID du nœud dont dépend le nœud associé au fichier lorsque le paramètre DependentType est défini sur USER_DEFINE. Plusieurs ID sont séparés par des virgules (,). La valeur de ce paramètre équivaut à l'ID du nœud que vous avez spécifié après avoir sélectionné Previous Cycle et défini Depend On sur Other Nodes dans la section Dependencies de l'onglet Properties dans la console DataWorks.
ResourceGroupId	Long	375827434852437	ID du groupe de ressources utilisé pour exécuter le nœud associé au fichier. Vous pouvez appeler l'opération ListResourceGroups pour interroger les groupes de ressources disponibles dans l'espace de travail.
DependentType	String	USER_DEFINE	Type de dépendance d'ordonnancement inter-cycles du nœud. Valeurs possibles : SELF : l'instance générée pour le nœud dans le cycle actuel dépend de l'instance générée pour le nœud dans le cycle précédent. CHILD : l'instance générée pour le nœud dans le cycle actuel dépend des instances générées pour les nœuds descendants au niveau le plus proche du nœud dans le cycle précédent. USER_DEFINE : l'instance générée pour le nœud dans le cycle actuel dépend des instances générées pour un ou plusieurs nœuds spécifiés dans le cycle précédent. NONE : aucun type de dépendance d'ordonnancement inter-cycles n'est sélectionné pour le nœud.
AutoRerunTimes	Integer	3	Nombre de réexécutions automatiques autorisées après une erreur.
AutoRerunIntervalMillis	Integer	120000	L'intervalle entre les réexécutions automatiques après une erreur, exprimé en millisecondes. Ce paramètre correspond au paramètre Intervalle de nouvelle tentative qui s'affiche lorsque vous cochez la case Nouvelle tentative automatique en cas d'erreur dans la section Ordonnancement de l'onglet Propriétés de la console DataWorks. Dans la console DataWorks, cet intervalle est indiqué en minutes. Veillez à convertir correctement les unités de temps lors de l'appel de l'opération.
CronExpress	String	00 05 00 * * ?	Expression CRON représentant la politique de planification périodique du nœud.
InputList	Array of NodeInputOutput		Les noms de sortie des fichiers parents dont dépend le fichier actuel.
Input	String	project.001_out	Le nom de sortie du fichier parent dont dépend le fichier actuel. Ce paramètre correspond au paramètre Nom de sortie du nœud ancêtre sous Nœuds parents après sélection de Même cycle dans la section Dépendances de l'onglet Propriétés de la console DataWorks.
ParseType	String	MANUAL	Le mode de dépendance du fichier de configuration. Valeurs possibles : MANUAL : les dépendances d'ordonnancement sont configurées manuellement. AUTO : les dépendances d'ordonnancement sont analysées automatiquement.
OutputList	Array of NodeInputOutput		Les noms de sortie du fichier actuel. Ce paramètre correspond au paramètre Nom de sortie sous Sortie après sélection de Même cycle dans la section Dépendances de l'onglet Propriétés de la console DataWorks.
RefTableName	String	ods_user_info_d	Le nom de la table de sortie du fichier actuel. Ce paramètre correspond au paramètre Nom de la table de sortie sous Sortie après sélection de Même cycle dans la section Dépendances de l'onglet Propriétés de la console DataWorks.
Output	String	dw_project.002_out	Le nom de sortie du fichier actuel. Ce paramètre correspond au paramètre Nom de sortie sous Sortie après sélection de Même cycle dans la section Dépendances de l'onglet Propriétés de la console DataWorks.
StartImmediately	Boolean	true	Indique si un nœud est exécuté immédiatement après son déploiement dans l'environnement de production. Ce paramètre n'est valide que pour un nœud EMR Spark Streaming ou un nœud EMR Streaming SQL. Il correspond au paramètre Méthode de démarrage dans la section Ordonnancement de l'onglet Configurer de la console DataWorks.
InputParameters	Array of InputContextParameter		Paramètres d'entrée du nœud. Ce paramètre correspond au tableau Paramètres d'entrée dans la section Paramètres d'entrée et de sortie de l'onglet Propriétés de la console DataWorks.
ParameterName	String	input	Le nom du paramètre d'entrée du nœud. Dans le code, utilisez la syntaxe ${...} pour référencer ce paramètre. Ce paramètre correspond au paramètre Nom du paramètre dans le tableau Paramètres d'entrée de la section Paramètres d'entrée et de sortie de l'onglet Propriétés de la console DataWorks.
ValueSource	String	project_001.parent_node:outputs	La source de valeur du paramètre d'entrée du nœud. Ce paramètre correspond au paramètre Source de valeur dans le tableau Paramètres d'entrée de la section Paramètres d'entrée et de sortie de l'onglet Propriétés de la console DataWorks.
OutputParameters	Array of OutputContextParameter		Paramètres de sortie du nœud. Ce paramètre correspond au tableau Paramètres de sortie dans la section Paramètres d'entrée et de sortie de l'onglet Propriétés de la console DataWorks.
ParameterName	String	output	Le nom du paramètre de sortie du nœud. Ce paramètre correspond au paramètre Nom du paramètre dans le tableau Paramètres de sortie de la section Paramètres d'entrée et de sortie de l'onglet Propriétés de la console DataWorks.
Value	String	${bizdate}	La valeur du paramètre de sortie du nœud. Ce paramètre correspond au paramètre Valeur dans le tableau Paramètres de sortie de la section Paramètres d'entrée et de sortie de l'onglet Propriétés de la console DataWorks.
Type	String	1	Le type du paramètre de sortie du nœud. Valeurs possibles : 1 : constante. 2 : variable. 3 : variable de transfert. Ce paramètre correspond au paramètre Type dans le tableau Paramètres de sortie de la section Paramètres d'entrée et de sortie de l'onglet Propriétés de la console DataWorks.
Description	String	It's a context output parameter.	La description du paramètre de sortie du nœud.

Exemples

Exemple de requête

http(s)://[Endpoint]/?Action=GetFile
&ProjectId=10000
&ProjectIdentifier=dw_project
&FileId=100000001
&NodeId=200000001
&<Common request parameters>

Exemple de réponse en cas de succès

Format XML

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

<GetFileResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Success>true</Success>
    <Data>
        <File>
            <CommitStatus>0</CommitStatus>
            <AutoParsing>true</AutoParsing>
            <Owner>7775674356****</Owner>
            <CreateTime>1593879116000</CreateTime>
            <FileType>10</FileType>
            <CurrentVersion>3</CurrentVersion>
            <BizId>1000001</BizId>
            <LastEditUser>62465892****</LastEditUser>
            <FileName>ods_user_info_d</FileName>
            <ConnectionName>odps_source</ConnectionName>
            <UseType>NORMAL</UseType>
            <FileFolderId>2735c2****</FileFolderId>
            <ParentId>-1</ParentId>
            <CreateUser>424732****</CreateUser>
            <IsMaxCompute>true</IsMaxCompute>
            <BusinessId>1000001</BusinessId>
            <FileDescription>My first DataWorks file</FileDescription>
            <DeletedStatus>RECYCLE</DeletedStatus>
            <LastEditTime>1593879116000</LastEditTime>
            <Content>SHOW TABLES;</Content>
            <NodeId>300001</NodeId>
            <AdvancedSettings>{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}</AdvancedSettings>
            <FileId>100000001</FileId>
        </File>
        <NodeConfiguration>
            <RerunMode>ALL_ALLOWED</RerunMode>
            <SchedulerType>NORMAL</SchedulerType>
            <Stop>false</Stop>
            <ParaValue>a=x b=y</ParaValue>
            <StartEffectDate>936923400000</StartEffectDate>
            <EndEffectDate>4155787800000</EndEffectDate>
            <CycleType>DAY</CycleType>
            <DependentNodeIdList>5,10,15,20</DependentNodeIdList>
            <ResourceGroupId>375827434852437</ResourceGroupId>
            <DependentType>USER_DEFINE</DependentType>
            <AutoRerunTimes>3</AutoRerunTimes>
            <AutoRerunIntervalMillis>120000</AutoRerunIntervalMillis>
            <CronExpress>00 05 00 * * ?</CronExpress>
            <InputList>
                <Input>project.001_out</Input>
                <ParseType>MANUAL</ParseType>
            </InputList>
            <OutputList>
                <RefTableName>ods_user_info_d</RefTableName>
                <Output>dw_project.002_out</Output>
            </OutputList>
            <StartImmediately>true</StartImmediately>
            <InputParameters>
                <ParameterName>input</ParameterName>
                <ValueSource>project_001.parent_node:outputs</ValueSource>
            </InputParameters>
            <OutputParameters>
                <ParameterName>output</ParameterName>
                <Value>${bizdate}</Value>
                <Type>1</Type>
                <Description>It's a context output parameter.</Description>
            </OutputParameters>
        </NodeConfiguration>
    </Data>
</GetFileResponse>

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" : {
    "File" : {
      "CommitStatus" : 0,
      "AutoParsing" : true,
      "Owner" : "7775674356****",
      "CreateTime" : 1593879116000,
      "FileType" : 10,
      "CurrentVersion" : 3,
      "BizId" : 1000001,
      "LastEditUser" : "62465892****",
      "FileName" : "ods_user_info_d",
      "ConnectionName" : "odps_source",
      "UseType" : "NORMAL",
      "FileFolderId" : "2735c2****",
      "ParentId" : -1,
      "CreateUser" : "424732****",
      "IsMaxCompute" : true,
      "BusinessId" : 1000001,
      "FileDescription" : "My first DataWorks file",
      "DeletedStatus" : "RECYCLE",
      "LastEditTime" : 1593879116000,
      "Content" : "SHOW TABLES;",
      "NodeId" : 300001,
      "AdvancedSettings" : "{\"queue\":\"default\",\"SPARK_CONF\":\"--conf spark.driver.memory=2g\"}",
      "FileId" : 100000001
    },
    "NodeConfiguration" : {
      "RerunMode" : "ALL_ALLOWED",
      "SchedulerType" : "NORMAL",
      "Stop" : false,
      "ParaValue" : "a=x b=y",
      "StartEffectDate" : 936923400000,
      "EndEffectDate" : 4155787800000,
      "CycleType" : "DAY",
      "DependentNodeIdList" : "5,10,15,20",
      "ResourceGroupId" : 375827434852437,
      "DependentType" : "USER_DEFINE",
      "AutoRerunTimes" : 3,
      "AutoRerunIntervalMillis" : 120000,
      "CronExpress" : "00 05 00 * * ?",
      "InputList" : {
        "Input" : "project.001_out",
        "ParseType" : "MANUAL"
      },
      "OutputList" : {
        "RefTableName" : "ods_user_info_d",
        "Output" : "dw_project.002_out"
      },
      "StartImmediately" : true,
      "InputParameters" : {
        "ParameterName" : "input",
        "ValueSource" : "project_001.parent_node:outputs"
      },
      "OutputParameters" : {
        "ParameterName" : "output",
        "Value" : "${bizdate}",
        "Type" : 1,
        "Description" : "It's a context output parameter."
      }
    }
  }
}

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 adressées à la resource 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 dans un court laps de temps. 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.