Monitore todos os limites de taxa de API de um serviço cloud com uma única regra de alerta global. Quando o uso ou a disponibilidade de qualquer API atingir um limiar, os contatos de alerta serão notificados para solicitar um aumento de cota.
Casos de uso
Altos volumes de chamadas de API podem causar limitações frequentes, afetando a estabilidade do negócio. Em vez de configurar regras de alerta individuais por API, uma regra de alerta global monitora todos os limites de taxa de um serviço cloud e permite um planejamento proativo de cotas.
É possível monitorar o uso global de APIs e as cotas por meio do console ou de operações de API.
Faturamento
As regras de alerta de limite de taxa de API consomem sua cota de notificações do CloudMonitor. O faturamento varia conforme o método de notificação:
Chamada telefônica — Não há cota gratuita disponível. Ative o método de faturamento pagamento conforme o uso ou adquira um plano de recursos. Para mais informações, consulte {{XREF_0}} e {{XREF_1}}.
SMS — Uma cota gratuita de 1.000 mensagens por mês é fornecida. Caso a cota gratuita seja excedida, ative o método de faturamento pagamento conforme o uso ou adquira um plano de recursos. Para mais informações, consulte {{XREF_2}}, {{XREF_3}} e {{XREF_4}}.
E-mail e callback de alerta — Ambos os métodos são gratuitos.
Pré-requisitos
Crie contatos de alerta e um grupo de contatos de alerta no console do CloudMonitor para receber mensagens de alerta. Para obter instruções, consulte {{XREF_5}}.
Se você utilizar um usuário do Resource Access Management (RAM) para gerenciar alertas de cota, esse usuário deverá ter a permissão de gerenciamento do Quota Center (
AliyunQuotasFullAccess) e as permissões para criar e excluir alertas de cota no CloudMonitor. O exemplo a seguir mostra o conteúdo da política personalizada. Para mais informações, consulte {{XREF_6}} e {{XREF_7}}.
Criar um alerta global pelo console
Este exemplo cria uma regra de alerta global para todos os limites de taxa de API do Compute Nest, acionada quando o uso atingir 80%. Uma notificação de nível Warning é enviada por SMS e e-mail para o grupo de contatos de alerta.
Utilize o console do Quota Center ou do CloudMonitor.
Console do Quota Center
No Quota Center console, abra a página API Rate Limits e selecione Compute Nest.
-
No canto superior direito, clique em Global Alert Rules.
Para detalhes sobre os parâmetros, consulte {{XREF_8}}. Insira um Rule Name, como
quota-computenest-rulename-test. Defina Metric como Usage Percentage (%) e o limiar de Warning como >= 80% para um período consecutivo, com notificações por SMS, e-mail e callback de alerta. Defina Silence Period como 5 Minutes, Effective Period como dia inteiro (00:00–23:59) e selecione um Alert Contact Group, como Cloud Account Alert Contact. Clique em Confirm. -
Visualize a regra criada na lista de regras de alerta.
-
Consulte a nova regra de alerta.
No painel de navegação à esquerda, clique em Alert Rules. Na aba API Rate Limits, localize a regra. Na coluna Actions, clique em View, Modify, Delete ou Monitoring Details.
-
Acesse os detalhes de monitoramento das APIs com dados de uso.
Na coluna Actions, clique em Monitoring Details. Na caixa de diálogo Quota Monitoring, selecione uma API alvo (por exemplo,
GetServiceTemplateParameterConstraints/2021-05-21), uma região (por exemplo,cn-hangzhou) e uma métrica (por exemplo, Usage Percentage (%)) e especifique um intervalo de tempo para visualizar o gráfico de porcentagem de uso.
-
Console do CloudMonitor
No Cloud Monitor Console, acesse a página Cloud Service Monitoring. Selecione para abrir a aba de monitoramento de API Rate Limits do Compute Nest.
-
No canto superior direito, clique em Global Alert Rule. Na página Global Alert Rule, crie uma regra de alerta para os limites de taxa de API do Compute Nest.
Para detalhes sobre os parâmetros, consulte {{XREF_9}}.
Clique em + Create Alert Rule, insira um nome de regra como
quota-computenest-rulename-test, selecione Usage Percentage como métrica e defina o limiar de nível Warning como >=80%.Nas configurações de notificação, selecione Cloud Account Alert Contact para Alert Contact Group, configure os demais parâmetros e clique em OK.
-
Visualize a regra criada na lista.
A regra de alerta aparece na lista com a condição
Notify if UsagePercentage (Warn) >= 80 for 3 consecutive periods. O status inicial é Insufficient Data.
Criar um alerta global por API
Este exemplo cria uma regra de alerta global para todos os limites de taxa de API do Compute Nest, acionada quando o uso atingir 80%. Uma notificação de nível Warning é enviada por SMS e e-mail para o grupo de contatos de alerta.
-
Verifique se o serviço cloud alvo (Compute Nest) oferece suporte a regras de alerta global para limites de taxa de API.
Chame {{XREF_10}} e verifique o parâmetro de resposta
UsageMetric. Um valor não vazio paraUsageMetricindica suporte a regras de alerta global.Parâmetros de solicitação: Defina
ProductCodecomocomputenesteQuotaCategorycomoFlowControl. Mantenha os valores padrão para os outros parâmetros.-
Parâmetros de resposta: O objeto
UsageMetriccontém informações de monitoramento de limites de taxa de API do CloudMonitor. O valor deMetricNamespaceéacs_quotas_flowcontrol. Exemplo de resposta para um limite de taxa de API:{ "Message": "", "RequestId": "BE4CAC0F-A134-55BA-909B-FF62568FE884", "FailedListResult": { "Target": [] }, "Code": "200", "Success": true }NotametricKeyé usado para criar uma regra de alerta para um único limite de taxa de API específico.
-
Chame {{XREF_11}} para consultar dados de monitoramento dos limites de taxa de API. Utilize as tendências de uso para determinar os limiares de alerta.
-
Parâmetros de solicitação: Defina
Namespacecomoacs_quotas_flowcontrol,MetricNamecomoUsagePercentageeDimensionscomo[{"productCode":"computenest"}]. Mantenha os valores padrão para os outros parâmetros.NotaO
MetricNameno Quota Center inclui:Quota(valor da cota),Usage(uso da cota),UsagePercentage(porcentagem de uso da cota) eAvailablePercentage(porcentagem de cota disponível). -
Parâmetros de retorno: O campo
ValueemDatapointspode servir de referência para o limiar de alerta. Exemplo de resposta:{ "Message": "", "RequestId": "BE4CAC0F-A134-55BA-909B-FF62568FE884", "FailedListResult": { "Target": [] }, "Code": "200", "Success": true }
-
-
Chame {{XREF_12}} para criar uma regra de alerta global para os limites de taxa de API.
-
Parâmetros de solicitação: A tabela a seguir lista os parâmetros obrigatórios e valores de exemplo.
Parâmetro
Descrição
Exemplo
MetricName
Nome da métrica. Valores válidos:
-
Quota: valor da cota
-
Usage: uso da cota
-
UsagePercentage: porcentagem de uso
-
AvailablePercentage: porcentagem disponível
NotaRegras de alerta global só podem usar
UsagePercentageeAvailablePercentage.UsagePercentage
Escalations.Warn.Threshold
Limiar para alertas de nível Warning.
80
EffectiveInterval
Período de vigência da regra de alerta.
00:00-23:59 +0800 dayofweek 1,2,3,4,5,6,7RuleId
ID da regra de alerta.
quota-computenest-ruleid-test
Escalations.Warn.ComparisonOperator
Operador de comparação para o limiar de nível Warning. Valores válidos:
-
GreaterThanOrEqualToThreshold: maior ou igual a
-
GreaterThanThreshold: maior que
-
LessThanOrEqualToThreshold: menor ou igual a
-
LessThanThreshold: menor que
-
NotEqualToThreshold: diferente de
-
GreaterThanYesterday: aumento percentual em relação ao mesmo horário ontem
-
LessThanYesterday: redução percentual em relação ao mesmo horário ontem
-
GreaterThanLastWeek: aumento percentual em relação ao mesmo horário na semana passada
-
LessThanLastWeek: redução percentual em relação ao mesmo horário na semana passada
-
GreaterThanLastPeriod: aumento percentual em relação ao período anterior
-
LessThanLastPeriod: redução percentual em relação ao período anterior
GreaterThanOrEqualToThreshold
Resources
Informações do recurso.
NotaPara criar um alerta para uma única API, especifique o parâmetro
Resourcescomo:[{"productCode":"computenest","metricKey":"GetServiceTemplateParameterConstraints/2021-06-01"}].[{"productCode":"computenest"}]
ContactGroups
Grupo de contatos de alerta.
CloudMonitor
Namespace
Namespace de dados do serviço cloud.
acs_quotas_flowcontrol
RuleName
Nome da regra de alerta.
quota-computenest-rulename-test
Escalations.Warn.Times
Número de períodos consecutivos em que a condição deve ser atendida para acionar um alerta de nível Warning.
3
Escalations.Warn.Statistics
Método estatístico para um alerta de nível Warning.
Value
-
-
Uma resposta bem-sucedida indica que a regra foi criada.
{ "Message": "", "RequestId": "BE4CAC0F-A134-55BA-909B-FF62568FE884", "FailedListResult": { "Target": [] }, "Code": "200", "Success": true }
-
Chame {{XREF_13}} para verificar a regra de alerta por
RuleNameouRuleId.
Documentos relacionados
Criar um alerta para um único limite de taxa de API: {{XREF_14}}
Solicitar aumento de cota após um alerta: {{XREF_15}}
Visualizar detalhes da regra de alerta: {{XREF_16}}
Visualizar histórico de alertas: {{XREF_17}}