DescribeMetricRuleList - - Centro de documentación de Alibaba Cloud

Consulta las reglas de alerta.

Este tema proporciona un ejemplo sobre cómo consultar todas las reglas de alerta en su cuenta de Alibaba Cloud. El resultado muestra que solo se encontró una regla de alerta. El nombre de la regla es Rule_01 y el ID es applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su conveniencia, le recomendamos llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de muestra de la operación para diferentes SDKs.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribeMetricRuleList	La operación que desea ejecutar. Establezca el valor en DescribeMetricRuleList.
MetricName	String	No	cpu_total	El nombre de la métrica. Para obtener información sobre cómo conseguir el nombre de una métrica, consulte DescribeMetricMetaList o Apéndice 1: Métricas.
EnableState	Boolean	No	true	Especifique si se deben consultar las reglas de alerta habilitadas o deshabilitadas. Valores válidos: true: consulta las reglas de alerta habilitadas. false: consulta las reglas de alerta deshabilitadas.
Namespace	String	No	acs_ecs_dashboard	El namespace del servicio en la nube. Para obtener información sobre cómo conseguir el namespace de un servicio en la nube, consulte DescribeMetricMetaList o Apéndice 1: Métricas.
Page	Integer	No	1	El número de página. Las páginas comienzan desde la página 1. Valor predeterminado: 1.
PageSize	Integer	No	10	El número de entradas por página. Las páginas comienzan desde la página 1. Valor predeterminado: 10.
AlertState	String	No	OK	El estado de la regla de alerta. Valores válidos: OK: La regla de alerta no tiene alertas activas. ALARM: La regla de alerta tiene alertas activas. INSUFFICIENT_DATA: No hay datos disponibles.
Dimensions	String	No	{"instanceId":"i-2ze2d6j5uhg20x47****"}	Las dimensiones de monitoreo del recurso especificado. Establezca el valor como una colección de pares `key:value`. Ejemplo: `{"userId":"120886317861"}` o `{"instanceId":"i-2ze2d6j5uhg20x47"}`.
RuleName	String	No	Rule_01	El nombre de la regla de alerta. Este parámetro admite coincidencias aproximadas.
GroupId	String	No	7301****	El ID del grupo de aplicaciones. Para obtener información sobre cómo conseguir el ID de un grupo de aplicaciones, consulte DescribeMonitorGroups.
RuleIds	String	No	applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****	El ID de la regla de alerta. Puede especificar hasta 20 IDs a la vez. Separe varios IDs con comas (,).

Para obtener más información sobre los parámetros de solicitud comunes, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	Integer	200	El código de estado HTTP. Nota El código de estado 200 indica que la solicitud fue exitosa.
Message	String	The specified resource is not found.	El mensaje de error.
RequestId	String	386C6712-335F-5054-930A-CC92B851ECBA	El ID de la solicitud.
Total	String	1	El número total de entradas.
Success	Boolean	true	Indica si la solicitud fue exitosa. Valores válidos: true false
Alarms	Array of Alarm		Los detalles de las reglas de alerta.
Alarm
SilenceTime	Integer	86400	El periodo de silencio durante el cual no se envían nuevas notificaciones de alerta incluso si se cumplen las condiciones de activación. Unidad: segundos. Valor predeterminado: 86400. Valor mínimo: 3600. Solo se reporta una alerta durante cada periodo de silencio, incluso si el valor de la métrica supera consecutivamente el umbral de alerta varias veces.
MetricName	String	cpu_total	El nombre de la métrica.
Webhook	String	https://www.aliyun.com	La URL de callback. CloudMonitor envía una notificación de alerta a la URL de callback especificada mediante una solicitud HTTP POST. Solo se admite el protocolo HTTP.
ContactGroups	String	ECS_Alarm	Los grupos de contactos de alerta.
SourceType	String	METRIC	El tipo de regla de alerta. Valor válido: METRIC. Este valor indica una regla de alerta para métricas de series temporales.
Namespace	String	acs_ecs_dashboard	El namespace del servicio en la nube.
MailSubject	String	"${serviceType}-${metricName}-${levelDescription}Notification (${dimensions})"	El asunto del correo electrónico de notificación de alerta.
NoEffectiveInterval	String	00:00-05:30	El periodo durante el cual la regla de alerta no está vigente.
EffectiveInterval	String	05:31-23:59	El periodo durante el cual la regla de alerta está vigente.
RuleName	String	Rule_01	El nombre de la regla de alerta.
AlertState	String	OK	El estado de la regla de alerta. Valores válidos: OK: La regla de alerta no tiene alertas activas. ALARM: La regla de alerta tiene alertas activas. INSUFFICIENT_DATA: No hay datos disponibles.
Period	String	60	El periodo estadístico.
RuleId	String	applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****	El ID de la regla de alerta.
GroupName	String	ECS_Group	El nombre del grupo de aplicaciones. Nota Si la regla de alerta está asociada con un grupo de aplicaciones, el nombre del grupo de aplicaciones se devuelve en este parámetro.
GroupId	String	7301****	El ID del grupo de aplicaciones.
Dimensions	String	[{"instanceId":"i-2ze2d6j5uhg20x47****"}]	Las dimensiones de la regla de alerta.
EnableState	Boolean	true	Indica si la regla de alerta está habilitada. Valores válidos: true: La regla de alerta está habilitada. false: La regla de alerta está deshabilitada.
Resources	String	[{\"instanceId\":\"i-2ze2d6j5uhg20x47****\"}]	Los recursos asociados con la regla de alerta.
Escalations	Object		Las condiciones para activar diferentes niveles de alertas.
Info	Object		Las condiciones para activar alertas de nivel Info.
ComparisonOperator	String	GreaterThanOrEqualToThreshold	El operador de comparación que se utiliza para comparar el valor de la métrica con el umbral para alertas de nivel Info. Valores válidos: GreaterThanOrEqualToThreshold: mayor o igual al umbral GreaterThanThreshold: mayor que el umbral LessThanOrEqualToThreshold: menor o igual al umbral LessThanThreshold: menor que el umbral NotEqualToThreshold: distinto al umbral GreaterThanYesterday: mayor que el valor de la métrica a la misma hora ayer LessThanYesterday: menor que el valor de la métrica a la misma hora ayer GreaterThanLastWeek: mayor que el valor de la métrica a la misma hora la semana pasada LessThanLastWeek: menor que el valor de la métrica a la misma hora la semana pasada GreaterThanLastPeriod: mayor que el valor de la métrica en el último ciclo de monitoreo LessThanLastPeriod: menor que el valor de la métrica en el último ciclo de monitoreo
PreCondition	String	$Average>80	Las condiciones adicionales para activar alertas de nivel Info. Las condiciones adicionales surten efecto cuando el valor del parámetro ComparisonOperator es GreaterThanYesterday, LessThanYesterday, GreaterThanLastWeek, LessThanLastWeek, GreaterThanLastPeriod o LessThanLastPeriod. Por ejemplo, los valores de los parámetros PreCondition, ComparisonOperator y Threshold se establecen en $Average>80, GreaterThanYesterday y 10, respectivamente. Una alerta se activa solo cuando el valor promedio de la métrica es mayor que 80 y un 10% mayor que el valor promedio de la métrica a la misma hora ayer. Nota $Average es un marcador de posición que consta de `un signo de dólar ($) y el método estadístico`. CloudMonitor reemplaza el marcador de posición con el valor agregado o el valor original antes de la comparación de valores.
Times	Integer	3	El número consecutivo de veces que el valor de la métrica cumple la condición de alerta antes de que se active una alerta de nivel Info.
Threshold	String	90	El umbral para alertas de nivel Info.
Statistics	String	Average	Los métodos estadísticos para alertas de nivel Info.
Warn	Object		Las condiciones para activar alertas de nivel Warn.
ComparisonOperator	String	GreaterThanOrEqualToThreshold	El operador de comparación que se utiliza para comparar el valor de la métrica con el umbral para alertas de nivel Warn. Valores válidos: GreaterThanOrEqualToThreshold: mayor o igual al umbral GreaterThanThreshold: mayor que el umbral LessThanOrEqualToThreshold: menor o igual al umbral LessThanThreshold: menor que el umbral NotEqualToThreshold: distinto al umbral GreaterThanYesterday: mayor que el valor de la métrica a la misma hora ayer LessThanYesterday: menor que el valor de la métrica a la misma hora ayer GreaterThanLastWeek: mayor que el valor de la métrica a la misma hora la semana pasada LessThanLastWeek: menor que el valor de la métrica a la misma hora la semana pasada GreaterThanLastPeriod: mayor que el valor de la métrica en el último ciclo de monitoreo LessThanLastPeriod: menor que el valor de la métrica en el último ciclo de monitoreo
PreCondition	String	$Average>80	Las condiciones adicionales para activar alertas de nivel Warn. Las condiciones adicionales surten efecto cuando el valor del parámetro ComparisonOperator es GreaterThanYesterday, LessThanYesterday, GreaterThanLastWeek, LessThanLastWeek, GreaterThanLastPeriod o LessThanLastPeriod. Por ejemplo, los valores de los parámetros PreCondition, ComparisonOperator y Threshold se establecen en $Average>80, GreaterThanYesterday y 10, respectivamente. Una alerta se activa solo cuando el valor promedio de la métrica es mayor que 80 y un 10% mayor que el valor promedio de la métrica a la misma hora ayer. Nota $Average es un marcador de posición que consta de `un signo de dólar ($) y el método estadístico`. CloudMonitor reemplaza el marcador de posición con el valor agregado o el valor original antes de la comparación de valores.
Times	Integer	3	El número consecutivo de veces que el valor de la métrica cumple la condición de alerta antes de que se active una alerta de nivel Warn.
Threshold	String	90	El umbral para alertas de nivel Warn.
Statistics	String	Average	Los métodos estadísticos para alertas de nivel Warn.
Critical	Object		Las condiciones para activar alertas de nivel Critical.
ComparisonOperator	String	GreaterThanOrEqualToThreshold	El operador de comparación que se utiliza para comparar el valor de la métrica con el umbral para alertas de nivel Critical. Valores válidos: GreaterThanOrEqualToThreshold: mayor o igual al umbral GreaterThanThreshold: mayor que el umbral LessThanOrEqualToThreshold: menor o igual al umbral LessThanThreshold: menor que el umbral NotEqualToThreshold: distinto al umbral GreaterThanYesterday: mayor que el valor de la métrica a la misma hora ayer LessThanYesterday: menor que el valor de la métrica a la misma hora ayer GreaterThanLastWeek: mayor que el valor de la métrica a la misma hora la semana pasada LessThanLastWeek: menor que el valor de la métrica a la misma hora la semana pasada GreaterThanLastPeriod: mayor que el valor de la métrica en el último ciclo de monitoreo LessThanLastPeriod: menor que el valor de la métrica en el último ciclo de monitoreo
PreCondition	String	$Average>80	Las condiciones adicionales para activar alertas de nivel Critical. Las condiciones adicionales surten efecto cuando el valor del parámetro ComparisonOperator es GreaterThanYesterday, LessThanYesterday, GreaterThanLastWeek, LessThanLastWeek, GreaterThanLastPeriod o LessThanLastPeriod. Por ejemplo, los valores de los parámetros PreCondition, ComparisonOperator y Threshold se establecen en $Average>80, GreaterThanYesterday y 10, respectivamente. Una alerta se activa solo cuando el valor promedio de la métrica es mayor que 80 y un 10% mayor que el valor promedio de la métrica a la misma hora ayer. Nota $Average es un marcador de posición que consta de `un signo de dólar ($) y el método estadístico`. CloudMonitor reemplaza el marcador de posición con el valor agregado o el valor original antes de la comparación de valores.
Times	Integer	3	El número consecutivo de veces que el valor de la métrica cumple la condición de alerta antes de que se active una alerta de nivel Critical.
Threshold	String	90	El umbral para alertas de nivel Critical.
Statistics	String	Average	Los métodos estadísticos para alertas de nivel Critical.
NoDataPolicy	String	KEEP_LAST_STATE	El método que se utiliza para manejar las alertas cuando no se encuentran datos de monitoreo. Valores válidos: KEEP_LAST_STATE (predeterminado): No se realiza ninguna operación. INSUFFICIENT_DATA: Se activa una alerta cuyo contenido es "Insufficient data". OK: El estado se considera normal.
CompositeExpression	Object		Las condiciones de activación para varias métricas. Nota Las condiciones de activación para una sola métrica y para varias métricas son mutuamente excluyentes. No puede especificar condiciones de activación para una sola métrica y para varias métricas al mismo tiempo.
Level	String	Critical	El nivel de alerta. Valores válidos: Critical Warn Info
ExpressionList	Array of ExpressionList		Las condiciones de activación creadas en modo estándar.
ExpressionList
MetricName	String	cpu_total	La métrica que se utiliza para monitorear el servicio en la nube.
ComparisonOperator	String	GreaterThanOrEqualToThreshold	El operador de comparación que se utiliza para comparar el valor de la métrica con el umbral. Valores válidos: GreaterThanOrEqualToThreshold: mayor o igual al umbral GreaterThanThreshold: mayor que el umbral LessThanOrEqualToThreshold: menor o igual al umbral LessThanThreshold: menor que el umbral NotEqualToThreshold: distinto al umbral GreaterThanYesterday: mayor que el valor de la métrica a la misma hora ayer LessThanYesterday: menor que el valor de la métrica a la misma hora ayer GreaterThanLastWeek: mayor que el valor de la métrica a la misma hora la semana pasada LessThanLastWeek: menor que el valor de la métrica a la misma hora la semana pasada GreaterThanLastPeriod: mayor que el valor de la métrica en el último ciclo de monitoreo LessThanLastPeriod: menor que el valor de la métrica en el último ciclo de monitoreo
Statistics	String	$Maximum	El método estadístico de la métrica. Valores válidos: $Maximum: el valor máximo $Minimum: el valor mínimo $Average: el valor promedio $Availability: la tasa de disponibilidad (generalmente utilizada para el monitoreo de sitios) Nota `$` es el prefijo de la métrica. Para obtener información sobre los servicios de Alibaba Cloud compatibles con CloudMonitor, consulte Apéndice 1: Métricas.
Threshold	String	90	El umbral de alerta.
Period	Integer	60	El periodo de agregación de la métrica. Unidad: segundos.
ExpressionListJoin	String	\|\|	La relación entre las condiciones de activación para varias métricas. Valores válidos: `&&`: Una alerta se activa solo si todas las métricas cumplen las condiciones de activación. Es decir, solo si los resultados de todas las expresiones especificadas en el parámetro ExpressionList son `true`. `\|\|`: Una alerta se activa si una de las métricas cumple las condiciones de activación.
ExpressionRaw	String	$Average > ($instanceId == 'i-io8kfvcpp7x5****'? 80: 50)	Las condiciones de activación creadas mediante expresiones. Puede usar expresiones para crear condiciones de activación en los siguientes escenarios: Establecer una lista de bloqueados de alertas para recursos específicos. Por ejemplo, si especifica `$instanceId != 'i-io8kfvcpp7x5**'` `&&` `$Average > 50`, no se genera ninguna alerta incluso cuando el `valor promedio de la métrica` de la instancia `i-io8kfvcpp7x5` supera 50. Establecer un umbral de alerta especial para una instancia especificada en la regla. Por ejemplo, si especifica `$Average > ($instanceId == 'i-io8kfvcpp7x5'? 80: 50)`, se activa una alerta cuando el `valor promedio de la métrica` de la instancia `i-io8kfvcpp7x5**` supera 80 o el `valor promedio de la métrica` de otras instancias supera 50. Limitar el número de instancias cuyos valores métricos superan el umbral. Por ejemplo, si especifica `count($Average > 20) > 3`, se activa una alerta solo cuando el número de instancias cuyo `valor promedio de la métrica` supera 20 excede tres.
Times	Integer	3	El número de activaciones consecutivas. Si el número de veces que los valores de la métrica cumplen las condiciones de activación alcanza el valor de este parámetro, CloudMonitor envía notificaciones de alerta.
Labels	Array of Labels		Las etiquetas de la regla de alerta.
Labels
Key	String	cmsRuleKey	La clave de etiqueta de la regla de alerta.
Value	String	cmsRuleValue	El valor de etiqueta de la regla de alerta.
Prometheus	Object		La regla de alerta de Prometheus. Nota Este parámetro es obligatorio solo cuando crea una regla de alerta de Prometheus para Hybrid Cloud Monitoring.
PromQL	String	CpuUsage{instanceId="xxxx"}[1m]>90	La sentencia de consulta PromQL. Nota Los datos obtenidos mediante la sentencia de consulta PromQL son los datos de monitoreo. Debe incluir el umbral de alerta en esta sentencia.
Level	String	Critical	El nivel de alerta. Valores válidos: Critical Warn Info
Times	Long	3	El número de activaciones consecutivas. Si el número de veces que los valores de la métrica cumplen las condiciones de activación alcanza el valor de este parámetro, CloudMonitor envía notificaciones de alerta.
Annotations	Array of Annotations		Las anotaciones de la regla de alerta de Prometheus. Cuando se activa una alerta de Prometheus, el sistema procesa las claves y valores anotados para ayudarle a comprender las métricas y la regla de alerta. Nota Este parámetro equivale al parámetro annotations de Prometheus de código abierto.
Annotations
Key	String	summary	La clave de la anotación.
Value	String	{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }	El valor de la anotación.

Ejemplos

Solicitudes de muestra

http(s)://[Endpoint]/?Action=DescribeMetricRuleList
&<Common request parameters>

Respuestas exitosas de muestra

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeMetricRuleListResponse>
	<RequestId>386C6712-335F-5054-930A-CC92B851ECBA</RequestId>
	<Total>1</Total>
	<Alarms>
		<Alarm>
			<GroupName>ECS_Group</GroupName>
			<SilenceTime>86400</SilenceTime>
			<ContactGroups>ECS_Alarm</ContactGroups>
			<NoEffectiveInterval>00:00-05:30</NoEffectiveInterval>
			<GroupBy>group</GroupBy>
			<MailSubject>${serviceType}-${metricName}-${levelDescription}Notification(${dimensions})</MailSubject>
			<SourceType>METRIC</SourceType>
			<RuleId>applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****</RuleId>
			<Period>60</Period>
			<Dimensions>
				<instanceId>i-2ze2d6j5uhg20x47****</instanceId>
			</Dimensions>
			<EffectiveInterval>05:31-23:59</EffectiveInterval>
			<Namespace>acs_ecs_dashboard</Namespace>
			<AlertState>OK</AlertState>
			<GroupId>7301****</GroupId>
			<MetricName>cpu_total</MetricName>
			<EnableState>true</EnableState>
			<Escalations>
				<Critical>
					<ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>
					<Times>3</Times>
					<Statistics>Average</Statistics>
					<Threshold>90</Threshold>
				</Critical>
				<Info>
					<ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>
					<Times>3</Times>
					<Statistics>Average</Statistics>
					<Threshold>90</Threshold>
				</Info>
				<Warn>
					<ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>
					<Times>3</Times>
					<Statistics>Average</Statistics>
					<Threshold>90</Threshold>
				</Warn>
			</Escalations>
			<Webhook>https://www.aliyun.com</Webhook>
			<Resources>[{\"instanceId\":\"i-2ze2d6j5uhg20x47****\"}]</Resources>
			<RuleName>Rule_01</RuleName>
		</Alarm>
	</Alarms>
	<Code>200</Code>
	<Success>true</Success>
</DescribeMetricRuleListResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "386C6712-335F-5054-930A-CC92B851ECBA",
  "Total" : 1,
  "Alarms" : {
    "Alarm" : [ {
      "GroupName" : "ECS_Group",
      "SilenceTime" : 86400,
      "ContactGroups" : "ECS_Alarm",
      "NoEffectiveInterval" : "00:00-05:30",
      "GroupBy" : "group",
      "MailSubject": "${serviceType}-${metricName}-${levelDescription}Notification(${dimensions})",
      "SourceType" : "METRIC",
      "RuleId" : "applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****",
      "Period" : 60,
      "Dimensions" : [ {
        "instanceId" : "i-2ze2d6j5uhg20x47****"
      } ],
      "EffectiveInterval" : "05:31-23:59",
      "Namespace" : "acs_ecs_dashboard",
      "AlertState" : "OK",
      "GroupId" : "7301****",
      "MetricName" : "cpu_total",
      "EnableState" : true,
      "Escalations" : {
        "Critical" : {
          "ComparisonOperator" : "GreaterThanOrEqualToThreshold",
          "Times" : 3,
          "Statistics" : "Average",
          "Threshold" : "90"
        },
        "Info" : {
          "ComparisonOperator" : "GreaterThanOrEqualToThreshold",
          "Times" : 3,
          "Statistics" : "Average",
          "Threshold" : "90"
        },
        "Warn" : {
          "ComparisonOperator" : "GreaterThanOrEqualToThreshold",
          "Times" : 3,
          "Statistics" : "Average",
          "Threshold" : "90"
        }
      },
      "Webhook" : "https://www.aliyun.com",
      "Resources" : "[{\"instanceId\":\"i-2ze2d6j5uhg20x47****\"}]",
      "RuleName" : "Rule_01"
    } ]
  },
  "Code" : "200",
  "Success" : true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
404	ResourceNotFound	The specified resource is not found.	El recurso especificado no se encontró.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.