全部產品
Search
文件中心

:API概覽

更新時間:Jun 19, 2024

本文列出了CloudMonitor所有可調用的API及相關描述。

說明
  • 單個API的調用次數限制:20次/秒。一個阿里雲帳號及該帳號下的RAM使用者共用20次/秒。

  • API請求資料大小限制如下:

    • Http Request Header+Query≤128KB

    • HttpRequestBody≤512KB

    • HttpResponse≤2048KB

應用分組

API

描述

CreateMonitorGroup

調用CreateMonitorGroup介面建立應用分組。

CreateMonitorGroupInstances

調用CreateMonitorGroupInstances介面添加指定資源到指定應用分組。

CreateMonitorGroupByResourceGroupId

調用CreateMonitorGroupByResourceGroupId介面通過資源群組建立應用分組。

CreateMonitorGroupNotifyPolicy

調用CreateMonitorGroupNotifyPolicy介面建立暫停應用分組警示通知的策略。

CreateGroupMonitoringAgentProcess

調用CreateGroupMonitoringAgentProcess介面建立組進程監控。

PutMonitorGroupDynamicRule

調用PutMonitorGroupDynamicRule介面為應用分組建立或修改動態警示規則。

ModifyMonitorGroupInstances

調用ModifyMonitorGroupInstances介面修改應用分組中的資源。

ModifyMonitorGroup

調用ModifyMonitorGroup介面修改應用分組。

ModifyGroupMonitoringAgentProcess

調用ModifyGroupMonitoringAgentProcess介面修改應用分組內的進程監控。

DescribeMonitorGroupDynamicRules

調用DescribeMonitorGroupDynamicRules介面查詢指定應用分組的動態規則列表。

DescribeMonitorGroupInstanceAttribute

調用DescribeMonitorGroupInstanceAttribute介面查詢應用分組的資源詳情。

DescribeMonitorGroupCategories

調用DescribeMonitorGroupCategories介面查詢指定應用分組的資源清單和每個雲端服務的資源數量。

DescribeMonitorGroups

調用DescribeMonitorGroups介面查詢應用分組列表。

DescribeMonitorGroupInstances

調用DescribeMonitorGroupInstances介面查詢指定應用分組內包含的資源清單。

DescribeGroupMonitoringAgentProcess

調用DescribeGroupMonitoringAgentProcess介面擷取組進程監控工作清單。

DescribeMonitorGroupNotifyPolicyList

調用DescribeMonitorGroupNotifyPolicyList介面查詢應用分組的警示通知暫停策略列表。

DeleteMonitorGroupNotifyPolicy

調用DeleteMonitorGroupNotifyPolicy介面刪除暫停指定應用分組警示通知策略。

DeleteMonitorGroupInstances

調用DeleteMonitorGroupInstances介面刪除應用分組內的資源執行個體。

DeleteMonitorGroupDynamicRule

調用DeleteMonitorGroupDynamicRule介面刪除指定應用分組的動態規則。

DeleteMonitorGroup

調用DeleteMonitorGroup介面刪除指定的應用分組。

DeleteGroupMonitoringAgentProcess

調用DeleteGroupMonitoringAgentProcess介面刪除群組進程監控任務。

CreateGroupMetricRules

調用CreateGroupMetricRules介面批量為應用分組建立警示規則。

PutGroupMetricRule

調用PutGroupMetricRule介面建立或修改應用分組的警示規則。

CreateHostAvailability

調用CreateHostAvailability介面建立可用性監控任務。

ModifyHostAvailability

調用ModifyHostAvailability介面修改可用性監控任務。

DeleteHostAvailability

調用DeleteHostAvailability介面刪除可用性監控任務。

EnableHostAvailability

調用EnableHostAvailability介面啟用指定可用性監控任務。

DescribeHostAvailabilityList

調用DescribeHostAvailabilityList介面查詢可用性監控工作清單。

DescribeUnhealthyHostAvailability

調用DescribeUnhealthyHostAvailability介面查詢探測結果異常的伺服器列表。

DisableHostAvailability

調用DisableHostAvailability介面禁用指定可用性監控任務。

AddTags

調用AddTags介面為資源建立標籤。

DescribeTagValueList

調用DescribeTagValueList介面查詢標籤值列表。

DescribeTagKeyList

調用DescribeTagKeyList介面查詢標籤鍵列表。

RemoveTags

調用RemoveTags介面刪除標籤。

CreateDynamicTagGroup

調用CreateDynamicTagGroup介面使用雲端服務的標籤自動同步建立應用分組。

DescribeProductResourceTagKeyList

調用DescribeProductResourceTagKeyList介面擷取對應地區下雲資源的所有標籤鍵列表。

DescribeDynamicTagRuleList

調用DescribeDynamicTagRuleList介面查詢智能標籤的規則列表。

DeleteDynamicTagGroup

調用DeleteDynamicTagGroup介面刪除智能標籤規則。

主機監控

API

描述

DeleteMonitoringAgentProcess

調用DeleteMonitoringAgentProcess介面刪除進程監控。

DescribeMonitoringAgentStatuses

調用DescribeMonitoringAgentStatuses介面查詢CloudMonitor外掛程式運行狀態。

DescribeMonitoringAgentProcesses

調用DescribeMonitoringAgentProcesses介面查詢進程監控列表。

DescribeMonitoringAgentAccessKey

調用DescribeMonitoringAgentAccessKey介面查詢非阿里雲主機安裝CloudMonitor外掛程式時所需要的AccessKey ID和AccessKey Secret。

UninstallMonitoringAgent

調用UninstallMonitoringAgent介面卸載非阿里雲主機的CloudMonitor外掛程式。

InstallMonitoringAgent

調用InstallMonitoringAgent介面對指定ECS執行個體安裝CloudMonitor外掛程式。

CreateMonitoringAgentProcess

調用CreateMonitoringAgentProcess介面建立進程監控。

DescribeMonitoringAgentHosts

調用DescribeMonitoringAgentHosts介面查詢所有已安裝和未安裝CloudMonitor外掛程式的主機列表。

DescribeMonitoringAgentConfig

調用DescribeMonitoringAgentConfig介面查詢CloudMonitor外掛程式的配置資訊。

CreateMonitorAgentProcess

調用CreateMonitorAgentProcess介面建立進程監控。

ModifyHostInfo

調用ModifyHostInfo介面修改非阿里雲的主機顯示資訊。

DescribeMonitoringConfig

調用DescribeMonitoringConfig介面查詢CloudMonitor外掛程式的全域配置。

PutMonitoringConfig

調用PutMonitoringConfig介面設定CloudMonitor外掛程式的全域配置。

事件監控

API

描述

SendDryRunSystemEvent

調用SendDryRunSystemEvent介面調試資源的系統事件。

DescribeSystemEventMetaList

調用DescribeSystemEventMetaList介面查詢系統事件的Meta資訊。

DescribeSystemEventCount

調用DescribeSystemEventCount介面查詢各個雲端服務指定時間段內事件的數量。

DescribeSystemEventAttribute

調用DescribeSystemEventAttribute介面查詢系統事件詳情。

DescribeSystemEventHistogram

調用DescribeSystemEventHistogram介面查詢系統事件的時段數量分布圖(柱狀圖)。

DescribeCustomEventCount

調用DescribeCustomEventCount介面查詢自訂事件的統計結果。

DescribeCustomEventAttribute

調用DescribeCustomEventAttribute介面查詢自訂事件的詳情。

PutCustomEvent

調用PutCustomEvent介面上報自訂事件的監控資料。

DescribeCustomEventHistogram

調用DescribeCustomEventHistogram介面查詢自訂上報事件的分時段數量分布圖。

自訂監控

API

描述

PutCustomMetric

調用PutCustomMetric介面上報自訂監控資料。

PutCustomMetricRule

調用PutCustomMetricRule介面建立自訂監控警示規則。

DescribeCustomMetricList

調用DescribeCustomMetricList介面查詢上報的自訂監控資料。

DeleteCustomMetric

調用DeleteCustomMetric介面刪除上報的自訂監控資料。

日誌監控

API

描述

DescribeLogMonitorList

調用DescribeLogMonitorList介面擷取日誌監控列表。

DescribeLogMonitorAttribute

調用DescribeLogMonitorAttribute介面擷取日誌監控詳情。

DeleteLogMonitor

調用DeleteLogMonitor介面刪除日誌監控。

PutLogMonitor

調用PutLogMonitor介面建立或修改日誌監控。

網路分析與監控

API

描述

DisableSiteMonitors

調用DisableSiteMonitors介面禁用一個或多個網站監控任務。

DescribeSiteMonitorQuota

調用DescribeSiteMonitorQuota介面查詢網站監控的配額以及版本。

DescribeSiteMonitorAttribute

調用DescribeSiteMonitorAttribute介面查詢網站監控詳細資料。

DeleteSiteMonitors

調用DeleteSiteMonitors介面刪除網站監控的探測任務。

DescribeSiteMonitorISPCityList

調用DescribeSiteMonitorISPCityList介面查詢建立任務的探測點列表。

DescribeSiteMonitorData

調用DescribeSiteMonitorData介面查詢任務的細粒度監控資料。

DescribeSiteMonitorStatistics

調用DescribeSiteMonitorStatistics介面查詢指定網站監控任務的平均統計資料。

CreateSiteMonitor

調用CreateSiteMonitor介面建立網站監控的監控任務。

BatchCreateInstantSiteMonitor

調用BatchCreateInstantSiteMonitor介面大量建立網站監控任務。

ModifySiteMonitor

調用ModifySiteMonitor介面修改網站監控任務。

EnableSiteMonitors

調用EnableSiteMonitors介面啟用一個或多個網站監控任務。

DescribeSiteMonitorList

調用DescribeSiteMonitorList介面查詢網站監控工作清單。

雲產品監控

API

描述

DescribeProjectMeta

調用DescribeProjectMeta介面查詢CloudMonitor支援雲端服務的監控項列表。

DescribeMetricLast

調用DescribeMetricLast介面查詢指定監控項的最新監控資料。

DescribeMetricMetaList

調用DescribeMetricMetaList介面查詢CloudMonitor開放的監控項描述。

DescribeMetricList

調用DescribeMetricList介面查詢指定雲端服務的監控資料。

DescribeMetricData

調用DescribeMetricData介面查詢指定時間段內雲端服務的監控資料。

DescribeMetricTop

調用DescribeMetricTop介面查詢排序後的指定雲端服務的監控資料。

DescribeMonitorResourceQuotaAttribute

調用DescribeMonitorResourceQuotaAttribute介面查詢CloudMonitor各個資源的配額。

警示服務

API

描述

DescribeAlertHistoryList

調用DescribeAlertHistoryList介面查詢警示歷史詳情。

DescribeAlertLogCount

調用DescribeAlertLogCount介面統計警示歷史。

DescribeAlertLogHistogram

調用DescribeAlertLogHistogram介面查詢警示歷史的長條圖列表。

DescribeAlertLogList

調用DescribeAlertLogList介面查詢警示歷史。

ApplyMetricRuleTemplate

調用ApplyMetricRuleTemplate介面將警示模板應用到應用分組並產生警示規則。

DescribeMetricRuleTemplateAttribute

調用DescribeMetricRuleTemplateAttribute介面查詢警示模板詳情。

DeleteMetricRuleTemplate

調用DeleteMetricRuleTemplate介面刪除警示規則模板。

ModifyMetricRuleTemplate

調用ModifyMetricRuleTemplate介面修改警示模板。

CreateMetricRuleTemplate

調用CreateMetricRuleTemplate介面建立警示模板。

DescribeMetricRuleTemplateList

調用DescribeMetricRuleTemplateList介面查詢警示模板列表。

PutResourceMetricRule

調用PutResourceMetricRule介面對單個資源的效能指標設定閾值警示規則。

PutResourceMetricRules

調用PutResourceMetricRules介面為多個資源的監控項設定多個閾值警示規則。

DeleteMetricRules

調用DeleteMetricRules介面刪除一個或多個警示規則。

DescribeMetricRuleCount

調用DescribeMetricRuleCount介面擷取各種狀態警示規則的數量。

EnableMetricRules

調用EnableMetricRules介面啟用一個或多個警示規則。

DescribeMetricRuleList

調用DescribeMetricRuleList介面查詢警示規則列表。

DisableMetricRules

調用DisableMetricRules介面禁用警示規則。

DescribeAlertingMetricRuleResources

調用DescribeAlertingMetricRuleResources介面查詢指定警示規則下警示的資源。

PutMetricRuleTargets

調用PutMetricRuleTargets介面添加或者修改警示規則的目標。

DescribeMetricRuleTargets

調用DescribeMetricRuleTargets介面查詢警示規則關聯目標。

DeleteMetricRuleTargets

調用DeleteMetricRuleTargets介面刪除一個警示規則的目標。

CreateMetricRuleResources

調用CreateMetricRuleResources介面建立一個警示規則關聯的資源。

DeleteMetricRuleResources

調用DeleteMetricRuleResources介面刪除警示規則關聯的資源。

DescribeEventRuleAttribute

調用DescribeEventRuleAttribute介面查詢指定警示規則的詳情。

PutEventRuleTargets

調用PutEventRuleTargets介面添加或修改規則的發送目標。

DeleteEventRuleTargets

調用DeleteEventRuleTargets介面刪除事件警示通知目標。

EnableEventRules

調用EnableEventRules介面啟用一個或者多個事件監控警示規則。

DescribeEventRuleList

調用DescribeEventRuleList介面查詢事件警示規則列表。

DeleteEventRules

調用DeleteEventRules介面刪除事件警示規則。

DisableEventRules

調用DisableEventRule介面禁用一個或多個事件警示規則。

PutEventRule

調用PutEventRule介面建立或修改事件的警示規則。

DescribeEventRuleTargetList

調用DescribeEventRuleTargetList介面查詢指定事件警示規則的警示目標。

PutCustomEventRule

調用PutCustomEventRule介面建立自訂事件警示規則。

PutContactGroup

調用PutContactGroup介面建立或修改警示聯絡組。

DescribeContactList

調用DescribeContactList介面查詢警示連絡人清單。

DeleteContact

調用DeleteContact介面刪除警示連絡人。

PutContact

調用PutContact介面建立或修改警示連絡人資訊。

DescribeContactGroupList

調用DescribeContactGroupList介面查詢警示聯絡組列表。

DeleteContactGroup

調用DeleteContactGroup介面刪除警示連絡人群組。

DescribeContactListByContactGroup

調用DescribeContactListByContactGroup介面查詢警示聯絡組中的警示連絡人清單。

DescribeProductsOfActiveMetricRule

調用DescribeProductsOfActiveMetricRule介面查詢開通一鍵警示規則的雲端服務列表。

EnableActiveMetricRule

調用EnableActiveMetricRule介面啟用一鍵警示規則。

DescribeActiveMetricRuleList

調用DescribeActiveMetricRuleList介面查詢一鍵警示規則的列表詳情。

DisableActiveMetricRule

調用DisableActiveMetricRule介面禁用一鍵警示規則。

企業CloudMonitor

API

描述

PutHybridMonitorMetricData

調用PutHybridMonitorMetricData介面將指定監控資料上報至企業CloudMonitor的指定指標倉庫中。

CreateHybridMonitorTask

調用CreateHybridMonitorTask介面建立阿里雲產品的資料接入任務或SLS日誌的監控項。

ModifyHybridMonitorTask

調用ModifyHybridMonitorTask介面修改SLS日誌的監控項。

DeleteHybridMonitorTask

調用DeleteHybridMonitorTask介面刪除資料接入任務。

DescribeHybridMonitorTaskList

調用DescribeHybridMonitorTaskList介面查詢資料接入工作清單。

CreateHybridMonitorNamespace

調用CreateHybridMonitorNamespace介面建立指標倉庫。

ModifyHybridMonitorNamespace

調用ModifyHybridMonitorNamespace介面修改指標倉庫。

DeleteHybridMonitorNamespace

調用DeleteHybridMonitorNamespace介面刪除指標倉庫。

DescribeHybridMonitorNamespaceList

調用DescribeHybridMonitorNamespaceList介面查詢指標倉庫列表。

CreateHybridMonitorSLSGroup

調用CreateHybridMonitorSLSGroup介面為SLS日誌的監控項建立Logstore組。

ModifyHybridMonitorSLSGroup

調用ModifyHybridMonitorSLSGroup介面修改Logstore組。

DeleteHybridMonitorSLSGroup

調用DeleteHybridMonitorSLSGroup介面刪除Logstore組。

DescribeHybridMonitorSLSGroup

調用DescribeHybridMonitorSLSGroup介面查詢Logstore組列表。

DescribeHybridMonitorDataList

調用DescribeHybridMonitorDataList介面查詢指定指標倉庫中的監控資料。

Cursor

調用Cursor介面定義匯出監控資料的範圍,並返回用於初始調用BatchExport介面的Cursor值。

BatchExport

調用BatchExport介面匯出在Cursor介面中定義的監控資料。