CreateWorkflowInstances - DataWorks: Central de Documentação do Alibaba Cloud

Cria uma instância de workflow com base em configurações, como uma instância de workflow de backfill de dados.

Descrição da operação

Você deve adquirir o DataWorks Basic Edition ou uma edição superior para usar este recurso.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dataworks:CreateWorkflowInstances

create

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Sim	O ID do projeto.	100
EnvType	string	Não	O ambiente do projeto. Valores válidos: Prod: produção Dev: desenvolvimento Valores válidos: Prod : produção. Dev : desenvolvimento.	Prod
WorkflowId	integer	Sim	O ID do workflow. O WorkflowId de uma tarefa agendada é sempre 1.	1
Name	string	Sim	O nome.	WorkflowInstance1
Periods	object	Não	As configurações de período de backfill de dados.
BizDates	array<object>	Sim	A lista de datas de negócio. Você pode especificar vários intervalos de datas de negócio, até um máximo de 7 intervalos.
	object	Não
EndBizDate	string	Sim	A data de negócio final. Formato: yyyy-mm-dd.	2024-11-24
StartBizDate	string	Sim	A data de negócio inicial. Formato: yyyy-mm-dd.	2024-11-20
EndTime	string	Não	A hora final do período. Especifique a hora no formato hh:mm:ss com base no relógio de 24 horas. Valor padrão: 23:59:59. Se você especificar este campo, também deverá especificar StartTime.	23:59:59
StartTime	string	Não	A hora inicial do período. Especifique a hora no formato hh:mm:ss com base no relógio de 24 horas. Valor padrão: 00:00:00. Se você especificar este campo, também deverá especificar EndTime.	00:00:00
Type	string	Sim	O tipo da instância de workflow. Valores válidos: SupplementData: backfill de dados. Os métodos para especificar RootTaskIds e IncludeTaskIds variam de acordo com o modo de backfill de dados. Para obter mais informações, consulte a descrição do parâmetro DefaultRunProperties.Mode. ManualWorkflow: workflow acionado manualmente. Você deve definir WorkflowId como o ID do workflow acionado manualmente. RootTaskIds é opcional. Se você não especificar RootTaskIds, a lista de nós raiz padrão do workflow acionado manualmente será usada. Manual: tarefa acionada manualmente. Você só precisa especificar RootTaskIds, que é a lista de tarefas acionadas manualmente a serem executadas. SmokeTest: teste de fumaça. Você só precisa especificar RootTaskIds, que é a lista de tarefas de teste a serem executadas. TriggerWorkflow: workflow acionado por evento. Você deve definir WorkflowId como o ID do workflow acionado por evento. IncludeTaskIds é opcional. Se você não especificar IncludeTaskIds, todo o workflow será executado. Valores válidos: SmokeTest : Teste de fumaça. Você só precisa especificar RootTaskIds, que é a lista de tarefas de teste a serem executadas. TriggerWorkflow : Workflow acionado por evento. Você deve definir WorkflowId como o ID do workflow acionado por evento. IncludeTaskIds é opcional. Se você não especificar IncludeTaskIds, todo o workflow será executado. Manual : Tarefa acionada manualmente. Você só precisa especificar RootTaskIds, que é a lista de tarefas acionadas manualmente a serem executadas. SupplementData : Backfill de dados. Os métodos para especificar RootTaskIds e IncludeTaskIds variam de acordo com o modo de backfill de dados. Para obter mais informações, consulte a descrição do parâmetro DefaultRunProperties.Mode. ManualWorkflow : Workflow acionado manualmente. Você deve definir WorkflowId como o ID do workflow acionado manualmente. RootTaskIds é opcional. Se você não especificar RootTaskIds, a lista de nós raiz padrão do workflow acionado manualmente será usada.	SupplementData
WorkflowParameters	string	Não	Os parâmetros do workflow. Este parâmetro entra em vigor apenas quando um workflow específico é especificado (WorkflowId != 1). Para um workflow periódico ou um workflow acionado por evento, o formato é chave=valor, e a prioridade é menor que a dos parâmetros da tarefa. Para um workflow acionado manualmente, o formato é JSON, e a prioridade é maior que a dos parâmetros da tarefa.	"key=value" format: key1=value1 key2=value2 JSON format: {"key1":"value1", "key2": "value2"}
TaskParameters	string	Não	Os parâmetros da tarefa, que são usados para definir parâmetros para tarefas específicas. O valor está no formato JSON. A chave é o ID da tarefa, e o formato do valor refere-se aos parâmetros do script da tarefa (Task.Script.Parameter na resposta da operação GetTask).	{ "1001": "key1=val2 key2=val2", "1002": "key1=val2 key2=val2" }
AutoStartEnabled	boolean	Não	Especifica se a instância de workflow deve ser executada imediatamente após a sua criação. Valor padrão: true.	true
DefaultRunProperties	object	Não	As configurações de tempo de execução.
Alert	object	Não	As configurações de alerta.
NoticeType	string	Não	O método de notificação. Valores válidos: Sms: apenas mensagem de texto Mail: apenas e-mail SmsMail: mensagem de texto e e-mail Valores válidos: Mail : apenas e-mail. Sms : apenas mensagem de texto. SmsMail : mensagem de texto e e-mail.	Sms
Type	string	Não	A política de alerta. Valores válidos: Success: alerta em caso de sucesso Failure: alerta em caso de falha SuccessFailure: alerta em caso de sucesso e falha Valores válidos: SuccessFailure : Alerta em caso de sucesso e falha. Failure : Alerta em caso de falha. Success : Alerta em caso de sucesso.	Succes
Analysis	object	Não	As configurações de análise. Este parâmetro é obrigatório quando Type é definido como SupplementData.
Blocked	boolean	Não	Especifica se a execução deve ser bloqueada se a análise falhar. Este parâmetro é obrigatório quando Type é definido como SupplementData.	true
Enabled	boolean	Não	Especifica se a análise deve ser ativada. Este parâmetro é obrigatório quando Type é definido como SupplementData.	true
DataSourceNameMappings	object	Não	Os mapeamentos de nomes de fontes de dados para execuções de backfill de dados. A chave do mapa é o DataSource.Name na definição da tarefa, e o valor é o DataSource.Name usado durante as execuções de backfill de dados. Este parâmetro entra em vigor apenas quando Type é definido como SupplementData. Se este parâmetro não for configurado, um mapa vazio for passado ou a chave não for correspondida, a tarefa continuará a usar a fonte de dados original. Atualmente, apenas as tarefas EMR Spark SQL, EMR Shell e EMR Spark são suportadas.
	string	Não	O nome da fonte de dados configurado na definição da tarefa, que é DataSource.Name.	emr_cluster
ExcludeProjectIds	array	Não	A lista de IDs de projetos a serem excluídos da execução.
	integer	Não	O ID do projeto.	200
ExcludeTaskIds	array	Não	A lista de IDs de tarefas a serem excluídos da execução.
	integer	Não	O ID da tarefa.	4321
IncludeProjectIds	array	Não	A lista de IDs de projetos a serem incluídos na execução.
	integer	Não	O ID do projeto.	100
IncludeTaskIds	array	Não	A lista de IDs de tarefas a serem incluídos na execução.
	integer	Não	O ID da tarefa.	1234
Mode	string	Não	O modo de backfill de dados. Valor padrão: ManualSelection. Este parâmetro é obrigatório quando Type é definido como SupplementData. Valores válidos: General: modo geral. Você pode especificar apenas um valor para RootTaskIds. IncludeTaskIds é opcional. Se você não especificar IncludeTaskIds, o valor de RootTaskIds será incluído por padrão. ManualSelection: modo de seleção manual. Você pode especificar vários valores para RootTaskIds. IncludeTaskIds é opcional. Se você não especificar IncludeTaskIds, os valores de RootTaskIds serão incluídos por padrão. Chain: modo de cadeia. RootTaskIds deve ser deixado vazio. Você deve especificar dois IDs para IncludeTaskIds, que são as tarefas inicial e final. AllDownstream: modo de todos os downstreams. Você pode especificar apenas um valor para RootTaskIds. Valores válidos: Chain : modo de cadeia. ManualSelection : seleção manual. General : modo geral. Huge : modo huge. AllDownstream : todos os downstreams.	ManualSelection
Order	string	Não	A ordem de execução. Valor padrão: Asc. Valores válidos: Asc: ordem crescente por data de negócio Desc: ordem decrescente por data de negócio Valores válidos: Asc : ordem crescente por data de negócio. Desc : ordem decrescente por data de negócio.	Asc
Parallelism	integer	Não	O número de tarefas paralelas. Um valor de 2 a 10 indica o paralelismo, e um valor de 1 indica execução em série. Este parâmetro é obrigatório quando Type é definido como SupplementData.	2
Priority	integer	Não	A prioridade de execução. Valores válidos: 1 a 11. Um valor maior indica uma prioridade mais alta. Essas configurações de parâmetro são suportadas apenas para workflows acionados manualmente e workflows acionados por evento.	1
PriorityWeightStrategy	string	Não	A política de peso de prioridade. Essas configurações de parâmetro são suportadas apenas para workflows acionados manualmente e workflows acionados por evento. Valores válidos: Disable: desativado. Este é o valor padrão. Upstream: calcula a soma dos pesos dos nós upstream para o nó atual. Uma hierarquia mais profunda indica um peso maior. Valores válidos: Upstream : por peso de upstream. Disable : desativado.	Upstream
RootTaskIds	array	Não	A lista de IDs de tarefas raiz. Quando Type é definido como SupplementData, RootTaskIds é obrigatório, exceto quando Mode é definido como Chain. Quando Type é definido como ManualWorkflow, RootTaskIds é opcional. Se você não especificar RootTaskIds, a lista de nós raiz padrão do workflow acionado manualmente será usada. Quando Type é definido como Manual, RootTaskIds é obrigatório e especifica a lista de tarefas manuais a serem executadas. Quando Type é definido como SmokeTest, RootTaskIds é obrigatório e especifica a lista de tarefas de teste a serem executadas.
	integer	Não	O ID da tarefa.	1234
RunPolicy	object	Não	A política de execução. Se este campo for deixado vazio, a configuração da tarefa será usada.
EndTime	string	Não	A hora final da execução. Especifique a hora no formato hh:mm:ss com base no relógio de 24 horas. Este campo é obrigatório se você configurar uma política de execução.	23:59:59
Immediately	boolean	Não	Especifica se a execução pode ser iniciada imediatamente se o horário de execução estiver no futuro. Valor padrão: false.	false
StartTime	string	Não	A hora inicial da execução. Especifique a hora no formato hh:mm:ss com base no relógio de 24 horas. Este campo é obrigatório se você configurar uma política de execução.	00:00:00
Type	string	Não	O tipo de período. Este campo é obrigatório se você configurar uma política de execução. Valores válidos: Daily: todos os dias Weekend: apenas fins de semana Valores válidos: Daily : todos os dias. Weekend : apenas fins de semana.	Daily
RuntimeResource	string	Não	O identificador do grupo de recursos de agendamento personalizado. Se este campo for deixado vazio, a configuração da tarefa será usada.	S_res_group_524258031846018_1684XXXXXXXXX
Comment	string	Não	O motivo da criação.	create for test
Tags	array<object>	Não	A lista de tags da tarefa.
	object	Não
Key	string	Não	A chave da tag.	tagKey
Value	string	Não	O valor da tag.	tagValue
TagCreationPolicy	string	Não	A política de criação de tags. Valores válidos: Append: Modo de anexação. Herda as tags existentes do fluxo de trabalho manual e anexa novas tags. Overwrite: Modo de substituição. Não herda as tags existentes do fluxo de trabalho manual e cria tags diretamente. Valores válidos: Overwrite : Modo de substituição. Não herda as tags existentes do fluxo de trabalho manual e cria tags diretamente. Append : Modo de anexação. Herda as tags existentes do fluxo de trabalho manual e anexa novas tags.	Append

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
OperationId	string	O ID da operação. Você pode usar este campo para consultar o resultado da operação de criação chamando a operação GetCreateWorkflowInstancesResult.	e15ad21c-b0e9-4792-8f55-b037xxxxxxxx
RequestId	string	O ID da solicitação. Você pode usar este ID para localizar logs e solucionar problemas.	22C97E95-F023-56B5-8852-B1A77A17XXXX

Exemplos

Resposta de sucesso

JSON formato

{
  "OperationId": "e15ad21c-b0e9-4792-8f55-b037xxxxxxxx",
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.