:UpdateFile

Action

String

Sim

UpdateFile

A operação a ser executada.

FileFolderPath

String

Não

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

O caminho do arquivo.

ProjectId

Long

Não

10000

O ID do workspace do DataWorks. Faça login no console do DataWorks e acesse a página Workspace para obter o ID.

FileName

String

Não

ods_user_info_d

O nome do arquivo. Defina o parâmetro FileName com outro valor para alterar o nome do arquivo.

Chame a operação ListFiles para consultar o ID do arquivo cujo nome deseja alterar. Em seguida, chame a operação UpdateFile para modificar o nome, definindo o parâmetro FileId com o ID consultado e o parâmetro FileName com o novo valor.

FileDescription

String

Não

Descrição do arquivo

A descrição do arquivo.

Content

String

Não

SELECT "1";

O código do arquivo. O formato varia conforme o tipo de arquivo. Para visualizar o formato de um tipo específico, acesse o Operation Center, abra o DAG de um nó desse tipo, clique em com o botão direito no nó e selecione View Code.

AutoRerunTimes

Integer

Sim

3

O número de reexecuções automáticas permitidas após a ocorrência de um erro.

AutoRerunIntervalMillis

Integer

Não

120000

O intervalo entre reexecuções automáticas após a ocorrência de um erro. Unidade: milissegundo. Valor máximo: 1800000 (30 minutos).

Este parâmetro corresponde ao parâmetro Rerun interval exibido após marcar a caixa de seleção Auto Rerun upon Error na seção Schedule da aba Properties no console do DataWorks.

O intervalo definido no console do DataWorks é medido em minutos. Atenção à conversão entre as unidades de tempo ao chamar a operação.

RerunMode

String

Não

ALL_ALLOWED

Define se o nó correspondente ao arquivo pode ser reexecutado. Valores válidos:

• ALL_ALLOWED: permite reexecução independentemente de o nó ter sido executado com sucesso ou ter falhado.

• FAILURE_ALLOWED: permite reexecução apenas após falha na execução.

• ALL_DENIED: impede reexecução, tenha o nó sido executado com sucesso ou não.

Este parâmetro corresponde ao parâmetro Rerun na seção Schedule da aba Properties no console do DataWorks.

Stop

Boolean

Não

false

Indica se o agendamento do nó deve ser suspenso. Valores válidos:

• true

• false

Este parâmetro corresponde ao parâmetro Recurrence na seção Schedule da aba Properties no console do DataWorks.

ParaValue

String

Não

x=a y=b z=c

Os parâmetros de agendamento do nó.

Este parâmetro corresponde à seção Scheduling Parameter da aba Properties no console do DataWorks. Para mais informações sobre as configurações de parâmetros de agendamento, consulte Configurar parâmetros de agendamento.

StartEffectDate

Long

Não

936923400000

A hora de início do agendamento automático. Defina o valor como um timestamp UNIX representando o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.

Este parâmetro corresponde à hora inicial especificada no parâmetro Validity Period na seção Schedule da aba Properties no console do DataWorks.

EndEffectDate

Long

Não

4155787800000

A hora de término do agendamento automático. Defina o valor como um timestamp UNIX representando o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.

Este parâmetro corresponde à hora final especificada no parâmetro Validity Period na seção Schedule da aba Properties no console do DataWorks.

CronExpress

String

Não

00 00-59/5 1-23 ?

A expressão CRON que representa a política de agendamento periódico do nó. Este parâmetro corresponde ao parâmetro Cron Expression na seção Schedule da aba Properties no console do DataWorks. Após configurar os parâmetros Scheduling Cycle e Scheduled time no console do DataWorks, o sistema gera o valor do parâmetro Cron Expression.

Exemplos:

• Nó agendado para executar às 05:30 diariamente: 00 30 05 ?

• Nó agendado para executar no décimo quinto minuto de cada hora: 00 15 * ?

• Nó agendado para executar a cada 10 minutos: 00 00/10 * ?

• Nó agendado para executar a cada 10 minutos, das 08:00 às 17:00, diariamente: 00 00-59/10 8-23 * ?

• Nó agendado para executar às 00:20 no primeiro dia de cada mês: 00 20 00 1 * ?

• Nó agendado para executar a cada três meses, a partir das 00:10 de 1º de janeiro: 00 10 00 1 1-12/3 ?

• Nó agendado para executar às 00:05 toda terça e sexta-feira: 00 05 00 2,5

O sistema de agendamento do DataWorks impõe os seguintes limites nas expressões CRON:

• O intervalo mínimo especificado em uma expressão CRON para agendar um nó é de 5 minutos.

• O horário mais cedo que um nó pode ser agendado para executar diariamente é 00:05.

CycleType

String

Não

NOT_DAY

O tipo de ciclo de agendamento do nó correspondente ao arquivo. Valores válidos: NOT_DAY e DAY. O valor NOT_DAY indica agendamento por minuto ou hora. O valor DAY indica agendamento por dia, semana ou mês.

Este parâmetro corresponde ao parâmetro Scheduling Cycle na seção Schedule da aba Properties no console do DataWorks.

DependentType

String

Não

USER_DEFINE

O tipo de dependência de agendamento entre ciclos do nó. Valores válidos:

• SELF: a instância gerada para o nó no ciclo atual depende da instância gerada para o mesmo nó no ciclo anterior.

• CHILD: a instância gerada para o nó no ciclo atual depende das instâncias geradas para os nós descendentes no nível mais próximo do nó no ciclo anterior.

• USER_DEFINE: a instância gerada para o nó no ciclo atual depende das instâncias geradas para um ou mais nós específicos no ciclo anterior.

• NONE: nenhum tipo de dependência de agendamento entre ciclos foi selecionado para o nó.

DependentNodeIdList

String

Não

5,10,15,20

O ID do nó do qual o nó correspondente ao arquivo depende quando o parâmetro DependentType está definido como USER_DEFINE. Separe vários IDs com vírgulas (,).

O valor deste parâmetro corresponde ao ID do nó especificado após selecionar Previous Cycle e definir Depend On como Other Nodes na seção Dependencies da aba Properties no console do DataWorks.

InputList

String

Não

project_root,project.file1,project.001_out

O nome de saída do arquivo pai do qual o arquivo atual depende. Se especificar vários nomes de saída, separe-os com vírgulas (,).

Este parâmetro corresponde ao parâmetro Parent Nodes exibido após selecionar Same Cycle na seção Dependencies da aba Properties no console do DataWorks.

ProjectIdentifier

String

Não

dw_project

O nome do workspace do DataWorks. Faça login no console do DataWorks e acesse a página Workspace para obter o nome do workspace.

Configure este parâmetro ou o parâmetro ProjectId para determinar o workspace do DataWorks ao qual a operação será aplicada.

FileId

Long

Sim

100000001

O ID do arquivo. Chame a operação ListFiles para obter o ID.

OutputList

String

Não

dw_project.ods_user_info_d

O nome de saída do arquivo atual.

Este parâmetro corresponde ao parâmetro Output na seção Dependencies da aba Properties no console do DataWorks.

ResourceGroupIdentifier

String

Não

default_group

O identificador do grupo de recursos usado para executar o nó correspondente ao arquivo. Chame a operação ListResourceGroups para consultar os grupos de recursos disponíveis no workspace.

ConnectionName

String

Não

odps_source

O nome da fonte de dados usada para executar o nó. Chame a operação ListDataSources para consultar as fontes de dados disponíveis no workspace.

Owner

String

Não

18023848927592

O ID do proprietário do arquivo.

AutoParsing

Boolean

Não

true

Indica se o recurso de análise automática deve ser ativado para o arquivo. Valores válidos:

• true

• false

Este parâmetro corresponde ao parâmetro Automatic Parsing From Code Before Node Committing exibido após selecionar Same Cycle na seção Dependencies da aba Properties no console do DataWorks.

SchedulerType

String

Não

NORMAL

O tipo de agendamento do nó. Valores válidos:

• NORMAL: nó acionado automaticamente.

• MANUAL: nó acionado manualmente. Nós acionados manualmente não podem ser disparados automaticamente e correspondem aos nós no painel Manually Triggered Workflows.

• PAUSE: nó pausado.

• SKIP: execução simulada (dry-run). Esses nós são iniciados conforme o agendamento, mas o sistema define seu status como bem-sucedido assim que começa a executá-los.

AdvancedSettings

String

Não

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

As configurações avançadas do nó.

Este parâmetro é válido apenas para um nó EMR Spark Streaming ou EMR Streaming SQL. Ele corresponde à aba Advanced Settings do nó no console do DataWorks.

O valor deste parâmetro deve estar no formato JSON.

StartImmediately

Boolean

Não

true

Indica se o nó deve ser executado imediatamente após a implantação no ambiente de produção. Valores válidos:

• true

• false

Este parâmetro é válido apenas para um nó EMR Spark Streaming ou EMR Streaming SQL. Ele corresponde ao parâmetro Start Method na seção Schedule da aba Configure no console do DataWorks.

InputParameters

String

Não

[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]

Os parâmetros de entrada do nó. O valor deste parâmetro deve estar no formato JSON. Para mais informações sobre os parâmetros de entrada, consulte o parâmetro InputContextParameterList na seção Response parameters da operação GetFile.

Este parâmetro corresponde à tabela Input Parameters na seção Input and Output Parameters da aba Properties no console do DataWorks.

OutputParameters

String

Não

[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]

Os parâmetros de saída do nó. O valor deste parâmetro deve estar no formato JSON. Para mais informações sobre os parâmetros de saída, consulte o parâmetro OutputContextParameterList na seção Response parameters da operação GetFile.

Este parâmetro corresponde à tabela Output Parameters na seção Input and Output Parameters da aba Properties no console do DataWorks.

IgnoreParentSkipRunningProperty

Boolean

Não

true

Indica se a propriedade de execução simulada (dry-run) dos nós ancestrais deve ser ignorada. Este parâmetro corresponde ao parâmetro Skip the dry-run property of the ancestor node exibido após configurar o parâmetro Depend On na seção Dependencies da aba Properties no console do DataWorks.

HttpStatusCode

Integer

200

O código de status HTTP.

ErrorMessage

String

The connection does not exist.

A mensagem de erro.

RequestId

String

0000-ABCD-EFGH-IJKLMNOPQ

O ID da solicitação.

ErrorCode

String

Invalid.Tenant.ConnectionNotExists

O código de erro.

Success

Boolean

true

Indica se a solicitação foi bem-sucedida. Valores válidos:

• true

• false