API概覽-CloudMonitor-阿里雲 - Cloud Monitor

API標準及多語言預置SDK

本產品（Cms/2019-01-01）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。

在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。

帳號與安全準備

阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。

應用程式分組

API	標題	API概述
管理應用程式分組	管理應用程式分組
CreateMonitorGroup	建立應用分組	調用CreateMonitorGroup介面建立應用分組。
ModifyMonitorGroup	修改應用分組	調用ModifyMonitorGroup介面修改應用分組。
DeleteMonitorGroup	刪除指定的應用分組	調用DeleteMonitorGroup介面刪除指定的應用分組。
DescribeMonitorGroups	查詢應用分組列表	調用DescribeMonitorGroups介面查詢應用分組列表。
CreateMonitorGroupInstances	添加指定資源到指定應用分組	調用CreateMonitorGroupInstances介面添加指定資源到指定應用分組。
ModifyMonitorGroupInstances	修改應用分組中的資源	調用ModifyMonitorGroupInstances介面修改應用分組中的資源。
DescribeMonitorGroupInstances	查詢指定應用分組內包含的資源清單	調用DescribeMonitorGroupInstances介面查詢指定應用分組內包含的資源清單。
DescribeMonitorGroupDynamicRules	查詢指定應用分組的動態規則列表	調用DescribeMonitorGroupDynamicRules介面查詢指定應用分組的動態規則列表。
DescribeMonitorGroupInstanceAttribute	查詢應用分組的資源詳情	調用DescribeMonitorGroupInstanceAttribute介面查詢應用分組的資源詳情。
DeleteMonitorGroupDynamicRule	刪除指定應用分組的動態規則	調用DeleteMonitorGroupDynamicRule介面刪除指定應用分組的動態規則。
DeleteMonitorGroupInstances	刪除應用分組內的資源執行個體	調用DeleteMonitorGroupInstances介面刪除應用分組內的資源執行個體。
DescribeMonitorGroupCategories	查詢指定應用分組的資源清單和每個雲端服務的資源數量	調用DescribeMonitorGroupCategories介面查詢指定應用分組的資源清單和每個雲端服務的資源數量。
PutMonitorGroupDynamicRule	建立或修改按照執行個體名稱動態匹配的應用分組	調用PutMonitorGroupDynamicRule介面建立或修改按照執行個體名稱動態匹配的應用分組，滿足匹配規則的所有執行個體自動添加到該應用分組中。
CreateGroupMonitoringAgentProcess	建立組進程監控	調用CreateGroupMonitoringAgentProcess介面建立組進程監控。
ModifyGroupMonitoringAgentProcess	修改應用程式分組內的處理程序監控。	修改應用程式分組內的處理程序監控。
DeleteGroupMonitoringAgentProcess	刪除組處理程序監控任務	呼叫 DeleteGroupMonitoringAgentProcess 介面刪除組處理程序監控任務。
DescribeGroupMonitoringAgentProcess	擷取組進程監控工作清單	調用DescribeGroupMonitoringAgentProcess介面擷取組進程監控工作清單。
CreateMonitorGroupNotifyPolicy	為應用分組建立暫停報警通知策略	呼叫 CreateMonitorGroupNotifyPolicy 介面為應用分組建立暫停報警通知策略。
DeleteMonitorGroupNotifyPolicy	刪除暫停指定應用分組警示通知策略	調用DeleteMonitorGroupNotifyPolicy介面刪除暫停指定應用分組警示通知策略。
DescribeMonitorGroupNotifyPolicyList	查詢應用程式分組的警報通知暫停策略清單。	查詢應用程式分組的警報通知暫停策略清單。
標籤	標籤
CreateDynamicTagGroup	通過標籤自動建立應用分組	調用CreateDynamicTagGroup介面通過標籤自動建立應用分組。
DeleteDynamicTagGroup	刪除智能標籤規則	調用DeleteDynamicTagGroup介面刪除智能標籤規則。
DescribeTagValueList	查詢指定標籤鍵對應的標籤值列表	調用DescribeTagValueList介面查詢指定標籤鍵對應的標籤值列表。
DescribeTagKeyList	查詢標籤鍵列表	呼叫 DescribeTagKeyList 介面查詢標籤鍵列表。
DescribeProductResourceTagKeyList	擷取對應地區下雲資源的所有標籤鍵列表	調用DescribeProductResourceTagKeyList介面擷取對應地區下雲資源的所有標籤鍵列表。
DescribeDynamicTagRuleList	查詢智能標籤的規則列表	調用DescribeDynamicTagRuleList介面查詢智能標籤的規則列表。
可用性監控	可用性監控
CreateHostAvailability	建立可用性監控任務。	建立可用性監控任務。
DeleteHostAvailability	刪除可用性監控任務	調用DeleteHostAvailability介面刪除可用性監控任務。
EnableHostAvailability	啟用指定可用性監控任務	呼叫 EnableHostAvailability 介面啟用指定可用性監控任務。
DisableHostAvailability	禁用指定可用性監控任務	調用DisableHostAvailability介面禁用指定可用性監控任務。
ModifyHostAvailability	修改可用性監控任務。	修改可用性監控任務。
DescribeUnhealthyHostAvailability	查詢探測結果異常的伺服器列表	調用DescribeUnhealthyHostAvailability介面查詢探測結果異常的伺服器列表。
DescribeHostAvailabilityList	查詢可用性監控任務清單。	查詢可用性監控任務清單。

主機監控

API	標題	API概述
InstallMonitoringAgent	為指定阿里雲主機安裝CloudMonitor外掛程式	調用InstallMonitoringAgent介面為指定阿里雲主機安裝CloudMonitor外掛程式。
DescribeMonitoringAgentHosts	查詢所有已安裝和未安裝CloudMonitor外掛程式的主機列表	調用DescribeMonitoringAgentHosts介面查詢所有已安裝和未安裝CloudMonitor外掛程式的主機列表。
DescribeMonitoringAgentAccessKey	查詢非阿里雲主機安裝CloudMonitor外掛程式時所需要的AccessKey和AccessSecret	調用DescribeMonitoringAgentAccessKey介面查詢非阿里雲主機安裝CloudMonitor外掛程式時所需要的AccessKey和AccessSecret。
DescribeMonitoringAgentConfig	查詢CloudMonitor外掛程式的配置資訊	調用DescribeMonitoringAgentConfig介面查詢CloudMonitor外掛程式的配置資訊。
DescribeMonitoringAgentStatuses	查詢雲端監控外掛程式執行狀態	呼叫 DescribeMonitoringAgentStatuses 介面查詢雲端監控外掛程式執行狀態。
ModifyHostInfo	修改非阿里雲的主機顯示資訊	呼叫ModifyHostInfo介面修改非阿里雲的主機顯示資訊。
DescribeMonitoringConfig	查詢CloudMonitor外掛程式的全域配置	調用DescribeMonitoringConfig介面查詢CloudMonitor外掛程式的全域配置。
PutMonitoringConfig	設定雲端監控外掛程式的全域組態。	呼叫 PutMonitoringConfig 介面設定雲端監控外掛程式的全域組態。
UninstallMonitoringAgent	卸載非阿里雲主機的CloudMonitor外掛程式	調用UninstallMonitoringAgent介面卸載非阿里雲主機的CloudMonitor外掛程式。
CreateMonitoringAgentProcess	建立進程監控	調用CreateMonitoringAgentProcess介面建立進程監控。
CreateMonitorAgentProcess	建立進程監控	調用CreateMonitorAgentProcess介面建立進程監控。
DescribeMonitoringAgentProcesses	查詢指定資源的進程數列表	調用DescribeMonitoringAgentProcesses介面查詢指定資源的進程數列表。
DeleteMonitoringAgentProcess	刪除指定主機中的指定處理程序監控	呼叫 DeleteMonitoringAgentProcess 介面刪除指定主機中的指定處理程序監控。

事件中心

API	標題	API概述
系統事件	系統事件
DescribeSystemEventHistogram	查詢系統事件的時段數量分布圖（柱狀圖）	調用DescribeSystemEventHistogram介面查詢系統事件的時段數量分布圖（柱狀圖）。
DescribeSystemEventMetaList	查詢系統事件的 Meta 資訊	呼叫 DescribeSystemEventMetaList 介面查詢系統事件的 Meta 資訊。
DescribeSystemEventAttribute	查詢系統事件詳情	調用DescribeSystemEventAttribute介面查詢系統事件詳情。
DescribeSystemEventCount	查詢當前帳號下各雲端服務發生事件的數量	呼叫 DescribeSystemEventCount 介面查詢當前帳號下各雲端服務發生事件的數量。
DescribeMonitorResourceQuotaAttribute	查詢雲端監控各個資源的配額。	查詢雲端監控各個資源的配額。
SendDryRunSystemEvent	調試雲資源的系統事件	調用SendDryRunSystemEvent介面調試雲資源的系統事件。
自訂事件	自訂事件
DescribeCustomEventCount	查詢自訂事件的統計結果	調用DescribeCustomEventCount介面查詢自訂事件的統計結果。
DescribeCustomEventHistogram	查詢自訂上報事件的分時段數量分布圖	調用DescribeCustomEventHistogram介面查詢自訂上報事件的分時段數量分布圖。
DescribeCustomEventAttribute	查詢自訂事件的詳情	調用DescribeCustomEventAttribute介面查詢自訂事件的詳情。
PutCustomEvent	上報自訂事件的監控資料	調用PutCustomEvent介面上報自訂事件的監控資料。

自訂監控

API	標題	API概述
PutCustomMetric	上報自訂監控資料	調用PutCustomMetric介面上報自訂監控資料。
PutCustomMetricRule	建立自訂監控報警規則	呼叫 PutCustomMetricRule 介面建立自訂監控報警規則。
DescribeCustomMetricList	查詢上報的自訂監控資料	調用DescribeCustomMetricList介面查詢上報的自訂監控資料。
DeleteCustomMetric	刪除自訂監控上報資料	調用DeleteCustomMetric介面刪除自訂監控上報資料。

日誌監控

API	標題	API概述
PutLogMonitor	建立或修改日誌監控	呼叫 PutLogMonitor 介面建立或修改日誌監控。
DeleteLogMonitor	刪除日誌監控	調用DeleteLogMonitor介面刪除日誌監控。
DescribeLogMonitorList	擷取日誌監控列表	調用DescribeLogMonitorList介面擷取日誌監控列表。
DescribeLogMonitorAttribute	擷取日誌監控詳情	調用DescribeLogMonitorAttribute介面擷取日誌監控詳情。

網站監控

API	標題	API概述
CreateMonitorGroupByResourceGroupId	通過資源群組建立應用分組	調用CreateMonitorGroupByResourceGroupId介面通過資源群組建立應用分組。
CreateInstantSiteMonitor	建立一次性探測任務。	建立一次性探測任務。
BatchCreateInstantSiteMonitor	大量建立網站監控任務	調用BatchCreateInstantSiteMonitor介面大量建立網站監控任務。
DeleteSiteMonitors	刪除站點監控的探測任務	呼叫 DeleteSiteMonitors 介面刪除站點監控的探測任務。
DisableSiteMonitors	停用一個或多個站點監控任務	呼叫 DisableSiteMonitors 介面停用一個或多個站點監控任務。
ModifySiteMonitor	修改站點監控任務	呼叫 ModifySiteMonitor 介面修改站點監控任務。
EnableSiteMonitors	啟用一個或多個網站監控任務	調用EnableSiteMonitors介面啟用一個或多個網站監控任務。
DescribeSiteMonitorQuota	查詢站點監控的配額以及版本	調用DescribeSiteMonitorQuota介面查詢站點監控的配額以及版本。
DescribeSiteMonitorAttribute	查詢站點監控任務的詳細資訊	呼叫 DescribeSiteMonitorAttribute 介面查詢站點監控任務的詳細資訊。
DescribeSiteMonitorISPCityList	查詢所有運營商探測點詳情	呼叫DescribeSiteMonitorISPCityList介面查詢所有運營商探測點詳情。
DescribeSiteMonitorData	查詢任務的細粒度監控資料	調用DescribeSiteMonitorData介面查詢任務的細粒度監控資料。
DescribeSiteMonitorStatistics	查詢指定站點監控任務中指定監控項的平均統計資料	呼叫 DescribeSiteMonitorStatistics 介面查詢指定站點監控任務中指定監控項的平均統計資料。
DescribeSiteMonitorList	查詢站點監控任務列表	呼叫 DescribeSiteMonitorList 介面查詢站點監控任務列表。
DescribeSiteMonitorLog	查詢一次性探測任務的探測日誌	調用DescribeSiteMonitorLog介面查詢一次性探測任務的探測日誌。

雲端產品監控

API	標題	API概述
DescribeMetricData	查詢指定雲產品的某個監控項的監控資料	調用DescribeMetricData介面查詢指定雲產品的某個監控項的監控資料。
DescribeProjectMeta	查詢雲監控支援的時序類監控項產品清單	呼叫DescribeProjectMeta介面查詢雲監控支援的時序類監控項產品清單。

警示服務

API	標題	API概述
警示歷史記錄	警示歷史記錄
DescribeAlertHistoryList	查詢警示歷史詳情	調用DescribeAlertHistoryList介面查詢警示歷史詳情。
DescribeAlertLogCount	統計警示歷史	調用DescribeAlertLogCount介面統計警示歷史。
DescribeAlertLogList	查詢報警歷史	呼叫DescribeAlertLogList介面查詢報警歷史。
DescribeAlertLogHistogram	查詢警示歷史的長條圖列表	調用DescribeAlertLogHistogram介面查詢警示歷史的長條圖列表。
一鍵警示	一鍵警示
DescribeProductsOfActiveMetricRule	查詢開通一鍵警示規則的雲端服務列表	調用DescribeProductsOfActiveMetricRule介面查詢開通一鍵警示規則的雲端服務列表。
DescribeActiveMetricRuleList	查詢一鍵警示規則的列表詳情	調用DescribeActiveMetricRuleList介面查詢一鍵警示規則的列表詳情。
EnableActiveMetricRule	啟用一鍵警示規則	調用EnableActiveMetricRule介面啟用一鍵警示規則。
DisableActiveMetricRule	禁用一鍵警示規則	調用DisableActiveMetricRule介面禁用一鍵警示規則。
警示範本	警示範本
CreateMetricRuleTemplate	建立警示模板	調用CreateMetricRuleTemplate介面建立警示模板。
DeleteMetricRuleTemplate	刪除報警規則範本	呼叫 DeleteMetricRuleTemplate 介面刪除報警規則範本。
ModifyMetricRuleTemplate	修改警示模板	調用ModifyMetricRuleTemplate介面修改警示模板。
DescribeMetricRuleTemplateAttribute	查詢報警範本詳情	呼叫DescribeMetricRuleTemplateAttribute介面查詢報警範本詳情。
DescribeMetricRuleTemplateList	查詢警示模板列表	調用DescribeMetricRuleTemplateList介面查詢警示模板列表。
ApplyMetricRuleTemplate	套用警示範本至應用程式分組。	將警示範本套用至應用程式分組，產生警示規則。
閾值警示規則	閾值警示規則
DescribeMetricRuleList	查詢報警規則列表中的所有規則	查詢報警規則列表中的所有規則。
CreateGroupMetricRules	批量為指定應用分組建立報警規則	呼叫 CreateGroupMetricRules 介面批量為指定應用分組建立報警規則。
CreateMetricRuleResources	建立一個警報規則關聯的資源	呼叫CreateMetricRuleResources介面建立一個警報規則關聯的資源。
DeleteMetricRuleTargets	刪除警示規則的推送渠道	調用DeleteMetricRuleTargets介面刪除一個警示規則的推送渠道。
DeleteMetricRules	刪除一個或多個警示規則	調用DeleteMetricRules介面刪除一個或多個警示規則。
DeleteMetricRuleResources	刪除警示規則關聯的資源	調用DeleteMetricRuleResources介面刪除警示規則關聯的資源。
EnableMetricRules	啟用一個或多個警示規則	調用EnableMetricRules介面啟用一個或多個警示規則。
DisableMetricRules	禁用警示規則	調用DisableMetricRules介面禁用警示規則。
DescribeMetricRuleTargets	查詢指定報警規則的推送渠道	呼叫 DescribeMetricRuleTargets 介面查詢指定報警規則的推送渠道。
DescribeMetricRuleCount	擷取各種狀態警示規則的數量	調用DescribeMetricRuleCount介面擷取各種狀態警示規則的數量。
DescribeAlertingMetricRuleResources	查詢指定警示規則中正在發生警示的資源清單。	查詢指定警示規則中正在發生警示的資源清單。
PutMetricRuleTargets	為指定報警規則新增或修改推送渠道	呼叫PutMetricRuleTargets介面為指定報警規則新增或修改推送渠道。
PutResourceMetricRule	為指定資源的指定監控項設定一條閾值報警規則	設定報警規則。
PutResourceMetricRules	為指定資源的指定監控項設置多條閾值報警規則。	呼叫 PutResourceMetricRules 介面為指定資源的指定監控項設置多條閾值報警規則。
PutGroupMetricRule	建立或修改指定應用分組中的報警規則	呼叫PutGroupMetricRule介面建立或修改指定應用分組中的報警規則。
事件警示規則	事件警示規則
DeleteEventRuleTargets	刪除事件警示的推送渠道	調用DeleteEventRuleTargets介面刪除事件警示的推送渠道。
DeleteEventRules	刪除事件警示規則	調用DeleteEventRules介面刪除事件警示規則。
EnableEventRules	啟用一個或者多個事件監控警示規則	調用EnableEventRules介面啟用一個或者多個事件監控警示規則。
DisableEventRules	調用DisableEventRule介面禁用一個或多個事件警示規則	調用DisableEventRule介面禁用一個或多個事件警示規則。
DescribeEventRuleAttribute	查詢指定事件報警規則的詳情	呼叫 DescribeEventRuleAttribute 介面查詢指定事件報警規則的詳情。
DescribeEventRuleList	查詢事件警示規則列表	調用DescribeEventRuleList介面查詢事件警示規則列表。
DescribeEventRuleTargetList	查詢指定事件報警規則的推送渠道	查詢事件規則列表。
PutEventRuleTargets	新增或修改規則的推送通道	呼叫 PutEventRuleTargets 介面新增或修改規則的推送通道。
PutEventRule	建立或修改事件的報警規則	呼叫 PutEventRule 介面建立或修改事件的報警規則。
PutCustomEventRule	建立自訂事件告警規則	呼叫PutCustomEventRule介面建立自訂事件告警規則。
警示黑名單	警示黑名單
CreateMetricRuleBlackList	建立警示黑名單策略	調用CreateMetricRuleBlackList介面建立警示黑名單策略。
ModifyMetricRuleBlackList	修改警示黑名單策略	調用ModifyMetricRuleBlackList介面修改警示黑名單策略。
DeleteMetricRuleBlackList	刪除告警黑名單策略	呼叫 DeleteMetricRuleBlackList 介面刪除告警黑名單策略。
DescribeMetricRuleBlackList	查詢警示黑名單策略清單。	查詢警示黑名單策略清單。
EnableMetricRuleBlackList	啟用或禁用警示黑名單策略	調用EnableMetricRuleBlackList介面啟用或禁用警示黑名單策略。
警示聯絡人	警示聯絡人
DescribeContactListByContactGroup	查詢警示聯絡組中的警示連絡人清單	調用DescribeContactListByContactGroup介面查詢警示聯絡組中的警示連絡人清單。
DescribeContactGroupList	查詢警示聯絡組列表	調用DescribeContactGroupList介面查詢警示聯絡組列表。
DescribeContactList	查詢告警聯絡人列表	呼叫 DescribeContactList 介面查詢告警聯絡人列表。
PutContact	建立或修改告警聯絡人資訊	呼叫PutContact介面建立或修改告警聯絡人資訊。
PutContactGroup	建立或修改報警聯絡群組	呼叫 PutContactGroup 介面建立或修改報警聯絡群組。

企業雲端監控

API	標題	API概述
CreateHybridMonitorNamespace	建立指標倉庫	呼叫 CreateHybridMonitorNamespace 介面建立指標倉庫。
ModifyHybridMonitorNamespace	修改指標倉庫	呼叫ModifyHybridMonitorNamespace介面修改指標倉庫。
DeleteHybridMonitorNamespace	刪除指標倉庫	調用DeleteHybridMonitorNamespace介面刪除指標倉庫。
DescribeHybridMonitorNamespaceList	查詢指標倉庫列表	調用DescribeHybridMonitorNamespaceList介面查詢指標倉庫列表，及其接入資料詳情。
CreateHybridMonitorTask	建立監控任務。	用於建立阿里雲產品或 SLS 日誌的監控項目接入任務。
ModifyHybridMonitorTask	修改監控任務	呼叫 ModifyHybridMonitorTask 介面修改 SLS 日誌的監控項。
DeleteHybridMonitorTask	刪除監控任務	調用DeleteHybridMonitorTask介面刪除阿里雲產品的資料接入任務或SLS日誌的監控項。
DescribeHybridMonitorTaskList	查詢資料接入工作清單	調用DescribeHybridMonitorTaskList介面查詢資料接入工作清單。
PutHybridMonitorMetricData	上報監控資料至指標倉庫	呼叫PutHybridMonitorMetricData介面將指定監控資料上報至企業雲監控的指定指標倉庫中。
DescribeHybridMonitorDataList	查詢指定指標倉庫中的監控資料	調用DescribeHybridMonitorDataList介面查詢指定指標倉庫中的監控資料。
CreateHybridMonitorSLSGroup	為 SLS 日誌的監控項建立 Logstore 組	建立企業雲端監控 SLS 分組。
ModifyHybridMonitorSLSGroup	修改 Logstore 組	呼叫 ModifyHybridMonitorSLSGroup 介面修改 Logstore 組。
DeleteHybridMonitorSLSGroup	刪除Logstore組	調用DeleteHybridMonitorSLSGroup介面刪除Logstore組。
DescribeHybridMonitorSLSGroup	查詢 Logstore 組列表	呼叫 DescribeHybridMonitorSLSGroup 介面查詢 Logstore 組列表。
Cursor	定義匯出監控數據的範圍	調用Cursor介面定義匯出監控數據的範圍，並返回用於初始調用BatchExport介面的Cursor值。
BatchExport	匯出在Cursor中定義的監控資料	調用BatchExport介面匯出在Cursor介面中定義的監控資料。

其他

API	標題	API概述
DescribeSyntheticProbeList	查詢撥測探測節點列表	調用DescribeSyntheticProbeList介面查詢撥測節點列表。

Others

API	標題	API概述
AddTags	為指定應用分組綁定標籤	調用AddTags介面為指定應用分組綁定標籤。
CreateSiteMonitor	建立網站監控任務	建立網站監控任務
DeleteContact	刪除報警聯絡人	呼叫 DeleteContact 介面刪除報警聯絡人。
DeleteContactGroup	刪除報警聯絡人群組	呼叫 DeleteContactGroup 介面刪除報警聯絡人群組。
DescribeMetricLast	查詢指定監控項目的最新監控資料。	查詢指定監控項目的最新監控資料。
DescribeMetricList	查詢指定雲產品的指定監控項的監控資料	調用 DescribeMetricList 介面查詢指定雲產品的指定監控項的監控資料。
DescribeMetricMetaList	查詢CloudMonitor開放的監控項詳情	調用DescribeMetricMetaList介面查詢CloudMonitor開放的監控項詳情。
DescribeMetricTop	查詢排序後的最新監控資料	調用DescribeMetricTop介面先查詢指定雲產品的指定監控項的最新監控資料，再查詢該監控項排序後的監控資料。
RemoveTags	刪除標籤	調用RemoveTags介面刪除標籤。