全部產品
Search
文件中心

Auto Scaling:CreateAlarm

更新時間:Jan 14, 2025

針對具有突發性或時間上不易預測的業務,調用CreateAlarm建立一個警示任務,該任務關聯CloudMonitor指標後,可以動態調整伸縮組內的ECS執行個體或ECI執行個體數量,並即時監控執行個體指標,協助您更好地管理和維護雲資源。

介面說明

  • 如果您建立自訂監控類型的警示任務(MetricType=custom),您需要先將自訂監控項指標上報到CloudMonitor。具體操作,請參見自訂監控警示任務
  • 建立警示任務時,您需要指定監控項(MetricName),並配合維度資訊(Dimension.N.DimensionKey和Dimension.N.DimensionValue),來確定伸縮組中該監控項資料的彙總範圍。例如,指定user_id和scaling_group來確定彙總該使用者、該伸縮組下所有ECS執行個體或ECI執行個體的監控項資料。
    • 自訂監控警示任務(MetricType=custom)的監控項取決於您自有的監控指標。
    • 系統監控警示任務(MetricType=system)支援的監控項的更多資訊,請參見系統監控警示任務
說明 維度資訊中,user_id和scaling_group由系統自動填滿,device、state需要您手動指定。更多資訊,請參見參數Dimension.N.DimensionKeyDimension.N.DimensionValue

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱

類型

是否必選

樣本值

描述

Action String CreateAlarm

系統規定參數。取值:CreateAlarm

RegionId String cn-hangzhou

伸縮組所屬的地區ID。

Name String TestAlarmTask

警示任務的名稱。

Description String Test alarm task.

警示任務的描述。

ScalingGroupId String asg-bp18p2yfxow2dloq****

警示任務關聯的伸縮組的ID。

MetricName String CpuUtilization

監控項名稱。取值範圍與警示任務的監控類型有關:

  • 當警示任務為自訂監控類型(即MetricType=custom)時,取值範圍是您自有的監控項範圍。
  • 當警示任務為系統監控類型(即MetricType=system)時,取值範圍如下:
    • CpuUtilization:(ECS)CPU使用率(%)。
    • ConcurrentConnections:(ECS)ECS同時串連數(個)。
    • IntranetTx:(ECS)內網出流量(Kb/min)。
    • IntranetRx:(ECS)內網入流量(Kb/min)。
    • VpcInternetTx:(ECS)外網出流量(Kb/min)。
    • VpcInternetRx:(ECS)外網入流量(Kb/min)。
    • SystemDiskReadBps:(ECS)系統硬碟讀BPS(Byte/s)。
    • SystemDiskWriteBps:(ECS)系統硬碟寫BPS(Byte/s)。
    • SystemDiskReadOps:(ECS)系統硬碟讀IOPS(次/s)。
    • SystemDiskWriteOps:(ECS)系統硬碟寫IOPS(次/s)。
    • CpuUtilizationAgent:(Agent)CPU使用率(%)。
    • GpuUtilizationAgent:(Agent)GPU使用率(%)。
    • GpuMemoryFreeUtilizationAgent:(Agent)GPU記憶體空閑率(%)。
    • GpuMemoryUtilizationAgent:(Agent)GPU記憶體使用量率(%)。
    • MemoryUtilization:(Agent)記憶體(%)。
    • LoadAverage:(Agent)系統平均負載。
    • TcpConnection:(Agent)TCP總串連數(個)。
    • TcpConnection:(Agent)TCP已建立串連數(個)。
    • PackagesNetOut:(Agent)內網網卡發包數(個/s)。
    • PackagesNetIn:(Agent)內網網卡收包數(個/s)。
    • PackagesNetOut:(Agent)外網網卡發包數(個/s)。
    • PackagesNetIn:(Agent)外網網卡收包數(個/s)。
    • EciPodCpuUtilization:CPU使用率(%)。
    • EciPodMemoryUtilization:記憶體(%)。
    • LoadBalancerRealServerAverageQps:(ALB)伺服器組單機QPS(次/s)。

更多資訊,請參見系統監控警示任務

MetricType String system

監控項類型。取值範圍:

  • system:使用CloudMonitor系統指標。
  • custom:使用上報到CloudMonitor的自訂指標。
Period Integer 300

統計監控項資料的周期,單位:秒。取值範圍:

  • 15。
  • 60。
  • 120。
  • 300。
  • 900。
說明 僅ECS類型的伸縮組支援設定15秒的統計周期。

預設值:300。

Statistics String Average

統計監控項資料的方法。取值範圍:

  • Average:平均值。
  • Minimum:最小值。
  • Maximum:最大值。

預設值:Average。

Threshold Float 80.0

監控指標的閾值,滿足閾值運算式達到指定次數即觸發執行伸縮規則。

ComparisonOperator String >=

監控項統計值與閾值的比較符,用於指定監控項統計值與閾值在什麼關係下滿足條件。取值範圍:

  • 監控項統計值大於等於閾值。取值:>=。
  • 監控項統計值小於等於閾值。取值:<=。
  • 監控項統計值大於閾值。取值:>。
  • 監控項統計值小於閾值。取值:<。

預設值:>=。

EvaluationCount Integer 3

觸發執行伸縮規則需要滿足閾值運算式的次數,例如,CPU使用率平均值3次的統計結果均大於等於80%。

預設值:3。

GroupId Integer 4055401

自訂監控項所屬CloudMonitor應用分組的ID,僅在監控項類型為custom時需要指定該參數。

Effective String TZ=+00 * * 1-2 * * ?

指定警示任務的生效時間段,預設所有時間都生效。

該參數遵循Cron運算式,預設格式為X X X X X ?,含義如下:

  • X:一個域的預留位置,依次表示秒、分鐘、小時、日期和月。X可以是確定的取值,也可以是具有邏輯意義的特殊字元。X的取值範圍,請參見Cron運算式
  • ?:表示不指定值。
說明 該參數指定值預設為UTC+8時區,支援在Cron運算式之前添加時區資訊TZ=+yy來指定時區,其中y表示時區的數值。例如,TZ=+00 * * 1-2 * * ?表示警示任務在UTC+0時區每天01:00~02:59之間生效。

取值樣本及含義如下:

  • * * * * * ? :所有時間都生效。
  • * * 17-18 * * ? :在UTC+8時區每天17:00~18:59之間生效。
  • TZ=+00 * * 1-2 * * ?:在UTC+0時區每天01:00~02:59之間生效。
AlarmAction.N String ari:acs:ess:cn-hangzhou:1406926****:scalingrule/asr-bp163l21e07uhn****

警示任務關聯伸縮規則的唯一識別碼。

Dimension.N.DimensionKey String device

監控項關聯的維度資訊鍵。取值範圍與警示任務的監控類型有關:

  • 當警示任務為自訂監控類型(即MetricType=custom)時,不限制取值範圍,由您自行指定。
  • 當警示任務為系統監控類型(即MetricType=system)時,取值範圍如下:
    • user_id:您的帳號ID。
    • scaling_group:被監控的伸縮組。
    • device:網卡裝置的類型。
    • state:TCP串連的狀態。
Dimension.N.DimensionValue String eth0

監控項關聯的維度資訊值,取值範圍由Dimension.N.DimensionKey決定:

  • 當Dimension.N.DimensionKey的取值是自訂的,即警示任務是自訂監控類型(即MetricType=custom)時,該參數不限制取值範圍,由您自行指定。
  • 當Dimension.N.DimensionKey的取值是系統指定的取值範圍中的,即警示任務為系統監控類型(即MetricType=system)時,該參數取值範圍如下:
    • user_id:由系統自動填滿。
    • scaling_group:由系統自動填滿。
    • device:
      • eth0:對於傳統網路執行個體,eth0表示內網網卡。對於VPC執行個體,只存在eth0一張網卡。
      • eth1:對於傳統網路執行個體,eth1代表外網網卡。
    • state:
      • TCP_TOTAL:表示總的TCP串連數。
      • ESTABLISHED:表示已建立的TCP串連數。
Expression.N.MetricName String CpuUtilization

多指標警示規則的監控指標名稱。取值範圍與警示任務的監控類型有關:

  • 當警示任務為自訂監控類型(即MetricType=custom)時,取值範圍是您自有的監控項範圍。
  • 當警示任務為系統監控類型(即MetricType=system)時,取值範圍如下所示:
    • CpuUtilization:(ECS)CPU使用率(%)。
    • ConcurrentConnections:(ECS)ECS同時串連數(個)。
    • IntranetTx:(ECS)內網出流量(Kb/min)。
    • IntranetRx:(ECS)內網入流量(Kb/min)。
    • VpcInternetTx:(ECS)外網出流量(Kb/min)。
    • VpcInternetRx:(ECS)外網入流量(Kb/min)。
    • SystemDiskReadBps:(ECS)系統硬碟讀BPS(Byte/s)。
    • SystemDiskWriteBps:(ECS)系統硬碟寫BPS(Byte/s)。
    • SystemDiskReadOps:(ECS)系統硬碟讀IOPS(次/s)。
    • SystemDiskWriteOps:(ECS)系統硬碟寫IOPS(次/s)。
    • CpuUtilizationAgent:(Agent)CPU使用率(%)。
    • GpuUtilizationAgent:(Agent)GPU使用率(%)。
    • GpuMemoryFreeUtilizationAgent:(Agent)GPU記憶體空閑率(%)。
    • GpuMemoryUtilizationAgent:(Agent)GPU記憶體使用量率(%)。
    • MemoryUtilization:(Agent)記憶體(%)。
    • LoadAverage:(Agent)系統平均負載。
    • TcpConnection:(Agent)TCP總串連數(個)。
    • TcpConnection:(Agent)TCP已建立串連數(個)。
    • PackagesNetOut:(Agent)內網網卡發包數(個/s)。
    • PackagesNetIn:(Agent)內網網卡收包數(個/s)。
    • PackagesNetOut:(Agent)外網網卡發包數(個/s)。
    • PackagesNetIn:(Agent)外網網卡收包數(個/s)。
    • EciPodCpuUtilization:CPU使用率(%)。
    • EciPodMemoryUtilization:記憶體(%)。
    • LoadBalancerRealServerAverageQps:(ALB)伺服器組單機QPS(次/s)。

更多資訊,請參見系統監控警示任務

Expression.N.ComparisonOperator String >=

多指標警示規則的監控項統計值與閾值的比較符,用於指定監控項統計值與閾值在什麼關係下滿足條件。取值範圍:

  • 監控項統計值大於等於閾值。取值:>=。
  • 監控項統計值小於等於閾值。取值:<=。
  • 監控項統計值大於閾值。取值:>。
  • 監控項統計值小於閾值。取值:<。

預設值:>=。

Expression.N.Period Integer 900

多指標警示規則中統計監控項資料的周期,單位:秒。取值範圍:

  • 15。
  • 60。
  • 120。
  • 300。
  • 900。
說明 僅ECS類型的伸縮組支援設定15秒的統計周期。

預設值:300。

Expression.N.Statistics String Average

多指標警示規則中統計監控項資料的方法。取值範圍:

  • Average:平均值。
  • Minimum:最小值。
  • Maximum:最大值。

預設值:Average。

Expression.N.Threshold Float 40.0

多指標警示規則中監控指標的閾值,滿足閾值運算式達到指定次數即觸發執行伸縮規則。

ExpressionsLogicOperator String &&

多指標警示條件之間的關係。取值範圍:

  • &&:當所有監控指標都符合警示條件時,才能觸發警示。即當多指標警示規則下的運算式均為true時,才能觸發警示。
  • ||:如果其中一個指標符合警示條件,即可觸發警示。

預設值: &&

返回資料

名稱

類型

樣本值

描述

AlarmTaskId String asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****

警示任務ID。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

請求ID。

樣本

請求樣本

http(s)://ess.aliyuncs.com/?Action=CreateAlarm
&RegionId=cn-hangzhou
&Name=TestAlarmTask
&Description=Test alarm task.
&ScalingGroupId=asg-bp18p2yfxow2dloq****
&MetricName=CpuUtilization
&MetricType=system
&Period=300
&Statistics=Average
&Threshold=80.0
&ComparisonOperator=>=
&EvaluationCount=3
&GroupId=4055401
&Effective=TZ=+00 * * 1-2 * * ?
&AlarmAction=["ari:acs:ess:cn-hangzhou:1406926****:scalingrule/asr-bp163l21e07uhn****"]
&Dimension=[{"DimensionKey":"device","DimensionValue":"eth0"}]
&Expression=[{"MetricName":"CpuUtilization","ComparisonOperator":">=","Period":900,"Statistics":"Average","Threshold":40.0}]
&ExpressionsLogicOperator=&&
&公用請求參數

正常返回樣本

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateAlarmResponse>
    <AlarmTaskId>asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****</AlarmTaskId>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
</CreateAlarmResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "AlarmTaskId" : "asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****",
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

HttpCode

錯誤碼

錯誤資訊

描述

404

InvalidParameter

The specified value of parameter "%s" is not valid.

指定參數“%s”不合法。