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

Consulta os detalhes de um alerta pelo ID do 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

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
AlertId	string	Sim	O ID do alerta. Você pode chamar a operação ListAlertMessages para obter o ID do alerta.	1421

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação. Você pode usar o ID da solicitação para localizar logs e solucionar problemas.	0000-ABCD-EFG****
HttpStatusCode	integer	O código de status HTTP.	200
ErrorMessage	string	A mensagem de erro.	The specified parameters are invalid.
ErrorCode	string	O código de erro.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Especifica se a chamada é bem-sucedida. Valores válidos: true: A chamada é bem-sucedida. false: A chamada falha.	true
Data	object	Os detalhes dos dados retornados.
RemindId	integer	O ID da regra de monitoramento personalizado que aciona o alerta. Este parâmetro é retornado apenas quando o parâmetro Source é definido como REMIND_ALERT.	1234
AlertMessageStatus	string	O status de envio da mensagem de alerta. Valores válidos: READY_TO_SEND: A mensagem está pronta para ser enviada. SEND_FAIL: Falha ao enviar a mensagem. SEND_SUCCESS: A mensagem é enviada. SEND_OVERLIMIT: O limite de alertas é excedido.	READY_TO_SEND
AlertUser	string	O UID da Alibaba Cloud do destinatário da mensagem de alerta.	9527952795****
AlertTime	integer	A hora em que o alerta é acionado. O valor é um carimbo de data e hora de 13 dígitos, como `1553524393000`.	1553524393000
AlertMethod	string	O método de notificação de alerta. Valores válidos: MAIL: E-mail. SMS: Mensagem de texto. PHONE: Chamada telefônica. Este método é suportado apenas no DataWorks Professional Edition ou em uma edição superior.	SMS
Source	string	A origem do alerta. Valores válidos: REMIND_ALERT: Alerta personalizado. TOPIC_ALERT: Alerta de evento. SLA_ALERT: Alerta de linha de base. NODE_CYCLE_ALERT: Alerta de loop de nó. NODE_LONELY_ALERT: Alerta de nó isolado.	REMIND_ALERT
Content	string	O conteúdo da mensagem de alerta.	Node error
RemindName	string	O nome da regra de monitoramento personalizado que aciona o alerta. Este parâmetro é retornado apenas quando o parâmetro Source é definido como REMIND_ALERT.	Custom monitoring rule name
AlertId	integer	O ID do alerta.	123
Instances	array<object>	A lista de instâncias que acionam a regra de monitoramento personalizado. Este parâmetro é retornado apenas quando o parâmetro Source é definido como REMIND_ALERT. Para outras origens de alerta, uma lista vazia é retornada.
	object	As informações da instância.
Status	string	O status da instância. Valores válidos: NOT_RUN: A instância não é executada. WAIT_TIME: A instância está aguardando o horário agendado. WAIT_RESOURCE: A instância está aguardando recursos. RUNNING: A instância está em execução. CHECKING: A instância está sendo verificada. CHECKING_CONDITION: As condições estão sendo verificadas. FAILURE: Falha na execução da instância. SUCCESS: A instância é executada com êxito.	NOT_RUN
InstanceId	integer	O ID da instância.	12312****
NodeName	string	O nome do nó.	Node name
NodeId	integer	O ID do nó.	1234
ProjectId	integer	O ID do workspace ao qual o nó pertence.	1234
Topics	array<object>	A lista de eventos que acionam o alerta. Este parâmetro é retornado apenas quando o parâmetro Source é definido como TOPIC_ALERT (alerta de evento global). Para outras origens de alerta, uma lista vazia é retornada.
	object	As informações do evento.
TopicName	string	O nome do evento.	error
InstanceId	integer	O ID da instância associada ao evento.	12345
TopicId	integer	O ID do evento.	412431
TopicOwner	string	O UID da Alibaba Cloud do proprietário do evento.	9527952795****
NodeId	integer	O ID do nó associado ao evento.	1234
TopicStatus	string	O status do evento. Valores válidos: IGNORE: O evento é ignorado. NEW: O evento foi descoberto recentemente. FIXING: O evento está sendo tratado. RECOVER: O evento é recuperado.	FIXING
Nodes	array<object>	A lista de nós retornada varia de acordo com a origem do alerta: Se Source for NODE_CYCLE_ALERT (alerta de nó cíclico), os tipos de nós cíclicos são retornados. Se Source for NODELONELYALERT (alerta de nó isolado), os tipos de nós isolados são retornados.
	object	As informações do nó.
Owner	string	O UID da Alibaba Cloud do proprietário do nó.	95279527952****
NodeName	string	O nome do nó.	Node name
NodeId	integer	O ID do nó.	1234
ProjectId	integer	O ID do workspace ao qual o nó pertence.	1234
SlaAlert	object	As informações básicas sobre a instância de linha de base que aciona o alerta de linha de base. Este parâmetro é retornado apenas quando o parâmetro Source é definido como SLA_ALERT. Para outras origens de alerta, este parâmetro está vazio.
Status	string	O status da linha de base. Valores válidos: ERROR: Anormal. SAFE: Seguro. DANGEROUS: Aviso. OVER: Quebrado.	SAFE
BaselineOwner	string	Os UIDs da Alibaba Cloud dos proprietários da linha de base. Vários UIDs são separados por vírgulas (,).	952795279****
BaselineId	integer	O ID da linha de base.	15142123
BaselineName	string	O nome da linha de base.	Baseline name
Bizdate	integer	O carimbo de data e hora da data de negócios para a instância de linha de base.	1553443200000
ProjectId	integer	O ID do workspace ao qual a linha de base pertence.	1234
InGroupId	integer	O número do ciclo da instância de linha de base. O valor é 1 para linhas de base diárias e varia de 1 a 24 para linhas de base horárias.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0000-ABCD-EFG****",
  "HttpStatusCode": 200,
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "RemindId": 1234,
    "AlertMessageStatus": "READY_TO_SEND",
    "AlertUser": "9527952795****",
    "AlertTime": 1553524393000,
    "AlertMethod": "SMS",
    "Source": "REMIND_ALERT",
    "Content": "Node error",
    "RemindName": "Custom monitoring rule name",
    "AlertId": 123,
    "Instances": [
      {
        "Status": "NOT_RUN",
        "InstanceId": 0,
        "NodeName": "Node name",
        "NodeId": 1234,
        "ProjectId": 1234
      }
    ],
    "Topics": [
      {
        "TopicName": "error",
        "InstanceId": 12345,
        "TopicId": 412431,
        "TopicOwner": "9527952795****",
        "NodeId": 1234,
        "TopicStatus": "FIXING"
      }
    ],
    "Nodes": [
      {
        "Owner": "95279527952****",
        "NodeName": "Node name",
        "NodeId": 1234,
        "ProjectId": 1234
      }
    ],
    "SlaAlert": {
      "Status": "SAFE",
      "BaselineOwner": "952795279****",
      "BaselineId": 15142123,
      "BaselineName": "Baseline name",
      "Bizdate": 1553443200000,
      "ProjectId": 1234,
      "InGroupId": 1
    }
  }
}

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.