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

Consulta as regras de alerta configuradas para uma tarefa de sincronização.

Descrição da operação

Você deve adquirir o DataWorks Basic Edition ou uma edição superior para usar esta operação.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
JobId	integer	Não	O ID da tarefa para a qual as regras de alerta estão configuradas.	1000001
PageNumber	integer	Não	O número da página.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10
DIAlarmRuleId	integer	Não	O ID da regra de alerta. Se você deixar este parâmetro vazio, todas as regras de alerta da tarefa serão consultadas.	34988

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação. Você pode usar o ID para consultar logs e solucionar problemas.	74C2FECD-5B3A-554A-BCF5-351A36DE9815
PagingInfo	object	As informações de paginação.
TotalCount	integer	O número total de entradas que atendem às condições.	90
PageNumber	integer	O número da página. As páginas começam a partir da página 1.	1
PageSize	integer	O número de entradas por página.	10
DIJobAlarmRules	array<object>	As regras de alerta.
	array<object>	Os detalhes de uma regra de alerta.
Id	integer	O ID da regra de alerta.	72402
DIJobId	integer	O ID da tarefa de sincronização.	32594
Description	string	A descrição da regra de alerta.	rule descrition
MetricType	string	O tipo de métrica na regra de alerta. Valores válidos: Heartbeat: alerta de status da tarefa FailoverCount: alerta de contagem de failover Delay: alerta de latência da tarefa DdlReport: notificação de DDL ResourceUtilization: utilização do grupo de recursos	Heartbeat
Name	string	O nome da regra de alerta.	rule_name
Enabled	boolean	Indica se a regra de alerta está ativada. Valores válidos: True e False.	True
TriggerConditions	array<object>	As condições usadas para acionar a regra de alerta.
	object	A condição usada para acionar a regra de alerta.
Severity	string	O nível de gravidade. Valores válidos: Warning Critical	Critical
Duration	integer	O intervalo de tempo para cálculo do alerta. Unidade: minutos.	1
Threshold	integer	O limite do alerta. Se a regra de alerta for para o status da tarefa, nenhum limite será usado. Se a regra de alerta for para failovers, o limite será o número de failovers. Se a regra de alerta for para latência, o limite será a duração da latência, em segundos.	5
DdlTypes	array	Os tipos de operações DDL para os quais a regra de alerta entra em vigor. Este parâmetro é retornado apenas se o parâmetro MetricType estiver definido como DdlReport.
	string	O tipo de operação DDL para a qual a regra de alerta entra em vigor. Este parâmetro é retornado apenas se o parâmetro MetricType estiver definido como DdlReport. Valores válidos: AlterAddColumn: adicionar uma coluna AlterDropColumn: remover uma coluna AlterRenameColumn: renomear uma coluna AlterRenameTable: renomear uma tabela AlterTableModify: outras modificações de tabela DropTable: remover uma tabela TruncateTable: esvaziar uma tabela	AlterAddColumn
DdlReportTags `deprecated`	array	Este parâmetro foi descontinuado e substituído pelo parâmetro DdlTypes.
`deprecated`	string	Este parâmetro foi descontinuado e substituído pelo parâmetro DdlTypes.	ALTERADDCOLUMN
NotificationSettings	object	O método de notificação de alerta e as configurações de destinatário.
NotificationChannels	array<object>	Os métodos de notificação de alerta.
	object	O método de notificação de alerta.
Severity	string	O nível de gravidade. Valores válidos: Warning Critical	Critical
Channels	array	Os métodos de notificação de alerta.
	string	O método de notificação de alerta. Valores válidos: Mail: e-mail Phone: chamada telefônica Sms: SMS Ding: DingTalk	Ding
NotificationReceivers	array<object>	As configurações dos destinatários da notificação de alerta.
	object	As configurações dos destinatários da notificação de alerta.
ReceiverType	string	O tipo de destinatário. Valores válidos: AliyunUid, DingToken, FeishuToken e WebHookUrl.	DingToken
ReceiverValues	array	O destinatário. Se o valor do parâmetro ReceiverType for AliyunUid, o valor deste parâmetro será o ID da conta Alibaba Cloud de um usuário. Se o valor do parâmetro ReceiverType for DingToken, o valor deste parâmetro será o token de um chatbot do DingTalk.
	string	O destinatário. Se o valor do parâmetro ReceiverType for AliyunUid, o valor deste parâmetro será o ID da conta Alibaba Cloud de um usuário. Se o valor do parâmetro ReceiverType for DingToken, o valor deste parâmetro será o token de um chatbot do DingTalk.	token1
MuteInterval	integer	A duração do intervalo de supressão de alerta. Unidade: minutos.	5
InhibitionInterval `deprecated`	integer	Este parâmetro foi descontinuado e substituído pelo parâmetro MuteInterval.	5
DIAlarmRuleId `deprecated`	integer	Este parâmetro foi descontinuado. Use o parâmetro Id em seu lugar.	72402

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "74C2FECD-5B3A-554A-BCF5-351A36DE9815",
  "PagingInfo": {
    "TotalCount": 90,
    "PageNumber": 1,
    "PageSize": 10,
    "DIJobAlarmRules": [
      {
        "Id": 72402,
        "DIJobId": 32594,
        "Description": "rule descrition",
        "MetricType": "Heartbeat",
        "Name": "rule_name",
        "Enabled": true,
        "TriggerConditions": [
          {
            "Severity": "Critical",
            "Duration": 1,
            "Threshold": 5,
            "DdlTypes": [
              "AlterAddColumn"
            ],
            "DdlReportTags": [
              "ALTERADDCOLUMN"
            ]
          }
        ],
        "NotificationSettings": {
          "NotificationChannels": [
            {
              "Severity": "Critical",
              "Channels": [
                "Ding"
              ]
            }
          ],
          "NotificationReceivers": [
            {
              "ReceiverType": "DingToken",
              "ReceiverValues": [
                "token1"
              ]
            }
          ],
          "MuteInterval": 5,
          "InhibitionInterval": 5
        },
        "DIAlarmRuleId": 72402
      }
    ]
  }
}

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.