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

Consulta o status de uma tarefa de sincronização em tempo real 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 espaço de trabalho do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de gerenciamento de espaços de trabalho para consultar o ID. Você deve configurar este parâmetro para especificar o espaço de trabalho 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 o parâmetro TaskType como DI_REALTIME, defina o parâmetro FileId como o ID do arquivo da tarefa de sincronização em tempo real que deseja consultar. Se você definir o parâmetro TaskType como DI_SOLUTION, defina o parâmetro FileId como o ID da solução de sincronização de dados que deseja consultar. Você pode chamar a operação ListFiles para consultar o ID do arquivo 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 dados retornados.
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true false	true
RequestId	string	O ID da solicitação.	0bc1411515937635973****
Data	object	O status da tarefa de sincronização em tempo real ou da solução de sincronização de dados.
Status	string	Se o parâmetro TaskType estiver definido como DI_REALTIME, o parâmetro Status indica o status da tarefa de sincronização em tempo real. Valores válidos: PAUSE, NORUN, RUN, KILLING e WAIT. Se o parâmetro TaskType estiver definido como DI_SOLUTION, o parâmetro Status indica o status da solução de sincronização de dados. Valores válidos: success e fail.	RUN
Message	string	A causa da falha ao obter o status da tarefa de sincronização em tempo real ou da solução de sincronização de dados. Se o status da tarefa de sincronização em tempo real ou da solução de sincronização de dados for obtido, o valor null será retornado.	fileId[100] is invalid
Name	string	Se o parâmetro TaskType estiver definido como DI_REALTIME, o parâmetro Name indica o nome da tarefa de sincronização em tempo real. Se o parâmetro TaskType estiver definido como DI_SOLUTION, o valor null será retornado.	streamx_name
SolutionInfo	object	Se o parâmetro TaskType estiver definido como DI_REALTIME, o valor null será retornado. Se o parâmetro TaskType estiver definido como DI_SOLUTION, o parâmetro SolutionInfo indica os detalhes da solução de sincronização de dados.
Status	string	O status da solução de sincronização de dados.	run
Id	integer	O ID da solução de sincronização de dados.	100
CreatorName	string	O criador da solução de sincronização de dados.	dataworks_3h1
StepDetail	array<object>	Os detalhes das etapas da solução de sincronização de dados.
	object	Os dados retornados.
Status	string	O status da etapa na solução de sincronização de dados.	success
StepId	integer	O ID da etapa na solução de sincronização de dados.	1
StepName	string	O nome da etapa na solução de sincronização de dados.	Create a base table
Info	string	As informações da solução de sincronização de dados.	{\"fusionProps\":{\"dataSource\":[{\"fileName\":\"holo_20221020161613\",\"status\":\"SUCCESS\"}]},\"customProps\":{\"showSN\":true,\"columns\":[{\"dataIndex\":\"fileName\",\"width\":0.8,\"title\":\"Real-time synchronization name\"},{\"dataIndex\":\"status\",\"width\":0.2,\"title\":\"Status\"}]},\"componentName\":\"Table\"}

Exemplos

Resposta de sucesso

JSON formato

{
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "RUN",
    "Message": "fileId[100] is invalid",
    "Name": "streamx_name",
    "SolutionInfo": {
      "Status": "run",
      "Id": 100,
      "CreatorName": "dataworks_3h1",
      "StepDetail": [
        {
          "Status": "success",
          "StepId": 1,
          "StepName": "Create a base table",
          "Info": "{\\\"fusionProps\\\":{\\\"dataSource\\\":[{\\\"fileName\\\":\\\"holo_20221020161613\\\",\\\"status\\\":\\\"SUCCESS\\\"}]},\\\"customProps\\\":{\\\"showSN\\\":true,\\\"columns\\\":[{\\\"dataIndex\\\":\\\"fileName\\\",\\\"width\\\":0.8,\\\"title\\\":\\\"Real-time synchronization name\\\"},{\\\"dataIndex\\\":\\\"status\\\",\\\"width\\\":0.2,\\\"title\\\":\\\"Status\\\"}]},\\\"componentName\\\":\\\"Table\\\"}"
        }
      ]
    }
  }
}

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.	Parâmetro inválido.
500	InternalError.System	An internal error occurred.	Ocorreu um erro interno.
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.