Todos os produtos
Search
Central de documentação

DataWorks:GetDIJob

Última atualização: Sep 29, 2026

Consulta as informações sobre uma tarefa de sincronização de nova versão criada no Data Integration. Os seguintes tipos de tarefas de sincronização são suportados: sincronização em tempo real de todos os dados em um banco de dados MySQL para o Hologres.

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

get

*全部资源

*

Nenhuma Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

DIJobId

integer

Sim

O ID da tarefa de sincronização.

11588

WithDetails

boolean

Não

Especifica se devem ser retornadas informações detalhadas de configuração, incluindo TransformationRules, TableMappings e JobSettings. Valores válidos: true e false. Valor padrão: true.

true

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

O resultado retornado.

Data

object

As informações sobre a tarefa de sincronização.

ProjectId

integer

O ID do workspace.

22

DIJobId

integer

O ID da tarefa de sincronização.

11588

JobName

string

O nome da tarefa de sincronização.

mysql_to_holo_sync_445

Description

string

A descrição da tarefa de sincronização.

Synchronize mysql to hologres

MigrationType

string

O tipo de sincronização. Valores válidos:

  • FullAndRealtimeIncremental: sincronização completa única e sincronização incremental em tempo real

  • RealtimeIncremental: sincronização incremental em tempo real

  • Full: sincronização completa

  • OfflineIncremental: sincronização incremental em lote

  • FullAndOfflineIncremental: sincronização completa única e sincronização incremental em lote

FullAndRealtimeIncremental

SourceDataSourceType

string

O tipo de origem. O valor MySQL é retornado.

MySQL

DestinationDataSourceType

string

O tipo de destino. Valores válidos: Hologres e Hive.

Hologres

SourceDataSourceSettings

array<object>

As configurações da origem. Apenas uma única origem é suportada.

array<object>

As configurações da fonte de dados de origem.

DataSourceName

string

O nome da fonte de dados.

mysql_datasource_1

DataSourceProperties

object

As propriedades da fonte de dados.

string

As propriedades da origem. As propriedades de uma fonte de dados MySQL incluem TimeZone e Encoding.

TimeZone

DestinationDataSourceSettings

array<object>

As configurações do destino. Apenas um único destino é suportado.

array<object>

As configurações da fonte de dados de destino.

DataSourceName

string

O nome da fonte de dados.

holo_datasource_1

DataSourceProperties

object

As propriedades da fonte de dados.

string

As propriedades do destino. Nenhuma propriedade é retornada porque o DataWorks não permite configurar propriedades para uma fonte de dados Hologres.

TimeZone

ResourceSettings

object

As configurações de recursos.

OfflineResourceSettings

object

O recurso usado para sincronização em lote.

ResourceGroupIdentifier

string

O identificador do grupo de recursos do Data Integration usado para sincronização em lote.

S_res_group_111_222

RealtimeResourceSettings

object

O recurso usado para sincronização em tempo real.

ResourceGroupIdentifier

string

O identificador do grupo de recursos do Data Integration usado para sincronização em tempo real.

S_res_group_111_222

RequestedCu

number

O número de unidades de computação (CUs) no grupo de recursos que são usadas para sincronização incremental e completa.

2.0

TransformationRules

array<object>

A lista de regras de transformação que são aplicadas aos objetos de sincronização selecionados da origem. Cada entrada na lista define uma regra de transformação.

object

A regra de transformação que é aplicada aos objetos de sincronização selecionados da origem.

RuleActionType

string

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

  • DefinePrimaryKey: define chaves primárias

  • Rename: renomeia

  • AddColumn: adiciona colunas

  • HandleDml: processa DML

  • DefineIncrementalCondition: define condições incrementais

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

  • DefineRuntimeSettings: define parâmetros de configuração avançados

  • DefinePartitionKey: define colunas de partição

Rename

RuleExpression

string

A expressão da regra. A expressão é uma string JSON.

  • Exemplo de uma regra de renomeação: {"expression":"${srcDatasourceName}_${srcDatabaseName}_0922","variables":\[{"variableName":"srcDatabaseName","variableRules":\[{"from":"fromdb","to":"todb"}\]}\]}.

    • expression: a expressão da regra de renomeação. A expressão pode conter as seguintes variáveis:

      • ${srcDatasourceName}: nome da fonte de dados de origem

      • ${srcDatabaseName}: nome do banco de dados de origem

      • ${srcTableName}: nome da tabela de origem

    • variables: a regra de geração para uma variável usada na expressão da regra de renomeação. O valor padrão da variável especificada é o valor original do objeto indicado pela variável. Você pode definir um grupo de regras de substituição de strings para alterar os valores originais conforme necessário.

      • variableName: o nome da variável. O nome da variável não é delimitado por ${}.

      • variableRules: as regras de substituição de strings para variáveis. O sistema executa as regras de substituição de strings em sequência. from indica a string original. to indica a nova string.

  • Exemplo de uma regra usada para adicionar um campo específico ao destino e atribuir um valor ao campo: {"columns":\[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}\]}.

    Se nenhuma regra deste tipo for configurada, nenhum campo será adicionado ao destino e nenhum valor será atribuído por padrão.

    • columnName: o nome do campo que é adicionado.

    • columnValueType: o tipo de valor do campo. Valores válidos: Constant e Variable.

    • columnValue: o valor do campo.

      • Se o valor do parâmetro columnValueType for Constant, o valor do parâmetro columnValue será uma constante do tipo de dados STRING.

      • Se o valor do parâmetro columnValueType for Variable, o valor do parâmetro columnValue será uma variável integrada. As seguintes variáveis integradas são suportadas: EXECUTE_TIME (tipo de dados LONG), DB_NAME_SRC (tipo de dados STRING), DATASOURCE_NAME_SRC (tipo de dados STRING), TABLE_NAME_SRC (tipo de dados STRING), DB_NAME_DEST (tipo de dados STRING), DATASOURCE_NAME_DEST (tipo de dados STRING), TABLE_NAME_DEST (tipo de dados STRING) e DB_NAME_SRC_TRANSED (tipo de dados STRING). EXECUTE_TIME indica o tempo de execução. DB_NAME_SRC indica o nome de um banco de dados de origem. DATASOURCE_NAME_SRC indica o nome da origem. TABLE_NAME_SRC indica o nome de uma tabela de origem. DB_NAME_DEST indica o nome de um banco de dados de destino. DATASOURCE_NAME_DEST indica o nome do destino. TABLE_NAME_DEST indica o nome de uma tabela de destino. DB_NAME_SRC_TRANSED indica o nome do banco de dados obtido após uma transformação.

  • Exemplo de uma regra usada para especificar campos de chave primária para uma tabela de destino: {"columns":\["ukcolumn1","ukcolumn2"\]}.

    Se nenhuma regra deste tipo for configurada, os campos de chave primária na tabela de origem mapeada serão usados para a tabela de destino por padrão.

    • Se a tabela de destino for uma tabela existente, o Data Integration não modificará o esquema da tabela de destino. Se os campos de chave primária especificados não existirem na tabela de destino, um erro será reportado quando a tarefa de sincronização começar a ser executada.

    • Se a tabela de destino for criada automaticamente pelo sistema, o Data Integration criará automaticamente o esquema da tabela de destino. O esquema contém os campos de chave primária que você especificar. Se os campos de chave primária especificados não existirem na tabela de destino, um erro será reportado quando a tarefa de sincronização começar a ser executada.

  • Exemplo de uma regra usada para processar mensagens DML: {"dmlPolicies":\[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}\]}.

    Se nenhuma regra deste tipo for configurada, a política de processamento padrão para mensagens geradas para operações de inserção, atualização e exclusão será Normal.

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

    • dmlAction: a política de processamento para mensagens DML. Valores válidos: Normal, Ignore, Filter e LogicalDelete. Filter indica processamento condicional. O valor Filter é retornado para o parâmetro dmlAction apenas quando o valor do parâmetro dmlType for Update ou Delete.

    • filterCondition: a condição usada para filtrar mensagens DML. Este parâmetro é retornado apenas quando o valor do parâmetro dmlAction for Filter.

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

RuleName

string

O nome da regra. Se os valores do parâmetro RuleActionType e do parâmetro RuleTargetType forem os mesmos para várias regras de transformação, você deve garantir que os nomes das regras de transformação sejam exclusivos.

rename_rule_1

RuleTargetType

string

O tipo do objeto no qual a ação é executada. Valores válidos:

  • Table: tabela

  • Schema: esquema

Table

TableMappings

array<object>

A lista de mapeamentos entre as regras usadas para selecionar objetos de sincronização na origem e as regras de transformação aplicadas aos objetos de sincronização selecionados. Cada entrada descreve uma lista de regras de seleção de objetos de origem e uma lista de regras de transformação aplicadas a esse grupo de objetos.

array<object>

O mapeamento entre uma regra usada para selecionar objetos de sincronização na origem e uma regra de transformação aplicada aos objetos de sincronização selecionados.

SourceObjectSelectionRules

array<object>

A lista de regras usadas para selecionar objetos de sincronização na origem.

object

A regra usada para selecionar objetos de sincronização na origem. Os objetos podem ser bancos de dados ou tabelas.

Expression

string

A expressão.

mysql_table_1

ObjectType

string

O tipo de objeto. Valores válidos:

  • Table: tabela

  • Database: banco de dados

Table

TransformationRules

array<object>

A lista de regras de transformação que são aplicadas aos objetos de sincronização selecionados da origem.

object

A regra de transformação que é aplicada aos objetos de sincronização selecionados da origem.

RuleActionType

string

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

  • DefinePrimaryKey: define chaves primárias

  • Rename: renomeia

  • AddColumn: adiciona colunas

  • HandleDml: processa DML

  • DefineIncrementalCondition: define condições incrementais

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

  • DefineRuntimeSettings: define parâmetros de configuração avançados

  • DefinePartitionKey: define colunas de partição

Rename

RuleName

string

O nome da regra. Se os valores do parâmetro RuleActionType e do parâmetro RuleTargetType forem os mesmos para várias regras de transformação, você deve garantir que os nomes das regras de transformação sejam exclusivos.

rename_rule_1

RuleTargetType

string

O tipo do objeto no qual a ação é executada. Valores válidos:

  • Table: tabela

  • Schema: esquema

Table

JobSettings

object

As configurações no nível da tarefa de sincronização. As configurações incluem políticas de processamento para mensagens DDL, políticas para mapeamentos de tipos de dados entre campos de origem e campos de destino, e parâmetros de tempo de execução da tarefa de sincronização.

ColumnDataTypeSettings

array<object>

As configurações para mapeamentos de tipos de dados entre campos de origem e campos de destino. O valor deste parâmetro é um array.

object

O mapeamento de tipo de coluna.

SourceDataType

string

O tipo de dados de um campo de origem.

bigint

DestinationDataType

string

O tipo de dados de um campo de destino.

text

DdlHandlingSettings

array<object>

As configurações para processamento de mensagens DDL. O valor deste parâmetro é um array.

object

A configuração de processamento para um tipo específico de mensagem DDL.

Action

string

A política de processamento. Valores válidos:

  • Ignore: ignora uma mensagem DDL.

  • Critical: reporta um erro para uma mensagem DDL.

  • Normal: processa normalmente uma mensagem DDL.

Critical

Type

string

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

  • RenameColumn: renomeia uma coluna

  • ModifyColumn: atualiza uma coluna

  • CreateTable: cria uma tabela

  • TruncateTable: esvazia uma tabela

  • DropTable: exclui uma tabela

  • DropColumn: exclui uma coluna

  • AddColumn: adiciona uma coluna

AddColumn

RuntimeSettings

array<object>

As configurações de tempo de execução. O valor deste parâmetro é um array.

object

A configuração de tempo de execução.

Name

string

O nome do item de configuração. Valores válidos:

  • runtime.offline.speed.limit.mb: indica a taxa máxima de transmissão permitida para uma tarefa de sincronização em lote. Este item de configuração entra em vigor apenas quando runtime.offline.speed.limit.enable é definido como true.

  • runtime.offline.speed.limit.enable: indica se a limitação de taxa está ativada para uma tarefa de sincronização em lote.

  • dst.offline.connection.max: indica o número máximo de conexões permitidas para gravar dados no destino de uma tarefa de sincronização em lote.

  • runtime.offline.concurrent: indica o número máximo de threads paralelas permitidas para uma tarefa de sincronização em lote.

  • dst.realtime.connection.max: indica o número máximo de conexões permitidas para gravar dados no destino de uma tarefa de sincronização em tempo real.

  • runtime.enable.auto.create.schema: indica se os esquemas são criados automaticamente no destino de uma tarefa de sincronização.

  • src.offline.datasource.max.connection: indica o número máximo de conexões permitidas para ler dados da origem de uma tarefa de sincronização em lote.

  • runtime.realtime.concurrent: indica o número máximo de threads paralelas permitidas para uma tarefa de sincronização em tempo real.

runtime.offline.concurrent

Value

string

O valor do item de configuração.

1

CycleScheduleSettings

object

As configurações para agendamento periódico.

CycleMigrationType

string

O tipo de sincronização que requer agendamento periódico. Valores válidos:

  • Full: sincronização completa

  • OfflineIncremental: sincronização incremental em lote

Full

ScheduleParameters

string

Os parâmetros de agendamento.

bizdate=$bizdate

ChannelSettings

string

As configurações de controle de canal para a tarefa de sincronização. O valor deste parâmetro é uma string JSON.

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

CreatedTime

integer

O carimbo de data/hora de quando a tarefa de sincronização foi criada. Unidade: segundos.

1671516776

CreatedUid

string

O ID do usuário que cria a tarefa de sincronização.

100000001

UpdatedTime

integer

O carimbo de data/hora de quando a tarefa de sincronização foi modificada pela última vez. Unidade: segundos.

1673859985

UpdatedUid

string

O ID do usuário que modificou a tarefa de sincronização pela última vez.

100000001

StartedTime

integer

O carimbo de data/hora de quando a tarefa de sincronização foi iniciada pela última vez. Unidade: segundos.

1673859999

StartedUid

string

O ID do usuário que iniciou a tarefa de sincronização pela última vez.

100000001

JobStatus

string

O status da tarefa de sincronização. Valores válidos:

  • Finished: concluída com sucesso

  • Initialized: inicializada

  • Stopped: parada

  • Failed: falhou

  • Running: em execução

  • Stopping: parando

Finished

ErrorMessage

string

A mensagem de erro retornada se o valor do parâmetro JobStatus for Failed.

error details xxx

RunStats

object

As informações sobre a execução da tarefa de sincronização.

string

As estatísticas detalhadas sobre a execução da tarefa de sincronização.

  • StructureMigrationTotalTables: o número total de tabelas cujos esquemas precisam ser migrados.

  • StructureMigrationSuccessTables: o número de tabelas cujos esquemas foram migrados com sucesso.

  • StructureMigrationFailedTables: o número de tabelas cujos esquemas falharam ao serem migrados.

  • StructureMigrationStatus: o status da migração de esquema. Valores válidos: Waiting, Running, Finished, Failed e Stopped.

  • StructureMigrationErrorMessage: a mensagem de erro retornada para a migração de esquema.

  • FullMigrationTotalTables: o número total de tabelas cujos dados completos precisam ser sincronizados.

  • FullMigrationSuccessTables: o número de tabelas cujos dados completos foram sincronizados com sucesso.

  • FullMigrationFailedTables: o número de tabelas cujos dados completos falharam ao serem sincronizados.

  • FullMigrationStatus: o status da sincronização completa.

  • FullMigrationErrorMessage: a mensagem de erro retornada para a sincronização completa.

  • RealtimeMigrationMaxDelay: a latência da sincronização em tempo real. Unidade: milissegundos.

  • RealtimeMigrationStatus: o status da sincronização em tempo real.

  • RealtimeMigrationErrorMessage: a mensagem de erro retornada para a sincronização em tempo real.

StructureMigrationTotalTables

RequestId

string

O ID da solicitação.

0000-ABCD-EFG****

Exemplos

Resposta de sucesso

JSON formato

{
  "Data": {
    "ProjectId": 22,
    "DIJobId": 11588,
    "JobName": "mysql_to_holo_sync_445",
    "Description": "Synchronize mysql to hologres\n",
    "MigrationType": "FullAndRealtimeIncremental",
    "SourceDataSourceType": "MySQL",
    "DestinationDataSourceType": "Hologres",
    "SourceDataSourceSettings": [
      {
        "DataSourceName": "mysql_datasource_1",
        "DataSourceProperties": {
          "key": "TimeZone"
        }
      }
    ],
    "DestinationDataSourceSettings": [
      {
        "DataSourceName": "holo_datasource_1",
        "DataSourceProperties": {
          "key": "TimeZone"
        }
      }
    ],
    "ResourceSettings": {
      "OfflineResourceSettings": {
        "ResourceGroupIdentifier": "S_res_group_111_222"
      },
      "RealtimeResourceSettings": {
        "ResourceGroupIdentifier": "S_res_group_111_222"
      },
      "RequestedCu": 2
    },
    "TransformationRules": [
      {
        "RuleActionType": "Rename",
        "RuleExpression": "{\"expression\":\"${srcDatasoureName}_${srcDatabaseName}\"}",
        "RuleName": "rename_rule_1",
        "RuleTargetType": "Table"
      }
    ],
    "TableMappings": [
      {
        "SourceObjectSelectionRules": [
          {
            "Expression": "mysql_table_1",
            "ObjectType": "Table"
          }
        ],
        "TransformationRules": [
          {
            "RuleActionType": "Rename",
            "RuleName": "rename_rule_1",
            "RuleTargetType": "Table"
          }
        ]
      }
    ],
    "JobSettings": {
      "ColumnDataTypeSettings": [
        {
          "SourceDataType": "bigint",
          "DestinationDataType": "text"
        }
      ],
      "DdlHandlingSettings": [
        {
          "Action": "Critical",
          "Type": "AddColumn"
        }
      ],
      "RuntimeSettings": [
        {
          "Name": "runtime.offline.concurrent",
          "Value": "1"
        }
      ],
      "CycleScheduleSettings": {
        "CycleMigrationType": "Full",
        "ScheduleParameters": "bizdate=$bizdate"
      },
      "ChannelSettings": "{\"structInfo\":\"MANAGED\",\"storageType\":\"TEXTFILE\",\"writeMode\":\"APPEND\",\"partitionColumns\":[{\"columnName\":\"pt\",\"columnType\":\"STRING\",\"comment\":\"\"}],\"fieldDelimiter\":\"\"}\n"
    },
    "CreatedTime": 1671516776,
    "CreatedUid": "100000001",
    "UpdatedTime": 1673859985,
    "UpdatedUid": "100000001",
    "StartedTime": 1673859999,
    "StartedUid": "100000001",
    "JobStatus": "Finished",
    "ErrorMessage": "error details xxx",
    "RunStats": {
      "key": "StructureMigrationTotalTables"
    }
  },
  "RequestId": "0000-ABCD-EFG****"
}

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

500 InternalError.System An internal system error occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later.
429 Throttling.Api The request for this resource has exceeded your available limit.
429 Throttling.System The DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.