集群请求

集群设置请求

方法 路径 描述
GET /v1/cluster 获取集群信息
PUT /v1/cluster 更新集群设置

获取集群信息

GET /v1/cluster

获取集群信息。

所需权限

权限名称
view_cluster_info

请求

示例HTTP请求

GET /cluster

请求头

键 值 描述
主机 cnm.cluster.fqdn 域名
Accept application/json 接受的媒体类型

响应

返回一个集群对象。

示例 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": ""
}

状态码

代码 描述
200 OK 无错误

更新集群设置

PUT /v1/cluster

更新集群设置。

如果使用dry_run URL查询字符串调用，该函数将验证cluster object，但不会应用请求的更改。

所需权限

权限名称
update_cluster

请求

示例HTTP请求

PUT /cluster

示例 JSON 主体

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

上述请求将启用电子邮件警报和节点故障及节点移除的警报报告。

请求头

键 值 描述
主机 cnm.cluster.fqdn 域名
Accept application/json 接受的媒体类型

URL 参数

字段 类型 描述
dry_run string 验证但不应用新的集群设置

请求体

在请求体中包含一个cluster object，并更新其字段。

响应

示例 JSON 主体

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

错误代码

当报告错误时，服务器可能会返回一个包含error_code和message字段的JSON对象，这些字段提供了额外的信息。以下是可能的error_code值：

代码 描述
bad_nginx_conf • 指定端口已被占用。
• nginx配置不合法。
bad_debuginfo_path • 调试信息路径不存在。
• 调试信息路径无法访问。
config_edit_conflict 集群配置被另一个来源同时编辑。

状态码

代码 描述
200 OK 没有错误。
400 Bad Request 提供了错误的内容。
RATE THIS PAGE
Back to top ↑