為API速率配額創(chuàng)建全局配額項告警
當您需要監(jiān)控某個云產(chǎn)品中的全部API的速率配額時,可以創(chuàng)建全局配額告警。當該云產(chǎn)品中的任意一個API的速率配額的使用率或可用率達到閾值時,告警聯(lián)系人會收到告警通知,提醒其及時申請?zhí)嵘漕~。
應(yīng)用場景
用戶A在管理云資源時,為了提高自動化管理能力,集成OpenAPI進行服務(wù)管理。但由于OpenAPI數(shù)量龐大,訪問頻率很高,所以API流控發(fā)生的頻率較高,時常會影響業(yè)務(wù)穩(wěn)定性。為了解決這一問題,運維團隊計劃監(jiān)控各云產(chǎn)品API的實時用量和配額,提前規(guī)劃以保證業(yè)務(wù)的穩(wěn)定性。然而API數(shù)量龐大,每個API單獨配置監(jiān)控很難實現(xiàn),于是客戶通過全局API的監(jiān)控能力來進行管理。
目前,我們提供了控制臺和OpenAPI集成兩種方式來監(jiān)控全局API的實時用量和配額。
計費說明
API速率配額的配額告警集成的是云監(jiān)控的告警能力,創(chuàng)建的配額告警將消耗云監(jiān)控的費用額度,不同告警方式的計費如下:
準備工作
您需要在云監(jiān)控中創(chuàng)建告警聯(lián)系人和告警聯(lián)系人組,用于接收告警消息。具體操作,請參見創(chuàng)建告警聯(lián)系人或告警聯(lián)系人組。
如果您使用RAM用戶操作API速率配額告警,RAM用戶除了需要配額中心的管理權(quán)限(AliyunQuotasFullAccess)外,還需要在云監(jiān)控中創(chuàng)建和刪除配額告警的權(quán)限。
自定義權(quán)限策略內(nèi)容如下。具體操作,請參見創(chuàng)建自定義權(quán)限策略、為RAM用戶授權(quán)。
{ "Statement": [ { "Effect": "Allow", "Action": [ "cms:PutMetricRuleTargets", "cms:PutResourceMetricRules", "cms:DeleteMetricRules", "cms:DeleteMetricRuleTargets" ], "Resource": "*" } ], "Version": "1" }
通過控制臺為API速率配額創(chuàng)建全局配額項告警
本文以為計算巢服務(wù)的全部API的速率配額創(chuàng)建告警為例進行介紹,其中告警條件為:當配額使用率的閾值大于等于80%時,通過短信和郵件給告警聯(lián)系人組內(nèi)的告警聯(lián)系人發(fā)送警告級別(Warn)的告警通知。
該操作可在配額中心控制臺和云監(jiān)控控制臺進行,您可根據(jù)需求選擇。
配額中心控制臺
在配額中心控制臺的API速率配額頁面,選擇計算巢服務(wù)。
單擊右上角的全局告警,為計算巢服務(wù)的API速率配額創(chuàng)建告警規(guī)則。
關(guān)于告警規(guī)則中參數(shù)的設(shè)置方法,請參見API速率配額告警規(guī)則參數(shù)。
創(chuàng)建完成后,可查看API速率配額的全局配額項告警。
查看新創(chuàng)建的告警規(guī)則。
查看每個有用量的API的監(jiān)控詳情。
云監(jiān)控控制臺
在云監(jiān)控控制臺的云產(chǎn)品監(jiān)控頁面,進入計算巢服務(wù)的API速率配額監(jiān)控頁簽。
單擊右上角的全局報警規(guī)則,在全局報警規(guī)則頁面,為計算巢服務(wù)的API速率配額創(chuàng)建告警規(guī)則。
關(guān)于告警規(guī)則中參數(shù)的設(shè)置方法,請參見API速率配額告警規(guī)則參數(shù)。
創(chuàng)建完成后,可查看API速率配額的全局配額項告警。
通過OpenAPI為API速率配額創(chuàng)建全局配額項告警
本文以為計算巢服務(wù)的全部API的速率配額創(chuàng)建告警為例進行介紹,其中告警條件為:當配額使用率的閾值大于等于80%時,通過短信和郵件給告警聯(lián)系人組內(nèi)的告警聯(lián)系人發(fā)送警告級別(Warn)的告警通知。
先確認目標云產(chǎn)品(即計算巢服務(wù))的API速率配額是否支持全局配額項告警。
調(diào)用配額中心的API ListProductQuotas查看返回參數(shù)
UsageMetric
。當UsageMetric
的返回值不為空時,表示計算巢服務(wù)支持API速率配額的全局配額項告警。請求參數(shù):
ProductCode
輸入computenest
,QuotaCategory
選擇FlowControl
,其他參數(shù)均保持默認值。返回參數(shù):在
UsageMetric
中顯示API速率配額在云監(jiān)控中的監(jiān)控信息,您可以得到MetricNamespace
為acs_quotas_flowcontrol
,每個API速率配額的返回信息如下:{ "QuotaDescription": "GetServiceTemplateParameterConstraints", "Consumable": false, "ProductCode": "computenest", "UsageMetric": { "MetricName": "Usage", "MetricDimensions": { "productCode": "computenest", "metricKey": "GetServiceTemplateParameterConstraints/2021-06-01", "regionId": "ap-southeast-1", "label": "none" }, "MetricNamespace": "acs_quotas_flowcontrol" }, "Dimensions": { "apiName": "GetServiceTemplateParameterConstraints", "apiVersion": "2021-06-01", "regionId": "ap-southeast-1" }, "GlobalQuota": false, "Period": { "PeriodValue": 1, "PeriodUnit": "second" }, "Adjustable": true, "QuotaActionCode": "f_4w8uhd", "QuotaName": "GetServiceTemplateParameterConstraints", "QuotaArn": "acs:quotas:ap-southeast-1:14133977********:quota/computenest/f_4w8uhd", "TotalQuota": 50, "QuotaCategory": "FlowControl" }
說明metricKey
用于為指定API速率配額創(chuàng)建配額告警(即單獨配額項告警)。
調(diào)用云監(jiān)控的API DescribeMetricList查詢API速率配額的監(jiān)控數(shù)據(jù),根據(jù)配額用量的變化趨勢配置配額告警。
請求參數(shù):
Namespace
輸入acs_quotas_flowcontrol
,MetricName
輸入UsagePercentage
,Dimensions
輸入[{"productCode":"computenest"}]
,其他參數(shù)均保持默認值。說明配額中心的
MetricName
包括:Quota
(配額值)、Usage
(配額用量)、UsagePercentage
(配額使用率)和AvailablePercentage
(配額剩余可用率)。返回參數(shù):在
Datapoints
中,您可以得到Value
的取值,作為告警閾值的參考,返回信息如下:{ "RequestId": "2A7DB5BF-825C-51BB-AD91-D728857792F9", "Period": "60", "Datapoints": "[{\"timestamp\":1727337180000,\"productCode\":\"computenest\",\"metricKey\":\"GetServiceTemplateParameterConstraints/2021-05-21\",\"regionId\":\"cn-hangzhou\",\"label\":\"none\",\"userId\":\"14133977********\",\"Value\":2.0}]", "Code": "200", "Success": true }
調(diào)用云監(jiān)控的API PutResourceMetricRules為API速率配額創(chuàng)建配額告警規(guī)則(即全局配額項告警)。
請求參數(shù):必填參數(shù)的設(shè)置方法及其示例如下表所示。
參數(shù)
描述
示例
MetricName
監(jiān)控項名稱。取值:
Quota:配額值。
Usage:配額用量。
UsagePercentage:配額使用率。
AvailablePercentage:配額剩余可用率。
說明全局配額項告警只能用
UsagePercentage
和AvailablePercentage
。UsagePercentage
Escalations.Warn.Threshold
Warn級別告警閾值。
80
EffectiveInterval
告警規(guī)則的生效時間。
00:00-23:59 +0800 dayofweek 1,2,3,4,5,6,7
RuleId
告警規(guī)則ID。
quota-computenest-ruleid-test
Escalations.Warn.ComparisonOperator
Warn級別閾值比較符。取值:
GreaterThanOrEqualToThreshold:大于等于。
GreaterThanThreshold:大于。
LessThanOrEqualToThreshold:小于等于。
LessThanThreshold:小于。
NotEqualToThreshold:不等于。
GreaterThanYesterday:同比昨天時間上漲。
LessThanYesterday:同比昨天時間下降。
GreaterThanLastWeek:同比上周同一時間上漲。
LessThanLastWeek:同比上周同一時間下降。
GreaterThanLastPeriod:環(huán)比上周期上漲。
LessThanLastPeriod:環(huán)比上周期下降。
GreaterThanOrEqualToThreshold
Resources
資源信息。
說明當您為某個API創(chuàng)建單獨的配額項告警時,Resources輸入示例:
[{"productCode":"computenest","metricKey":"GetServiceTemplateParameterConstraints/2021-06-01"}]
。[{"productCode":"computenest"}]
ContactGroups
告警聯(lián)系人組。
CloudMonitor
Namespace
云產(chǎn)品的數(shù)據(jù)命名空間。
acs_quotas_flowcontrol
RuleName
告警規(guī)則名稱。
quota-computenest-rulename-test
Escalations.Warn.Times
Warn級別告警重試次數(shù)。
3
Escalations.Warn.Statistics
Warn級別告警統(tǒng)計方法。
Value
返回信息如下,說明創(chuàng)建告警規(guī)則成功。
{ "Message": "", "RequestId": "BE4CAC0F-A134-55BA-909B-FF62568FE884", "FailedListResult": { "Target": [] }, "Code": "200", "Success": true }
調(diào)用云監(jiān)控的API DescribeMetricRuleList,通過
RuleName
或RuleId
查看告警規(guī)則的創(chuàng)建結(jié)果。
相關(guān)文檔
您可以為某個云產(chǎn)品中的某個API速率創(chuàng)建配額告警(即單獨配額項告警)。具體操作,請參見創(chuàng)建API速率配額告警。
當您收到某個配額項的告警時,可以申請?zhí)嵘渑漕~。具體操作,請參見創(chuàng)建配額提升申請。
創(chuàng)建配額告警后,您可以查看配額告警詳情。具體操作,請參見查詢配額告警列表及其詳情。
創(chuàng)建配額告警后,您可以查看配額告警歷史。具體操作,請參見查詢配額告警歷史記錄。