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

Obtém os detalhes de uma regra de alerta de qualidade de dados por ID da regra.

Descrição da operação

É necessária a edição Basic do DataWorks 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:GetDataQualityAlertRule

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Id	integer	Não	O ID da regra de alerta de monitoramento de qualidade de dados.	113642

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	0bc14115****159376359
DataQualityAlertRule	object	As regras de alerta de monitoramento de qualidade de dados.
Id	integer	O ID da regra de alerta de monitoramento de qualidade de dados.	21045
Condition	string	As condições de alerta da regra de alerta de monitoramento de qualidade de dados.	results.any { r -> r.status == 'fail' && r.rule.severity == 'High' }
ProjectId	integer	O ID do projeto.	90912
Target	object	O destino monitorado da regra de alerta de monitoramento de qualidade de dados.
Type	string	The type of the monitored target. Only `DataQualityScan` is supported.	DataQualityScan
Ids	array	The list of monitored target IDs.
	integer	The monitored target ID.	113647
Notification	object	As configurações de notificação de alerta.
Channels	array	In Channels, you can set both Email and Sms at the same time. In other cases, only one channel can be set.
	string	Alert channels. Dingding Mail Weixin Feishu Phone Sms Webhook	Dingding
Receivers	array<object>	The alert recipients.
	object	The alert recipients.
Extension	string	Additional configurations required for the alert recipients. When ReceiverType is DingdingUrl, you can set `{"atAll":true}` to mention all members.	{"atAll":true}
ReceiverType	string	The type of alert recipients. ShiftSchedule WebhookUrl FeishuUrl TaskOwner WeixinUrl DingdingUrl DataQualityScanOwner AliUid	TaskOwner
ReceiverValues	array	The value of alert recipients.
	string	The value of alert recipients. If ReceiverType is AliUid, enter the Alibaba Cloud account ID. If ReceiverType is ShiftSchedule, enter the shift schedule ID. If ReceiverType is WebhookUrl, DingdingUrl, FeishuUrl, or WeixinUrl, enter the corresponding URL.	https://oapi.dingtalk.com/robot/send?access_token=a30bae7******

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0bc14115****159376359",
  "DataQualityAlertRule": {
    "Id": 21045,
    "Condition": "results.any { r -> r.status == 'fail' && r.rule.severity == 'High' }",
    "ProjectId": 90912,
    "Target": {
      "Type": "DataQualityScan",
      "Ids": [
        113647
      ]
    },
    "Notification": {
      "Channels": [
        "Dingding"
      ],
      "Receivers": [
        {
          "Extension": "{\"atAll\":true}",
          "ReceiverType": "TaskOwner",
          "ReceiverValues": [
            "https://oapi.dingtalk.com/robot/send?access_token=a30bae7******"
          ]
        }
      ]
    }
  }
}

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.