Este tópico descreve os tipos de eventos do DataWorks, os formatos de mensagem e o significado dos campos. Utilize este documento para localizar e consultar rapidamente informações sobre a lista de eventos e seus respectivos formatos.
Introdução
No DataWorks, os eventos são classificados como eventos padrão ou eventos de ponto de extensão. Essa classificação depende da capacidade do evento de criar um checkpoint no DataWorks e de retornar resultados de processamento após a assinatura por um service autogerenciado.
Eventos padrão: É possível assinar essas mensagens de evento, mas elas não bloqueiam operações internas do DataWorks. Assine esses eventos por meio do OpenEvent. Para mais informações, consulte Open Events Overview.
Eventos de ponto de extensão: Após assinar essas mensagens, você pode personalizar a resposta utilizando o recurso Extensions na DataWorks Open Platform. Ao usar Extensions para gerenciar operações em um ponto de extensão, a ação executada pelo usuário da plataforma nesse ponto é interrompida até que sua extensão personalizada retorne um resultado de processamento.
Esta lista categoriza os eventos suportados por módulo e indica se cada um é um evento padrão ou um evento de ponto de extensão. Também são listados o tipo de evento do EventBridge (Type) e o código do evento de extensão (eventCode).
Tipo de evento do EventBridge (Type): Campo utilizado para filtrar mensagens de evento. Para detalhes, consulte Enable message subscription.
Código do evento de extensão (eventCode): Código correspondente ao tipo de evento. Durante o desenvolvimento local, obtenha esse código no conteúdo da mensagem enviada pelo DataWorks para identificar o tipo de evento alvo.
Eventos no nível do workspace
Os eventos gerados por módulos no nível do workspace são denominados eventos no nível do workspace, como execuções de nós no Data Studio ou alterações de status de instâncias agendadas no Operation Center. Utilize a lista de eventos abaixo para identificar quais são eventos padrão e quais são eventos de ponto de extensão, bem como seus formatos de mensagem.
As abas de formato de mensagem a seguir contêm apenas conteúdo parcial. Para visualizar as mensagens completas enviadas ao EventBridge ou Function Compute, consulte Appendix: Message Format.
Lista de eventos do Data Studio
Lista de eventos
|
Tipo de evento |
Evento (e operação de gatilho) |
Evento padrão |
Evento de ponto de extensão |
Tipo de evento do EventBridge (Type) |
Código do evento de extensão (eventCode) |
|
Alteração de nó |
Criar nó
|
|
|
|
|
|
Atualizar nó
|
|
|
|
|
|
|
Alteração de arquivo
|
Pré-evento para exclusão de arquivo Excluir um nó no ambiente de desenvolvimento Nota
Arquivos excluídos são movidos para a lixeira. |
|
|
|
|
|
Pré-evento para envio de arquivo |
|
|
|
|
|
|
Pré-evento para implantação de arquivo |
|
|
|
|
|
|
Pré-evento para execução de código |
|
|
|
|
|
|
Alteração de tabela |
Pré-evento para envio de tabela ao desenvolvimento |
|
|
|
|
|
Pré-evento para envio de tabela à produção |
|
|
|
|
Formato da mensagem
Eventos de alteração de nó (criação e atualização)
Eventos de alteração de arquivo (envio, implantação, execução e exclusão)
Eventos de alteração de tabela (envio de tabela ao ambiente de desenvolvimento ou implantação no ambiente de produção)
Lista de eventos do Data Integration
Lista de eventos
|
Tipo de evento |
Evento (e operação de acionamento) |
Evento padrão |
Evento de ponto de extensão |
Tipo de evento do EventBridge (Tipo) |
Código do evento de extensão (eventCode) |
|
Evento de alteração de nó |
Iniciar uma tarefa |
|
|
|
|
|
Início em lote de tarefas |
|
|
|
|
Formato da mensagem
Evento de alteração de nó- Iniciar uma tarefa
Evento de alteração de nó- Início em lote de tarefas
Lista de eventos do Operation Center
Lista de eventos
Instruções
Leia o conteúdo em inglês para compreender O QUE precisa ser comunicado
Escreva o texto em português do Brasil DO ZERO — esqueça a estrutura das frases em inglês
Preserve toda a formatação markdown, blocos de código, links e imagens exatamente como estão
Copie os placeholders de xref (
{XREF_N}) literalmente, sem traduzi-los ou modificá-losAplique todas as regras específicas do idioma com rigor
Siga as regras de stopwords com tolerância zero
Utilize o modo imperativo em passos numerados e listas de procedimentos
Garanta a consistência terminológica — o mesmo termo deve ter a mesma tradução em todo o documento
Varie os inícios de frase em listas e tabelas — nenhum início deve se repetir 3 ou mais vezes
-
Retorne APENAS o documento markdown em português do Brasil, sem explicações
ImportanteA modificação do grupo de recursos de agendamento ou a alteração do proprietário aciona o evento node-change-updated.
Tipo de evento
Evento (e operação de gatilho)
Evento padrão
Evento de ponto de extensão
Tipo de evento do EventBridge
(Tipo)
Código do evento de extensão (eventCode)
Alteração de nó
Exclusão de um nó
-
Implante a operação de exclusão para remover o nó de produção
-
Exclua um nó da lixeira


dataworks:NodeChange:NodeChangeDeletednode-change-deletedPré-evento para remoção de nó
Remove diretamente um nó das tarefas agendadas no ambiente de produção
NotaEsta operação também exclui o nó no Data Studio e o move para a lixeira.


dataworks:NodeChange:UndeployNodeundeploy-nodePré-evento para congelamento de nó
ImportanteEste evento também aciona o evento node-change-updated.


dataworks:NodeChange:FreezeNodefreeze-nodePré-evento para descongelamento de nó
ImportanteEste evento também aciona o evento node-change-updated.


dataworks:NodeChange:UnFreezeNodeunfreeze-nodeDados de backfill de nó
Pré-evento para dados de backfill


dataworks:BackfillDataOperate:BackfillDatabackfill-dataAlteração de status da tarefa
Alteração de status de tarefa agendada


dataworks:InstanceStatusChanges:InstanceStatusChangesinstance-status-changesAlterações de instância
Congelar instância


dataworks:InstanceChange:FreezeInstancefreeze-instanceDescongelar instância


dataworks:InstanceChange:UnfreezeInstanceunfreeze-instanceEncerrar instância


dataworks:InstanceChange:KillInstancekill-instanceReexecutar instância
-
Reexecutar
-
Reexecutar downstream


dataworks:InstanceChange:RerunInstancererun-instanceDefinir instância como bem-sucedida


dataworks:InstanceChange:SetInstanceSuccessset-instance-successRemover dependências upstream especificadas de uma instância


dataworks:InstanceChange:DeleteTaskInstanceDependenciesdelete-task-instance-dependenciesPré-evento para congelamento de instância


dataworks:InstanceChange:PreFreezeInstancepre-freeze-instancePré-evento para descongelamento de instância


dataworks:InstanceChange:PreUnfreezeInstancepre-unfreeze-instancePré-evento para reexecução de instância


dataworks:InstanceChange:PreRerunInstancepre-rerun-instancePré-evento para definição de instância como bem-sucedida


dataworks:InstanceChange:PreSetInstanceSuccesspre-set-instance-successPré-evento para encerramento de instância


dataworks:InstanceChange:PreKillInstancepre-kill-instanceExcluir instâncias expiradas


dataworks:InstanceChange:ExpiredTaskInstancesDeletedexpired-task-instances-deletedAlterações de status do fluxo de trabalho
Alterações de status do fluxo de trabalho
-
Instâncias de dados de backfill
-
Fluxos de trabalho manuais


dataworks:DagStatusChanges:DagStatusChangesdag-status-changesAlertas de monitoramento
Alertas de monitoramento


dataworks:MonitorAlert:WorkbenchMonitorAlertworkbench-monitor-alert -
Formato da mensagem
Eventos de alteração de nó (exclusão, cancelamento de publicação, congelamento e descongelamento)
Backfill de dados para nós
Evento de alteração de status da tarefa
Evento de alteração de instância (congelar, descongelar, terminar, reexecutar, definir como bem-sucedido)
Evento de alteração de pré-instância (congelar, descongelar, reexecutar, definir como bem-sucedido, eliminar instância)
Evento de alteração de instância - Excluir instâncias expiradas
Evento de remoção de dependência upstream específica da instância
Evento de alteração de status do fluxo de trabalho
Monitoring alerts
Lista de eventos do Security Center
Lista de eventos
|
Tipo de evento |
Evento (e operação de gatilho) |
Evento padrão |
Evento de ponto de extensão |
Tipo de evento do EventBridge (Type) |
Código de evento de extensões (eventCode) |
|
Approval center (V1) |
Create Permission Request Process V1 |
|
|
|
|
|
Complete Permission Request Process V1 |
|
|
|
|
|
|
Approval center (V2) |
Create Permission Request Process V2 |
|
|
|
|
|
Complete Permission Request Process V2 |
|
|
|
|
|
|
Security Center (permission request V1) |
Create Pre-event for Permission Request Form V1 |
|
|
|
|
|
Security Center (permission request V2) |
Create Pre-event for Permission Request Form V2 |
|
|
|
|
Formato da mensagem
Approval center (permission request process V1)
Approval Center (permission request process V2)
Security Center (permission request pre-creation event V1)
Security Center (permission request pre-creation event V2)
Guia de manutenção e migração de eventos V1
Apêndice: Lista de conteúdo de concessão (MaxCompute)
Apêndice: Lista de conteúdo de concessão (Data Service)
Lista de eventos de Data Quality
Instruções
Leia o conteúdo em inglês para compreender O QUE precisa ser comunicado
Escreva o português brasileiro DO ZERO — esqueça a estrutura das frases em inglês
Preserve toda a formatação markdown, blocos de código, links e imagens exatamente como estão
Copie os placeholders de xref (
{XREF_N}) literalmente, sem traduzir ou modificarAplique todas as regras específicas do idioma rigorosamente
Aplique as regras de stopwords com tolerância zero
Use o modo imperativo em passos numerados e listas de procedimentos
Garanta a consistência terminológica — o mesmo termo deve ter a mesma tradução em todo o documento
Varie os inícios de frase em listas e tabelas — nenhum início deve se repetir 3 vezes ou mais
-
Retorne APENAS o documento markdown em português brasileiro, sem explicações
Lista de eventos
Tipo de evento
Evento (e operação de gatilho)
Evento padrão
Evento de ponto de extensão
Tipo de evento do EventBridge
(Tipo)
Código do evento de extensão (eventCode)
Verificação de qualidade de dados
Feedback do resultado da verificação
-
Feedback fornecido pelo usuário sobre os resultados da verificação


dataworks:DqcCheck:DqcCheckFeedbackEventdqc-check-feedback-eventVerificação concluída
-
Envia o resultado da verificação de regras após a conclusão (inclui informações como aprovação ou reprovação, dados de amostra e outros detalhes)


dataworks:DqcCheck:DqcCheckFinishedEventdqc-check-finished-eventPré-evento de regra de qualidade de dados
Pré-evento para criação em lote de regras de qualidade de dados


dataworks:DqcCheck:BatchCreateDataQualityRulesbatch-create-data-quality-rulesPré-evento para atualização em lote de regras de qualidade de dados


dataworks:DqcCheck:BatchUpdateDataQualityRulesbatch-update-data-quality-rulesPré-evento para exclusão em lote de regras de qualidade de dados


dataworks:DqcCheck:BatchDeleteDataQualityRulesbatch-delete-data-quality-rulesPré-evento para atualização de regra de qualidade de dados


dataworks:DqcCheck:UpdateDataQualityRuleupdate-data-quality-rulePré-evento de monitoramento de qualidade de dados
Pré-evento para criação de monitoramento de qualidade de dados


dataworks:DqcCheck:CreateDataQualityEvaluationTaskcreate-data-quality-evaluation-taskPré-evento para atualização de monitoramento de qualidade de dados


dataworks:DqcCheck:UpdateDataQualityEvaluationTaskupdate-data-quality-evaluation-taskPré-evento para clonagem de monitoramento de qualidade de dados


dataworks:DqcCheck:CloneDataQualityEvaluationTaskclone-data-quality-evaluation-taskPré-evento para exclusão em lote de monitoramentos de qualidade de dados


dataworks:DqcCheck:BatchDeleteDataQualityEvaluationTasksbatch-delete-data-quality-evaluation-tasksPré-evento de assinatura de alerta de monitoramento de qualidade de dados
Pré-evento para criação de assinatura de alerta de monitoramento de qualidade de dados


dataworks:DqcCheck:CreateDataQualityEvaluationTaskNotificationcreate-data-quality-evaluation-task-notification
Pré-evento para atualização de assinatura de alerta de monitoramento de qualidade de dados


dataworks:DqcCheck:UpdateDataQualityEvaluationTaskNotificationupdate-data-quality-evaluation-task-notificationPré-evento para exclusão de assinatura de alerta de monitoramento de qualidade de dados


dataworks:DqcCheck:DeleteDataQualityEvaluationTaskNotificationdelete-data-quality-evaluation-task-notificationFormato da mensagem
Verificação de Data Quality
Eventos de ponto de extensão para regras de qualidade de dados (criação, atualização e exclusão em lote)
Pré-eventos de monitoramento de qualidade de dados (criar, atualizar, clonar e excluir em lote)
Eventos de ponto de extensão de assinatura de alerta de monitoramento de Data Quality (criação, atualização e exclusão)
-
Instruções
Leia o texto em inglês para compreender O QUE precisa ser comunicado
Escreva o português brasileiro DO ZERO — esqueça a estrutura das frases em inglês
Preserve toda a formatação markdown, blocos de código, links e imagens exatamente como estão
Copie os placeholders xref (
{XREF_N}) literalmente, NÃO os traduza ou modifiqueAplique todas as regras específicas de idioma rigorosamente
Aplique as regras de stopwords com tolerância zero
Use o modo imperativo em etapas numeradas e listas de procedimentos
Garanta a consistência terminológica — o mesmo termo deve ter a mesma tradução em todo o documento
Varie os inícios de frase em listas e tabelas — nenhum início deve se repetir mais de 3 vezes
-
Retorne APENAS o documento markdown em português brasileiro, sem explicações
Eventos no nível do locatário
Os eventos gerados por módulos no nível do locatário são classificados como eventos desse nível, como eventos gerados quando um workspace é excluído no console. Utilize a lista de eventos abaixo para identificar quais são eventos padrão e quais são eventos de ponto de extensão, além de seus formatos de mensagem.
As abas de formato de mensagem a seguir contêm apenas conteúdo parcial. Para obter as mensagens completas enviadas ao EventBridge ou Function Compute, consulte Appendix: Message format.
Lista de eventos do Console
Lista de eventos
|
Tipo de evento |
Evento (e operação de gatilho) |
Evento padrão |
Evento de ponto de extensão |
Tipo de evento do EventBridge (Type) |
Tipo de evento de extensões (eventCode) |
|
Excluir workspace |
Evento de ponto de extensão de exclusão de workspace |
|
|
|
|
|
Evento pós-exclusão de workspace |
|
|
|
|
Formato da mensagem
Formato da entidade de mensagem: Eventos de exclusão de workspace
Lista de eventos de Upload e Download de Dados
Lista de eventos
|
Tipo de evento |
Evento (e operação de gatilho) |
Evento padrão |
Evento de ponto de extensão |
Tipo de evento do EventBridge (Type) |
Código de evento de extensão (eventCode) |
|
Download e upload de dados |
Pré-evento para download de dados - geração de arquivo |
|
|
dataworks:ResourcesDownload:DownloadResources |
download-resources |
|
Pré-evento para download de dados - download de arquivo |
|
|
dataworks:ResourcesDownload:DownloadResourcesExecute |
download-resources-execute |
|
|
Pré-evento para upload de dados |
|
|
dataworks:ResourcesUpload:UploadDataToTable |
upload-data-to-table |
Formato da mensagem
Download e upload de dados
Apêndice: Formato da mensagem
Formato de mensagem para EventBridge
Após configurar Open Event e adicionar um canal de distribuição de eventos, quando um evento no nível do workspace ou nível do locatário for acionado no DataWorks, o evento será filtrado com base no tipo de evento (Type) configurado no EventBridge. Abaixo está o formato da mensagem que o DataWorks envia ao EventBridge por meio do canal de distribuição de eventos.
{
"datacontenttype": "application/json;charset=utf-8",// The content format of the data parameter. Only application/json is supported for datacontenttype.
"data": {
// The message content varies depending on the message type. The following two fields are fixed in the message. For event messages, see the preceding sections.
"tenantId": 28378****10656,// The tenant ID. Each Alibaba Cloud account corresponds to a tenant in DataWorks, and each tenant has its own tenant ID. You can view this value in the user information in the upper-right corner of Data Studio in DataWorks.
"eventCode": "xxxx"//
},
"id": "539fd8f4-4ea1-4625-aa8b-6c906674****",// The event ID. A unique value that identifies the event.
"source": "acs.dataworks",// The event source, which is the service that provides the event. This indicates that the message is pushed by DataWorks.
"specversion": "1.0",
"subject": "",
"time": "2020-11-19T21:04:41+08:00",// The time when the event was generated.
"type": "dataworks:InstanceStatusChanges:InstanceStatusChanges",// The event type. You can use this event type to filter all messages pushed by DataWorks in the EventBridge console. The Type value varies for each event. See the preceding sections for different event message types.
"aliyunaccountid": "123456789098****",// The Alibaba Cloud account ID.
"aliyunpublishtime": "2020-11-19T21:04:42.179PRC",// The time when EventBridge received the event.
"aliyuneventbusname": "example-bus",// The name of the EventBridge event bus used to receive DataWorks event messages.
"aliyunregionid": "cn-hangzhou",// The region where the event is received.
"aliyunpublishaddr": "172.25.XX.XX"
}
Uma mensagem de evento completa inclui o corpo da mensagem e informações básicas, como ID da mensagem, origem e hora de geração. A tabela a seguir descreve os campos importantes.
|
Campo |
Tipo |
Descrição |
|
data |
object |
Corpo da mensagem. O formato da mensagem e o significado dos campos variam conforme o tipo de evento. Para mais informações, consulte: Formato de mensagem de evento do Data Studio: Data Studio event list. Formato de mensagem de evento do Data Integration: Data Integration event list. Formato de mensagem de evento do Operation Center: Operation Center event list. Formato de mensagem de evento do Security Center: Security Center event list. Formato de mensagem de evento do Data Quality: Data Quality event list. |
|
id |
String |
ID exclusivo da mensagem de evento. Este campo serve para localizar a mensagem de evento. |
|
type |
String |
Tipo de evento. Este campo descreve o tipo de evento relacionado à origem do evento. Exemplos:
Use este tipo de evento para filtrar todas as mensagens enviadas pelo DataWorks no console do EventBridge. O valor de Type varia para cada evento. Consulte as seções anteriores para ver os diferentes tipos de mensagens de evento. |
Formato de mensagem para Function Compute
Ao configurar Extensions com o método Function Compute no DataWorks, o sistema envia mensagens de evento em formato JSON para o Function Compute quando o evento de ponto de extensão correspondente é acionado. Abaixo está o formato da mensagem enviada ao Function Compute.
Instruções
Leia o texto em inglês para entender O QUE precisa ser comunicado
Escreva o português brasileiro DO ZERO — esqueça a estrutura das frases em inglês
Preserve toda a formatação markdown, blocos de código, links e imagens exatamente como estão
Copie os placeholders xref (
{XREF_N}) literalmente, NÃO os traduza ou modifiqueAplique todas as regras específicas de idioma rigorosamente
Aplique as regras de stopwords com tolerância zero
Use o modo imperativo em etapas numeradas e listas de procedimentos
Garanta a consistência terminológica — o mesmo termo deve ter a mesma tradução em todo o documento
Varie os inícios de frase em listas/tabelas — nenhum iniciador deve se repetir mais de 3 vezes
-
Retorne APENAS o documento markdown em português brasileiro, sem explicações
{ "blockBusiness": true, "eventCategoryType": "resources-download",// The event category. "eventType": "upload-data-to-table",// The event type. "extensionBizId": "job_6603***070", "messageBody": { // The message content varies depending on the message type. The following two fields are fixed in the message. For event messages, see the preceding sections. "tenantId": 28378****10656,// The tenant ID. Each Alibaba Cloud account corresponds to a tenant in DataWorks, and each tenant has its own tenant ID. You can view this value in the user information in the upper-right corner of Data Studio in DataWorks. "eventCode": "xxxx"// }, "messageId": "52d44ee7-b51f-4d4d-afeb-*******"// The event ID. A unique value that identifies the event. }
A tabela a seguir descreve os campos importantes.
|
Campo |
Tipo |
Descrição |
|
|
messageId |
String |
ID do evento. Valor único que identifica o evento. |
|
|
messageBody |
Mensagem específica do evento enviada pelo DataWorks. Utilize este campo ao desenvolver Extensions. O conteúdo varia conforme o tipo de mensagem. |
||
|
tenantId |
ID do tenant. Cada conta Alibaba Cloud corresponde a um tenant no DataWorks, e cada tenant possui seu próprio ID. Visualize esse valor nas informações do usuário, no canto superior direito do Data Studio no DataWorks. |
||
|
eventCode |
Código do evento. Este campo identifica um tipo específico de mensagem de evento. Para consultar o eventCode de cada tipo de evento, consulte a coluna Código de evento da Extension (eventCode) na tabela event list. |
||