:UpdateFile

Action

String

Yes

UpdateFile

Opération à effectuer.

FileFolderPath

String

No

Workflow/1/Data Integration/Folder 1/Folder 2

Chemin d'accès du fichier.

ProjectId

Long

No

10000

ID de l'espace de travail DataWorks. Connectez-vous à la console DataWorks et accédez à la page Workspace pour obtenir l'ID de l'espace de travail.

FileName

String

No

ods_user_info_d

Nom du fichier. Définissez le paramètre FileName sur une autre valeur pour modifier le nom du fichier.

Appelez l'opération ListFiles pour récupérer l'ID du fichier dont vous souhaitez modifier le nom. Ensuite, appelez l'opération UpdateFile pour changer le nom du fichier en définissant le paramètre FileId sur l'ID récupéré et le paramètre FileName sur une autre valeur.

FileDescription

String

No

File description

Description du fichier.

Content

String

No

SELECT "1";

Code du fichier. Le format du code varie selon le type de fichier. Pour afficher le format de code d'un type de fichier spécifique, accédez à Operation Center, ouvrez le DAG d'un nœud de ce type de fichier, cliquez avec le bouton droit sur le nœud, puis sélectionnez View Code.

AutoRerunTimes

Integer

Yes

3

Nombre de réexécutions automatiques autorisées après une erreur.

AutoRerunIntervalMillis

Integer

No

120000

Intervalle entre les réexécutions automatiques après une erreur. Unité : milliseconde. 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 spécifié dans la console DataWorks est exprimé en minutes. Veillez à convertir correctement les unités de temps lors de l'appel de 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 réussi ou échoué.

• FAILURE_ALLOWED : Le nœud ne peut être réexécuté qu'après un é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 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

x=a y=b z=c

Paramètres de planification du nœud.

Ce paramètre correspond à la section Scheduling Parameter de l'onglet Properties de la console DataWorks. Pour plus d'informations sur la configuration des paramètres de planification, consultez Configurer les paramètres de planification.

StartEffectDate

Long

No

936923400000

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.

Ce paramètre correspond à l'heure de début spécifiée pour le paramètre Validity Period dans la section Schedule de l'onglet Properties de la console DataWorks.

EndEffectDate

Long

No

4155787800000

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.

Ce paramètre correspond à l'heure de fin spécifiée pour le paramètre Validity Period dans la section Schedule de l'onglet Properties de la console DataWorks.

CronExpress

String

No

00 00-59/5 1-23 ?

Expression CRON représentant 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 Scheduled time 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 à 05:30 tous les jours : 00 30 05 ?

• Expression CRON pour un nœud planifié pour s'exécuter à la quinzième minute de chaque heure : 00 15 * ?

• 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-23 * ?

• 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 du 1er janvier à 00:10 : 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 sur les 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 à laquelle un nœud peut être planifié pour s'exécuter chaque jour est 00:05.

CycleType

String

No

NOT_DAY

Type de cycle de planification du nœud correspondant au fichier. 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

USER_DEFINE

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 du 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.

DependentNodeIdList

String

No

5,10,15,20

ID du nœud dont dépend le nœud correspondant au fichier lorsque le paramètre DependentType est défini sur USER_DEFINE. Séparez plusieurs ID par des virgules (,).

La valeur de ce paramètre correspond à 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 de la console DataWorks.

InputList

String

No

project_root,project.file1,project.001_out

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 Parent Nodes 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

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 soit ce paramètre, soit le paramètre ProjectId pour déterminer l'espace de travail DataWorks auquel l'opération s'applique.

FileId

Long

Yes

100000001

ID du fichier. Appelez l'opération ListFiles pour obtenir l'ID.

OutputList

String

No

dw_project.ods_user_info_d

Nom de sortie du fichier actuel.

Ce paramètre correspond au paramètre Output dans la section Dependencies de l'onglet Properties de la console DataWorks.

ResourceGroupIdentifier

String

No

default_group

Identifiant du groupe de ressources utilisé pour exécuter le nœud correspondant au fichier. Appelez l'opération ListResourceGroups pour interroger les groupes de ressources disponibles dans l'espace de travail.

ConnectionName

String

No

odps_source

Nom de la source de données utilisée pour exécuter le nœud. Appelez l'opération ListDataSources pour interroger les sources de données disponibles de l'espace de travail.

Owner

String

No

18023848927592

ID du propriétaire du fichier.

AutoParsing

Boolean

No

true

Indique s'il faut activer la fonction 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

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 du 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 comme prévu, mais le système de planification définit leur statut sur « réussi » dès qu'il commence à les exécuter.

AdvancedSettings

String

No

{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}

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. Il 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. Valeurs valides :

• true

• false

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

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 Response parameters 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"}]

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 Response parameters 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

true

Indique s'il faut ignorer la propriété de test à blanc des nœuds ancêtres du nœud. Ce paramètre correspond au paramètre Skip the dry-run property of the ancestor node qui s'affiche après avoir configuré le paramètre Depend On dans la section Dependencies de l'onglet Properties de la console DataWorks.

HttpStatusCode

Integer

200

Code d'état HTTP.

ErrorMessage

String

The connection does not exist.

Message d'erreur.

RequestId

String

0000-ABCD-EFGH-IJKLMNOPQ

ID de la requête.

ErrorCode

String

Invalid.Tenant.ConnectionNotExists

Code d'erreur.

Success

Boolean

true

Indique si la requête a abouti. Valeurs valides :

• true

• false