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

Obtém os detalhes de uma tarefa de sincronização ou de uma solução de sincronização de dados.

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

*All Resource

*

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 Workspace para obter o ID do workspace. Você deve configurar este parâmetro para especificar o workspace do DataWorks ao qual a operação de API é aplicada.	10000
TaskType	string	Sim	O tipo do objeto que você deseja consultar. Valores válidos: DI_REALTIME: tarefa de sincronização em tempo real DI_SOLUTION: solução de sincronização de dados	DI_REALTIME
FileId	integer	Sim	Se você definir TaskType como DI_REALTIME, defina este parâmetro como o ID da tarefa de sincronização em tempo real que você deseja implantar. Se você definir TaskType como DI_SOLUTION, defina este parâmetro como o ID da solução de sincronização de dados que você deseja implantar. Você pode chamar a operação ListFiles para consultar o ID da tarefa de sincronização em tempo real ou da solução de sincronização de dados.	100

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: True False	true
RequestId	string	O ID da solicitação. Você pode localizar logs e solucionar problemas com base no ID.	0bc1411515937635973****
Data	object	Os resultados retornados.
Code	string	Se o parâmetro TaskType estiver definido como DI_REALTIME, os detalhes da tarefa de sincronização em tempo real são retornados. Se o parâmetro TaskType estiver definido como DI_SOLUTION, o valor null é retornado.	{"extend":{"mode":"wizard","resourceGroup":"S_res_group_287114642182658_1560324290517"},"nodeDef":{},"order":{"hops":[{"from":"datahub_8htXSsfiS2vtZCVG","to":"datahub_CRHBAyGfhSaLmv2f"}]},"setting":{"errorLimit":{},"jvmOption":""},"steps":[{"stepType":"datahub","category":"writer","displayName":"DataHub1","parameter":{"batchSize":1000,"datasource":"datahub_cloud_dev_test","topic":"dwd_tfc_opt_speed_rid_amap_rt"},"name":"datahub_CRHBAyGfhSaLmv2f","gui":{"x":262,"y":325}},{"stepType":"datahub","displayName":"DataHub2","parameter":{"datasource":"datahub_uric_test","topic":"dwd_tfc_opt_speed_rid_amap_rt_330000","batchSize":1000},"name":"datahub_8htXSsfiS2vtZCVG","gui":{"x":268,"y":160.5},"category":"writer"}]}
Status	string	Indica se os detalhes da tarefa de sincronização em tempo real ou da solução de sincronização de dados foram obtidos. Valores válidos: success: os detalhes foram obtidos. fail: falha ao obter os detalhes.	success
Message	string	A causa da falha ao obter os detalhes da tarefa de sincronização em tempo real ou da solução de sincronização de dados. Se os detalhes da tarefa de sincronização em tempo real ou da solução de sincronização de dados forem obtidos, o valor null é retornado.	fileId:[100] is invalid.
AlarmList	array<object>	As regras de alerta associadas à tarefa de sincronização em tempo real. O valor deste parâmetro é um array.
	array<object>	A regra de alerta associada à tarefa de sincronização em tempo real.
Id	integer	The ID of the alert rule.	45242
Enabled	boolean	Indicates whether the alert rule is enabled.	true
RuleName	string	The name of the alert rule.	Delay alert rule name 1
Metric	string	The alert type. Valid values: taskStatus bizDelay taskFailoverCount ddlUnsupport ddlReport totalDirtyRecordWriteInLines	taskStatus
Description	string	The description of the alert rule.	Description
AlarmRuleList	array<object>	The alert notification settings. The value of this parameter is an array.
	object	The alert notification setting.
Level	string	WARNING CRITICAL	WARNING
Comparator	string	The comparison operator, which indicates the method used to compare a metric with the alert rule. '=' '<' '>'	=
Threshold	integer	The threshold for the comparison between a metric and the alert rule.	1
Duration	integer	The duration that a condition is met before an alert is triggered. Unit: minutes.	3
Aggregator	string	The calculation method of a metric. Valid values: avg max	avg
NotifyRule	object	The settings for alert notification rules. The value of this parameter is an array.
Interval	integer	The alert interval. Unit: minutes.	5
Warning	array	The settings for Warning-level alert notifications.
	string	The alert notification method. Valid values: Mail Phone Sms Ding	Ding
Critical	array	The settings for Critical-level alert notifications.
	string	The alert notification method. Valid values: Mail Phone Sms Ding	Ding
SolutionDetail	object	Se o parâmetro TaskType estiver definido como DI_REALTIME, o valor null é retornado. Se o parâmetro TaskType estiver definido como DI_SOLUTION, os detalhes da solução de sincronização de dados são retornados.
Status	string	The status of the data synchronization solution. Valid values: 0: successful 1: not running 2: running 3: failed 4: committed 5: pending manual confirmation 6: manually confirmed 7: others 8: waiting 9: deleted	0
Type	string	The type of the data synchronization solution.	holo
StartTime	string	The start time of the data synchronization solution.	2021-12-07 14:40:51
CreatorName	string	The creator of the data synchronization solution.	dataworks_di
ProjectId	integer	The ID of the project to which the data synchronization solution belongs.	10000
SourceType	string	The type of the source of the data synchronization solution.	mysql
ProcessContent	string	The configuration details of the data synchronization solution.	{"holoDatasource":"holo","offlineSyncConfig":{"nodeNameRule":"oneclick_holo_di_${db_table_name_src}_to_${db_table_name_dest}","resourceGroup":"group_219193793999490"},"processRuleId":1007,"readerConcurrent":10,"realtimeSyncConfig":{"content":{"order":{"hops":[{"from":"reader","to":"writer"}]},"setting":{"speed":{"readerConcurrent":10}},"steps":[{"stepType":"mysql","name":"reader","category":"reader","parameter":{"connection":[{"datasource":"mm","datasourceType":"mysql","table":[]}]}},{"stepType":"holo","name":"writer","category":"writer","parameter":{"datasource":"holo","writeMode":"replay","datasourceSchema":"public","tableMappingRule":{"datasource":[{"tableRule":[],"srcDatasourceName":"mm"}]}}}]},"extend":{"mode":"migration_holo","resourceGroup":"group_219193793999490"}},"setting":{"autoCreateWorkflow":true,"userDefinedFileNameExpression":"oneclick"},"srcType":"mysql","tableMappingRuleFromRealtimeSyncConfig":{"datasource":[{"srcDatasourceName":"mm","tableRule":[]}]}}
Name	string	The name of the data synchronization solution.	holo_20211206161025
ProcessExtra	string	The additional parameters of the data synchronization solution.	{"processType":"new","tableNum":300}
SubmitTime	string	The time when the data synchronization solution was committed.	2021-12-07 14:40:51
Id	integer	The ID of the data synchronization solution.	100

Exemplos

Resposta de sucesso

JSON formato

{
  "Success": true,
  "RequestId": "0bc1411515937635973****\t",
  "Data": {
    "Code": "{\"extend\":{\"mode\":\"wizard\",\"resourceGroup\":\"S_res_group_287114642182658_1560324290517\"},\"nodeDef\":{},\"order\":{\"hops\":[{\"from\":\"datahub_8htXSsfiS2vtZCVG\",\"to\":\"datahub_CRHBAyGfhSaLmv2f\"}]},\"setting\":{\"errorLimit\":{},\"jvmOption\":\"\"},\"steps\":[{\"stepType\":\"datahub\",\"category\":\"writer\",\"displayName\":\"DataHub1\",\"parameter\":{\"batchSize\":1000,\"datasource\":\"datahub_cloud_dev_test\",\"topic\":\"dwd_tfc_opt_speed_rid_amap_rt\"},\"name\":\"datahub_CRHBAyGfhSaLmv2f\",\"gui\":{\"x\":262,\"y\":325}},{\"stepType\":\"datahub\",\"displayName\":\"DataHub2\",\"parameter\":{\"datasource\":\"datahub_uric_test\",\"topic\":\"dwd_tfc_opt_speed_rid_amap_rt_330000\",\"batchSize\":1000},\"name\":\"datahub_8htXSsfiS2vtZCVG\",\"gui\":{\"x\":268,\"y\":160.5},\"category\":\"writer\"}]}",
    "Status": "success",
    "Message": "fileId:[100] is invalid.",
    "AlarmList": [
      {
        "Id": 45242,
        "Enabled": true,
        "RuleName": "Delay alert rule name 1",
        "Metric": "taskStatus",
        "Description": "Description",
        "AlarmRuleList": [
          {
            "Level": "WARNING",
            "Comparator": "=",
            "Threshold": 1,
            "Duration": 3,
            "Aggregator": "avg"
          }
        ],
        "NotifyRule": {
          "Interval": 5,
          "Warning": [
            "Ding"
          ],
          "Critical": [
            "Ding"
          ]
        }
      }
    ],
    "SolutionDetail": {
      "Status": "0",
      "Type": "holo",
      "StartTime": "2021-12-07 14:40:51",
      "CreatorName": "dataworks_di",
      "ProjectId": 10000,
      "SourceType": "mysql",
      "ProcessContent": "{\"holoDatasource\":\"holo\",\"offlineSyncConfig\":{\"nodeNameRule\":\"oneclick_holo_di_${db_table_name_src}_to_${db_table_name_dest}\",\"resourceGroup\":\"group_219193793999490\"},\"processRuleId\":1007,\"readerConcurrent\":10,\"realtimeSyncConfig\":{\"content\":{\"order\":{\"hops\":[{\"from\":\"reader\",\"to\":\"writer\"}]},\"setting\":{\"speed\":{\"readerConcurrent\":10}},\"steps\":[{\"stepType\":\"mysql\",\"name\":\"reader\",\"category\":\"reader\",\"parameter\":{\"connection\":[{\"datasource\":\"mm\",\"datasourceType\":\"mysql\",\"table\":[]}]}},{\"stepType\":\"holo\",\"name\":\"writer\",\"category\":\"writer\",\"parameter\":{\"datasource\":\"holo\",\"writeMode\":\"replay\",\"datasourceSchema\":\"public\",\"tableMappingRule\":{\"datasource\":[{\"tableRule\":[],\"srcDatasourceName\":\"mm\"}]}}}]},\"extend\":{\"mode\":\"migration_holo\",\"resourceGroup\":\"group_219193793999490\"}},\"setting\":{\"autoCreateWorkflow\":true,\"userDefinedFileNameExpression\":\"oneclick\"},\"srcType\":\"mysql\",\"tableMappingRuleFromRealtimeSyncConfig\":{\"datasource\":[{\"srcDatasourceName\":\"mm\",\"tableRule\":[]}]}}",
      "Name": "holo_20211206161025",
      "ProcessExtra": "{\"processType\":\"new\",\"tableNum\":300}",
      "SubmitTime": "2021-12-07 14:40:51",
      "Id": 100
    }
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Param.Invalid	The parameter is invalid.	Param invalid
500	InternalError.System	An internal error occurred.	InternalError
403	Forbidden.Access	Access is forbidden.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.