ListAlertMessages - DataWorks - Centro de documentación de Alibaba Cloud

Consulta una lista de alertas.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

No se requiere autorización para esta operación. Si experimenta problemas al ejecutarla, póngase en contacto con el soporte técnico.

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
PageNumber	integer	Sí	El número de página. Valor predeterminado: 1. Valor mínimo: 1. Valor máximo: 30.	1
PageSize	integer	Sí	El número de entradas por página. Valor predeterminado: 10. Valor máximo: 100.	10
BeginTime	string	Sí	El inicio del intervalo de tiempo a consultar. Especifique la hora según el estándar ISO 8601 en el formato yyyy-MM-dd'T'HH:mm:ssZ. La hora debe estar en UTC.	2020-04-02T00:00:00+0800
EndTime	string	Sí	El fin del intervalo de tiempo a consultar. Especifique la hora según el estándar ISO 8601 en el formato yyyy-MM-dd'T'HH:mm:ssZ. La hora debe estar en UTC.	2020-04-04T00:00:00+0800
RemindId	integer	No	El ID de la regla de alerta personalizada. Este parámetro surte efecto si el parámetro AlertRuleTypes se establece en USER_DEFINE. Puede configurar este parámetro o el parámetro BaselineId.	9527
AlertMethods	string	No	El método de notificación. Valores válidos: MAIL: correo electrónico. SMS: mensaje de texto. Las alertas por mensaje de texto son compatibles con las regiones de Singapur, Malasia (Kuala Lumpur) y Alemania (Fráncfort). Separe varios métodos de notificación con comas (,).	SMS,MAIL,PHONE
AlertUser	string	No	El ID de la cuenta de Alibaba Cloud que utiliza el destinatario de la alerta.	12345
AlertRuleTypes	string	No	El tipo de regla de alerta. Valores válidos: GLOBAL, USER_DEFINE y OTHER. El valor GLOBAL indica que la regla de alerta es una regla de alerta global. El valor USER_DEFINE indica que la regla de alerta está personalizada por un usuario. El valor OTHER indica que la regla de alerta es una regla de otro tipo. Puede especificar varios tipos. Sepárelos con comas (,).	GLOBAL,USER_DEFINE,OTHER
BaselineId	integer	No	El ID de la línea base. Este parámetro surte efecto si el parámetro AlertRuleTypes se establece en GLOBAL. Puede configurar este parámetro o el parámetro RemindId.	1234

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
HttpStatusCode	integer	El código de estado HTTP.	200
RequestId	string	El ID de la solicitud.	0000-ABCD-EFG****
ErrorMessage	string	El mensaje de error.	The specified parameters are invalid.
ErrorCode	string	El código de error.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica si la solicitud se realizó correctamente.	true
Data	object	La información sobre las alertas devueltas.
PageNumber	string	El número de página.	1
PageSize	string	El número de entradas por página.	10
TotalCount	string	El número total de alertas.	100
AlertMessages	array<object>	Las alertas.
	array<object>	Los datos devueltos.
RemindId	integer	El ID de la regla de alerta personalizada que se activó. Este parámetro se devuelve si el valor del parámetro Source es REMIND_ALERT.	1234
AlertMessageStatus	string	El estado de envío de la notificación. Valores válidos: READY_TO_SEND, SEND_FAIL, SEND_SUCCESS y SEND_OVERLIMIT. El valor READY_TO_SEND indica que la notificación está en espera de ser enviada. El valor SEND_FAIL indica que no se pudo enviar la notificación. El valor SEND_SUCCESS indica que la notificación se envió correctamente. El valor SEND_OVERLIMIT indica que el número de notificaciones enviadas supera el límite superior.	READY_TO_SEND
AlertUser	string	El ID de la cuenta de Alibaba Cloud que utiliza el destinatario de la alerta.	9527952795****
AlertTime	integer	La marca de tiempo en la que se reportó la alerta.	1553531401000
AlertMethod	string	El método de notificación. Valores válidos: MAIL (correo electrónico), SMS (mensaje de texto) y PHONE (llamada telefónica). Solo DataWorks Professional Edition y las ediciones más avanzadas admiten el método de notificación PHONE.	SMS
Source	string	El tipo de alerta. Valores válidos: REMIND_ALERT, TOPIC_ALERT, SLA_ALERT, NODE_CYCLE_ALERT y NODE_LONELY_ALERT. El valor REMIND_ALERT indica que la alerta es una alerta personalizada. El valor TOPIC_ALERT indica que la alerta es una alerta de evento. El valor SLA_ALERT indica que la alerta es una alerta de línea base. El valor NODE_CYCLE_ALERT indica que la alerta se reporta por un bucle de dependencia de nodos. El valor NODE_LONELY_ALERT indica que la alerta se reporta por nodos aislados.	REMIND_ALERT
Content	string	El contenido de la alerta.	Node error
RemindName	string	El nombre de la regla de alerta personalizada que se activó. Este parámetro se devuelve si el valor del parámetro Source es REMIND_ALERT.	Custom monitoring rule name
AlertId	integer	El ID de la alerta.	1234
Instances	array<object>	Las instancias que activaron la regla de alerta personalizada. Este parámetro se devuelve si el valor del parámetro Source es REMIND_ALERT. Este parámetro se deja vacío si el valor del parámetro Source no es REMIND_ALERT.
	object	La información sobre la instancia.
Status	string	El estado de la instancia. Valores válidos: NOT_RUN, WAIT_TIME, WAIT_RESOURCE, RUNNING, CHECKING, CHECKING_CONDITION, FAILURE y SUCCESS. El valor NOT_RUN indica que la instancia no se ejecuta. El valor WAIT_TIME indica que la instancia está en espera de ejecución. El valor WAIT_RESOURCE indica que la instancia está en espera de recursos. El valor RUNNING indica que la instancia se está ejecutando. El valor CHECKING indica que se está comprobando la calidad de los datos para el nodo para el cual se genera la instancia. El valor CHECKING_CONDITION indica que se están comprobando las condiciones de ramificación para el nodo para el cual se genera la instancia. El valor FAILURE indica que la ejecución de la instancia falla. El valor SUCCESS indica que la instancia se ejecuta correctamente.	NOT_RUN
InstanceId	integer	El ID de la instancia.	12345
NodeName	string	El nombre del nodo.	Node name
NodeId	integer	El ID del nodo.	1234
ProjectId	integer	El ID del espacio de trabajo al que pertenece el nodo.	1234
Topics	array<object>	Los eventos que activaron las alertas. Este parámetro se devuelve si el valor del parámetro Source es TOPIC_ALERT. Este parámetro se deja vacío si el valor del parámetro Source no es TOPIC_ALERT.
	object	La información sobre el evento.
TopicName	string	El nombre del evento.	9527 error
InstanceId	integer	El ID de la instancia asociada con el evento.	12345
TopicId	integer	El ID del evento.	1234
TopicOwner	string	El ID de la cuenta de Alibaba Cloud que utiliza el propietario del evento.	9527952795****
NodeId	integer	El ID del nodo asociado con el evento.	1234
TopicStatus	string	El estado del evento. Valores válidos: IGNORE, NEW, FIXING y RECOVER. El valor IGNORE indica que el evento se ignora. El valor NEW indica que el evento es un evento nuevo. El valor FIXING indica que el evento se está gestionando. El valor RECOVER indica que el evento se ha recuperado.	FIXING
Nodes	array<object>	Los nodos devueltos para diferentes orígenes de alerta. Se devuelven los nodos que forman un bucle si el valor del parámetro Source es NODE_CYCLE_ALERT. Se devuelven los nodos que están aislados si el valor del parámetro Source es NODE_LONELY_ALERT.
	object	La información sobre el nodo.
Owner	string	El ID de la cuenta de Alibaba Cloud que utiliza el propietario del nodo.	95279527952****
NodeName	string	El nombre del nodo.	Node name
NodeId	integer	El ID del nodo.	1234
ProjectId	integer	El ID del espacio de trabajo al que pertenece el nodo.	1234
SlaAlert	object	La información básica sobre la instancia de línea base que activó una alerta. Este parámetro se devuelve si el valor del parámetro Source es SLA_ALERT. Este parámetro se deja vacío si el valor del parámetro Source no es SLA_ALERT.
Status	string	El estado de la línea base. Valores válidos: ERROR, SAFE, DANGROUS y OVER. El valor ERROR indica que no hay nodos asociados con la línea base, o que todos los nodos asociados con la línea base están suspendidos. El valor SAFE indica que los nodos se ejecutan antes de que comience la duración de la alerta. El valor DANGROUS indica que los nodos se siguen ejecutando después de que finaliza la duración de la alerta, pero no se ha alcanzado la hora de finalización comprometida. El valor OVER indica que los nodos se siguen ejecutando después de la hora de finalización comprometida.	SAFE
BaselineOwner	string	El ID de la cuenta de Alibaba Cloud que utiliza el propietario de la línea base. Varios ID se separan con comas (,).	952795279****
BaselineId	integer	El ID de la línea base.	1234
BaselineName	string	El nombre de la línea base.	Baseline name
Bizdate	integer	La marca de tiempo de la fecha de negocio de la instancia de línea base.	1553443200000
ProjectId	integer	El ID del espacio de trabajo al que pertenece la línea base.	1234
InGroupId	integer	El ID del ciclo de la instancia de línea base. Valores válidos del ID de un ciclo de nivel de hora: [1,24]. El ID de un ciclo de nivel de día es 1.	1

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
500	Forbidden.Not.Server	The dataworksAPI service is not available in this area. Please try it in another area.
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.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.
429	Throttling.Resource	You have reached the limit for the resource. Please contact us by submitting a ticket.
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 error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.