CheckMonitorAlert - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Checks whether the monitoring and alerting feature that is provided by Application Real-Time Monitoring Service (ARMS) is enabled for an ApsaraDB for ClickHouse cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	cc-bp13s14l8498l****
RegionId	string	No	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	94F92113-FF63-5E57-8401-6FE123AD11DD
State	string	Indicates whether the monitoring and alerting feature is enabled. Valid values: enable: The monitoring and alerting feature is enabled. disable: The monitoring and alerting feature is disabled.	enable
Parameter	string	The parameters that are used to configure the monitoring and alerting feature.	{ "monitor":{ "key1":"value1", "key2":"value2" }, "alert":{ "key1":"value1", "key2":"value2" } }

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history