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

Consulta a lista de regras de alerta para nós de nova versão de integração de dados. Atualmente, os tipos de nó suportados incluem as soluções em tempo real de banco de dados completo do MySQL para Hologres.

Descrição da operação

Quando o tipo de sincronização da sua tarefa inclui sincronização em tempo real, você pode configurar regras de alerta.

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

list

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DIJobId	integer	Sim	O ID da tarefa. Este é o ID da tarefa associado à regra de alerta. Você pode obter esse valor em DIJobPaging.DIJobs[].DIJobId na resposta do ListDIJobs.	11260
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O tamanho da página. Valor padrão: 10.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	74C2FECD-5B3A-554A-BCF5-35****
DIAlarmRulePaging	object	O resultado paginado das regras de alerta.
TotalCount	integer	O número total de registros.	2
PageNumber	integer	O número da página.	1
PageSize	integer	O tamanho da página.	10
DIJobAlarmRules	array<object>	A lista de regras de alerta.
	array<object>	A regra de alerta.
DIAlarmRuleId	integer	O ID da regra de alerta.	41998
DIJobId	integer	O ID da tarefa. Este é o ID da tarefa associado à regra de alerta.	11260
Description	string	A descrição.	mysql synchronizes to hologres heartbeat alert
MetricType	string	O tipo de métrica de alerta. Valores válidos: Heartbeat: alerta de status da tarefa. FailoverCount: alerta de contagem de failover. Delay: alerta de atraso da tarefa.	Heartbeat
Enabled	boolean	Indica se a regra de alerta está ativada.	true
TriggerConditions	array<object>	A lista de condições de acionamento de alerta. Há suporte para várias condições.
	object	A condição de acionamento de alerta.
Severity	string	O nível de gravidade. Valores válidos: Warning Critical	Warning
Duration	integer	A janela de tempo para cálculo do alerta. Unidade: minutos.	15
Threshold	integer	O limite de alerta. Alerta de status da tarefa: sem limite. Alerta de contagem de failover: o limite é o número de failovers. Alerta de atraso da tarefa: o limite é a duração do atraso. Unidade: segundos.	5
NotificationSettings	object	As configurações de notificação de alerta.
NotificationChannels	array<object>	Os canais de notificação de alerta. Há suporte para vários valores.
	object	O canal de notificação de alerta.
Severity	string	O nível de gravidade. Valores válidos: Warning Critical	Warning
Channels	array	A lista de canais.
	string	O canal. Valores válidos: Mail: e-mail. Phone: chamada telefônica. Sms: mensagem de texto. Ding: DingTalk.	Ding
NotificationReceivers	array<object>	Os destinatários da notificação de alerta. Há suporte para vários valores.
	object	O destinatário da notificação de alerta.
ReceiverType	string	O tipo de destinatário. Se o canal de notificação de alerta for e-mail, chamada telefônica ou mensagem de texto, o tipo de destinatário é o ID de usuário do Alibaba Cloud (AliyunUid). Se o canal de notificação de alerta for o DingTalk, o tipo de destinatário é o token do DingTalk (DingToken).	DingToken
ReceiverValues	array	A lista de valores do destinatário.
	string	O valor do destinatário. Se o tipo de destinatário for o ID do Alibaba Cloud, o valor do destinatário é o ID de usuário específico do Alibaba Cloud. Se o tipo de destinatário for o token do DingTalk, o valor do destinatário é o valor específico do token do DingTalk.	token1
InhibitionInterval	integer	O intervalo de supressão de alerta. Unidade: minutos.	5

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "74C2FECD-5B3A-554A-BCF5-35****",
  "DIAlarmRulePaging": {
    "TotalCount": 2,
    "PageNumber": 1,
    "PageSize": 10,
    "DIJobAlarmRules": [
      {
        "DIAlarmRuleId": 41998,
        "DIJobId": 11260,
        "Description": "mysql synchronizes to hologres heartbeat alert",
        "MetricType": "Heartbeat",
        "Enabled": true,
        "TriggerConditions": [
          {
            "Severity": "Warning",
            "Duration": 15,
            "Threshold": 5
          }
        ],
        "NotificationSettings": {
          "NotificationChannels": [
            {
              "Severity": "Warning",
              "Channels": [
                "Ding"
              ]
            }
          ],
          "NotificationReceivers": [
            {
              "ReceiverType": "DingToken",
              "ReceiverValues": [
                "token1"
              ]
            }
          ],
          "InhibitionInterval": 5
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	Acesso negado. Autorize o acesso.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.