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

Obtém uma regra de alerta de monitoramento personalizado.

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
Id	string	Não	O ID da regra de alerta personalizada.	28547072

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação, que é usado para localizar logs e solucionar problemas.	8abcb91f-d266-4073-b907-2ed****
AlertRule	object	Os detalhes da regra de alerta personalizada.
Id	integer	O ID da regra de alerta personalizada.	16035
Name	string	O nome da regra de alerta personalizada.	error_rule
Owner	string	O UID da Alibaba Cloud do proprietário da regra de alerta personalizada.	279961421580845157
Enabled	boolean	Indica se a regra de alerta está ativada.	true
Notification	object	A configuração de notificação de alerta.
SilenceStartTime	string	A hora de início do período de silenciamento. Formato: HH:mm:ss.	00:00:00
SilenceEndTime	string	A hora de término do período de silenciamento. Formato: HH:mm:ss.	00:00:00
IntervalInMinutes	integer	O intervalo de alerta, em minutos. Valores válidos: 5 a 10000.	30
Maximum	integer	O número máximo de alertas em um dia civil. Valores válidos: 1 a 10000.	3
Channels	array	A lista de canais de alerta.
	string	O canal de alerta. Valores válidos: Mail: e-mail. Phone: chamada telefônica. Sms: mensagem de texto. Dingding: webhook do DingTalk. Feishu: webhook do Lark. Weixin: webhook do WeCom. Webhook: webhook personalizado.	Sms
Receivers	array<object>	Os destinatários do alerta.
	object
ReceiverType	string	O tipo de destinatário do alerta. Valores válidos: AliUid: UID da Alibaba Cloud. ShiftSchedule: escala de turnos. TaskOwner: proprietário do nó. Aplicável a alertas personalizados e alertas de eventos. Owner: proprietário. Aplicável a alertas de linha de base. WebhookUrl: URL de webhook personalizado. DingdingUrl: URL de webhook do DingTalk. FeishuUrl: URL de webhook do Lark. WeixinUrl: URL de webhook do WeCom.	WebhookUrl
ReceiverValues	array	Os valores do destinatário do alerta.
	string	O valor do destinatário do alerta. Se ReceiverType for AliUid, especifique um UID da Alibaba Cloud. Se ReceiverType for ShiftSchedule, especifique um ID de escala de turnos. Se ReceiverType for WebhookUrl, DingdingUrl, FeishuUrl ou WeixinUrl, especifique a URL correspondente.	123123123
Extension	string	A configuração adicional exigida pelo destinatário do alerta. Se ReceiverType for DingdingUrl, você pode definir {"atAll":true} para @ todos os membros.	{"atAll":true}
TriggerCondition	object	A condição que aciona o alerta.
Type	string	O tipo de acionamento do alerta. Valores válidos: Finished: instância concluída. UnFinished: instância não concluída. Error: instância com falha. CycleUnfinished: ciclo da instância não concluído. Timeout: tempo limite da instância esgotado. InstanceTransferComplete: conversão de nó para instância concluída. InstanceTransferFluctuate: flutuação na contagem de instâncias. ExhaustedError: instância ainda com falha após novas execuções automáticas. InstanceKeyword: instância com falha contém palavra-chave. InstanceErrorCount: número de instâncias com falha. InstanceErrorPercentage: porcentagem de instâncias com falha. ResourceGroupPercentage: utilização do grupo de recursos. ResourceGroupWaitCount: número de instâncias aguardando recursos do grupo de recursos.	Error
Extension	object	As informações de extensão. Necessárias para determinadas condições de acionamento.
Error	object	A configuração de alerta de erro.
StreamTaskIds	array	Os IDs dos nós de computação em tempo real a serem monitorados.
	integer	O ID do nó de computação em tempo real.	123123
AutoRerunAlertEnabled	boolean	Especifica se deve ser gerado um alerta quando uma tarefa em lote é executada novamente de forma automática devido a uma falha.	false
Timeout	object	A configuração de alerta de tempo limite.
TimeoutInMinutes	integer	A duração do tempo limite, em minutos.	10
UnFinished	object	A configuração de alerta de não concluído.
UnFinishedTime	string	O horário de não conclusão. Formato: hh:mm. Valores válidos de hh: 0 a 47. Valores válidos de mm: 0 a 59.	12:00
CycleUnfinished	object	A configuração de alerta de ciclo não concluído.
CycleAndTime	array<object>	A lista de configurações de ciclo e horário.
	object
CycleId	integer	O ID do ciclo. Valores válidos: 1 a 288.	1
Time	string	O horário de tempo limite. Formato: hh:mm. Valores válidos de hh: 0 a 47. Valores válidos de mm: 0 a 59.	12:00
InstanceErrorCount	object	A configuração de alerta de contagem de erros de instância.
Count	integer	O número de instâncias com falha. Valores válidos: 1 a 10000.	10
InstanceErrorPercentage	object	A configuração de alerta de porcentagem de erros de instância.
Percentage	integer	A porcentagem de instâncias com falha. Valores válidos: 1 a 100.	10
InstanceTransferFluctuate	object	A configuração de alerta de flutuação na contagem de instâncias.
Trend	string	O tipo de flutuação. Valores válidos: abs: valor absoluto. increase: aumento. decrease: diminuição.	10
Percentage	integer	A porcentagem de flutuação. Valores válidos: 1 a 100.	10
Target	object	O objeto monitorado.
Type	string	O tipo de objeto monitorado. Valores válidos: Task: nó. Baseline: linha de base. Project: espaço de trabalho. BizProcess: fluxo de processo de negócios.	Task
Ids	array	A lista de IDs de objetos monitorados.
	integer	O ID do objeto monitorado.	32570
AllowTasks	array	A lista de permissões de nós monitorados.
	integer	O ID do nó monitorado na lista de permissões.	123123

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "8abcb91f-d266-4073-b907-2ed****",
  "AlertRule": {
    "Id": 16035,
    "Name": "error_rule",
    "Owner": "279961421580845157",
    "Enabled": true,
    "Notification": {
      "SilenceStartTime": "00:00:00",
      "SilenceEndTime": "00:00:00",
      "IntervalInMinutes": 30,
      "Maximum": 3,
      "Channels": [
        "Sms"
      ],
      "Receivers": [
        {
          "ReceiverType": "WebhookUrl",
          "ReceiverValues": [
            "123123123"
          ],
          "Extension": "{\"atAll\":true}"
        }
      ]
    },
    "TriggerCondition": {
      "Type": "Error",
      "Extension": {
        "Error": {
          "StreamTaskIds": [
            123123
          ],
          "AutoRerunAlertEnabled": false
        },
        "Timeout": {
          "TimeoutInMinutes": 10
        },
        "UnFinished": {
          "UnFinishedTime": "12:00"
        },
        "CycleUnfinished": {
          "CycleAndTime": [
            {
              "CycleId": 1,
              "Time": "12:00"
            }
          ]
        },
        "InstanceErrorCount": {
          "Count": 10
        },
        "InstanceErrorPercentage": {
          "Percentage": 10
        },
        "InstanceTransferFluctuate": {
          "Trend": "10",
          "Percentage": 10
        }
      },
      "Target": {
        "Type": "Task",
        "Ids": [
          32570
        ],
        "AllowTasks": [
          123123
        ]
      }
    }
  }
}

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.