Todos os produtos
Search
Central de documentação

DataWorks:CreateWorkflowDefinition

Última atualização: Oct 20, 2026

Cria um fluxo de trabalho em um diretório especificado no Data Studio.

Descrição da operação

Importante Esta operação não oferece suporte a operações em lote. Se mais de um fluxo de trabalho for definido no FlowSpec, todos os fluxos de trabalho, exceto o primeiro, serão ignorados. Além disso, os nós definidos dentro do fluxo de trabalho também são ignorados diretamente. Chame a operação CreateNode para criar os nós internos um por um.

Esta operação faz parte dos novos recursos do Data Studio e aplica-se apenas a workspaces que utilizam o novo Data Studio. Se você não utiliza o novo Data Studio, use a operação correspondente da versão 2020-05-18.

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

create

*All resources.

*

Nenhuma Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

ProjectId

integer

Sim

O ID do workspace do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de Configuração do Workspace para obter o ID do workspace. Você também pode chamar a operação ListProjects para consultar o ID do workspace do locatário atual.

10000

Spec

string

Sim

As informações do FlowSpec que descrevem o fluxo de trabalho. Para obter mais informações sobre as especificações, consulte FlowSpec.\n\n> Como obter rapidamente um modelo de FlowSpec?\n> - 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 criar rapidamente um modelo compatível com base nesta descrição do FlowSpec.\n\n

Importante Esta operação oferece suporte apenas à criação de fluxos de trabalho. Os nós internos descritos no FlowSpec não são criados.

{ "kind": "CycleWorkflow", "version": "1.1.0", "spec": { "name": "OpenAPITestWorkflowDemo", "type": "CycleWorkflow", "workflows": [ { "script": { "path": "XX/OpenAPITest/WorkflowTest/OpenAPITestWorkflowDemo", "runtime": { "command": "WORKFLOW" } }, "trigger": { "type": "Scheduler", "cron": "00 02 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": "OpenAPITestWorkflowDemo", "outputs": { "nodeOutputs": [ { "data": "workflow_output", "artifactType": "NodeOutput", "refTableName": "OpenAPITestWorkflowDemo" } ] }, "dependencies": [] } ] } }

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Esquema da resposta.

RequestId

string

O ID da solicitação. Você pode usar o ID para localizar logs e solucionar problemas.

0EF298E5-0940-5AC7-9CB0-6502507****

Id

string

O identificador exclusivo do fluxo de trabalho do Data Studio.\n\n

Importante Este campo é do tipo Long antes do SDK 8.0.0 e do tipo String no SDK 8.0.0 e posterior. Essa alteração não afeta o uso normal do SDK, e o parâmetro ainda é retornado com base no tipo definido no SDK. A alteração de tipo pode causar falhas na compilação do projeto apenas quando você atualiza o SDK para uma versão posterior à 8.0.0. Nesse caso, você deve corrigir manualmente o tipo de dados.

463497880880954XXXX

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0EF298E5-0940-5AC7-9CB0-6502507****",
  "Id": "463497880880954XXXX"
}

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.