调用CheckMonitorAlert是否开通监控告警功能_云数据库 ClickHouse(ClickHouse)-阿里云帮助中心

调用CheckMonitorAlert接口校验指定云数据库ClickHouse集群是否开通了ARMS（Application Real-Time Monitoring Service）服务提供的监控告警功能。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
clickhouse:CheckMonitorAlert	get	*DBCluster `acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。	cc-bp13s14l8498l****
RegionId	string	否	地域 ID。您可以通过调用 DescribeRegions 接口查询地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	94F92113-FF63-5E57-8401-6FE123AD11DD
State	string	是否开通了监控告警功能，取值说明： enable：已开通。 disable：未开通。	enable
Parameter	string	监控告警参数。	{ "monitor":{ "key1":"value1", "key2":"value2" }, "alert":{ "key1":"value1", "key2":"value2" } }

示例

正常返回示例

JSON格式

{
  "RequestId": "94F92113-FF63-5E57-8401-6FE123AD11DD",
  "State": "enable",
  "Parameter": "{   \"monitor\":{     \"key1\":\"value1\",     \"key2\":\"value2\"   },   \"alert\":{     \"key1\":\"value1\",     \"key2\":\"value2\"   } }"
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史