英方服务集群管理
June 24, 2022About 6 min
英方服务集群管理
SDK类名：/resource/ServiceCluster;
服务集群 - 新建
SDK方法名：createServiceCls;
URL
//service_cls
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| service_cls | Object | 服务集群对象表单 | |||
| cls_name | String | 名称 | |||
| label_list | Array | 【多选】标签 | |||
| service_type | Array | 【多选】服务类型： 0-实时备份 1-文件定时备份 2-MSSQL定时备份 | |||
| cls_node | Array | 集群节点列表 | |||
| hostname | String | 节点名 | |||
| ip | String | 节点地址 | |||
| port | String | 端口 | |||
| version | String | ||||
| data_addr | String | 数据地址 | |||
| os_user | String | 用户名 | |||
| bind_lic_list | Array | *绑定的软件许可列表 | |||
| cc_ip_uuid | String | 控制台地址ID | |||
| cc_ip | String | 控制台地址 | |||
| os_type | Number | 【预留】系统类型 0-Linux, 1-Windows 默认0 | |||
| etcd_url_uuid | String | 节点选择的etcd服务器地址对应的uuid | |||
| etcd_url | Array | etcd服务器地址： 【ip:port】 | |||
| ip | String | ||||
| port | String |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | success | |||
| ret | Number | 200 |
服务集群 - 修改
SDK方法名：modifyServiceCls;
URL
//service_cls
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| service_cls | Object | ||||
| cls_name | String | svc1 | |||
| cls_uuid | String | AB790C28-62D6-7236-612F-65D73C80036F | |||
| label_list | Array | ||||
| random_str | String | AB790B28-62D6-7236-612F-65D73C80036F | |||
| cls_node | Array | ||||
| hostname | String | ||||
| ip | String | ||||
| port | String | ||||
| service_type | Array | ||||
| bind_lic_list | Array |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功 |
服务集群 - 删除
SDK方法名：deleteServiceCls;
URL
//service_cls
Method
DELETE
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| cls_uuids | Array | ||||
| force | Number | 0-不强制删除 1-强制删除 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| data | Object | ||||
| code | Number | 11110001 | |||
| message | String | ||||
| fail_list | Array | ||||
| code | Number | 11110001 | |||
| message | String | [-1] 找不到节点 | |||
| node_uuid | String | @uuid | |||
| node_name | String | @name | |||
| success_list | Array | ||||
| code | Number | 11110001 | |||
| message | String | [0] success | |||
| node_uuid | String | @uuid | |||
| node_name | String | @name | |||
| ret | Number | 200 |
服务集群 - 单个
SDK方法名：describeServiceCls;
URL
//service_cls/:uuid([A-F0-9-]+)
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| message | String | ||||
| service_cls | Object | ||||
| cls_name | String | svc1 | |||
| cls_uuid | String | AB790C28-62D6-7236-612F-65D73C80036F | |||
| create_time | String | 1533871285 | |||
| random_str | String | AB790B28-62D6-7236-612F-65D73C80036F | |||
| label_list | Array | ||||
| cls_node | Array | ||||
| hostname | String | node1 | |||
| ip | String | 172.20.20.20 | |||
| port | String | 26821 | |||
| service_type | Array | [0,1,2] | |||
| bind_lic_list | Array | ["CBAA5927-A2AE-30F7-C0A9-4C45B29EC75E"] | |||
| user_uuid | String | AB790B28-62D6-7236-612F-65D73C80036F | |||
| code | Number | 0 |
服务集群 - 列表
SDK方法名：listServiceCls;
URL
//service_cls
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| limit | Number | 1 | |||
| page | Number | 1 | |||
| search_value | String | ||||
| search_field | String |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | ||||
| info_list | Array | ||||
| cls_name | String | svc1 | |||
| cls_uuid | String | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | |||
| label_list | Array | ["0DD4E727-70AB-62C6-BEB5-D012DFAE46E3","0DD4E727-70AB-62C6-BEB5-D012DFAE46E4","0DD4E727-70AB-62C6-BEB5-D012DFAE46E5"] | |||
| service_type | Array | [0,1,2] | |||
| cls_node | Array | 2 | |||
| hostname | Array | ["node1","node2"] | +1 | ||
| ip | Array | ["172.20.20.20","172.20.20.21"] | +1 | ||
| port | String | 26821 | |||
| can_up | Number | 1 | |||
| can_del | Number | 1 | |||
| can_op | Number | 1 | |||
| bind_res | Array | 绑定资源：复制卷名称,磁带名称 | |||
| name | String | 资源名称 | zfs-42-15-3 | ||
| status | String | 资源状态 | ONLINE | ||
| code | Number | 0 | |||
| message | String | ||||
| total | Number | 100 | |||
| count | Number | 10 | |||
| msg | String | ||||
| ret | Number | 200 |
服务集群 - 状态
SDK方法名：listServiceClsStatus;
URL
//service_cls/status
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| cls_uuids | Array |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success | |||
| status | Array | 2 | |||
| cls_uuid | Array | ["849A4E09-6F8D-21E6-4FF7-53731D3CAF7B","67559885-6D7C-A2D7-27D3-FA624403D122"] | +1 | ||
| status | String | ONLINE | |||
| time | Number | 1636192464 |
服务集群 - 集群节点检查 是否可删
SDK方法名：chkServiceClsNode;
URL
//service_cls/cls_node_chk
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| cls_uuid | String | 服务集群uuid | |||
| node_uuid | String | 集群节点uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| message | String | ||||
| has_rules | Number | 0-表示没有运行的规则，可删出 1-表示存在运行的规则，禁止删除 | 1 | ||
| code | Number | 0 |
服务集群 - 配置 编辑
SDK方法名：configServiceCls;
URL
//service_cls/config
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| cls_uuid | String | 服务集群uuid | |||
| config | Object | 配置信息 | |||
| cc_ip_uuid | String | 【基本设置】控制台地址 | |||
| log_path | String | 【基本设置】日志目录 | |||
| keep_log_days | Number | 【基本设置】日志保留时长 | |||
| mem_limit | Number | 【基本设置】内存使用上限 | |||
| disk_limit | Number | 【基本设置】磁盘使用上限 | |||
| disk_free_space_limit | Number | 【基本设置】磁盘剩余空间阈值 | |||
| security_check | Number | 【基本设置】安全检测 | |||
| comment | String | 【基本设置】备注 | |||
| monitor_switch | Number | 【监控设置】监控 | |||
| mon_send_interval | Number | 【监控设置】监控延迟 | |||
| mon_data_path | String | 【监控设置】分析数据目录 | |||
| db_save_day | Number | 【监控设置】监控数据保留 | |||
| mon_save_day | Number | 【监控设置】分析数据保留 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| message | String | ||||
| code | Number | 0 |
服务集群 - 配置 获取
SDK方法名：describeServiceClsConfig;
URL
//service_cls/config
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| cls_uuid | String |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| ret | Number | 200 | |||
| config | Object | ||||
| cc_ip_uuid | String | ||||
| log_path | String | ||||
| keep_log_days | Number | 1 | |||
| mem_limit | Number | 1 | |||
| disk_limit | Number | 1 | |||
| disk_free_space_limit | Number | 1 | |||
| security_check | Number | 1 | |||
| comment | String | ||||
| monitor_switch | Number | 1 | |||
| mon_send_interval | Number | 1 | |||
| mon_data_path | String | ||||
| db_save_day | Number | 1 | |||
| mon_save_day | Number | 1 |
服务集群 - 获取有效节点
SDK方法名：listServiceClsValidNode;
URL
//service_cls/valid_node
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| cls_uuid | String | 服务集群uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| message | String | ||||
| code | Number | 0 | |||
| valid_node | Object | ||||
| hostname | String | node1 | |||
| ip | String | 172.20.20.20 | |||
| port | String | 26821 | |||
| data_addr | String | 172.20.20.20 |