Undermoon HTTP API完全手册集群管理与监控的高效操作指南【免费下载链接】undermoonMordern Redis Cluster solution for easy operation.项目地址: https://gitcode.com/gh_mirrors/un/undermoonUndermoon是一个现代化的Redis集群解决方案通过强大的HTTP API实现简单高效的集群管理与监控。本文将全面介绍Undermoon的HTTP API功能帮助新手和普通用户快速掌握集群创建、节点管理、故障处理等核心操作。一、API基础概述 Undermoon的HTTP API采用RESTful设计风格所有请求和响应均使用JSON格式通过HTTP 200状态码标识成功或失败。主要包含两类API基础的Broker HTTP API和扩展的Memory Broker API后者是前者的超集提供更丰富的集群管理功能。1.1 API版本与路径规范基础路径/api/v3/核心文档Broker HTTP API、Memory Broker API配置文件mem-broker.toml定义HTTP API地址二、集群管理核心API 2.1 集群创建与配置创建集群请求POST /api/v3/clusters/meta/cluster_name参数{ node_number: 8 // 必须是4的倍数 }成功响应HTTP 200错误码INVALID_CLUSTER_NAME集群名称包含非法字符NO_AVAILABLE_RESOURCE资源不足获取集群元数据请求GET /api/v3/clusters/meta/cluster_name响应示例{ cluster: { name: mycluster, epoch: 1, nodes: [{ address: redis9:6379, proxy_address: server_proxy5:6005, slots: [[0, 8191]] }] } }2.2 节点扩缩容操作动态添加节点请求PATCH /api/v3/clusters/nodes/cluster_name参数{ node_number: 4 // 新增节点数量4的倍数 }自动扩缩容迁移请求POST /api/v3/clusters/migrations/auto/cluster_name/node_number扩容自动添加节点并启动迁移缩容仅收缩槽位需手动删除空闲节点三、监控与故障处理 3.1 集群状态监控获取集群信息请求GET /api/v3/clusters/info/cluster_name响应示例{ name: mycluster, node_number: 8, is_migrating: false }查看失败代理请求GET /api/v3/proxies/failed/addresses响应{ addresses: [server_proxy1:6001] }3.2 故障转移与恢复触发故障转移请求POST /api/v3/proxies/failover/server_proxy_address成功响应返回新主节点信息资源故障检查请求POST /api/v3/resources/failures/check响应{ hosts_cannot_fail: [host1] // 资源不足的主机列表 }四、实用操作指南 4.1 快速初始化集群通过Docker Compose部署后可执行初始化脚本注册存储资源git clone https://gitcode.com/gh_mirrors/un/undermoon cd undermoon/examples/mem-broker ./init.sh # 通过HTTP API自动完成集群注册4.2 配置压缩策略请求PATCH /api/v3/clusters/config/cluster_name参数{ compression_strategy: set_get_only // 仅压缩SET/GET命令 }4.3 元数据备份与恢复导出元数据请求GET /api/v3/metadata恢复元数据请求PUT /api/v3/metadata注意仅用于调试生产环境需谨慎使用五、API错误码速查 错误码含义处理建议CLUSTER_NOT_FOUND集群不存在检查集群名称拼写MIGRATION_RUNNING迁移中等待当前迁移完成NO_AVAILABLE_RESOURCE资源不足添加更多代理节点RETRY操作冲突稍后重试请求通过本文介绍的Undermoon HTTP API您可以轻松实现Redis集群的自动化管理与监控。无论是新手还是资深用户都能快速掌握集群创建、扩缩容、故障处理等关键操作提升Redis集群的运维效率。更多高级功能请参考官方文档docs/。【免费下载链接】undermoonMordern Redis Cluster solution for easy operation.项目地址: https://gitcode.com/gh_mirrors/un/undermoon创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考