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

Consulta as informações de alerta com base no ID de alerta especificado pelo parâmetro AlertId.

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	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	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	Indica se a solicitação foi bem-sucedida. Valores válidos: true false	true
Data	object	As informações sobre os alertas retornados.
RemindId	integer	O ID da regra de alerta personalizada que foi acionada. Este parâmetro é retornado se o valor do parâmetro Source for REMIND_ALERT.	1234
AlertMessageStatus	string	O status de envio da notificação. Valores válidos: READY_TO_SEND: A notificação está aguardando para ser enviada. SEND_FAIL: Falha ao enviar a notificação. SEND_SUCCESS: A notificação foi enviada. SEND_OVERLIMIT: O número de notificações enviadas excede o limite superior.	READY_TO_SEND
AlertUser	string	O ID da conta Alibaba Cloud usada pelo destinatário do alerta.	9527952795****
AlertTime	integer	A hora em que o alerta foi reportado.	1553524393000
AlertMethod	string	O método de notificação. Valores válidos: MAIL. SMS. PHONE. Apenas o DataWorks Professional Edition e as edições mais avançadas suportam o método de notificação PHONE.	SMS
Source	string	O tipo do alerta. Valores válidos: REMIND_ALERT: O alerta é um alerta personalizado. TOPIC_ALERT: O alerta é um alerta de evento. SLA_ALERT: O alerta é um alerta de linha de base. NODE_CYCLE_ALERT: O alerta é reportado para um loop de dependência de nó. NODE_LONELY_ALERT: O alerta é reportado para nós isolados.	REMIND_ALERT
Content	string	O conteúdo do alerta.	Node error
RemindName	string	O nome da regra de alerta personalizada que foi acionada. Este parâmetro é retornado se o valor do parâmetro Source for REMIND_ALERT.	Custom monitoring rule name
AlertId	integer	O ID do alerta.	123
Instances	array<object>	As instâncias que acionaram a regra de alerta personalizada. Este parâmetro é retornado se o valor do parâmetro Source for REMIND_ALERT. Este parâmetro é retornado vazio se o valor do parâmetro Source não for REMIND_ALERT.
	object	As informações sobre a instância.
Status	string	The status of the instance. Valid values: NOT_RUN WAIT_TIME WAIT_RESOURCE RUNNING CHECKING CHECKING_CONDITION FAILURE SUCCESS	NOT_RUN
InstanceId	integer	The instance ID.	12312****
NodeName	string	The name of the node.	Node name
NodeId	integer	The node ID.	1234
ProjectId	integer	The ID of the workspace to which the node belongs.	1234
Topics	array<object>	Os eventos que acionaram alertas. Este parâmetro é retornado se o valor do parâmetro Source for TOPIC_ALERT. Este parâmetro é retornado vazio se o valor do parâmetro Source não for TOPIC_ALERT.
	object	As informações sobre o evento.
TopicName	string	The name of the event.	error
InstanceId	integer	The ID of the instance that triggered the event.	12345
TopicId	integer	The event ID.	412431
TopicOwner	string	The ID of the Alibaba Cloud account used by the event owner.	9527952795****
NodeId	integer	The ID of the node that triggered the event.	1234
TopicStatus	string	The status of the event. Valid values: IGNORE NEW FIXING RECOVER	FIXING
Nodes	array<object>	Os nós retornados para diferentes origens de alerta. Os nós que formam um loop são retornados se o valor do parâmetro Source for NODE_CYCLE_ALERT. Os nós que estão isolados são retornados se o valor do parâmetro Source for NODE_LONELY_ALERT.
	object	As informações sobre o nó.
Owner	string	The ID of the Alibaba Cloud account used by the node owner.	95279527952****
NodeName	string	The name of the node.	Node name
NodeId	integer	The node ID.	1234
ProjectId	integer	The ID of the workspace to which the node belongs.	1234
SlaAlert	object	As informações básicas sobre a instância de linha de base que acionou um alerta. Este parâmetro é retornado se o valor do parâmetro Source for SLA_ALERT. Este parâmetro é retornado vazio se o valor do parâmetro Source não for SLA_ALERT.
Status	string	The status of the baseline. Valid values: ERROR SAFE DANGEROUS OVER	SAFE
BaselineOwner	string	The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).	952795279****
BaselineId	integer	The baseline ID.	15142123
BaselineName	string	The name of the baseline.	Baseline name
Bizdate	integer	The data timestamp of the baseline instance.	1553443200000
ProjectId	integer	The ID of the workspace to which the baseline belongs.	1234
InGroupId	integer	The ID of the cycle of the baseline instance. Valid values of the ID of an hour-level cycle: [1,24]. The ID of a day-level cycle is 1.	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.