集群请求

集群设置请求

Redis 企业软件
方法 路径 描述
获取 /v1/cluster 获取集群信息
放 /v1/cluster 更新集群设置

获取集群信息

GET /v1/cluster

获取群集信息。

所需权限

权限名称
view_cluster_info

请求

HTTP 请求示例

GET /v1/cluster

请求标头

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

响应

返回 cluster 对象。

示例 JSON 正文

{
   "name": "my-rlec-cluster",
   "alert_settings": { "..." },
   "created_time": "2015-04-29T09:09:25Z",
   "email_alerts": false,
   "email_from": "",
   "rack_aware": false,
   "smtp_host": "",
   "smtp_password": "",
   "smtp_port": 25,
   "smtp_tls_mode": "none",
   "smtp_username": ""
}

Status codes

Code Description
200 OK No error

Update cluster settings

PUT /v1/cluster

Update cluster settings.

If called with the dry_run URL query string, the function will validate the cluster object, but will not apply the requested changes.

Required permissions

Permission name
update_cluster

Request

Example HTTP request

PUT /v1/cluster

Example JSON body

{
    "email_alerts": true,
    "alert_settings": {
        "node_failed": true,
        "node_memory": {
            "enabled": true,
            "threshold": "80"
        }
    }
}

The above request will enable email alerts and alert reporting for node failures and node removals.

Request headers

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

URL parameters

Field Type Description
dry_run string Validate but don't apply the new cluster settings

Request body

Include a cluster object with updated fields in the request body.

Response

Example JSON body

{
    "name": "mycluster.mydomain.com",
    "email_alerts": true,
    "alert_settings": {
        "node_failed": true,
        "node_memory": {
            "enabled": true,
            "threshold": "80"
        }
    },
    "// additional fields..."
}

Error codes

When errors are reported, the server may return a JSON object with error_code and message field that provide additional information. The following are possible error_code values:

Code Description
bad_nginx_conf • Designated port is already bound.

• nginx configuration is illegal.
bad_debuginfo_path • Debuginfo path doesn't exist.

• Debuginfo path is inaccessible.
config_edit_conflict Cluster config was edited by another source simultaneously.

Status codes

Code Description
200 OK No error.
400 Bad Request Bad content provided.
RATE THIS PAGE
Back to top ↑