All Products
Search
Document Center

ApsaraDB for ClickHouse:CheckMonitorAlert

Last Updated:Nov 12, 2024

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
clickhouse:CheckMonitorAlertget
  • DBCluster
    acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The cluster ID.

cc-bp13s14l8498l****
RegionIdstringNo

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

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

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
Parameterstring

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 codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe 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 timeSummary of changesOperation
No change history