Todos os produtos
Search

Este produto

    DataWorks:UpdateDIJob

    Central de documentação

    DataWorks:UpdateDIJob

    Última atualização: Jun 26, 2026

    Atualiza uma tarefa do Data Integration.

    Descrição da operação

    Este recurso requer o DataWorks Basic Edition ou superior.

    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

    Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    Id

    integer

    Não

    O ID do trabalho de sincronização.

    11588
    Description

    string

    Não

    A descrição do trabalho de sincronização.

    DI Job Demo
    TableMappings

    array<object>

    Não

    Uma lista de mapeamentos de transformação de objetos. Cada mapeamento especifica um conjunto de regras de seleção para objetos de origem e uma lista de regras de transformação que se aplicam aos objetos selecionados.

    Nota

    [ { "SourceObjectSelectionRules":[ { "ObjectType":"Database", "Action":"Include", "ExpressionType":"Exact", "Expression":"biz_db" }, { "ObjectType":"Schema", "Action":"Include", "ExpressionType":"Exact", "Expression":"s1" }, { "ObjectType":"Table", "Action":"Include", "ExpressionType":"Exact", "Expression":"table1" } ], "TransformationRuleNames":[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema" } ] } ].

    array<object>

    Não

    Um único mapeamento de transformação de objeto, que especifica um conjunto de regras de seleção para objetos de origem e uma lista de regras de transformação a serem aplicadas a esses objetos.

    SourceObjectSelectionRules

    array<object>

    Não

    As regras para seleção de objetos de origem. Cada regra pode selecionar um tipo diferente de objeto de origem para sincronizar, como um banco de dados ou tabela de origem.

    object

    Não

    Uma regra para selecionar um objeto de origem a ser sincronizado, como um banco de dados ou tabela.

    Action

    string

    Não

    A ação de seleção. Valores válidos: Include e Exclude.

    Include
    Expression

    string

    Não

    A expressão.

    mysql_table_1
    ExpressionType

    string

    Não

    O tipo da expressão. Valores válidos: Exact e Regex.

    Exact
    ObjectType

    string

    Não

    O tipo de objeto. Valores válidos:

    • Table (tabela)

    • Schema (schema)

    • Database (banco de dados).

    Table
    TransformationRules

    array<object>

    Não

    As regras de transformação para os objetos de origem.

    object

    Não

    Uma única regra de transformação para um objeto de origem.

    RuleName

    string

    Não

    O nome da regra de transformação. O nome deve ser exclusivo para uma combinação específica de RuleActionType e RuleTargetType e pode ter até 50 caracteres.

    rename_rule_1
    RuleActionType

    string

    Não

    O tipo da ação. Valores válidos:

    • DefinePrimaryKey: Define uma chave primária.

    • Rename: Renomeia um objeto.

    • AddColumn: Adiciona uma coluna.

    • HandleDml: Trata operações DML.

    Rename
    RuleTargetType

    string

    Não

    O tipo do objeto de destino. Valores válidos:

    • Table (tabela)

    • Schema (schema)

    • Database (banco de dados).

    Table
    JobSettings

    object

    Não

    As configurações do trabalho de sincronização. Isso inclui configurações de tratamento de DDL, mapeamentos de tipo de dados para colunas entre a origem e o destino, e parâmetros de tempo de execução.

    ChannelSettings

    string

    Não

    As configurações de trabalho para canais específicos de sincronização de dados. Você pode aplicar configurações especiais a determinados canais. Atualmente, Holo2Holo (sincronização do Hologres para o Hologres) e Holo2Kafka (sincronização do Hologres para o Kafka) são suportados.

    1. Holo2Kafka

    • Exemplo: {"destinationChannelSettings":{"kafkaClientProperties":[{"key":"linger.ms","value":"100"}],"keyColumns":["col3"],"writeMode":"canal"}} kafkaClientProperties: Os parâmetros do produtor Kafka usados ao gravar no Kafka.

    • keyColumns: As colunas cujos valores são gravados na chave de uma mensagem do Kafka.

    • writeMode: O formato para gravar dados no Kafka. Valores válidos: json e canal.

    1. Holo2Holo

    • Exemplo: {"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}

    • conflictMode: A política de tratamento de conflitos para gravar dados no Hologres. Valores válidos: replace (substituir) e ignore (ignorar).

    • writeMode: O método para gravar dados no Hologres. Valores válidos: replay e insert.

    • dynamicColumnAction: A ação para tratar colunas dinâmicas ao gravar dados no Hologres. Valores válidos: replay, insert e ignore.

    { "structInfo": "MANAGED", "storageType": "TEXTFILE", "writeMode": "APPEND", "partitionColumns": [ { "columnName": "pt", "columnType": "STRING", "comment": "" } ], "fieldDelimiter": "" }
    ColumnDataTypeSettings

    array<object>

    Não

    Uma matriz de mapeamentos de tipo de dados de coluna.

    Nota

    ["ColumnDataTypeSettings":[ { "SourceDataType":"Bigint", "DestinationDataType":"Text" } ].

    object

    Não

    Um único mapeamento de tipo de dados de coluna.

    DestinationDataType

    string

    Não

    O tipo de dados de destino. Exemplos: bigint, boolean, string, text, datetime, timestamp, decimal e binary. Os tipos de dados suportados dependem da fonte de dados de destino.

    text
    SourceDataType

    string

    Não

    O tipo de dados de origem. Exemplos: bigint, boolean, string, text, datetime, timestamp, decimal e binary. Os tipos de dados suportados dependem da fonte de dados de origem.

    bigint
    CycleScheduleSettings

    object

    Não

    As configurações para agendamento periódico.

    ScheduleParameters

    string

    Não

    Os parâmetros de agendamento.

    bizdate=$bizdate

    DdlHandlingSettings

    array<object>

    Não

    Uma matriz de configurações de tratamento de DDL.

    Nota

    ["DDLHandlingSettings":[ { "Type":"Insert", "Action":"Normal" } ].

    object

    Não

    Uma única configuração de tratamento de DDL.

    Action

    string

    Não

    A ação de tratamento. Valores válidos:

    • Ignore: Ignora a mensagem DDL.

    • Critical: Relata um erro e encerra o trabalho de sincronização.

    • Normal: Processa a mensagem DDL normalmente.

    Critical
    Type

    string

    Não

    O tipo de DDL. Valores válidos:

    • RenameColumn

    • ModifyColumn

    • CreateTable

    • TruncateTable

    • DropTable

    • DropColumn

    • AddColumn.

    AddColumn
    RuntimeSettings

    array<object>

    Não

    As configurações de tempo de execução.

    object

    Não

    Uma única configuração de tempo de execução.

    Name

    string

    Não

    O nome da configuração. Valores válidos:

    • src.offline.datasource.max.connection: O número máximo de conexões simultâneas com a origem para um trabalho de sincronização offline.

    • dst.offline.truncate: Especifica se a tabela de destino deve ser truncada antes de um trabalho de sincronização offline.

    • runtime.offline.speed.limit.enable: Especifica se o limite de velocidade deve ser ativado para um trabalho de sincronização offline.

    • runtime.offline.concurrent: O nível de simultaneidade para um trabalho de sincronização offline.

    • runtime.enable.auto.create.schema: Especifica se um schema deve ser criado automaticamente no destino.

    • runtime.realtime.concurrent: O nível de simultaneidade para um trabalho de sincronização em tempo real.

    • runtime.realtime.failover.minute.dataxcdc: O número de minutos a aguardar antes de uma nova tentativa de failover.

    • runtime.realtime.failover.times.dataxcdc: O número de novas tentativas de failover.

    src.offline.datasource.max.connection
    Value

    string

    Não

    O valor da configuração.

    1
    ResourceSettings

    object

    Não

    As configurações de recursos.

    OfflineResourceSettings

    object

    Não

    As configurações de recursos para o trabalho de sincronização offline.

    RequestedCu

    number

    Não

    O número de CUs para o grupo de recursos do Data Integration usado pelo trabalho de sincronização offline.

    2
    ResourceGroupIdentifier

    string

    Não

    O nome do grupo de recursos do Data Integration usado pelo trabalho de sincronização offline.

    S_res_group_111_222
    RealtimeResourceSettings

    object

    Não

    As configurações de recursos para o trabalho de sincronização em tempo real.

    RequestedCu

    number

    Não

    O número de CUs para o grupo de recursos do Data Integration usado pelo trabalho de sincronização em tempo real.

    2
    ResourceGroupIdentifier

    string

    Não

    O nome do grupo de recursos do Data Integration usado pelo trabalho de sincronização em tempo real.

    S_res_group_111_222
    ScheduleResourceSettings

    object

    Não

    As configurações de recursos de agendamento.

    RequestedCu

    number

    Não

    O número de CUs para o grupo de recursos de agendamento usado pelo trabalho de sincronização offline.

    2
    ResourceGroupIdentifier

    string

    Não

    O nome do grupo de recursos de agendamento usado pelo trabalho de sincronização offline.

    S_res_group_222_333
    TransformationRules

    array<object>

    Não

    Uma lista de definições de regras de transformação.

    Nota

    [ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema", "RuleExpression":"{"expression":"${srcDatasoureName}_${srcDatabaseName}"}" } ].

    object

    Não

    Uma única definição de regra de transformação.

    RuleActionType

    string

    Não

    O tipo da ação. Valores válidos:

    • DefinePrimaryKey: Define uma chave primária.

    • Rename: Renomeia um objeto.

    • AddColumn: Adiciona uma coluna.

    • HandleDml: Trata operações DML.

    • DefineIncrementalCondition: Define uma condição incremental.

    • DefineCycleScheduleSettings: Define configurações de agendamento periódico.

    • DefinePartitionKey: Define uma chave de partição.

    Rename
    RuleExpression

    string

    Não

    A expressão da regra, especificada como uma string JSON.

    1. Regra de renomeação (Rename)

    • Exemplo: {"expression":"${srcDatasourceName}_${srcDatabaseName}_0922"}

    • expression: A expressão para a regra de transformação de renomeação. A expressão suporta variáveis, incluindo ${srcDatasourceName} (nome da fonte de dados de origem), ${srcDatabaseName} (nome do banco de dados de origem) e ${srcTableName} (nome da tabela de origem).

    1. Regra de adição de coluna (AddColumn)

    • Exemplo: {"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}

    • Se esta regra não for especificada, nenhuma coluna será adicionada.

    • columnName: O nome da coluna a ser adicionada.

    • columnValueType: O tipo de valor da coluna adicionada. Valores válidos: Constant e Variable.

    • columnValue: O valor da coluna adicionada. Se columnValueType for Constant, o valor é uma constante personalizada do tipo string. Se columnValueType for Variable, o valor é uma variável integrada. Variáveis integradas válidas: EXECUTE_TIME (tempo de execução, tipo Long), DB_NAME_SRC (nome do banco de dados de origem, tipo String), DATASOURCE_NAME_SRC (nome da fonte de dados de origem, tipo String), TABLE_NAME_SRC (nome da tabela de origem, tipo String), DB_NAME_DEST (nome do banco de dados de destino, tipo String), DATASOURCE_NAME_DEST (nome da fonte de dados de destino, tipo String), TABLE_NAME_DEST (nome da tabela de destino, tipo String) e DB_NAME_SRC_TRANSED (nome do banco de dados transformado, tipo String).

    1. Regra de definição de chave primária (DefinePrimaryKey)

    • Exemplo: {"columns":["ukcolumn1","ukcolumn2"]}

    • Se esta regra não for especificada, a chave primária da origem será usada por padrão.

    • O Data Integration não modifica a estrutura de uma tabela de destino existente. Se uma coluna de chave primária especificada não existir na tabela, o trabalho de sincronização falhará.

    • Quando uma tabela de destino é criada automaticamente, o Data Integration inclui as colunas de chave primária definidas na estrutura. Se uma coluna de chave primária especificada não estiver no conjunto de colunas de destino, o trabalho de sincronização falhará.

    1. Regra de tratamento de DML (HandleDml)

    • Exemplo: {"dmlPolicies":[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}

    • Se esta regra não for especificada, a ação padrão para as operações Insert, Update e Delete será Normal.

    • dmlType: O tipo de operação DML. Valores válidos: Insert, Update e Delete.

    • dmlAction: A política de tratamento de DML. Valores válidos: Normal (processar a operação), Ignore (ignorar a operação), Filter (processar a operação condicionalmente, usado quando dmlType é Update ou Delete) e LogicalDelete (executar uma exclusão lógica).

    • filterCondition: A condição de filtro DML, usada quando dmlAction é Filter.

    1. Regra de condição incremental (DefineIncrementalCondition)

    • Exemplo: {"where":"id > 0"}

    • A cláusula WHERE para a condição incremental.

    1. Regra de agendamento periódico (DefineCycleScheduleSettings)

    • Exemplo: {"cronExpress":" * * * * * *", "cycleType":"1"}

    • Especifica os parâmetros de agendamento para um trabalho periódico.

    1. Regra de definição de chave de partição (DefinePartitionKey)

    • Exemplo: {"columns":["id"]}

    • Especifica a chave de partição.

    {"expression":"${srcDatasoureName}_${srcDatabaseName}"}
    RuleName

    string

    Não

    O nome da regra de transformação. O nome deve ser exclusivo para uma combinação específica de RuleActionType e RuleTargetType e pode ter até 50 caracteres.

    rename_rule_1
    RuleTargetType

    string

    Não

    O tipo do objeto de destino. Valores válidos:

    • Table (tabela)

    • Schema (schema)

    • Database (banco de dados).

    Table
    ProjectId

    integer

    Não

    O ID do workspace do DataWorks. Você pode chamar a operação ListProjects para obter o ID do workspace.

    10000
    DIJobId deprecated

    integer

    Não

    Este parâmetro foi descontinuado. Use o parâmetro Id em seu lugar.

    11588
    Owner

    string

    Não

    O proprietário do trabalho de sincronização.

    95279527
    FileSpec

    string

    Não

    A configuração do trabalho no modo de script.

    { "resourceSettings": { "realtimeResourceSettings": { "requestedCu": 2, "resourceGroupIdentifier": "Serverless_res_group_123_456" }, "offlineResourceSettings": { "requestedCu": 2, "resourceGroupIdentifier": "Serverless_res_group_123_456" } }, "tableMappings": [ { "sourceObjectSelectionRules": [ { "expression": "autotest_hologres", "action": "Include", "expressionType": "Exact", "objectType": "Datasource" }, { "expression": "auto_holo_2661647", "action": "Include", "expressionType": "Exact", "objectType": "Table" }, { "expression": "public", "action": "Include", "expressionType": "Exact", "objectType": "Schema" } ], "transformationRules": [ { "ruleTargetType": "Table", "ruleActionType": "SourceSchema", "ruleName": "SourceSchema_Table_BStf8aXPSCJjOWGe" }, { "ruleTargetType": "Schema", "ruleActionType": "Rename", "ruleName": "Rename_Schema_3qWNOIsljtInvKJy" }, { "ruleTargetType": "Table", "ruleActionType": "Rename", "ruleName": "Rename_Table_o3PVQq1aIKDGoVVW" }, { "ruleTargetType": "Table", "ruleActionType": "DefineDstTableSettings", "ruleName": "DefineDstTableSettings_Table_BhJltOmOCIc81fzi" }, { "ruleTargetType": "Table", "ruleActionType": "ColumnMapping", "ruleName": "ColumnMapping_Table_nP4hJPX1wh2W3fpo" } ] } ], "sourceDataSourceSettings": [ { "dataSourceProperties": { "timeZone": "Asia/Shanghai" }, "dataSourceName": "autotest_hologres" } ], "jobSettings": { "runtimeSettings": [ ], "ddlHandlingSettings": [ ], "columnDataTypeSettings": [ ], "cycleScheduleSettings": { }, "channelSettings": { "destinationChannelSettings": { "conflictMode": "replace", "dynamicColumnAction": "replay", "writeMode": "replay" }, "sourceChannelSettings": { } } }, "destinationDataSourceType": "Hologres", "transformationRules": [ { "ruleTargetType": "Table", "ruleName": "SourceSchema_Table_BStf8aXPSCJjOWGe", "ruleActionType": "SourceSchema", "ruleExpression": { "columns": [ { "name": "id", "category": "normal", "type": "BIGINT" }, { "name": "decimal", "category": "normal", "type": "DECIMAL" } ] } }, { "ruleTargetType": "Schema", "ruleName": "Rename_Schema_3qWNOIsljtInvKJy", "ruleActionType": "Rename", "ruleExpression": { "expression": "public" } }, { "ruleTargetType": "Table", "ruleName": "Rename_Table_o3PVQq1aIKDGoVVW", "ruleActionType": "Rename", "ruleExpression": { "expression": "auto_holo_2661647_dst" } }, { "ruleTargetType": "Table", "ruleName": "DefineDstTableSettings_Table_BhJltOmOCIc81fzi", "ruleActionType": "DefineDstTableSettings", "ruleExpression": { "ddlString": "BEGIN; CREATE TABLE IF NOT EXISTS public.auto_holo_2661647_dst ( id BIGINT PRIMARY KEY, "decimal" DECIMAL(38,18) ); CALL SET_TABLE_PROPERTY('public.auto_holo_2661647_dst', 'time_to_live_in_seconds', '3153600000'); CALL SET_TABLE_PROPERTY('public.auto_holo_2661647_dst', 'orientation', 'column'); CALL SET_TABLE_PROPERTY('public.auto_holo_2661647_dst', 'binlog.level', 'replica'); CALL SET_TABLE_PROPERTY('public.auto_holo_2661647_dst', 'binlog.ttl', '2592000'); CALL SET_TABLE_PROPERTY('public.auto_holo_2661647_dst', 'bitmap_columns', '"text","char","varchar"'); CALL SET_TABLE_PROPERTY('public.auto_holo_2661647_dst', 'dictionary_encoding_columns', '"text":auto,"bytea":auto,"char":auto,"varchar":auto'); CALL SET_TABLE_PROPERTY('public.auto_holo_2661647_dst', 'distribution_key', '"id"'); COMMIT; ", "ddlType": "STRUCT" } }, { "ruleTargetType": "Table", "ruleName": "ColumnMapping_Table_nP4hJPX1wh2W3fpo", "ruleActionType": "ColumnMapping", "ruleExpression": { "columnMapping": [ { "sourceColName": "id", "dstColName": "id" }, { "sourceColName": "decimal", "dstColName": "decimal" } ] } } ], "migrationType": "FullAndRealtimeIncremental", "destinationDataSourceSettings": [ { "dataSourceProperties": { }, "dataSourceName": "autotest_hologres" } ], "sourceDataSourceType": "Hologres" }

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    O schema da resposta.

    Success

    boolean

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

    • true: A solicitação foi bem-sucedida.

    • false: A solicitação falhou.

    true
    RequestId

    string

    O ID da solicitação. Você pode usar este ID para solucionar problemas.

    AAC30B35-820D-5F3E-A42C-E96BB****

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "Success": true,
  "RequestId": "AAC30B35-820D-5F3E-A42C-E96BB****"
}

    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.