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

Importa um nó de fluxo de trabalho definido pelo FlowSpec e seus nós filhos internos para o Data Studio.

Descrição da operação

Importante

Esta operação não oferece suporte à importação de múltiplos fluxos de trabalho. Se mais de um fluxo de trabalho for definido no FlowSpec, todos os fluxos de trabalho após o primeiro serão ignorados.
Esta é uma operação assíncrona. Chamar esta operação retorna um objeto de tarefa assíncrona. Para consultar o status de execução da tarefa, chame GetJobStatus.

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:*

update

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Sim	O ID do espaço de trabalho do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de gerenciamento de espaços de trabalho para obter o ID. Este parâmetro especifica o espaço de trabalho do DataWorks usado para esta chamada de API.	123456
Spec	string	Sim	As informações do FlowSpec que descrevem o fluxo de trabalho. Para obter detalhes sobre a especificação, consulte FlowSpec. Nota Como obter rapidamente um modelo do FlowSpec? Abra um fluxo de trabalho no Data Studio e clique em "Show Spec" no canto superior direito para obter a descrição do FlowSpec do fluxo de trabalho atual. Você pode usar essa descrição do FlowSpec para criar rapidamente um modelo que atenda aos seus requisitos. Nota <notice>Esta operação oferece suporte à criação de um fluxo de trabalho e seus nós internos ao mesmo tempo. Preste atenção aos IDs especificados no FlowSpec. Se um ID especificado já existir, a operação se tornará uma atualização. Somente quando nenhum ID for especificado ou o ID não existir, a operação se tornará uma criação.></notice>	{ "version": "1.1.0", "kind": "CycleWorkflow", "spec": { "name": "Asynchronous_Workflow_Creation_Test", "id": "632647691239009XXXX", "type": "CycleWorkflow", "workflows": [ { "script": { "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test", "runtime": { "command": "WORKFLOW" } }, "id": "632647691239009XXXX", "trigger": { "type": "Scheduler", "cron": "00 03 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "strategy": { "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "failureStrategy": "Break" }, "name": "Asynchronous_Workflow_Creation_Test", "inputs": {}, "outputs": { "nodeOutputs": [ { "data": "632647691239009XXXX", "artifactType": "NodeOutput", "refTableName": "Asynchronous_Workflow_Creation_Test" } ] }, "nodes": [ { "recurrence": "Normal", "id": "742981001612325XXXX", "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "script": { "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test/111", "runtime": { "command": "ODPS_SQL" }, "content": "select now();\n" }, "trigger": { "type": "Scheduler", "cron": "00 24 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "name": "111", "inputs": {}, "outputs": { "nodeOutputs": [ { "data": "742981001612325XXXX", "artifactType": "NodeOutput", "refTableName": "111" } ] } }, { "recurrence": "Normal", "id": "595182137303408XXXX", "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "script": { "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test/222", "runtime": { "command": "ODPS_SQL" }, "content": "select now();\n select 1;" }, "trigger": { "type": "Scheduler", "cron": "00 00 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "name": "222", "inputs": {}, "outputs": { "nodeOutputs": [ { "data": "595182137303408XXXX", "artifactType": "NodeOutput", "refTableName": "222" } ] } } ], "dependencies": [ { "nodeId": "595182137303408XXXX", "depends": [ { "type": "Normal", "output": "742981001612325XXXX", "refTableName": "111" } ] } ] } ] } }
DryRun	boolean	Não	Especifica se esta operação deve ser chamada no modo de validação. Se este parâmetro for definido como true, apenas a validade da especificação do fluxo de trabalho de entrada será validada. A mesma lógica de pré-processamento e validação da importação real é reutilizada (com regras idênticas), mas nenhum dado é persistido e nenhuma operação de gravação é executada. O resultado da validação é retornado por meio de uma tarefa assíncrona. Se a validação falhar, a tarefa assíncrona falhará, e os detalhes do erro incluirão o código de erro, a mensagem de erro e um JSONPath que localiza o nó específico (como $.spec.workflows[0].nodes[1]). Valor padrão: false. Nesse caso, o fluxo de trabalho é importado normalmente.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O esquema da resposta.
RequestId	string	O ID da solicitação. Você pode usar este ID para solucionar problemas.	7C352CB7-CD88-50CF-9D0D-E81BDF020E7F
AsyncJob	object	As informações de status da tarefa assíncrona.
Completed	boolean	Indica se a tarefa assíncrona foi concluída.	false
CreateTime	integer	O timestamp em que a tarefa assíncrona foi criada.	1706581425000
Error	string	A mensagem de erro quando a tarefa assíncrona falha.	target folder already exists: XXXX
Id	string	O ID da tarefa assíncrona.	1234567691239009XXXX
Progress	integer	O progresso da tarefa assíncrona. Valores válidos: 0 a 100.	0
Response	string	O conteúdo que a tarefa assíncrona deve retornar. Nota Atualmente, este campo armazena o ID do fluxo de trabalho criado na tarefa assíncrona.	632647691239009XXXX
Status	string	O status da tarefa assíncrona. Valores válidos: Running: A tarefa está em execução. Success: A tarefa foi bem-sucedida. Fail: A tarefa falhou. Cancel: A tarefa foi cancelada.	Running
Type	string	O tipo de operação da tarefa assíncrona. Valores válidos: Create: cria um recurso. Cancel: cancela uma tarefa de criação.	Create

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF020E7F.",
  "AsyncJob": {
    "Completed": true,
    "CreateTime": 1706581425000,
    "Error": "target folder already exists: XXXX.",
    "Id": "1234567691239009XXXX.",
    "Progress": 0,
    "Response": "632647691239009XXXX.",
    "Status": "Running.",
    "Type": "Create."
  }
}

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.