當您需要監控某個云產品中的全部API的速率配額時,可以通過云監控創建全局配額告警。當該云產品中的任意一個API的速率配額的使用率或可用率達到閾值時,告警聯系人會收到告警通知,提醒其及時申請提升配額。
應用場景
用戶A在管理云資源時,為了提高自動化管理能力,集成OpenAPI進行服務管理。但由于OpenAPI數量龐大,訪問頻率很高,所以API流控發生的頻率較高,時常會影響業務穩定性。為了解決這一問題,運維團隊計劃監控各云產品API的實時用量和配額,提前規劃以保證業務的穩定性。然而API數量龐大,每個API單獨配置監控很難實現,于是客戶通過全局API的監控能力來進行管理。
目前,我們提供了控制臺和OpenAPI集成兩種方式來監控全局API的實時用量和配額。
背景信息
創建配額告警后,當告警指標達到閾值時,告警聯系人組中的告警聯系人會收到電話、短信、郵件和告警回調方式的告警通知。創建的配額告警將消耗云監控的費用額度,不同告警方式的計費如下:
前提條件
API速率配額的配額告警集成云監控的告警能力,目前處于邀測階段,請您提交工單申請。
通過控制臺為API速率配額創建全局配額項告警
本文以為云服務器ECS的全部API的速率配額創建告警為例進行介紹,其中告警條件為:當配額使用率的閾值大于等于80%時,通過短信和郵件給告警聯系人組內的告警聯系人發送警告級別(Warn)的告警通知。
進入云服務器ECS的API速率配額監控頁簽。
單擊全局報警規則,在全局報警規則頁面,為云服務器ECS的API速率配額創建告警規則。
查看API速率配額的全局配額項告警的創建結果。
通過云監控控制臺查看
通過配額中心控制臺查看
查看新創建的告警規則。
查看每個有用量的API的監控詳情。
通過OpenAPI為API速率配額創建全局配額項告警
本文以為云服務器ECS的全部API的速率配額創建告警為例進行介紹,其中告警條件為:當配額使用率的閾值大于等于80%時,通過短信和郵件給告警聯系人組內的告警聯系人發送警告級別(Warn)的告警通知。
先確認目標云產品(即云服務器ECS)的API速率配額是否支持全局配額項告警。
調用配額中心的API ListProductQuotas或GetProductQuota查看返回參數
UsageMetric
。當UsageMetric
的返回值不為空時,表示云服務器ECS支持API速率配額的全局配額項告警。請求參數:
ProductCode
輸入ecs
,QuotaCategory
選擇FlowControl
,其他參數均保持默認值。返回參數:在
UsageMetric
中顯示API速率配額在云監控中的監控信息,您可以得到MetricNamespace
為acs_quotas_flowcontrol
,每個API速率配額的返回信息如下:{ "QuotaActionCode": "f_ow93wj", "QuotaName": "DescribeDisks", "QuotaArn": "acs:quotas:ap-northeast-1:120886317861****:quota/ecs/f_ow93wj", "TotalQuota": 1000, "ProductCode": "ecs", "UsageMetric": { "MetricName": "Usage", "MetricDimensions": { "productCode": "ecs", "metricKey": "DescribeDisks/2014-05-26", "regionId": "ap-northeast-1", "label": "none" }, "MetricNamespace": "acs_quotas_flowcontrol" }, "QuotaCategory": "FlowControl", "Dimensions": { "apiName": "DescribeDisks", "apiVersion": "2014-05-26", "regionId": "ap-northeast-1" }, "Period": { "PeriodValue": 60, "PeriodUnit": "second" }, "Adjustable": false }
說明metricKey
用于為指定API速率配額創建配額告警(即單獨配額項告警)。
調用云監控的API DescribeMetricList查詢API速率配額的監控數據,根據配額用量的變化趨勢配置配額告警。
請求參數:
Namespace
輸入acs_quotas_flowcontrol
,MetricName
輸入UsagePercentage
,Dimensions
輸入[{"productCode":"ecs"}]
,其他參數均保持默認值。說明配額中心的
MetricName
包括:Quota
(配額值)、Usage
(配額用量)、UsagePercentage
(配額使用率)和AvailablePercentage
(配額剩余可用率)。返回參數:在
Datapoints
中,您可以得到Value
的取值,作為告警閾值的參考,返回信息如下:{ "RequestId": "14885854-7869-5E95-91BD-35B33B7E619D", "Period": "60", "Datapoints": "[{\"timestamp\":1721068920000,\"productCode\":\"ecs\",\"metricKey\":\"DescribeInstances/2014-05-26\",\"regionId\":\"cn-huhehaote\",\"label\":\"none\",\"userId\":\"120886317861****\",\"Value\":0.002},{\"timestamp\":1721068920000,\"productCode\":\"ecs\",\"metricKey\":\"InvokeCommand/2014-05-26\",\"regionId\":\"cn-qingdao\",\"label\":\"none\",\"userId\":\"120886317861****\",\"Value\":0.125}]", "Code": "200", "Success": true }
調用云監控的API PutResourceMetricRules為API速率配額創建配額告警規則(即全局配額項告警)。
請求參數:必填參數的設置方法及其示例如下表所示。
參數
描述
示例
MetricName
監控項名稱。取值:
Quota:配額值。
Usage:配額用量。
UsagePercentage:配額使用率。
AvailablePercentage:配額剩余可用率。
說明全局配額項告警只能用
UsagePercentage
和AvailablePercentage
。UsagePercentage
Escalations.Warn.Threshold
Warn級別告警閾值。
80
EffectiveInterval
告警規則的生效時間。
00:00-23:59 +0800 dayofweek 1,2,3,4,5,6,7
RuleId
告警規則ID。
quota-ecs-ruleid-test
Escalations.Warn.ComparisonOperator
Warn級別閾值比較符。取值:
GreaterThanOrEqualToThreshold:大于等于。
GreaterThanThreshold:大于。
LessThanOrEqualToThreshold:小于等于。
LessThanThreshold:小于。
NotEqualToThreshold:不等于。
GreaterThanYesterday:同比昨天時間上漲。
LessThanYesterday:同比昨天時間下降。
GreaterThanLastWeek:同比上周同一時間上漲。
LessThanLastWeek:同比上周同一時間下降。
GreaterThanLastPeriod:環比上周期上漲。
LessThanLastPeriod:環比上周期下降。
GreaterThanOrEqualToThreshold
Resources
資源信息。
說明當您為某個API創建單獨的配額項告警時,Resources輸入示例:
[{"productCode":"ecs","metricKey":"DescribeInstances/2014-05-26"}]
。[{"productCode":"ecs"}]
ContactGroups
告警聯系人組。
CloudMonitor
Namespace
云產品的數據命名空間。
acs_quotas_flowcontrol
RuleName
告警規則名稱。
quota-ecs-rulename-test
Escalations.Warn.Times
Warn級別告警重試次數。
3
Escalations.Warn.Statistics
Warn級別告警統計方法。
Value
返回信息如下,說明創建告警規則成功。
{ "Message": "", "RequestId": "BE4CAC0F-A134-55BA-909B-FF62568FE884", "FailedListResult": { "Target": [] }, "Code": "200", "Success": true }
調用云監控的API DescribeMetricRuleList,通過
RuleName
或RuleId
查看告警規則的創建結果。
相關文檔
您可以為某個云產品中的某個API速率創建配額告警(即單獨配額項告警)。具體操作,請參見為API速率配額創建配額告警。
當您收到某個配額項的告警時,可以申請提升其配額。具體操作,請參見創建配額提升申請。
創建配額告警后,您可以查看配額告警詳情。具體操作,請參見查詢配額告警列表及其詳情。
創建配額告警后,您可以查看配額告警歷史。具體操作,請參見查詢配額告警歷史記錄。