CreateAlarm - 建立一個警示任務 - Auto Scaling

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

介面說明

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

說明

維度資訊中，user_id 和 scaling_group 由系統自動填滿，device、state 需要您手動指定。更多資訊，請參見參數Dimensions.DimensionKey和Dimensions.DimensionValue。

調試

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

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ess:CreateAlarm

create

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	伸縮組所屬的地區 ID。	cn-hangzhou
Name	string	否	警示任務的名稱。	TestAlarmTask
Description	string	否	警示任務的描述。	Test alarm task.
ScalingGroupId	string	是	警示任務關聯的伸縮組的 ID。	asg-bp18p2yfxow2dloq****
MetricName	string	否	監控項名稱。取值範圍與警示任務的監控類型有關：當警示任務為自訂監控類型（即 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）。更多資訊，請參見系統監控警示任務。	CpuUtilization
MetricType	string	否	監控項類型。取值範圍： system：使用CloudMonitor系統指標。 custom：使用上報到CloudMonitor的自訂指標。	system
Period	integer	否	統計監控項資料的周期，單位：秒。取值範圍： 15。 60。 120。 300。 900。說明僅 ECS 類型的伸縮組支援設定 15 秒的統計周期。預設值：300。	300
Statistics	string	否	統計監控項資料的方法。取值範圍： Average：平均值。 Minimum：最小值。 Maximum：最大值。預設值：Average。	Average
Threshold	number	否	監控指標的閾值，滿足閾值運算式達到指定次數即觸發執行伸縮規則。	80.0
ComparisonOperator	string	否	監控項統計值與閾值的比較符，用於指定監控項統計值與閾值在什麼關係下滿足條件。取值範圍：監控項統計值大於等於閾值。取值：>=。監控項統計值小於等於閾值。取值：<=。監控項統計值大於閾值。取值：>。監控項統計值小於閾值。取值：<。預設值：>=。	>=
EvaluationCount	integer	否	觸發執行伸縮規則需要滿足閾值運算式的次數，例如，CPU 使用率平均值 3 次的統計結果均大於等於 80%。預設值：3。	3
GroupId	integer	否	自訂監控項所屬CloudMonitor應用分組的 ID，僅在監控項類型為 custom 時需要指定該參數。	4055401
Effective	string	否	指定警示任務的生效時間段，預設所有時間都生效。該參數遵循 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 之間生效。	TZ=+00 * * 1-2 * * ?
AlarmActions	array	否	警示任務關聯伸縮規則的唯一識別碼的列表。
	string	否	警示任務關聯伸縮規則的唯一識別碼的列表。	ari:acs:ess:cn-hangzhou:1406926**:scalingrule/asr-bp163l21e07uhn**
Dimensions	array<object>	否	監控項關聯的維度資訊。
	object	否	監控項關聯的維度資訊。
DimensionKey	string	否	監控項關聯的維度資訊鍵，取值範圍與警示任務的監控類型有關：當警示任務為自訂監控類型（即 MetricType=custom）時，不限制取值範圍，由您自行指定。當警示任務為系統監控類型（即 MetricType=system）時，取值範圍如下： user_id：您的帳號 ID。 scaling_group：被監控的伸縮組。 device：網卡裝置的類型。 state：TCP 串連的狀態。 rulePool: ALB qps 監控指標指定伺服器組。	device
DimensionValue	string	否	監控項關聯的維度資訊值，取值範圍由 Dimensions.DimensionKey 決定：當 Dimensions.DimensionKey 的取值是自訂的，即警示任務是自訂監控類型（即 MetricType=custom）時，該參數不限制取值範圍，由您自行指定。當 Dimensions.DimensionKey 的取值是系統指定的取值範圍中的，即警示任務為系統監控類型（即 MetricType=system）時，該參數取值範圍如下： user_id：由系統自動填滿。 scaling_group：由系統自動填滿。 device： eth0：對於傳統網路執行個體，eth0 表示內網網卡。對於 VPC 執行個體，只存在 eth0 一張網卡。 eth1：對於傳統網路執行個體，eth1 代表外網網卡。 state： TCP_TOTAL：表示總的 TCP 串連數。 ESTABLISHED：表示已建立的 TCP 串連數。 rulePool：ALB 伺服器組 id，樣本：sgp-xxxxx。	eth0
Expressions	array<object>	否	多指標警示規則相關資訊。
	object	否	多指標警示規則相關資訊。
MetricName	string	否	多指標警示規則的監控指標名稱。取值範圍與警示任務的監控類型有關：當警示任務為自訂監控類型（即 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）。更多資訊，請參見系統監控警示任務。	CpuUtilization
ComparisonOperator	string	否	多指標警示規則的監控項統計值與閾值的比較符，用於指定監控項統計值與閾值在什麼關係下滿足條件。取值範圍：監控項統計值大於等於閾值。取值：>=。監控項統計值小於等於閾值。取值：<=。監控項統計值大於閾值。取值：>。監控項統計值小於閾值。取值：<。預設值：>=。	>=
Period	integer	否	多指標警示規則中統計監控項資料的周期，單位：秒。取值範圍： 15。 60。 120。 300。 900。說明僅 ECS 類型的伸縮組支援設定 15 秒的統計周期。預設值：300。	900
Statistics	string	否	多指標警示規則中統計監控項資料的方法。取值範圍： Average：平均值。 Minimum：最小值。 Maximum：最大值。預設值：Average。	Average
Threshold	number	否	多指標警示規則中監控指標的閾值，滿足閾值運算式達到指定次數即觸發執行伸縮規則。	40.0
ExpressionsLogicOperator	string	否	多指標警示條件之間的關係。取值範圍： `&&`：當所有監控指標都符合警示條件時，才能觸發警示。即當多指標警示規則下的運算式均為`true`時，才能觸發警示。 `\|\|`：如果其中一個指標符合警示條件，即可觸發警示。預設值： `&&`。	&&

返回參數

名稱	類型	描述	樣本值
	object	建立警示任務的返回資訊集合。
AlarmTaskId	string	警示任務 ID。	asg-bp1hvbnmkl10vll5**_f95ce797-dc2e-4bad-9618-14fee7d1**
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

樣本

正常返回樣本

JSON格式

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

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。