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

Consulta a lista de modelos de regras de qualidade de dados em um projeto especificado.

Descrição da operação

Você deve adquirir o DataWorks Basic Edition ou uma edição 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:ListDataQualityTemplates

list

*Todos os recursos.

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Catalog	string	Não	O caminho do catálogo ao qual o modelo de qualidade de dados pertence.	/timeliness/ods_layer.
ProjectId	integer	Não	O ID do projeto.	10000
Name	string	Não	O nome da regra do modelo para correspondência difusa.	table_rows.
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros da resposta.
RequestId	string	O ID da solicitação.	0bc14115***159376359
PageInfo	object	O resultado da consulta paginada dos modelos de regras de qualidade de dados.
TotalCount	integer	O número total de entradas.	10
PageSize	integer	O tamanho da página.	20
PageNumber	integer	O número da página.	1
DataQualityTemplates	array<object>	A lista de modelos de regras.
	object	O modelo de regra.
ModifyTime	integer	A hora em que o modelo de regra de qualidade de dados foi atualizado.	1729816478147
Owner	string	O proprietário do modelo de regra de qualidade de dados.	205250754596036836
ModifyUser	string	O último atualizador do modelo de regra de qualidade de dados.	205250754596036836
CreateTime	integer	A hora em que o modelo de regra de qualidade de dados foi criado.	1729816478147
ProjectId	integer	O ID do projeto.	7635
CreateUser	string	O criador do modelo de regra de qualidade de dados.	7892346529452
Id	string	O ID do modelo de regra de qualidade de dados.	819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a
Spec	string	Configurações específicas do modelo de regra de qualidade de dados. Para mais informações, consulte Descrição da configuração do Spec de qualidade de dados.	{ "assertion": "anomaly detection fro id_not_null_cnt", "id_not_null_cnt": { "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = '$[yyyymmdd-1]';" }, "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a" }

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0bc14115***159376359",
  "PageInfo": {
    "TotalCount": 10,
    "PageSize": 20,
    "PageNumber": 1,
    "DataQualityTemplates": [
      {
        "ModifyTime": 1729816478147,
        "Owner": "205250754596036836",
        "ModifyUser": "205250754596036836",
        "CreateTime": 1729816478147,
        "ProjectId": 7635,
        "CreateUser": "7892346529452",
        "Id": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a",
        "Spec": "{\n    \"assertion\": \"anomaly detection fro id_not_null_cnt\",\n    \"id_not_null_cnt\": {\n        \"query\": \"SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = '$[yyyymmdd-1]';\"\n    },\n    \"identity\": \"819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a\"\n}"
      }
    ]
  }
}

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.