DescribeActiveMetricRuleList - : Central de Documentação do Alibaba Cloud

Consulta os detalhes das regras de alerta proativas.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Exemplo

Descrição

Action

String

Sim

DescribeActiveMetricRuleList

A operação a ser executada. Defina o valor como DescribeActiveMetricRuleList.

Product

String

Sim

ecs

A abreviação do serviço em nuvem compatível com regras de alerta proativas.

Para mais informações sobre como obter o nome de um serviço em nuvem, consulte DescribeProductsOfActiveMetricRule.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	200	O código de status HTTP. Nota O código de status 200 indica que a solicitação foi bem-sucedida.
Message	String	The Request is not authorization.	A mensagem de erro.
RequestId	String	F82E6667-7811-4BA0-842F-5B2DC42BBAAD	O ID da solicitação.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true false
Datapoints	Array of Alarm		Os detalhes das regras de alerta.
Alarm
SilenceTime	String	86400	O período de silêncio durante o qual novos alertas não são enviados, mesmo que as condições de acionamento sejam atendidas. Unidade: segundos.
MetricName	String	cpu_total	O nome da métrica.
EvaluationCount	String	3	O número consecutivo de vezes em que o valor da métrica atende à condição de acionamento antes do disparo do alerta.
Webhook	String	https://www.aliyun.com	A URL de callback.
State	String	Enable	Indica se a regra de alerta está ativada.
ContactGroups	String	ECS_Group	O grupo de contatos de alerta.
Namespace	String	acs_ecs_dashboard	O namespace do serviço em nuvem.
RuleName	String	SystemDefault_acs_rds_dashboard_CpuUsage	O nome da regra de alerta.
RuleId	String	a151cd6023eacee2f0978e03863cc1697c89508****	O ID da regra de alerta.
Period	String	60	O período de agregação dos dados de monitoramento. Unidade: segundos.
ComparisonOperator	String	>	O operador de comparação usado na regra de alerta. Valores válidos: `>` `<` `>=` `<=` `=` `=`
EndTime	String	24	O fim do período de vigência da regra de alerta. Unidade: horas. Por exemplo, o valor 23 indica `23:59:59`.
StartTime	String	00	O início do período de vigência da regra de alerta. Unidade: horas. Por exemplo, o valor 00 indica `00:00:00`.
Threshold	String	90	O limiar de alerta.
Statistics	String	Average	O método estatístico.
Enable	String	true	Indica se a regra de alerta está ativada. Valores válidos: true: A regra de alerta está ativada. false: A regra de alerta está desativada.
AlertList	Array of Alert		Os detalhes das regras de alerta. O resultado possui a mesma estrutura retornada pela operação DescribeMetricRuleList.
Alert
SilenceTime	String	86400	O período de silêncio durante o qual novos alertas não são enviados, mesmo que as condições de acionamento sejam atendidas. Unidade: segundos.
MetricName	String	cpu_total	O nome da métrica.
Webhook	String	http://www.aliyun.com	A URL de callback.
ContactGroups	String	ECS_Group	O grupo de contatos de alerta.
Namespace	String	acs_ecs_dashboard	O namespace do serviço em nuvem.
EffectiveInterval	String	00:00-23:59	O período de vigência da regra de alerta.
NoEffectiveInterval	String	00:00-06:00	O período de inatividade da regra de alerta.
MailSubject	String	ECS_Bucket	O assunto do e-mail de notificação de alerta.
RuleName	String	myAlert	O nome da regra de alerta.
RuleId	String	ruleIdxxxx	O ID da regra de alerta.
Period	String	60	O período de agregação dos dados de monitoramento. Unidade: segundos.
AlertState	String	OK	O status da regra de alerta. Valores válidos: OK: A regra de alerta não possui alertas ativos. ALARM: A regra de alerta possui alertas ativos. INSUFFICIENT_DATA: Não há dados disponíveis.
Dimensions	String	""	Os dados de monitoramento do recurso especificado.
EnableState	Boolean	true	Indica se a regra de alerta está ativada. Valores válidos: true: A regra de alerta está ativada. false: A regra de alerta está desativada.
Resources	String	[{"resource":"_ALL"}]	Os recursos associados à regra de alerta.
Escalations	Object		As condições para acionar diferentes níveis de alertas.
Info	Object		As condições para acionar alertas de nível Info.
ComparisonOperator	String	GreaterThanThreshold	O operador de comparação usado para comparar o valor da métrica com o limiar para alertas de nível Info. Valores válidos: GreaterThanOrEqualToThreshold: maior ou igual ao limiar GreaterThanThreshold: maior que o limiar LessThanOrEqualToThreshold: menor ou igual ao limiar LessThanThreshold: menor que o limiar NotEqualToThreshold: diferente do limiar GreaterThanYesterday: maior que o valor da métrica no mesmo horário ontem LessThanYesterday: menor que o valor da métrica no mesmo horário ontem GreaterThanLastWeek: maior que o valor da métrica no mesmo horário na semana passada LessThanLastWeek: menor que o valor da métrica no mesmo horário na semana passada GreaterThanLastPeriod: maior que o valor da métrica no último ciclo de monitoramento LessThanLastPeriod: menor que o valor da métrica no último ciclo de monitoramento
Times	String	3	O número consecutivo de vezes em que o valor da métrica excede o limiar para alertas de nível Info antes do disparo do alerta.
Threshold	String	95	O limiar para alertas de nível Info.
Statistics	String	Average	Os métodos estatísticos para alertas de nível Info.
Warn	Object		A condição para acionar alertas de nível Warn.
ComparisonOperator	String	GreaterThanThreshold	O operador de comparação usado para comparar o valor da métrica com o limiar para alertas de nível Critical. Valores válidos: GreaterThanOrEqualToThreshold: maior ou igual ao limiar GreaterThanThreshold: maior que o limiar LessThanOrEqualToThreshold: menor ou igual ao limiar LessThanThreshold: menor que o limiar NotEqualToThreshold: diferente do limiar GreaterThanYesterday: maior que o valor da métrica no mesmo horário ontem LessThanYesterday: menor que o valor da métrica no mesmo horário ontem GreaterThanLastWeek: maior que o valor da métrica no mesmo horário na semana passada LessThanLastWeek: menor que o valor da métrica no mesmo horário na semana passada GreaterThanLastPeriod: maior que o valor da métrica no último ciclo de monitoramento LessThanLastPeriod: menor que o valor da métrica no último ciclo de monitoramento
Times	String	3	O número consecutivo de vezes em que o valor da métrica excede o limiar para alertas de nível Warn antes do disparo do alerta.
Threshold	String	80	O limiar para alertas de nível Warn.
Statistics	String	Average	Os métodos estatísticos para alertas de nível Warn.
Critical	Object		As condições para acionar alertas de nível Critical.
ComparisonOperator	String	GreaterThanThreshold	O operador de comparação usado para comparar o valor da métrica com o limiar para alertas de nível Critical. Valores válidos: GreaterThanOrEqualToThreshold: maior ou igual ao limiar GreaterThanThreshold: maior que o limiar LessThanOrEqualToThreshold: menor ou igual ao limiar LessThanThreshold: menor que o limiar NotEqualToThreshold: diferente do limiar GreaterThanYesterday: maior que o valor da métrica no mesmo horário ontem LessThanYesterday: menor que o valor da métrica no mesmo horário ontem GreaterThanLastWeek: maior que o valor da métrica no mesmo horário na semana passada LessThanLastWeek: menor que o valor da métrica no mesmo horário na semana passada GreaterThanLastPeriod: maior que o valor da métrica no último ciclo de monitoramento LessThanLastPeriod: menor que o valor da métrica no último ciclo de monitoramento
Times	String	3	O número consecutivo de vezes em que o valor da métrica excede o limiar para alertas de nível Critical antes do disparo do alerta.
Threshold	String	99	O limiar para alertas de nível Critical.
Statistics	String	Average	Os métodos estatísticos para alertas de nível Critical.

Exemplos

Solicitações de exemplo

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

Respostas de sucesso de exemplo

Formato XML

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

<DescribeActiveMetricRuleListResponse>
        <AlertList>
            <Alert>
                <SilenceTime>86400</SilenceTime>
                <ContactGroups>ECS_Group</ContactGroups>
                <NoEffectiveInterval></NoEffectiveInterval>
                <MailSubject>${serviceType}-${metricName}-${levelDescription}</MailSubject>
                <RuleId>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleId>
                <Period>300</Period>
                <Dimensions></Dimensions>
                <EffectiveInterval></EffectiveInterval>
                <Namespace>acs_rds_dashboard</Namespace>
                <AlertState>INSUFFICIENT_DATA</AlertState>
                <MetricName>IOPSUsage</MetricName>
                <EnableState>true</EnableState>
                <Escalations>
                    <Critical />
                    <Info>
                        <ComparisonOperator>GreaterThanThreshold</ComparisonOperator>
                        <Times>5</Times>
                        <Statistics>Average</Statistics>
                        <Threshold>80</Threshold>
                    </Info>
                    <Warn />
                </Escalations>
                <Webhook></Webhook>
                <Resources>[{\"resource\":\"_ALL\"}]</Resources>
                <RuleName>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleName>
            </Alert>
            <Alert>
                <SilenceTime>86400</SilenceTime>
                <ContactGroups>ECS_Group</ContactGroups>
                <NoEffectiveInterval></NoEffectiveInterval>
                <MailSubject>${serviceType}-${metricName}-${levelDescription}</MailSubject>
                <RuleId>SystemDefault_acs_rds_dashboard_CpuUsage</RuleId>
                <Period>300</Period>
                <Dimensions></Dimensions>
                <EffectiveInterval></EffectiveInterval>
                <Namespace>acs_rds_dashboard</Namespace>
                <AlertState>INSUFFICIENT_DATA</AlertState>
                <MetricName>CpuUsage</MetricName>
                <EnableState>true</EnableState>
                <Escalations>
                    <Critical />
                    <Info>
                        <ComparisonOperator>GreaterThanThreshold</ComparisonOperator>
                        <Times>5</Times>
                        <Statistics>Average</Statistics>
                        <Threshold>80</Threshold>
                    </Info>
                    <Warn />
                </Escalations>
                <Webhook></Webhook>
                <Resources>[{\"resource\":\"_ALL\"}]</Resources>
                <RuleName>SystemDefault_acs_rds_dashboard_CpuUsage</RuleName>
            </Alert>
        </AlertList>
        <Datapoints>
            <Alarm>
                <SilenceTime>86400</SilenceTime>
                <ContactGroups>[\"Alice\"]</ContactGroups>
                <ComparisonOperator>GreaterThanThreshold</ComparisonOperator>
                <EndTime></EndTime>
                <RuleId>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleId>
                <StartTime></StartTime>
                <Period>300</Period>
                <EvaluationCount>5</EvaluationCount>
                <Statistics>Average</Statistics>
                <Namespace>acs_rds_dashboard</Namespace>
                <MetricName>IOPSUsage</MetricName>
                <State>INSUFFICIENT_DATA</State>
                <Enable>true</Enable>
                <Webhook></Webhook>
                <RuleName>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleName>
                <Threshold>80</Threshold>
            </Alarm>
            <Alarm>
                <SilenceTime>86400</SilenceTime>
                <ContactGroups>[\"Jim\"]</ContactGroups>
                <ComparisonOperator>GreaterThanThreshold</ComparisonOperator>
                <EndTime></EndTime>
                <RuleId>SystemDefault_acs_rds_dashboard_CpuUsage</RuleId>
                <StartTime></StartTime>
                <Period>300</Period>
                <EvaluationCount>5</EvaluationCount>
                <Statistics>Average</Statistics>
                <Namespace>acs_rds_dashboard</Namespace>
                <MetricName>CpuUsage</MetricName>
                <State>INSUFFICIENT_DATA</State>
                <Enable>true</Enable>
                <Webhook></Webhook>
                <RuleName>SystemDefault_acs_rds_dashboard_CpuUsage</RuleName>
                <Threshold>80</Threshold>
            </Alarm>
        </Datapoints>
        <Code>200</Code>
        <Success>true</Success>
</DescribeActiveMetricRuleListResponse>

Formato JSON

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

{
  "AlertList" : {
    "Alert" : [ {
      "SilenceTime" : 86400,
      "ContactGroups" : "ECS_Group",
      "NoEffectiveInterval" : "",
      "MailSubject" : "${serviceType}-${metricName}-${levelDescription}",
      "RuleId" : "SystemDefault_acs_rds_dashboard_IOPSUsage",
      "Period" : 300,
      "Dimensions" : "",
      "EffectiveInterval" : "",
      "Namespace" : "acs_rds_dashboard",
      "AlertState" : "INSUFFICIENT_DATA",
      "MetricName" : "IOPSUsage",
      "EnableState" : true,
      "Escalations" : {
        "Critical" : { },
        "Info" : {
          "ComparisonOperator" : "GreaterThanThreshold",
          "Times" : 5,
          "Statistics" : "Average",
          "Threshold" : "80"
        },
        "Warn" : { }
      },
      "Webhook" : "",
      "Resources" : "[{\"resource\":\"_ALL\"}]",
      "RuleName" : "SystemDefault_acs_rds_dashboard_IOPSUsage"
    }, {
      "SilenceTime" : 86400,
      "ContactGroups" : "ECS_Group",
      "NoEffectiveInterval" : "",
      "MailSubject" : "${serviceType}-${metricName}-${levelDescription}",
      "RuleId" : "SystemDefault_acs_rds_dashboard_CpuUsage",
      "Period" : 300,
      "Dimensions" : "",
      "EffectiveInterval" : "",
      "Namespace" : "acs_rds_dashboard",
      "AlertState" : "INSUFFICIENT_DATA",
      "MetricName" : "CpuUsage",
      "EnableState" : true,
      "Escalations" : {
        "Critical" : { },
        "Info" : {
          "ComparisonOperator" : "GreaterThanThreshold",
          "Times" : 5,
          "Statistics" : "Average",
          "Threshold" : "80"
        },
        "Warn" : { }
      },
      "Webhook" : "",
      "Resources" : "[{\"resource\":\"_ALL\"}]",
      "RuleName" : "SystemDefault_acs_rds_dashboard_CpuUsage"
    } ]
  },
  "Datapoints" : {
    "Alarm" : [ {
      "SilenceTime" : 86400,
      "ContactGroups" : "[\"Alice\"]",
      "ComparisonOperator" : "GreaterThanThreshold",
      "EndTime" : "",
      "RuleId" : "SystemDefault_acs_rds_dashboard_IOPSUsage",
      "StartTime" : "",
      "Period" : 300,
      "EvaluationCount" : 5,
      "Statistics" : "Average",
      "Namespace" : "acs_rds_dashboard",
      "MetricName" : "IOPSUsage",
      "State" : "INSUFFICIENT_DATA",
      "Enable" : true,
      "Webhook" : "",
      "RuleName" : "SystemDefault_acs_rds_dashboard_IOPSUsage",
      "Threshold" : "80"
    }, {
      "SilenceTime" : 86400,
      "ContactGroups" : "[\"Jim\"]",
      "ComparisonOperator" : "GreaterThanThreshold",
      "EndTime" : "",
      "RuleId" : "SystemDefault_acs_rds_dashboard_CpuUsage",
      "StartTime" : "",
      "Period" : 300,
      "EvaluationCount" : 5,
      "Statistics" : "Average",
      "Namespace" : "acs_rds_dashboard",
      "MetricName" : "CpuUsage",
      "State" : "INSUFFICIENT_DATA",
      "Enable" : true,
      "Webhook" : "",
      "RuleName" : "SystemDefault_acs_rds_dashboard_CpuUsage",
      "Threshold" : "80"
    } ]
  },
  "Code" : "200",
  "Success" : true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
404	ResourceNotFound	The specified resource is not found.	O recurso especificado não foi encontrado.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.