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

Consulta a lista de regras de alerta de qualidade de dados em um projeto.

Descrição da operação

É necessário o DataWorks Basic Edition ou uma edição superior.

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

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
ProjectId	integer	Sim	O ID do projeto.	10001
DataQualityScanId	integer	Não	O ID do monitor de qualidade de dados que a regra de alerta tem como alvo.	10001
SortBy	string	Não	A lista de campos de ordenação. Suporta campos como a hora da última modificação e a hora de criação. Formato: SortField+SortOrder (Desc/Asc), em que Asc é o valor padrão. Valores válidos: CreateTime (Desc/Asc) Id (Desc/Asc)	CreateTime Desc
PageNumber	integer	Sim	O número da página dos resultados.	1
PageSize	integer	Sim	O número de registros a serem retornados em cada página.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	0bc14115***159376359
PageInfo	object	Configurações de regras de alerta.
TotalCount	integer	O número total de entradas que atendem às condições.	335
PageNumber	integer	O número da página atual.	1
PageSize	integer	O número de registros por página.	10
DataQualityAlertRules	array<object>	A lista de configurações de regras de alerta.
	array<object>	Configurações de regras de alerta.
Condition	string	As condições de alerta.	results.any { r -> r.status == 'fail' && r.rule.severity == 'High' }
Target	object	Alvos monitorados da regra de alerta de qualidade de dados.
Type	string	O tipo do alvo monitorado. Apenas DataQualityScan é suportado.	DataQualityScan
Ids	array	A lista de IDs dos alvos monitorados.
	integer	O ID do alvo monitorado.	7638999336
ProjectId	integer	O ID do projeto.	59094
Id	integer	O ID da regra de alerta do monitor de qualidade de dados.	26433
Notification	object	Configurações de notificação de alerta.
Receivers	array<object>	Os destinatários do alerta.
	object	Os destinatários do alerta.
Extension	string	Configurações adicionais necessárias para os destinatários do alerta. Quando ReceiverType for DingdingUrl, você pode definir {"atAll":true} para mencionar todos os membros.	{"atAll":true}
ReceiverType	string	O tipo de destinatários do alerta. ShiftSchedule WebhookUrl FeishuUrl TaskOwner WeixinUrl DingdingUrl DataQualityScanOwner AliUid	AliUid
ReceiverValues	array	O valor dos destinatários do alerta.
	string	O valor dos destinatários do alerta. Se ReceiverType for AliUid, insira o ID da conta Alibaba Cloud. Se ReceiverType for ShiftSchedule, insira o ID da escala de turnos. Se ReceiverType for WebhookUrl, DingdingUrl, FeishuUrl ou WeixinUrl, insira a URL correspondente.	https://oapi.dingtalk.com/robot/send?access_token=a30bae7******
Channels	array	Em Channels, você pode definir Email e Sms ao mesmo tempo. Em outros casos, apenas um canal pode ser definido.
	string	Canais de alerta. Mail Weixin Feishu Phone Sms Webhook	Sms

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0bc14115***159376359",
  "PageInfo": {
    "TotalCount": 335,
    "PageNumber": 1,
    "PageSize": 10,
    "DataQualityAlertRules": [
      {
        "Condition": "results.any { r -> r.status == 'fail' && r.rule.severity == 'High' }",
        "Target": {
          "Type": "DataQualityScan",
          "Ids": [
            7638999336
          ]
        },
        "ProjectId": 59094,
        "Id": 26433,
        "Notification": {
          "Receivers": [
            {
              "Extension": "{\"atAll\":true}",
              "ReceiverType": "AliUid",
              "ReceiverValues": [
                "https://oapi.dingtalk.com/robot/send?access_token=a30bae7******"
              ]
            }
          ],
          "Channels": [
            "Sms"
          ]
        }
      }
    ]
  }
}

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.