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

Consulta o snapshot de dados do ponto de extensão no momento em que um evento de ponto de extensão é acionado, com base no ID da mensagem de uma mensagem aberta do DataWorks.

Descrição da operação

Antes de começar: Ative o DataWorks Enterprise Edition ou Ultimate Edition antes de chamar esta operação. Se a edição não estiver ativada, o serviço retornará um erro 403 Forbidden.Access.

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

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
MessageId	string	Sim	O ID da mensagem aberta do DataWorks. Após um evento de ponto de extensão ser acionado, você pode obter o ID da mensagem a partir da mensagem de evento recebida.	8abcb91f-d266-4073-b907-2ed67****1
ProjectId	integer	Sim	O ID do workspace do DataWorks. Você pode obter o ID do workspace analisando a mensagem aberta do DataWorks.	10000

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID exclusivo da solicitação, que pode ser usado para solução de problemas.	8abcb91f-d266-4073-b907-2ed670378ed1
EventDetail	object	O snapshot de dados no momento em que o evento de ponto de extensão foi acionado. Diferentes tipos de eventos de mensagem possuem diferentes campos válidos no snapshot de dados. Para obter detalhes, consulte as descrições de campos de cada evento de mensagem.
FileExecutionCommand	object	O snapshot quando o código do arquivo é executado. Este campo é válido apenas quando o tipo de mensagem é IDE_FILE_EXECUTE_BEFORE.
FileId	integer	O ID do arquivo.	1234123
DataSourceName	string	O identificador exclusivo da fonte de dados associada ao arquivo.	odps_source
Content	string	O código do arquivo que gerou esta versão do arquivo.	SHOW TABLES;
FileType	integer	O tipo de arquivo. Diferentes tipos de arquivo possuem códigos diferentes. Para obter mais informações, consulte Nós do DataWorks.	10
DeletedFile	object	As informações de snapshot quando um arquivo é excluído. Este campo é válido apenas quando o tipo de mensagem é IDE_FILE_DELETE_BEFORE.
Owner	string	O proprietário do arquivo.	7384234****
FileType	integer	O tipo de arquivo. Diferentes tipos de arquivo possuem códigos diferentes. Para obter mais informações, consulte Nós do DataWorks.	10
CurrentVersion	integer	A versão mais recente do arquivo.	1
BusinessId	integer	O ID do fluxo de trabalho ao qual o arquivo pertence.	74328
FileName	string	O nome do arquivo.	hello_dataworks.sql
DataSourceName	string	O identificador exclusivo da fonte de dados associada ao arquivo.	odps_source
UseType	string	O módulo funcional ao qual o arquivo pertence. Valores válidos: NORMAL: Data Studio. MANUAL: tarefa manual. MANUAL_BIZ: fluxo de trabalho manual. SKIP: agendamento de dry run no Data Studio. ADHOCQUERY: consulta ad hoc. COMPONENT: gerenciamento de componentes.	NORMAL
FolderId	string	O ID da pasta à qual o arquivo pertence. Você pode chamar a operação GetFolder para consultar os detalhes do arquivo pelo ID da pasta.	aldurie78l2falure
ParentFileId	integer	O ID do nó de loop ou nó de travessia ao qual o arquivo pertence.	1234122
Content	string	O código do arquivo que gerou esta versão do arquivo.	SHOW TABLES;
NodeId	integer	O ID do nó de agendamento.	421429
FileId	integer	O ID do arquivo.	1234123
CommittedFile	object	O snapshot quando um arquivo é confirmado ou implantado. Este campo é válido apenas quando o tipo de mensagem é IDE_FILE_SUBMIT_BEFORE ou IDE_FILE_DEPLOY_BEFORE.
FileId	integer	O ID do arquivo.	1234123
Content	string	O código do arquivo que gerou esta versão do arquivo.	SHOW TABLES;
Committor	string	O ID de usuário do Alibaba Cloud que gerou esta versão do arquivo.	7384234****
FileType	integer	O tipo de arquivo. Diferentes tipos de arquivo possuem códigos diferentes. Para obter mais informações, consulte Nós do DataWorks.	10
ChangeType	string	O tipo de alteração desta versão do arquivo. Valores válidos: CREATE, UPDATE e DELETE.	UPDATE
FileName	string	O nome do arquivo.	hello_dataworks.sql
NodeId	integer	O ID do nó de agendamento.	421429
Comment	string	A descrição desta versão do arquivo.	Second version submission
UseType	string	O módulo funcional ao qual o arquivo pertence. Valores válidos: NORMAL: Data Studio. MANUAL: tarefa manual. MANUAL_BIZ: fluxo de trabalho manual. SKIP: agendamento de dry run no Data Studio. ADHOCQUERY: consulta ad hoc. COMPONENT: gerenciamento de componentes.	NORMAL
FilePropertyContent	object	As propriedades adicionais do arquivo.
DataSourceName	string	O identificador exclusivo da fonte de dados associada ao arquivo.	odps_source
ParentFileId	integer	O ID do nó de loop ou nó de travessia ao qual o arquivo pertence.	1234122
BusinessId	integer	O ID do fluxo de trabalho ao qual o arquivo pertence.	74328
CurrentVersion	integer	A versão mais recente do arquivo.	1
Owner	string	O proprietário do arquivo.	7384234****
FolderId	string	O ID da pasta à qual o arquivo pertence. Você pode chamar a operação GetFolder para consultar os detalhes do arquivo pelo ID da pasta.	aldurie78l2falure
NodeConfiguration	object	A configuração de agendamento do arquivo.
RerunMode	string	A propriedade de reexecução. Valores válidos: ALL_ALLOWED: O nó pode ser reexecutado independentemente de ser executado com sucesso ou falhar. FAILURE_ALLOWED: O nó pode ser reexecutado apenas após falhar. ALL_DENIED: O nó não pode ser reexecutado independentemente de ser executado com sucesso ou falhar. Este parâmetro corresponde à configuração "Configuração de agendamento > Propriedades de tempo > Propriedades de reexecução" de uma tarefa do Data Studio no console do DataWorks.	ALL_ALLOWED
SchedulerType	string	O tipo de agendamento. Valores válidos: NORMAL: tarefa de agendamento normal. MANUAL: tarefa manual que não é agendada regularmente. Isso corresponde a nós em um fluxo de trabalho manual. PAUSE: tarefa pausada. SKIP: tarefa de dry run que é agendada regularmente, mas é definida diretamente como bem-sucedida quando o agendamento é iniciado.	NORMAL
ParaValue	string	Os parâmetros de agendamento. Este parâmetro corresponde à configuração "Configuração de agendamento > Parâmetros" de uma tarefa do Data Studio no console do DataWorks. Para obter mais informações, consulte Parâmetros de agendamento.	a=x b=y
CycleType	string	O tipo do ciclo de agendamento. Valores válidos: NOT_DAY (minuto ou hora) e DAY (dia, semana ou mês). Este parâmetro corresponde à configuração "Configuração de agendamento > Propriedades de tempo > Ciclo de agendamento" de uma tarefa do Data Studio no console do DataWorks.	DAY
DependentNodeIdList	string	Os IDs dos nós dos quais o arquivo atual depende quando as configurações do parâmetro DependentType são definidas como USER_DEFINE. Separe vários IDs de nó com vírgulas (,). Este parâmetro corresponde à configuração "Configuração de agendamento > Dependências de agendamento > Dependências entre ciclos (Ciclo anterior)" de uma tarefa do Data Studio no console do DataWorks, quando a dependência é definida como "Outros nós".	5,10,15,20
ResourceGroupId	integer	O grupo de recursos usado quando a tarefa é executada após a implantação do arquivo. Você pode chamar a operação ListResourceGroups para obter a lista de grupos de recursos disponíveis para o workspace.	375827434852437
AutoRerunTimes	integer	O número de reexecuções automáticas.	3
AutoRerunIntervalMillis	integer	O intervalo entre reexecuções automáticas, em milissegundos.	120000
CronExpress	string	A expressão cron de agendamento.	00 05 00 * * ?
InputList	array<object>	As saídas de arquivo upstream das quais o arquivo depende.
	object	As informações sobre a saída de arquivo upstream da qual o arquivo depende.
Input	string	O nome da saída do arquivo upstream do qual o arquivo depende. Este parâmetro corresponde ao "Nome da saída do nó upstream" na configuração "Configuração de agendamento > Dependências de agendamento > Depende de nós upstream" de uma tarefa do Data Studio no console do DataWorks.	dw_project_root
ParseType	string	O método usado para configurar as dependências de arquivo. Valores válidos: MANUAL: configuração manual. AUTO: análise automática.	MANUAL
OutputList	array<object>	As saídas do arquivo. Este parâmetro corresponde à configuração "Configuração de agendamento > Dependências de agendamento > Nome da saída do nó atual" de uma tarefa do Data Studio no console do DataWorks.
	object	As informações de saída do arquivo.
RefTableName	string	O nome da tabela de saída do arquivo. Este parâmetro corresponde ao "Nome da tabela de saída" na configuração "Configuração de agendamento > Dependências de agendamento > Nome da saída do nó atual" de uma tarefa do Data Studio no console do DataWorks.	ods_user_info_d
Output	string	O nome da saída do arquivo. Este parâmetro corresponde ao "Nome da saída" na configuração "Configuração de agendamento > Dependências de agendamento > Nome da saída do nó atual" de uma tarefa do Data Studio no console do DataWorks.	dw_project.002_out
DependentType	string	O método de dependência do ciclo anterior. Valores válidos: SELF: a dependência é definida para o nó atual. CHILD: a dependência é definida para os nós filho de primeiro nível. USER_DEFINE: a dependência é definida para outros nós. NONE: nenhuma dependência é selecionada, o que significa que o nó não depende do ciclo anterior.	USER_DEFINE
TableModel	object	O snapshot quando uma tabela é confirmada ou implantada. Este campo é válido apenas quando o tipo de mensagem é IDE_TABLE_SUBMIT_BEFORE ou IDE_TABLE_DEPLOY_BEFORE.
Env	string	O ambiente ao qual a tabela pertence. Valores válidos: DEV: ambiente de desenvolvimento. PROD: ambiente de produção.	DEV
LifeCycle	integer	O ciclo de vida da tabela. Unidade: dias.	7
TableName	string	O nome da tabela.	tb_hello
DataSourceName	string	O identificador exclusivo da fonte de dados à qual a tabela pertence.	odps_source
Columns	array<object>	A lista de colunas.
	object	As informações da coluna.
ColumnName	string	O nome da coluna.	ID
ColumnType	string	O tipo da coluna.	BIGINT
IsPartitionColumn	boolean	Indica se a coluna é uma coluna de partição. Valores válidos: true: A coluna é uma coluna de partição. false: A coluna não é uma coluna de partição.	false
Comment	string	O comentário da coluna.	ID
Comment	string	O comentário da tabela.	A new table
Location	string	As informações de localização da tabela externa.	hdfs://path/to/object

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "8abcb91f-d266-4073-b907-2ed670378ed1",
  "EventDetail": {
    "FileExecutionCommand": {
      "FileId": 1234123,
      "DataSourceName": "odps_source",
      "Content": "SHOW TABLES;",
      "FileType": 10
    },
    "DeletedFile": {
      "Owner": "7384234****",
      "FileType": 10,
      "CurrentVersion": 1,
      "BusinessId": 74328,
      "FileName": "hello_dataworks.sql",
      "DataSourceName": "odps_source",
      "UseType": "NORMAL",
      "FolderId": "aldurie78l2falure",
      "ParentFileId": 1234122,
      "Content": "SHOW TABLES;",
      "NodeId": 421429,
      "FileId": 1234123
    },
    "CommittedFile": {
      "FileId": 1234123,
      "Content": "SHOW TABLES;",
      "Committor": "7384234****",
      "FileType": 10,
      "ChangeType": "UPDATE",
      "FileName": "hello_dataworks.sql",
      "NodeId": 421429,
      "Comment": "Submissão da segunda versão",
      "UseType": "NORMAL",
      "FilePropertyContent": {
        "DataSourceName": "odps_source",
        "ParentFileId": 1234122,
        "BusinessId": 74328,
        "CurrentVersion": 1,
        "Owner": "7384234****",
        "FolderId": "aldurie78l2falure"
      },
      "NodeConfiguration": {
        "RerunMode": "ALL_ALLOWED",
        "SchedulerType": "NORMAL",
        "ParaValue": "a=x b=y",
        "CycleType": "DAY",
        "DependentNodeIdList": "5,10,15,20",
        "ResourceGroupId": 375827434852437,
        "AutoRerunTimes": 3,
        "AutoRerunIntervalMillis": 120000,
        "CronExpress": "00 05 00 * * ?",
        "InputList": [
          {
            "Input": "dw_project_root",
            "ParseType": "MANUAL"
          }
        ],
        "OutputList": [
          {
            "RefTableName": "ods_user_info_d",
            "Output": "dw_project.002_out"
          }
        ],
        "DependentType": "USER_DEFINE"
      }
    },
    "TableModel": {
      "Env": "DEV",
      "LifeCycle": 7,
      "TableName": "tb_hello",
      "DataSourceName": "odps_source",
      "Columns": [
        {
          "ColumnName": "ID",
          "ColumnType": "BIGINT",
          "IsPartitionColumn": false,
          "Comment": "ID"
        }
      ],
      "Comment": "Uma nova tabela",
      "Location": "hdfs://path/to/object"
    }
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InternalError.UserId.Missing	An internal system error occurred. Try again later.
500	InternalError.System	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	Acesso negado. Autorize o acesso.
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.