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

Consulta os registros de execução de varredura de qualidade de dados de um projeto especificado.

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

list

*All Resource

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DataQualityScanId	integer	Não	O ID do monitoramento de qualidade de dados.	10001
CreateTimeFrom	integer	Não	A hora de início mais antiga da execução do monitoramento de qualidade de dados.	1710239005403
CreateTimeTo	integer	Não	A hora de início mais recente da execução do monitoramento de qualidade de dados.	1710239005403
Status	string	Não	O status do resultado da verificação de qualidade de dados. Valores válidos: Pass Running Error Fail Warn Valores válidos: Pass : Aprovado. Running : Em execução. Error : Erro. Kill : Encerrado. Fail : Falha. Warn : Aviso.	Fail
SortBy	string	Não	A lista de campos de ordenação. Campos como hora de modificação e hora de criação são suportados. O formato é "SortField+SortOrder(Desc/Asc)". O valor padrão é Asc, que pode ser omitido. Valores válidos para o campo de ordenação: CreateTime (Desc/Asc) Id (Desc/Asc)	CreateTime Desc
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10.	20
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
ProjectId	integer	Sim	O ID do projeto.	12345
Filter	object	Não	O filtro de consulta de extensão. Os seguintes parâmetros de filtro são suportados: TaskInstanceId: o ID da instância da tarefa agendada. RunNumber: o número de vezes que a instância foi executada.	{ "TaskInstanceId": "111", "RunNumber": "1" }

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	0bc14115***159376359
PageInfo	object	As informações de paginação.
TotalCount	integer	O número total de entradas.	324
PageSize	integer	O número de entradas por página. Valor padrão: 10.	10
PageNumber	integer	O número da página. Valor padrão: 1.	1
DataQualityScanRuns	array<object>	A lista de registros de execução do monitoramento de qualidade de dados.
	array<object>	A lista de registros de execução do monitoramento de qualidade de dados.
Id	integer	O ID do registro de execução do monitoramento de qualidade de dados.	3155
CreateTime	integer	A hora de início da execução do monitoramento de qualidade de dados. O valor é um número de 13 dígitos, como `1710239005403`.	1710239005403
FinishTime	integer	A hora de término da execução do monitoramento de qualidade de dados. O valor é um número de 13 dígitos, como `1710239005403`.	1710239005403
Status	string	O status de execução atual. Valores válidos: Pass Running Error Warn Fail	Fail
Parameters	array<object>	As configurações de parâmetros usadas durante a execução real.
	object	As informações do parâmetro.
Name	string	O nome do parâmetro.	dt
Value	string	O valor do parâmetro. Você pode usar uma expressão de tempo de agendamento.	$[yyyy-mm-dd-1]

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0bc14115***159376359",
  "PageInfo": {
    "TotalCount": 324,
    "PageSize": 10,
    "PageNumber": 1,
    "DataQualityScanRuns": [
      {
        "Id": 3155,
        "CreateTime": 1710239005403,
        "FinishTime": 1710239005403,
        "Status": "Fail",
        "Parameters": [
          {
            "Name": "dt",
            "Value": "$[yyyy-mm-dd-1]"
          }
        ]
      }
    ]
  }
}

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.