應(yīng)用場(chǎng)景

用戶A在管理云資源時(shí)，為了提高自動(dòng)化管理能力，集成OpenAPI進(jìn)行服務(wù)管理。但由于OpenAPI數(shù)量龐大，訪問頻率很高，所以API流控發(fā)生的頻率較高，時(shí)常會(huì)影響業(yè)務(wù)穩(wěn)定性。為了解決這一問題，運(yùn)維團(tuán)隊(duì)計(jì)劃監(jiān)控各云產(chǎn)品API的實(shí)時(shí)用量和配額，提前規(guī)劃以保證業(yè)務(wù)的穩(wěn)定性。然而API數(shù)量龐大，每個(gè)API單獨(dú)配置監(jiān)控很難實(shí)現(xiàn)，于是客戶通過全局API的監(jiān)控能力來(lái)進(jìn)行管理。

目前，我們提供了控制臺(tái)和OpenAPI集成兩種方式來(lái)監(jiān)控全局API的實(shí)時(shí)用量和配額。

背景信息

創(chuàng)建配額告警后，當(dāng)告警指標(biāo)達(dá)到閾值時(shí)，告警聯(lián)系人組中的告警聯(lián)系人會(huì)收到電話、短信、郵件和告警回調(diào)方式的告警通知。創(chuàng)建的配額告警將消耗云監(jiān)控的費(fèi)用額度，不同告警方式的計(jì)費(fèi)如下：

• 電話：無(wú)免費(fèi)額度，您需要開通按量計(jì)費(fèi)或購(gòu)買資源包。更多信息，請(qǐng)參見按量計(jì)費(fèi)和資源包。

• 短信：免費(fèi)額度為1000條/月，如果超過免費(fèi)額度，則請(qǐng)您開通按量計(jì)費(fèi)或購(gòu)買資源包。更多信息，請(qǐng)參見免費(fèi)額度、按量計(jì)費(fèi)和資源包。

• 郵件和告警回調(diào)：均免費(fèi)。

通過控制臺(tái)為API速率配額創(chuàng)建全局配額項(xiàng)告警

本文以為云服務(wù)器ECS的全部API的速率配額創(chuàng)建告警為例進(jìn)行介紹，其中告警條件為：當(dāng)配額使用率的閾值大于等于80%時(shí)，通過短信和郵件給告警聯(lián)系人組內(nèi)的告警聯(lián)系人發(fā)送警告級(jí)別（Warn）的告警通知。

1. 進(jìn)入云服務(wù)器ECS的API速率配額監(jiān)控頁(yè)簽。

   

2. 單擊全局報(bào)警規(guī)則，在全局報(bào)警規(guī)則頁(yè)面，為云服務(wù)器ECS的API速率配額創(chuàng)建告警規(guī)則。

   

   

3. 查看API速率配額的全局配額項(xiàng)告警的創(chuàng)建結(jié)果。

   • 通過云監(jiān)控控制臺(tái)查看

     

   • 通過配額中心控制臺(tái)查看

     1. 查看新創(chuàng)建的告警規(guī)則。

        

     2. 查看每個(gè)有用量的API的監(jiān)控詳情。

        

通過OpenAPI為API速率配額創(chuàng)建全局配額項(xiàng)告警

本文以為云服務(wù)器ECS的全部API的速率配額創(chuàng)建告警為例進(jìn)行介紹，其中告警條件為：當(dāng)配額使用率的閾值大于等于80%時(shí)，通過短信和郵件給告警聯(lián)系人組內(nèi)的告警聯(lián)系人發(fā)送警告級(jí)別（Warn）的告警通知。

1. 先確認(rèn)目標(biāo)云產(chǎn)品（即云服務(wù)器ECS）的API速率配額是否支持全局配額項(xiàng)告警。

   調(diào)用配額中心的API ListProductQuotas或GetProductQuota查看返回參數(shù)UsageMetric。當(dāng)UsageMetric的返回值不為空時(shí)，表示云服務(wù)器ECS支持API速率配額的全局配額項(xiàng)告警。

   • 請(qǐng)求參數(shù)：ProductCode輸入ecs，QuotaCategory選擇FlowControl，其他參數(shù)均保持默認(rèn)值。

   • 返回參數(shù)：在UsageMetric中顯示API速率配額在云監(jiān)控中的監(jiān)控信息，您可以得到MetricNamespace為acs_quotas_flowcontrol，每個(gè)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
         }

     說(shuō)明

     metricKey用于為指定API速率配額創(chuàng)建配額告警（即單獨(dú)配額項(xiàng)告警）。

2. 調(diào)用云監(jiān)控的API DescribeMetricList查詢API速率配額的監(jiān)控?cái)?shù)據(jù)，根據(jù)配額用量的變化趨勢(shì)配置配額告警。

   • 請(qǐng)求參數(shù)：Namespace輸入acs_quotas_flowcontrol，MetricName輸入UsagePercentage，Dimensions輸入[{"productCode":"ecs"}]，其他參數(shù)均保持默認(rèn)值。

     說(shuō)明

     配額中心的MetricName包括：Quota（配額值）、Usage（配額用量）、UsagePercentage（配額使用率）和AvailablePercentage（配額剩余可用率）。

   • 返回參數(shù)：在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
     }

3. 調(diào)用云監(jiān)控的API PutResourceMetricRules為API速率配額創(chuàng)建配額告警規(guī)則（即全局配額項(xiàng)告警）。

   • 請(qǐng)求參數(shù)：必填參數(shù)的設(shè)置方法及其示例如下表所示。

     參數(shù)	描述	示例
     MetricName	監(jiān)控項(xiàng)名稱。取值： Quota：配額值。 Usage：配額用量。 UsagePercentage：配額使用率。 AvailablePercentage：配額剩余可用率。 說(shuō)明 全局配額項(xiàng)告警只能用UsagePercentage和AvailablePercentage。	UsagePercentage
     Escalations.Warn.Threshold	Warn級(jí)別告警閾值。	80
     EffectiveInterval	告警規(guī)則的生效時(shí)間。	00:00-23:59 +0800 dayofweek 1,2,3,4,5,6,7
     RuleId	告警規(guī)則ID。	quota-ecs-ruleid-test
     Escalations.Warn.ComparisonOperator	Warn級(jí)別閾值比較符。取值： GreaterThanOrEqualToThreshold：大于等于。 GreaterThanThreshold：大于。 LessThanOrEqualToThreshold：小于等于。 LessThanThreshold：小于。 NotEqualToThreshold：不等于。 GreaterThanYesterday：同比昨天時(shí)間上漲。 LessThanYesterday：同比昨天時(shí)間下降。 GreaterThanLastWeek：同比上周同一時(shí)間上漲。 LessThanLastWeek：同比上周同一時(shí)間下降。 GreaterThanLastPeriod：環(huán)比上周期上漲。 LessThanLastPeriod：環(huán)比上周期下降。	GreaterThanOrEqualToThreshold
     Resources	資源信息。 說(shuō)明 當(dāng)您為某個(gè)API創(chuàng)建單獨(dú)的配額項(xiàng)告警時(shí)，Resources輸入示例：[{"productCode":"ecs","metricKey":"DescribeInstances/2014-05-26"}]。	[{"productCode":"ecs"}]
     ContactGroups	告警聯(lián)系人組。	CloudMonitor
     Namespace	云產(chǎn)品的數(shù)據(jù)命名空間。	acs_quotas_flowcontrol
     RuleName	告警規(guī)則名稱。	quota-ecs-rulename-test
     Escalations.Warn.Times	Warn級(jí)別告警重試次數(shù)。	3
     Escalations.Warn.Statistics	Warn級(jí)別告警統(tǒng)計(jì)方法。	Value

   • 返回信息如下，說(shuō)明創(chuàng)建告警規(guī)則成功。

     {
       "Message": "",
       "RequestId": "BE4CAC0F-A134-55BA-909B-FF62568FE884",
       "FailedListResult": {
         "Target": []
       },
       "Code": "200",
       "Success": true
     }

4. 調(diào)用云監(jiān)控的API DescribeMetricRuleList，通過RuleName或RuleId查看告警規(guī)則的創(chuàng)建結(jié)果。

相關(guān)文檔

• 您可以為某個(gè)云產(chǎn)品中的某個(gè)API速率創(chuàng)建配額告警（即單獨(dú)配額項(xiàng)告警）。具體操作，請(qǐng)參見為API速率配額創(chuàng)建配額告警。

• 當(dāng)您收到某個(gè)配額項(xiàng)的告警時(shí)，可以申請(qǐng)?zhí)嵘渑漕~。具體操作，請(qǐng)參見創(chuàng)建配額提升申請(qǐng)。

• 創(chuàng)建配額告警后，您可以查看配額告警詳情。具體操作，請(qǐng)參見查詢配額告警列表及其詳情。

• 創(chuàng)建配額告警后，您可以查看配額告警歷史。具體操作，請(qǐng)參見查詢配額告警歷史記錄。