CreateFile - - 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	CreateFile	L'opération à effectuer. Définissez la valeur sur CreateFile.
FileFolderPath	String	Yes	Workflow/1/MaxCompute/Folder 1/Folder 2	Le chemin d'accès du fichier.
ProjectId	Long	Yes	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. 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.
FileName	String	Yes	File name	Le nom du fichier.
FileDescription	String	No	File description	La description du fichier.
FileType	Integer	Yes	10	Le type de code du fichier. Valeurs valides : 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 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). Appelez l'opération ListFileType pour interroger le type de code du fichier.
Owner	String	No	1000000000001	L'ID du compte Alibaba Cloud utilisé par le propriétaire du fichier. Si ce paramètre n'est pas configuré, l'ID du compte Alibaba Cloud de l'utilisateur qui appelle l'opération est utilisé par défaut.
Content	String	No	SHOW TABLES;	Le code du fichier. Le format du code varie en fonction du type de fichier. Pour afficher le format de code d'un type de fichier spécifique, accédez au centre d'opérations, recherchez un nœud du type de fichier concerné, puis ouvrez le graphe acyclique dirigé (DAG) du nœud. Cliquez avec le bouton droit sur le nœud dans le DAG et sélectionnez View Code.
AutoRerunTimes	Integer	No	3	Le nombre de réexécutions automatiques autorisées après une erreur. Valeur maximale : 10.
AutoRerunIntervalMillis	Integer	No	120000	L'intervalle entre les réexécutions automatiques après une erreur. Unité : millisecondes. Valeur maximale : 1800000 (30 minutes). Ce paramètre correspond au paramètre Rerun Interval qui s'affiche après avoir coché la case Auto Rerun upon Error dans la section Schedule de l'onglet Properties de la console DataWorks. L'intervalle que vous spécifiez dans la console DataWorks est mesuré en minutes. Veillez à convertir correctement les unités de temps lorsque vous appelez l'opération.
RerunMode	String	No	ALL_ALLOWED	Indique si le nœud correspondant au fichier peut être réexécuté. Valeurs valides : ALL_ALLOWED : Le nœud peut être réexécuté, qu'il ait été exécuté avec succès ou qu'il ait échoué. FAILURE_ALLOWED : Le nœud ne peut être réexécuté qu'après un échec d'exécution. ALL_DENIED : Le nœud ne peut pas être réexécuté, qu'il ait été exécuté avec succès ou qu'il ait échoué. Ce paramètre correspond au paramètre Rerun dans la section Schedule de l'onglet Properties de la console DataWorks.
Stop	Boolean	No	false	Indique s'il faut suspendre la planification du nœud. Valeurs valides : true false Ce paramètre correspond au paramètre Recurrence dans la section Schedule de l'onglet Properties de la console DataWorks.
ParaValue	String	No	a=x b=y	Les paramètres de planification du nœud. Séparez plusieurs paramètres par des espaces. Ce paramètre correspond à la section Parameters de l'onglet Properties de la console DataWorks. Pour plus d'informations sur les configurations des paramètres de planification, consultez Configurer les paramètres de planification.
StartEffectDate	Long	No	1671608450000	L'heure de début de la planification automatique. Définissez la valeur sur 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 de la console DataWorks.
EndEffectDate	Long	No	1671694850000	L'heure de fin de la planification automatique. Définissez la valeur sur 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 de la console DataWorks.
CronExpress	String	No	00 05 00 ?	L'expression CRON qui représente la stratégie de planification périodique du nœud. Ce paramètre correspond au paramètre Cron Expression dans la section Schedule de l'onglet Properties de la console DataWorks. Après avoir configuré les paramètres Scheduling Cycle et Run At dans la console DataWorks, DataWorks génère la valeur du paramètre Cron Expression. Exemples : Expression CRON pour un nœud planifié pour s'exécuter tous les jours à 05:30 : `00 30 05 ?` Expression CRON pour un nœud planifié pour s'exécuter à la quinzième minute de chaque heure : `00 15 00-23/1 ?` Expression CRON pour un nœud planifié pour s'exécuter toutes les 10 minutes : `00 00/10 * ?` Expression CRON pour un nœud planifié pour s'exécuter toutes les 10 minutes de 08:00 à 17:00 tous les jours : `00 00-59/10 8-17 * ?` Expression CRON pour un nœud planifié pour s'exécuter à 00:20 le premier jour de chaque mois : `00 20 00 1 * ?` Expression CRON pour un nœud planifié pour s'exécuter tous les trois mois à partir de 00:10 le 1er janvier : `00 10 00 1 1-12/3 ?` Expression CRON pour un nœud planifié pour s'exécuter à 00:05 tous les mardis et vendredis : `00 05 00 2,5` Le système de planification de DataWorks impose les limites suivantes aux expressions CRON : L'intervalle minimal spécifié dans une expression CRON pour planifier un nœud est de 5 minutes. L'heure la plus tôt spécifiée dans une expression CRON pour planifier un nœud tous les jours est 00:05.
CycleType	String	No	DAY	Le type de cycle de planification. Valeurs valides : NOT_DAY et DAY. La valeur NOT_DAY indique que le nœud est planifié pour s'exécuter par minute ou par heure. La valeur DAY indique que le nœud est planifié pour s'exécuter par jour, par semaine ou par mois. Ce paramètre correspond au paramètre Scheduling Cycle dans la section Schedule de l'onglet Properties de la console DataWorks.
DependentType	String	No	NONE	Le type de dépendance de planification inter-cycles du nœud. Valeurs valides : 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 de planification inter-cycles n'est sélectionné pour le nœud. USER_DEFINE_AND_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 et des instances générées pour un ou plusieurs nœuds spécifiés dans le cycle précédent. CHILD_AND_SELF : 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 et de l'instance générée pour le nœud dans le cycle précédent.
DependentNodeIdList	String	No	abc	Les ID des nœuds qui génèrent des instances dans le cycle précédent dont dépend le nœud actuel.
InputList	String	Yes	project_root,project.file1,project.001_out	Le nom de sortie du fichier parent dont dépend le fichier actuel. Si vous spécifiez plusieurs noms de sortie, séparez-les par des virgules (,). Ce paramètre correspond au paramètre Output Name of Ancestor Node qui s'affiche après avoir sélectionné Same Cycle dans la section Dependencies de l'onglet Properties de la console DataWorks.
ProjectIdentifier	String	No	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 ProjectId pour déterminer l'espace de travail DataWorks auquel l'opération s'applique.
ResourceGroupIdentifier	String	No	group_375827434852437	L'identifiant du groupe de ressources utilisé pour exécuter le nœud. Appelez l'opération ListResourceGroups pour interroger les groupes de ressources disponibles dans l'espace de travail. Le paramètre Identifier dans la réponse de l'opération indique l'identifiant d'un groupe de ressources disponible.
ResourceGroupId	Long	No	375827434852437	Ce paramètre est obsolète. Ne l'utilisez pas. L'ID du groupe de ressources utilisé pour exécuter le nœud. Ce paramètre correspond au paramètre Resource Group dans la section Resource Group de l'onglet Properties de la console DataWorks. Vous devez configurer ce paramètre ou ResourceGroupIdentifier pour déterminer le groupe de ressources utilisé pour exécuter le nœud. Appelez l'opération ListResourceGroups pour interroger les groupes de ressources disponibles dans l'espace de travail. Lorsque vous appelez l'opération, définissez ResourceGroupType sur 1. Le paramètre de réponse Id indique l'ID d'un groupe de ressources disponible.
ConnectionName	String	No	odps_source	Le nom de la source de données pour laquelle le nœud est exécuté. Appelez l'opération UpdateDataSource pour interroger les sources de données disponibles dans l'espace de travail.
AutoParsing	Boolean	No	true	Indique s'il faut activer la fonctionnalité d'analyse automatique pour le fichier. Valeurs valides : true false Ce paramètre correspond au paramètre Automatic Parsing From Code Before Node Committing qui s'affiche après avoir sélectionné Same Cycle dans la section Dependencies de l'onglet Properties de la console DataWorks.
SchedulerType	String	No	NORMAL	Le type de planification du nœud. Valeurs valides : NORMAL : Le nœud est un nœud déclenché automatiquement. MANUAL : Le nœud est un nœud déclenché manuellement. Les nœuds déclenchés manuellement ne peuvent pas être déclenchés automatiquement. Ils correspondent aux nœuds dans le volet Manually Triggered Workflows. PAUSE : Le nœud est un nœud en pause. SKIP : Le nœud est un nœud de test à blanc. Les nœuds de test à blanc sont démarrés selon la planification, mais le système définit leur statut comme réussi lorsqu'il commence à les exécuter.
AdvancedSettings	String	No	{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}	Les configurations avancées du nœud. Ce paramètre n'est valide que pour un nœud EMR Spark Streaming ou un nœud EMR Streaming SQL. Ce paramètre correspond à l'onglet Advanced Settings du nœud dans la console DataWorks. La valeur de ce paramètre doit être au format JSON.
StartImmediately	Boolean	No	true	Indique s'il faut exécuter immédiatement un nœud 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. Ce paramètre correspond au paramètre Start Method dans la section Schedule de l'onglet Configure de la console DataWorks.
InputParameters	String	No	[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]	Les paramètres d'entrée du nœud. La valeur de ce paramètre doit être au format JSON. Pour plus d'informations sur les paramètres d'entrée, consultez le paramètre InputContextParameterList dans la section Paramètres de réponse de l'opération GetFile. Ce paramètre correspond au tableau Input Parameters dans la section Input and Output Parameters de l'onglet Properties de la console DataWorks.
OutputParameters	String	No	[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]	Les paramètres de sortie du nœud. La valeur de ce paramètre doit être au format JSON. Pour plus d'informations sur les paramètres de sortie, consultez le paramètre OutputContextParameterList dans la section Paramètres de réponse de l'opération GetFile. Ce paramètre correspond au tableau Output Parameters dans la section Input and Output Parameters de l'onglet Properties de la console DataWorks.
IgnoreParentSkipRunningProperty	Boolean	No	false	Indique s'il faut utiliser la propriété de test à blanc du cycle précédent. Valeurs valides : true false
CreateFolderIfNotExists	Boolean	No	false	Indique s'il faut créer automatiquement le répertoire spécifié par le paramètre FileFolderPath si le répertoire n'existe pas. Valeurs valides : true : Le système crée automatiquement le répertoire s'il n'existe pas. false : Le système ne crée pas automatiquement le répertoire s'il n'existe pas. Dans ce cas, l'appel échoue.

Paramètres de réponse

Parameter	Type	Example	Description
HttpStatusCode	Integer	200	Le code d'état HTTP.
Data	Long	1000001	L'ID du fichier créé.
RequestId	String	0000-ABCD-EFG	L'ID de la requête.
ErrorMessage	String	The connection does not exist.	Le message d'erreur.
Success	Boolean	true	Indique si la requête a abouti. Valeurs valides : true false
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	Le code d'erreur.

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=CreateFile
&FileFolderPath=Workflow/1/MaxCompute/Folder 1/Folder 2
&ProjectId=10000
&FileName=File name
&FileDescription=File description
&FileType=10
&Owner=1000000000001
&Content=SHOW TABLES;
&AutoRerunTimes=3
&AutoRerunIntervalMillis=120000
&RerunMode=ALL_ALLOWED
&Stop=false
&ParaValue=a=x b=y
&StartEffectDate=1671608450000
&EndEffectDate=1671694850000
&CronExpress=00 05 00 * * ?
&CycleType=DAY
&DependentType=NONE
&DependentNodeIdList=abc
&InputList=project_root,project.file1,project.001_out
&ProjectIdentifier=dw_project
&ResourceGroupIdentifier=group_375827434852437
&ResourceGroupId=375827434852437
&ConnectionName=odps_source
&AutoParsing=true
&SchedulerType=NORMAL
&AdvancedSettings={"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}
&StartImmediately=true
&InputParameters=[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]
&OutputParameters=[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]
&IgnoreParentSkipRunningProperty=false
&CreateFolderIfNotExists=false
&<Common request parameters>

Exemples de réponses réussies

XML format

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

<CreateFileResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <Data>1000001</Data>
    <RequestId>0000-ABCD-EFG</RequestId>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <Success>true</Success>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
</CreateFileResponse>

JSON format

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

{
  "HttpStatusCode" : 200,
  "Data" : 1000001,
  "RequestId" : "0000-ABCD-EFG",
  "ErrorMessage" : "The connection does not exist.",
  "Success" : true,
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists"
}

Codes d'erreur

HTTP status code	Error code	Error message	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é. Réessayez plus tard.
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. Réessayez plus tard.
500	InternalError.System	An internal system error occurred. Try again later.	Une erreur interne s'est produite. Réessayez plus tard.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	Une erreur interne s'est produite. Réessayez plus tard.

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