集群警报请求

集群警报请求

Redis 企业软件
方法 路径 描述
获取 /v1/cluster/alerts 获取所有集群警报
获取 /v1/cluster/alerts/{alert} 获取特定群集警报

获取所有集群警报

GET /v1/cluster/alerts

获取集群对象的所有警报状态。

所需权限

权限名称
view_cluster_alerts

请求

HTTP 请求示例

GET /v1/cluster/alerts

请求标头

钥匙 价值 描述
主机 cnm.cluster.fqdn 中 域名
接受 应用程序/JSON 接受的媒体类型

查询参数

田 类型 描述
ignore_settings 布尔 检索更新的警报状态，而不管集群的alert_settings如何。如果不存在，则禁用的警报将始终检索为禁用，并显示 false 状态。（可选）

响应

返回警报对象及其状态的哈希值。

示例 JSON 正文

{
    "cluster_too_few_nodes_for_replication": {
        "change_time": "2014-12-22T11:48:00Z",
        "change_value": {
            "state": false
        },
       "enabled": true,
       "state": "off",
       "severity": "WARNING",
    },
    "..."
}

Status codes

Code Description
200 OK No error

Get cluster alert

GET /v1/cluster/alerts/{alert}

Get a cluster alert state.

Required permissions

Permission name
view_cluster_alerts

Request

Example HTTP request

GET /v1/cluster/alerts/cluster_too_few_nodes_for_replication

Request headers

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted media type

Query parameters

Field Type Description
ignore_settings boolean Retrieve updated alert state regardless of the cluster’s alert_settings. When not present, a disabled alert will always be retrieved as disabled with a false state. (optional)

Response

Returns an alert object.

Example JSON body

{
    "change_time": "2014-12-22T11:48:00Z",
    "change_value": {
        "state": false
    },
   "enabled": true,
   "state": "off",
   "severity": "WARNING",
}

Status codes

Code Description
200 OK No error
404 Not Found Specified alert does not exist
RATE THIS PAGE
Back to top ↑