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

Realiza uma consulta paginada da lista de instâncias de tarefas de monitoramento de qualidade.

Nota

Esta API foi descontinuada. Recomendamos migrar para dataworks-public(2024-05-18) - ListDataQualityScanRuns 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 superior para usar este recurso.

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 Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Sim	O ID do workspace do DataWorks.	100
DataQualityEvaluationTaskId	integer	Não	O ID da tarefa de avaliação de qualidade de dados.	10000
TableGuid	string	Não	O ID exclusivo da tabela no Data Map.	odps.unit_test.tb_unit_test
CreateTimeFrom	integer	Não	O horário de início mais antigo da instância da tarefa de avaliação de qualidade de dados.	1710239005403
CreateTimeTo	integer	Não	O horário de início mais recente da instância da tarefa de avaliação de qualidade de dados.	1710239005403
BizdateFrom	string	Não	A data de início de negócios da tarefa de avaliação de qualidade.	2024-04-01
BizdateTo	string	Não	A data de término de negócios da tarefa de avaliação de qualidade.	2024-05-01
TriggerClientId	string	Não	O TriggerClientId no TriggerContext.	1001
TriggerClient	string	Não	O TriggerClient no TriggerContext.	CWF2
PageSize	integer	Sim	O tamanho da página para a consulta de paginação da lista. Valor padrão: 10.	10
PageNumber	integer	Sim	O número da página para a consulta de paginação da lista. Valor padrão: 1.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O valor de retorno.
RequestId	string	O ID da solicitação da API.	691CA452-D37A-4ED****
PagingInfo	object	O resultado da consulta de paginação das instâncias de tarefas de avaliação de qualidade.
PageNumber	integer	O número da página.	1
PageSize	integer	O tamanho da página.	10
TotalCount	integer	O número total de registros.	294
DataQualityEvaluationTaskInstances	array<object>	A TaskInstance acionada com sucesso.
	array<object>
Id	integer	The ID of the quality check task instance.	10001
CreateTime	integer	The creation time of the task instance.	1710239005403
FinishTime	integer	The end time of the task instance.	1710239005403
Status	string	The current running status. Running Error Passed Warned Critical	Critical
Parameters	string	The parameter settings used during the actual runtime.	{ "bizdate": "20240517", "triggerTime": "1710239005403" }
TriggerContext	string	The context information when the instance is triggered.	{ "TriggerClientId": 10001, "TriggerClient": "CWF2" }
ProjectId	integer	The ID of the DataWorks project workspace.	100
Task	object	The snapshot of the data quality evaluation task when the evaluation starts.
Id	integer	The ID of the data quality evaluation task.	10001
Description	string	The description of the quality monitoring task.	This is a daily run data quality evaluation plan.
ProjectId	integer	The ID of the project workspace.	100
Target	object	The monitoring object of the data quality evaluation task.
Type	string	The type of the monitoring object. Table	Table
DatabaseType	string	For a dataset of table type, the database type to which the table belongs. maxcompute emr cdh hologres analyticdb_for_postgresql analyticdb_for_mysql starrocks	maxcompute
TableGuid	string	The unique ID of the table in Data Map.	odps.unit_test.tb_unit_test
PartitionSpec	string	The partition settings of the partitioned table.	ds=$[yyyymmdd-1]
Trigger	object	The trigger configuration of the data quality evaluation task.
Type	string	The type of event that can trigger the execution of the quality evaluation task. ByScheduledTaskInstance: A scheduled instance runs successfully.	ByScheduledTaskInstance
TaskIds	array	The IDs of scheduled task nodes.
	integer	The ID of the scheduled task node.	10000
RuntimeConf	string	Settings used when accessing data sources. Currently, only specifying the YARN queue of EMR and specifying the SQL engine as SPARK_SQL\|KYUUBI\|PRESTO_SQL\|HIVE_SQL when collecting EMR tables are supported.	{ "queue": "default", "sqlEngine": "SPARK_SQL" }
Hooks	array<object>	The callback settings in the lifecycle of the data quality evaluation task instance. Currently, only one Hook for blocking scheduled tasks is supported.
	object	Hook.
Type	string	The type of the subsequent processing action. BlockTaskInstance: Blocks the execution of the DataWorks task instance.	BlockTaskInstance
Condition	string	The trigger condition of the Hook.	${severity} == "High" AND ${status} == "Critical"
Notifications	object	The notification subscription configuration.
Condition	string	The trigger condition of the notification.	${severity} == "High"
Notifications	array<object>	The notification settings.
	array<object>	The notification settings.
NofiticationReceivers	array<object>	The alert recipient settings.
	object	The alert recipient settings.
ReceiverType	string	The type of the alert recipient. AliUid - The UID of the Alibaba Cloud account WebhookUrl - A custom webhook URL DingdingUrl - The URL of a DingTalk bot FeishuUrl - The URL of a Lark bot WeixinUrl - The URL of a WeCom bot	AliUid
Extension	string	The extension information, in JSON format. For example, a DingTalk bot supports at-all.	{"atAll":"true"}
ReceiverValues	array	The alert recipient.
	string	The specific value of the alert recipient.	10000001
NotificationChannels	array<object>	The alert method.
	object	The notification method.
Channels	array	The alert method.
	string	Mail - Email Sms - SMS Phone - Phone call Feishu - Lark Weixin - WeChat Dingding - DingTalk Webhook - Custom Webhook	Mail
Name	string	The name of the quality monitoring task.	Quality verification task

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "691CA452-D37A-4ED****",
  "PagingInfo": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 294,
    "DataQualityEvaluationTaskInstances": [
      {
        "Id": 10001,
        "CreateTime": 1710239005403,
        "FinishTime": 1710239005403,
        "Status": "Critical",
        "Parameters": "{\n  \"bizdate\": \"20240517\",\n  \"triggerTime\": \"1710239005403\"\n}",
        "TriggerContext": "{\n  \"TriggerClientId\": 10001,\n  \"TriggerClient\": \"CWF2\"\n}",
        "ProjectId": 100,
        "Task": {
          "Id": 10001,
          "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": [
              10000
            ]
          },
          "RuntimeConf": "{ \"queue\": \"default\", \"sqlEngine\": \"SPARK_SQL\" }",
          "Hooks": [
            {
              "Type": "BlockTaskInstance",
              "Condition": "${severity} == \"High\" AND ${status} == \"Critical\""
            }
          ],
          "Notifications": {
            "Condition": "${severity} == \"High\"",
            "Notifications": [
              {
                "NofiticationReceivers": [
                  {
                    "ReceiverType": "AliUid",
                    "Extension": "{\"atAll\":\"true\"}",
                    "ReceiverValues": [
                      "10000001"
                    ]
                  }
                ],
                "NotificationChannels": [
                  {
                    "Channels": [
                      "Mail"
                    ]
                  }
                ]
              }
            ]
          },
          "Name": "Quality verification task"
        }
      }
    ]
  }
}

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.