DescribeAlarms - 查詢警示任務的資訊 - Auto Scaling

調用API DescribeAlarms查詢警示任務資訊，及時瞭解已有警示任務的配置和監控項資料的變化趨勢，協助您即時發現系統資源異常，確保系統的穩定性和可靠性。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ess:DescribeAlarms

get

*ScalingGroup

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	警示任務所屬地區的 ID。	cn-qingdao
ScalingGroupId	string	否	警示任務關聯的伸縮組的 ID。	asg-bp18p2yfxow2dloq****
AlarmTaskId	string	否	警示任務 ID。	asg-bp1hvbnmkl10vll5**_f95ce797-dc2e-4bad-9618-14fee7d1**
State	string	否	警示任務的狀態。取值範圍： ALARM：警示，已滿足警示條件。 OK：正常，尚未滿足警示條件。 INSUFFICIENT_DATA：資料不足，不足以判斷是否滿足了警示條件。	OK
IsEnable	boolean	否	警示任務是否啟用。取值範圍： true：已啟用。 false：已停用。	true
MetricType	string	否	監控項類型。取值範圍： system：使用CloudMonitor系統指標。 custom：使用上報到CloudMonitor的自訂指標。 hybrid：使用企業CloudMonitor的指標。	system
MetricName	string	否	監控項名稱。	CpuUtilization
PageSize	integer	否	分頁查詢時設定的每頁行數。最大值：50。預設值：10。	10
PageNumber	integer	否	伸縮規則列表的頁碼，起始值：1。預設值：1。	1

返回參數

名稱	類型	描述	樣本值
	object	響應結構。
PageSize	integer	每頁行數。	10
RequestId	string	請求 ID。	871C7C53-34A4-45AA-8C14-4B72FA6A****
PageNumber	integer	當前頁碼。	1
TotalCount	integer	警示任務的總數。	2
AlarmList	array<object>	警示任務的列表。
	array<object>	警示任務的列表。
AlarmTaskId	string	警示任務 ID。	asg-bp1hvbnmkl10vll5**_f95ce797-dc2e-4bad-9618-14fee7d1**
MetricName	string	監控項名稱。可能值： 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
EvaluationCount	integer	觸發執行伸縮規則需要滿足閾值運算式的次數，例如，CPU 使用率平均值 3 次的統計結果均大於等於 80%。	3
State	string	警示任務的狀態。可能值： ALARM：警示，已滿足警示條件。 OK：正常，尚未滿足警示條件。 INSUFFICIENT_DATA：資料不足，不足以判斷是否滿足了警示條件。	ALARM
Period	integer	統計監控項資料的周期，單位為秒。可能值： 15。 60。 120。 300。 900。說明僅 ECS 類型的伸縮組支援設定 15 秒的統計周期。	300
ScalingGroupId	string	警示任務關聯的伸縮組的 ID。	asg-bp18p2yfxow2dloq****
ComparisonOperator	string	監控項統計值與閾值的比較符，用於指定監控項統計值與閾值在什麼關係下滿足條件。可能值：監控項統計值大於等於閾值。取值：>=。監控項統計值小於等於閾值。取值：<=。監控項統計值大於閾值。取值：>。監控項統計值小於閾值。取值：<。	>=
Effective	string	指定警示任務的生效時間段。	* * * * * ?
Description	string	警示任務的描述。	Test alarm task.
MetricType	string	監控項類型。可能值： system：使用CloudMonitor系統指標。 custom：使用上報到CloudMonitor的自訂指標。 hybrid：使用企業CloudMonitor的指標。	system
Name	string	警示任務的名稱。	TestAlarmTask
Threshold	number	監控指標的閾值，滿足閾值運算式達到指定次數即觸發執行伸縮規則。	80.0
Enable	boolean	警示任務是否啟用。可能值： true：已啟用。 false：已停用。	true
Statistics	string	統計監控項資料的方法。可能值： Average：平均值。 Minimum：最小值。 Maximum：最大值。	Average
Dimensions	array<object>	監控項關聯的維度資訊。
	object	監控項關聯的維度資訊。
DimensionKey	string	監控項關聯的維度資訊鍵，可能值： user_id：您的帳號 ID。 scaling_group：被監控的伸縮組。 device：網卡裝置的類型。 state：TCP 串連的狀態。	device
DimensionValue	string	監控項關聯的維度資訊值，取值範圍由維度資訊鍵決定。 `user_id`：由系統自動填滿。 `scaling_group`：由系統自動填滿。 `device`取值範圍： eth0：對於傳統網路執行個體，eth0 表示內網網卡。對於 VPC 執行個體，只存在 eth0 一張網卡。 eth1：對於傳統網路執行個體，eth1 代表外網網卡。 `state`取值範圍： TCP_TOTAL：表示總的 TCP 串連數。 ESTABLISHED：表示已建立的 TCP 串連數。	eth0
AlarmActions	array	警示任務關聯伸縮規則的唯一識別碼的列表。
	string	警示任務關聯伸縮規則的唯一識別碼的列表。	ari:acs:ess:cn-hangzhou:1406926474**:scalingrule/asr-bp163l21e07uh**
Expressions	array<object>	多指標警示規則的相關資訊。
	object	多指標警示規則的相關資訊。
MetricName	string	多指標警示規則的監控指標名稱。可能值： 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 類型伸縮組時，使用CloudMonitor（Agent 開頭的監控項）用戶端採集的監控項指標，才可以選擇 15 秒的統計周期。	900
Statistics	string	多指標警示規則中統計監控項資料的方法。可能值： Average：平均值。 Minimum：最小值。 Maximum：最大值。	Average
Threshold	number	多指標警示規則中監控指標的閾值，滿足閾值運算式達到指定次數即觸發執行伸縮規則。	40.0
ExpressionsLogicOperator	string	多指標警示條件之間的關係。可能值： `&&`：當所有監控指標都符合警示條件時，才能觸發警示。即當多指標警示規則下的運算式均為`true`時，才能觸發警示。 `\|\|`：如果其中一個指標符合警示條件，即可觸發警示。	&&
HybridMonitorNamespace	string	企業CloudMonitor指標倉庫 id。管理指標倉庫，請參見管理指標倉庫。	aliyun-test
HybridMetrics	array<object>	企業CloudMonitor指標設定。如何設定，請參見使用公式運算自訂目標追蹤規則。
	array<object>
Id	string	公制運算運算式中指標的引用 id。	a
Expression	string	多個企業CloudMonitor指標的公制運算運算式，運算式的計算結果將用於觸發擴縮容。運算運算式需滿足逆波蘭運算式（RPN）規範，並且操作符只支援`+ - * /`。	(a+b)/2
MetricName	string	企業CloudMonitor指標倉庫中的指標名稱。	AliyunSmq_NumberOfMessagesVisible
Statistic	string	指標的統計方式。可能值： Average：指定區間內所有點的平均值。 Minimum：指定區間內所有點的最小值。 Maximum：指定區間內所有點的最大值。	Average
Dimensions	array<object>	指標緯度。用於指定指標監控的資源。
	object
DimensionKey	string	指標維度 key。	queue
DimensionValue	string	指標維度 value。	testQueue
PromQL	string	企業CloudMonitor promql 查詢語句。	(avg(last_over_time(AliyunMnsnew_ActiveMessages{region='cn-hangzhou',userId='123456**',queue='testQueue'}[900s])) by (userId))/(avg(last_over_time(AliyunEss_RunningInstanceCount{instanceId='asg-bp1**'}[900s])) by (userId) != 0)

樣本

正常返回樣本

JSON格式

{
  "PageSize": 10,
  "RequestId": "871C7C53-34A4-45AA-8C14-4B72FA6A****",
  "PageNumber": 1,
  "TotalCount": 2,
  "AlarmList": [
    {
      "AlarmTaskId": "asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****",
      "MetricName": "CpuUtilization",
      "EvaluationCount": 3,
      "State": "ALARM",
      "Period": 300,
      "ScalingGroupId": "asg-bp18p2yfxow2dloq****",
      "ComparisonOperator": ">=",
      "Effective": "* * * * * ?",
      "Description": "Test alarm task.",
      "MetricType": "system",
      "Name": "TestAlarmTask",
      "Threshold": 80,
      "Enable": true,
      "Statistics": "Average",
      "Dimensions": [
        {
          "DimensionKey": "device",
          "DimensionValue": "eth0"
        }
      ],
      "AlarmActions": [
        "ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp163l21e07uh****"
      ],
      "Expressions": [
        {
          "MetricName": "CpuUtilization",
          "ComparisonOperator": ">=",
          "Period": 900,
          "Statistics": "Average",
          "Threshold": 40
        }
      ],
      "ExpressionsLogicOperator": "&&",
      "HybridMonitorNamespace": "aliyun-test",
      "HybridMetrics": [
        {
          "Id": "a",
          "Expression": "(a+b)/2",
          "MetricName": "AliyunSmq_NumberOfMessagesVisible",
          "Statistic": "Average",
          "Dimensions": [
            {
              "DimensionKey": "queue",
              "DimensionValue": "testQueue"
            }
          ]
        }
      ],
      "PromQL": "(avg(last_over_time(AliyunMnsnew_ActiveMessages{region='cn-hangzhou',userId='123456****',queue='testQueue'}[900s])) by (userId))/(avg(last_over_time(AliyunEss_RunningInstanceCount{instanceId='asg-bp1****'}[900s])) by (userId) != 0)"
    }
  ]
}

錯誤碼

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

變更歷史

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