Cloud Monitor:API レート制限のグローバルアラートルールの作成

ユースケース

API 操作によるサービスの自動管理では、呼び出し量が多い場合に API スロットリングが頻繁に発生し、ビジネスの安定性に影響を与える可能性があります。API ごとに個別のアラートルールを設定するのは非現実的です。グローバルアラートルールは、クラウドサービスのすべての API レート制限を監視し、プロアクティブなクォータ計画を可能にします。

コンソールを使用するか、API 操作を呼び出すことで、グローバルな API 使用量とクォータを監視できます。

課金

API レート制限のアラートルールは、CloudMonitor の通知クォータを消費します。課金は通知方法によって異なります。

• 電話：無料クォータは提供されません。従量課金方式を有効にするか、リソースプランを購入する必要があります。詳細については、「従量課金」および「リソースプラン」をご参照ください。

• SMS メッセージ：無料クォータは毎月 1,000 メッセージです。無料クォータを使い切った場合は、従量課金方式を有効にするか、リソースプランを購入する必要があります。詳細については、「無料クォータ」、「従量課金」、および「リソースプラン」をご参照ください。

• E メールとアラートコールバック：これら 2 つの通知方法はどちらも無料です。

前提条件

• CloudMonitor コンソール でアラート連絡先とアラート連絡グループを作成して、アラート通知を受信する必要があります。詳細については、「アラート連絡先またはアラート連絡グループを作成する」をご参照ください。

  

• RAM ユーザーとしてクォータアラートルールを作成する場合は、RAM ユーザーに AliyunQuotasFullAccess ポリシーをアタッチし、CloudMonitor でクォータ項目のアラートルールを作成および削除する権限を RAM ユーザーに付与する必要があります。

  RAM ユーザーに以下の権限を付与します。詳細については、「カスタムポリシーの作成」および「RAM ユーザーへの権限の付与」をご参照ください。

  {
    "Statement": [
      {
        "Effect": "Allow",
        "Action": [
          "cms:PutMetricRuleTargets",
          "cms:PutResourceMetricRules",
          "cms:DeleteMetricRules",
          "cms:DeleteMetricRuleTargets"
        ],
        "Resource": "*"
      }
    ],
    "Version": "1"
  }

コンソールを使用したグローバルアラートの作成

この例では、すべての Compute Nest API レート制限に対して、使用率が 80% に達したときにトリガーされるグローバルアラートルールを作成します。警告レベルの通知が SMS とメールでアラート連絡先グループに送信されます。

クォータセンターまたは CloudMonitor のいずれかのコンソールを使用できます。

APIを使用したグローバルアラートの作成

この例では、すべての Compute Nest API レート制限に対して、使用率が 80% に達したときにトリガーされるグローバルアラートルールを作成します。警告レベルの通知が SMS とメールでアラート連絡先グループに送信されます。

1. ターゲットのクラウドサービス (Compute Nest) が API レート制限のグローバルアラートルールをサポートしていることを確認します。

   Quota Center の ListProductQuotas API を呼び出し、UsageMetric レスポンスパラメーターを確認します。UsageMetric の値が空でない場合は、Compute Nest が API レート制限のグローバルアラートルールをサポートしていることを示します。

   • リクエストパラメーター: ProductCode を computenest に、QuotaCategory を FlowControl に設定し、他のパラメーターはデフォルト値のままにします。

   • レスポンスパラメーター: UsageMetric オブジェクトには、CloudMonitor による API レート制限のモニタリング情報が含まれています。MetricNamespace の値は acs_quotas_flowcontrol です。各 API レート制限に対して、次の情報が返されます。

     {
           "QuotaDescription": "GetServiceTemplateParameterConstraints",
           "Consumable": false,
           "ProductCode": "computenest",
           "UsageMetric": {
             "MetricName": "Usage",
             "MetricDimensions": {
               "productCode": "computenest",
               "metricKey": "GetServiceTemplateParameterConstraints/2021-05-21",
               "regionId": "ap-southeast-1",
               "label": "none"
             },
             "MetricNamespace": "acs_quotas_flowcontrol"
           },
           "Dimensions": {
             "apiName": "GetServiceTemplateParameterConstraints",
             "apiVersion": "2021-05-21",
             "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 レート制限のアラート ルールを作成するために使用されます。

2. CloudMonitor の DescribeMetricList API を呼び出して、API レート制限のモニタリングデータをクエリします。使用量の傾向を基にアラートのしきい値を決定します。

   • リクエストパラメーター: Namespace を acs_quotas_flowcontrol に、MetricName を UsagePercentage に、Dimensions を [{"productCode":"computenest"}] に設定します。 その他のパラメーターはデフォルト値のままにします。

     説明

     Quota Center の MetricName には、Quota（クォータ値）、Usage（クォータ使用量）、UsagePercentage（クォータ使用率）、および AvailablePercentage（利用可能なクォータの割合）が含まれます。

   • 戻りパラメーター: 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
     }

3. CloudMonitor の PutResourceMetricRules API を呼び出して、API レート制限のグローバルアラートルールを作成します。

   • リクエストパラメーター：次の表に、必須パラメーターと値の例を示します。

     パラメーター	説明	例
     MetricName	メトリック名。有効な値： Quota: クォータ値 Usage: クォータ使用量 UsagePercentage: 使用率 AvailablePercentage: 利用可能な割合 説明 グローバルアラートルールは UsagePercentage と AvailablePercentage のみ使用できます。	UsagePercentage
     Escalations.Warn.Threshold	警告レベルのアラートのしきい値。	80
     EffectiveInterval	アラートルールの有効期間。	00:00-23:59 +0800 dayofweek 1,2,3,4,5,6,7
     RuleId	アラートルールのID。	quota-computenest-ruleid-test
     Escalations.Warn.ComparisonOperator	警告レベルのしきい値の比較演算子。有効な値： GreaterThanOrEqualToThreshold: 以上 GreaterThanThreshold: より大きい LessThanOrEqualToThreshold: 以下 LessThanThreshold: 未満 NotEqualToThreshold: 等しくない GreaterThanYesterday: 昨日の同時刻からのパーセント増加 LessThanYesterday: 昨日の同時刻からのパーセント減少 GreaterThanLastWeek: 先週の同時刻からのパーセント増加 LessThanLastWeek: 先週の同時刻からのパーセント減少 GreaterThanLastPeriod: 前の期間からのパーセント増加 LessThanLastPeriod: 前の期間からのパーセント減少	GreaterThanOrEqualToThreshold
     Resources	リソース情報。 説明 API のクォータ項目に個別の アラーム を作成する場合、Resources の入力例は次のとおりです: [{"productCode":"computenest","metricKey":"GetServiceTemplateParameterConstraints/2021-06-01"}]。	[{"productCode":"computenest"}]
     ContactGroups	アラート連絡先グループ。	CloudMonitor
     Namespace	クラウドサービスのデータ名前空間。	acs_quotas_flowcontrol
     RuleName	アラートルール名。	quota-computenest-rulename-test
     Escalations.Warn.Times	警告レベルのアラートをトリガーする条件が、連続して満たされる回数。	1
     Escalations.Warn.Statistics	警告レベルのアラートの統計方法。	Value

   • 成功レスポンスは、アラートルールが作成されたことを示します。

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

4. CloudMonitor の DescribeMetricRuleList API をコールして、RuleName または RuleId でアラートルールを検証します。

関連ドキュメント

• 単一の API レート制限に対するアラートルールの作成：クォータのアラートルールの作成。

• アラート受信後のクォータ引き上げの申請：クォータ引き上げ申請の作成。

• アラートルールの詳細の表示：アラートルールのリストと詳細の表示。

• アラート履歴の表示：クォータアラート履歴の表示。