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

Consulta a lista de tarefas de monitoramento de qualidade de dados por página.

Nota

Esta API foi descontinuada. Recomendamos migrar para dataworks-public(2024-05-18) - ListDataQualityScans para funcionalidade aprimorada e suporte contínuo. Embora a API descontinuada permaneça temporariamente acessível, nenhuma atualização ou correção de bugs será fornecida.

Descrição da operação

Você deve adquirir o DataWorks Basic Edition ou uma edição superior para usar esta operação de API.

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

list

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Não	O ID do workspace do DataWorks.	100
TableGuid	string	Não	O ID exclusivo da tabela no Data Map.	odps.unit_test.tb_unit_test
Name	string	Não	A palavra-chave usada para correspondência aproximada do nome da tarefa de verificação de qualidade de dados.	Test
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10.	10
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação de API.	691CA452-D37A-4ED0-****
PagingInfo	object	Os resultados da consulta paginada das tarefas de verificação de qualidade de dados.
TotalCount	string	O número total de entradas.	131
PageSize	string	O número de entradas por página.	10
PageNumber	string	O número da página.	1
DataQualityEvaluationTasks	array<object>	As tarefas de verificação de qualidade de dados.
	array<object>
Id	integer	O ID da tarefa de verificação de qualidade de dados.	10001
Name	string	O nome da tarefa de verificação de qualidade de dados. O nome pode conter dígitos, letras, caracteres chineses e marcas de pontuação de meia largura ou largura total, e pode ter até 255 caracteres de comprimento.	Data quality verification task
Description	string	A descrição da tarefa de verificação de qualidade de dados. A descrição pode ter até 65.535 caracteres de comprimento.	This is a daily run data quality evaluation plan
ProjectId	integer	O ID do workspace do DataWorks.	100
Target	object	O objeto monitorado da tarefa de verificação de qualidade de dados.
Type	string	O tipo do objeto monitorado. Tabela	Table
DatabaseType	string	O tipo de banco de dados da tabela para conjuntos de dados do tipo tabela. Valores válidos: maxcompute emr cdh hologres analyticdb_for_postgresql analyticdb_for_mysql starrocks	maxcompute
TableGuid	string	O ID exclusivo da tabela no Data Map.	odps.unit_test.tb_unit_test
PartitionSpec	string	As configurações de partição da tabela particionada.	ds=$[yyyymmdd-1]
Trigger	object	A configuração de gatilho da tarefa de verificação de qualidade de dados.
Type	string	O evento que aciona a execução da tarefa de verificação de qualidade de dados. ByScheduledTaskInstance: A instância agendada é executada com êxito.	ByScheduledTaskInstance
TaskIds	array	Os IDs dos nós agendados. Este parâmetro entra em vigor apenas quando Type é definido como ByScheduledTaskInstance. Ele especifica os nós agendados cuja execução bem-sucedida da instância aciona a tarefa.
	integer	O ID do nó agendado.	10001
RuntimeConf	string	As configurações usadas ao acessar a fonte de dados. Atualmente, você pode especificar apenas a fila YARN para EMR e definir o mecanismo SQL como SPARK_SQL, KYUUBI, PRESTO_SQL ou HIVE_SQL ao coletar tabelas EMR.	{ "queue": "default", "sqlEngine": "SPARK_SQL" }
Hooks	array<object>	As configurações de callback no ciclo de vida da instância da tarefa de verificação de qualidade de dados. Atualmente, há suporte apenas para um hook que bloqueia a tarefa agendada.
	object	As configurações de callback.
Type	string	O tipo da ação subsequente. BlockTaskInstance: Bloqueia a execução da instância da tarefa do DataWorks.	BlockTaskInstance
Condition	string	A condição de acionamento do hook.	${severity} == "High" AND ${status} == "Critical"
Notifications	object	A configuração de alerta.
Condition	string	A condição de acionamento da notificação.	${severity} == "High"
Notifications	array<object>	As configurações de alerta específicas.
	array<object>	As configurações de alerta.
NotificationChannels	array<object>	A configuração do canal de notificação.
	object	O canal de notificação.
Channels	array	O canal de notificação.
	string	O canal de notificação. Mail: E-mail Sms: Mensagem de texto Phone: Chamada telefônica Feishu: Lark Weixin: WeChat Dingding: DingTalk Webhook: Webhook personalizado	Mail
NotificationReceivers	array<object>	A configuração do destinatário do alerta.
	object	O destinatário do alerta.
ReceiverType	string	O tipo do destinatário do alerta. AliUid: UID da conta Alibaba Cloud WebhookUrl: URL do webhook personalizado DingdingUrl: URL do webhook do chatbot do DingTalk FeishuUrl: URL do webhook do chatbot do Lark WeixinUrl: URL do webhook do chatbot do WeCom	AliUid
ReceiverValues	array	O valor específico do destinatário do alerta.
	string	O valor específico do destinatário do alerta.	user1
Extension	string	As informações estendidas no formato JSON. Por exemplo, os chatbots do DingTalk oferecem suporte à menção de todos os membros.	{"atAll":"true"}
DataSourceId	integer	O ID da fonte de dados usada pela tarefa de monitoramento de qualidade de dados.	45238

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "691CA452-D37A-4ED0-****",
  "PagingInfo": {
    "TotalCount": "131",
    "PageSize": "10",
    "PageNumber": "1",
    "DataQualityEvaluationTasks": [
      {
        "Id": 10001,
        "Name": "Data quality verification task",
        "Description": "This is a daily run data quality evaluation plan",
        "ProjectId": 100,
        "Target": {
          "Type": "Table",
          "DatabaseType": "maxcompute",
          "TableGuid": "odps.unit_test.tb_unit_test",
          "PartitionSpec": "ds=$[yyyymmdd-1]"
        },
        "Trigger": {
          "Type": "ByScheduledTaskInstance",
          "TaskIds": [
            10001
          ]
        },
        "RuntimeConf": "{ \"queue\": \"default\", \"sqlEngine\": \"SPARK_SQL\" }",
        "Hooks": [
          {
            "Type": "BlockTaskInstance",
            "Condition": "${severity} == \"High\" AND ${status} == \"Critical\""
          }
        ],
        "Notifications": {
          "Condition": "${severity} == \"High\"",
          "Notifications": [
            {
              "NotificationChannels": [
                {
                  "Channels": [
                    "Mail"
                  ]
                }
              ],
              "NotificationReceivers": [
                {
                  "ReceiverType": "AliUid",
                  "ReceiverValues": [
                    "user1"
                  ],
                  "Extension": "{\"atAll\":\"true\"}"
                }
              ]
            }
          ]
        },
        "DataSourceId": 45238
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.