全部产品
Search
文档中心

云数据库 ClickHouse:CheckMonitorAlert - 是否开通监控告警功能

更新时间:Sep 26, 2024

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
DBClusterIdstring

集群 ID。

cc-bp13s14l8498l****
RegionIdstring

地域 ID。您可以通过调用 DescribeRegions 接口查询地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

94F92113-FF63-5E57-8401-6FE123AD11DD
Statestring

是否开通了监控告警功能,取值说明:

  • enable:已开通。
  • disable:未开通。
enable
Parameterstring

监控告警参数。

{ "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错误码错误信息描述
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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

变更历史

变更时间变更内容概要操作
暂无变更历史