通過CreateMetricRuleBlackList建立警示黑名單策略-CloudMonitor-阿里雲

調用CreateMetricRuleBlackList介面建立警示黑名單策略。

介面說明

背景資訊

警示黑名單是指CloudMonitor根據警示黑名單策略對警示通知進行屏蔽。當閾值警示規則中某個雲端服務的某個執行個體中的某個指標無需發送警示通知時，您可以為其設定警示黑名單策略，對警示通知進行屏蔽。
目前CloudMonitor僅支援為閾值指標設定警示黑名單策略，不支援系統事件。關於CloudMonitor支援的雲端服務和閾值指標，請參見雲端服務監控項。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

cms:CreateMetricRuleBlackList

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Name	string	是	警示黑名單策略的名稱。	Blacklist-01
Namespace	string	是	雲端服務的資料命名空間。關於雲端服務的命名空間，請參見雲端服務監控項。	acs_ecs_dashboard
Category	string	是	雲端服務的類型分類。例如：Redis 有`kvstore_standard`（標準版）、`kvstore_sharding`（叢集版）和`kvstore_splitrw`（讀寫分離版）等。	ecs
ScopeType	string	否	警示黑名單策略的生效範圍。取值： USER（預設值）：警示黑名單策略僅在當前阿里雲帳號中生效。 GROUP：警示黑名單策略在指定應用分組中生效，您需要選擇指定應用分組。關於如何擷取應用分組 ID，請參見 DescribeMonitorGroups 。	USER
ScopeValue	string	否	應用分組 ID 列表。格式為 JSON Array。說明僅當`ScopeType`為`GROUP`時，需要設定該參數。	["67**","78**"]
EnableStartTime	string	否	警示黑名單策略生效的開始時間戳。單位：毫秒。	1640237400000
EnableEndTime	string	否	警示黑名單策略生效的結束時間戳記。單位：毫秒。	1640608200000
EffectiveTime	string	否	警示黑名單策略的生效時間範圍。如果您未設定該參數，則警示黑名單策略永久有效。如果您已設定該參數，則黑名單策略僅在指定的時間範圍內有效。該參數有以下兩種格式樣本： `03:00-04:59`：本地時間淩晨 3 點到淩 5 點（不包含 05:00）警示黑名單策略有效。 `03:00-04:59 UTC+0700`：東 7 區時間淩晨 3 點到淩晨 5 點（不包含 05:00）警示黑名單策略有效。	03:00-04:59
Instances	array	是	警示黑名單策略中指定雲端服務的執行個體列表。
	string	否	警示黑名單策略中指定雲端服務的執行個體列表。 N 的取值範圍：1~100。	{"instanceId":"i-bp1ew0zfkjblsuwx****"}
Metrics	array<object>	否	執行個體中的監控指標。如果您未設定該參數，則警示黑名單策略應用於指定雲端服務下的所有監控指標。如果您已設定該參數，則黑名單策略僅應用於當前監控指標。
	object	否	無。
MetricName	string	是	監控指標名稱。 N 的取值範圍：1~10。	disk_utilization
Resource	string	否	執行個體的擴充維度資訊。例如：`{"device":"C:"}`，表示對Elastic Compute Service 執行個體下的所有 C 盤應用黑名單策略。 N 的取值範圍：1~10。	{"device":"C:"}

關於公用請求參數的詳情，請參見公用參數。

返回參數

名稱	類型	描述	樣本值
	object	無。
Code	string	狀態代碼。說明 200 表示成功。	200
Message	string	錯誤資訊。	The request has failed due to a temporary failure of the server.
RequestId	string	請求 ID。	5C637FA3-3959-3352-8BE6-78CE2ED2D33D
Success	boolean	操作是否成功。取值： true：成功。 false：失敗。	true
Id	string	警示黑名單策略的 ID。	93514c96-ceb8-47d8-8ee3-93b6d98b****

樣本

正常返回樣本

JSON格式

{
  "Code": "200",
  "Message": "The request has failed due to a temporary failure of the server.",
  "RequestId": "5C637FA3-3959-3352-8BE6-78CE2ED2D33D",
  "Success": true,
  "Id": "93514c96-ceb8-47d8-8ee3-93b6d98b****"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	未找到指定資源。
409	ResourceConflict	Concurrent modification of resources.
409	ResourceExist	Resources already exist.

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

變更歷史

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