Todos os produtos
Search

Este produto

    DataWorks:UpdateWorkflowDefinition

    Central de documentação

    DataWorks:UpdateWorkflowDefinition

    Última atualização: Sep 29, 2026

    Atualiza as informações básicas de um fluxo de trabalho no Data Studio. Esta operação de API realiza uma atualização incremental. As informações de atualização são descritas por meio do FlowSpec.

    Descrição da operação

    Importante

    Esta API não oferece suporte a operações em lote. Se você definir mais de uma definição de fluxo de trabalho no FlowSpec, todas as definições de fluxo de trabalho, exceto a primeira, serão ignoradas. Além disso, os nós definidos na definição do fluxo de trabalho também serão ignorados. Chame a API UpdateNode para atualizar os nós internos um a um.

    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 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 Workspace para consultar o ID.

    10001
    Id

    string

    Sim

    O identificador exclusivo do fluxo de trabalho do Data Studio.

    Nota

    Este campo é do tipo Long nas versões do SDK anteriores à 8.0.0 e do tipo String nas versões do SDK 8.0.0 e posteriores. Essa alteração não afeta o uso normal do SDK; o parâmetro ainda será retornado de acordo com o tipo definido no SDK. No entanto, podem ocorrer falhas de compilação devido à alteração de tipo apenas ao atualizar o SDK para uma versão igual ou superior à 8.0.0. Nesse caso, você deve atualizar manualmente o tipo de dados.

    652567824470354XXXX
    Spec

    string

    Sim

    As informações do FlowSpec que descrevem este fluxo de trabalho. Para obter detalhes da especificação, consulte FlowSpec.

    Esta operação atualiza apenas as informações do próprio fluxo de trabalho. As informações de nós internos descritas no FlowSpec não são atualizadas.

    { "kind": "CycleWorkflow", "version": "1.1.0", "spec": { "workflows": [ { "id": "652567824470354XXXX", "script": { "path": "XX/OpenAPI_Test/Workflow_Test/OpenAPI_Test_Workflow_Demo", "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": "OpenAPI_Test_Workflow_Demo", "outputs": { "nodeOutputs": [ { "data": "workflow_output", "artifactType": "NodeOutput", "refTableName": "OpenAPI_Test_Workflow_Demo" } ] }, "dependencies": [] } ] } }

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Esquema da resposta.

    RequestId

    string

    O ID da solicitação. Você pode localizar logs e solucionar problemas com base no ID.

    20BF7E80-668A-5620-8AD8-879B8FEA****
    Success

    boolean

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

    • true

    • false

    true

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "20BF7E80-668A-5620-8AD8-879B8FEA****",
  "Success": true
}

    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.