HDR服务化
April 30, 2024About 10 min
HDR服务化
SDK类名：/hw/HDR;
系统设置 - 更新云平台配置
SDK方法名：updateSetting;
发送键值对，更新记录；
仅发送当前需要改的参数；
URL
/sys/settings/
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| hcs_url | String | 云平台地址 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | 否 | |||
| ret | Number | 否 | @mock=200 | 200 | |
| data | Object | 否 | |||
| message | String | 否 | @mock=success update to latest version | success update to latest version | |
| code | Number | 否 | @mock=0 | 0 |
VDC管理员 - 保存云账户
SDK方法名：modifyProfile
URL
/user/hcs_info
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| hcs_username | String | 用户名/AK | |||
| hcs_password | String | 密码/SK |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | 否 | |||
| message | String | 否 | |||
| code | Number | 否 | 错误码，0：成功，其余：失败 | 0 | |
| ret | Number | 否 | HTTP code | 200 | |
| msg | String | 否 |
VDC管理员 - 查看当前登录用户信息
SDK方法名：listProfile
URL
/user/profile/
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| message | String | 否 | @mock="" | "" | |
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | |||
| profile | Object | 否 | |||
| user_uuid | String | 否 | 用户UUID | 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC | |
| username | String | 否 | 登录用户名 | system | |
| mobile | String | 否 | 手机号 | 123412341234 | |
| String | 否 | 邮件 | a@qq.com | ||
| nickname | String | 否 | 昵称 | admin | |
| company | String | 否 | 公司 | 公司 | |
| address | String | 否 | 地址 | 上海市闵行区 | |
| comment | String | 否 | 备注 | ||
| pwd_change_time | String | 否 | 下次密码更新时间 | 1756863795 | |
| is_biz_admin | String | 否 | 是否是业务管理员 | ||
| main_role | String | 用户首选角色 | tenant_admin | ||
| layout_conf | Object | 布局 - 配置项 | |||
| menu_mode | String | 菜单类型： generalMenu 默认 mixedMenu mixedCollapseMenu | |||
| show_logo | Boolean | 是否显示logo 默认true | |||
| hcs_username | String | HCS云账户名或者AK | |||
| access_log | Array |
许可配额 - 总览
URL
/gts/quota_overview
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| page | String | 页码 | 1 | ||
| limit | String | 单页数量 | 15 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 错误码，0：成功，其余错误 | 0 | ||
| message | String | 错误信息 | |||
| user_list | Array | 用户配额详情列表 | 4 | ||
| username | Array | 用户名 | ["test1","null_operator","test","operator"] | +1 | |
| user_uuid | Array | 用户UUID | ["11398544-3176-49D9-9635-C165EDC150D2","27E7B2D8-BF25-4281-BFB6-771CF64FD408","AB8C6E7D-AD6F-4037-914B-A8886C1CA67B","EFB53F11-7BA2-2001-3418-85865EA58E47"] | +1 | |
| nas_phy_num | Number | NAS物理节点已分配配额 | 0 | +1 | |
| nas_vm_num | Number | NAS虚拟节点已分配配额 | 0 | +1 | |
| nas_phy_used_num | Number | NAS物理节点已使用配额 | 0 | ||
| nas_vm_used_num | Number | NAS虚拟节点已使用配额 | 0 | +1 | |
| ha_phy_num | Number | HA物理节点已分配配额 | 0 | +1 | |
| ha_vm_num | Number | HA虚拟节点已分配配额 | 0 | +1 | |
| ha_phy_used_num | Number | HA物理节点已使用配额 | 0 | ||
| ha_vm_used_num | Number | HA虚拟节点已使用配额 | 0 | +1 | |
| move_num | Number | MOVE已分配配额 | 0 | +1 | |
| move_used_num | Number | MOVE已使用配额 | 0 | ||
| dto_num | Number | DTO已分配配额 | 0 | +1 | |
| dto_used_num | Number | DTO已使用配额 | 0 | ||
| db_num | Number | Oracle已分配配额 | 0 | +1 | |
| db_num_used | Number | Oracle已使用配额 | 0 | ||
| mysql_num | Number | MySQL已分配配额 | 0 | +1 | |
| mysql_num_used | Number | MySQL已使用配额 | 0 | ||
| sqlserver_num | Number | sqlserver已分配配额 | 0 | +1 | |
| sqlserver_num_used | Number | sqlserver已使用配额 | 0 | ||
| postgresql_num | Number | postgresql已分配配额 | |||
| postgresql_num_used | Number | postgresql已使用配额 | |||
| dm_num | Number | dm已分配配额 | |||
| dm_num_used | Number | dm已使用配额 | |||
| mongodb_num | Number | mongodb已分配配额 | |||
| mongodb_num_used | Number | mongodb已使用配额 | |||
| redis_num | Number | redis已分配配额 | |||
| redis_num_used | Number | redis已使用配额 | |||
| kafka_num | Number | kafka已分配配额 | |||
| kafka_num_used | Number | kafka已使用配额 | |||
| quota_summary | Object | 整体许可已分配量和许可总量信息 | |||
| status | String | 状态 | |||
| group_sn | String | 许可组SN | |||
| nas_phy_num | Number | NAS物理节点许可总容量 | 3 | ||
| nas_vm_num | Number | NAS虚拟节点许可总容量 | 3 | ||
| ha_num | Number | HA许可总容量 | 10 | ||
| ha_phy_num | Number | HA物理节点许可容量 | 5 | ||
| ha_phy_used_num | Number | HA物理节点已分配配额 | 1 | ||
| ha_used_num | Number | HA已分配总配额（物理+虚拟） | 2 | ||
| move_num | Number | MOVE许可总容量 | 5 | ||
| move_used_num | Number | MOVE已分配配额 | 1 | ||
| dto_num | Number | DTO许可总容量 | 100 | ||
| dto_used_num | Number | DTO已分配配额 | 1 | ||
| db_num | Number | Oracle许可总容量 | 10 | ||
| db_num_used | Number | Oracle已分配配额 | 1 | ||
| mysql_num | Number | MySQL许可总容量 | 10 | ||
| mysql_num_used | Number | MySQL已分配配额 | 2 | ||
| sqlserver_num | Number | sqlserver许可总容量 | 10 | ||
| sqlserver_num_used | Number | sqlserver已分配配额 | 3 | ||
| nas_num | Number | NAS许可总容量（物理+虚拟） | 2 | ||
| nas_used_num | Number | NAS已分配总配额（物理+虚拟） | 1 | ||
| nas_phy_used_num | Number | NAS物理节点已分配配额 | 1 | ||
| nas_vm_used_num | Number | NAS虚拟节点已分配配额 | 1 | ||
| ha_vm_num | Number | HA虚拟节点许可容量 | 5 | ||
| ha_vm_used_num | Number | HA虚拟节点已分配配额 | 1 | ||
| active_num | Number | 数据库同步总许可容量 | 30 | ||
| active_num_used | Number | 数据库同步总分配配额 | 6 | ||
| purchase_time | String | 购买时间 | 2024-05-10 | ||
| expire_time | String | 过期时间 | 2025-06-24 | ||
| postgresql_num | Number | sqlserver许可总容量 | |||
| postgresql_num_used | Number | sqlserver已分配配额 | |||
| dm_num | Number | dm许可总容量 | |||
| dm_num_used | Number | dm已分配配额 | |||
| mongodb_num | Number | mongodb许可总容量 | |||
| mongodb_num_used | Number | mongodb已分配配额 | |||
| redis_num | Number | redis许可总容量 | |||
| redis_num_used | Number | redis已分配配额 | |||
| kafka_num | Number | kafka许可总容量 | |||
| kafka_num_used | Number | kafka已分配配额 | |||
| total | Number | 4 |
许可配额 - 查看指定用户配额
接口的uuid为对应用户的uuid
URL
/gts/license_quota/:uuid([A-F-0-9]+)
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| info_list | Array | 5 | |||
| feature | String | 许可类型，高可用：ha， DTO：dto， NAS：nas， 数据库同步：active， MOVE：move | ha | ||
| vm_num | Number | （类型为：ha、nas）虚拟节点 | |||
| phy_num | Number | （类型为：ha、nas）物理节点 | |||
| move_num | Number | （类型为：move）迁移次数， （类型为：dto）容量（GB） | |||
| db_num | Number | （类型为：active）Oracle容量 | |||
| sqlserver_num | Number | （类型为：active）sqlserver容量 | |||
| mysql_num | Number | （类型为：active）MySQL容量 | |||
| vm_used_num | Number | （类型为：ha、nas）已使用虚拟节点 | |||
| phy_used_num | Number | （类型为：ha、nas）已使用物理节点 | |||
| db_used_num | Number | （类型为：active）已使用Oracle容量 | |||
| create_time | Number | 创建时间 | |||
| verify_str | Number | （废弃字段） | |||
| postgresql_num | Number | （类型为：active）postgresql容量 | |||
| dm_num | Number | （类型为：active）dm容量 | |||
| mongodb_num | Number | （类型为：active）mongodb容量 | |||
| redis_num | Number | （类型为：active）redis容量 | |||
| kafka_num | Number | （类型为：active）kafka容量 | |||
| total | Number | 5 |
许可配额 - 修改配额
URL
/gts/license_quota/:uuid([A-F-0-9]+)
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| quota_list | Array | ||||
| feature | String | 许可类型，下面的参数按照对应许可类型赋值， 高可用：ha， DTO：dto， NAS：nas， 数据库同步：active， MOVE：move | |||
| vm_num | Number | （类型为：ha、nas）虚拟节点，赋值为null则代表按照最大容量限制 | |||
| phy_num | Number | （类型为：ha、nas）物理节点，赋值为null则代表按照最大容量限制 | |||
| db_num | Number | （类型为：active）Oracle容量，赋值为null则代表按照最大容量限制 | |||
| sqlserver_num | Number | （类型为：active）sqlserver容量，赋值为null则代表按照最大容量限制 | |||
| mysql_num | Number | （类型为：active）MySQL容量，赋值为null则代表按照最大容量限制 | |||
| move_num | Number | （类型为：move）迁移次数， （类型为：dto）容量（GB），赋值为null则代表按照最大容量限制 | |||
| postgresql_num | String | （类型为：active）postgresql容量，赋值为null则代表按照最大容量限制 | |||
| dm_num | String | （类型为：active）dm容量，赋值为null则代表按照最大容量限制 | |||
| mongodb_num | String | （类型为：active）mongodb容量，赋值为null则代表按照最大容量限制 | |||
| redis_num | String | （类型为：active）redis容量，赋值为null则代表按照最大容量限制 | |||
| kafka_num | String | （类型为：active）kafka容量，赋值为null则代表按照最大容量限制 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 操作错误码，0：成功 | 0 | ||
| message | String | 操作结果 |
许可配额 - 批量修改配额
URL
/gts/license_quota/
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| quota_list | Array | ||||
| feature | String | 许可类型，下面的参数按照对应许可类型赋值， 高可用：ha， DTO：dto， NAS：nas， 数据库同步：active， MOVE：move | |||
| vm_num | Number | （类型为：ha、nas）虚拟节点 | |||
| phy_num | Number | 是 | （类型为：ha、nas）物理节点 | ||
| db_num | Number | （类型为：active）Oracle容量 | |||
| sqlserver_num | Number | （类型为：active）sqlserver容量 | |||
| mysql_num | Number | （类型为：active）MySQL容量 | |||
| move_num | Number | （类型为：move）迁移次数， （类型为：dto）容量（GB） | |||
| postgresql_num | String | （类型为：active）postgresql容量 | |||
| dm_num | String | （类型为：active）dm容量 | |||
| mongodb_num | String | （类型为：active）mongodb容量 | |||
| redis_num | String | （类型为：active）redis容量 | |||
| kafka_num | String | （类型为：active）kafka容量 | |||
| uuids | Array | 用户uuid数组 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 1055554016 | |||
| message | String | [1055554016] 节点离线，通常为iahelper程序异常 |
客户端 - 列表
URL
/gts/cloud_servers
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| search_field | String | 模糊搜索字段 | server_name | ||
| search_value | String | 模糊搜索值 | test_name |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| info_list | Array | ||||
| server_name | String | 客户端名称 | |||
| server_id | String | ID | |||
| server_uuid | String | UUID | |||
| server_az | String | 可用区 | |||
| status | String | 状态，ACTIVE，SHUTOFF，ERROR，VERIFY_RESIZE | |||
| flavor | Object | 规格 | |||
| vcpus | String | CPU | |||
| ram | String | 内存 | |||
| name | String | 名称 | c1.medium | ||
| id | String | c1.medium | |||
| image_name | String | 镜像名 | HEC_Public_Cloudinit_CentOS_7.4_64bit | ||
| addresses | Array | 地址 | |||
| addr | String | ip | |||
| type | String | 私有：fixed， 公有：floating | fixed | ||
| total | String | 20 |
获取操作日志用户列表
SDK方法名：getOpLogUsers
URL
/user/op_log_user
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| code | Number | 0 | |||
| message | String | ||||
| users | Array | 2 | |||
| id | Number | 3 | +1 | ||
| user_uuid | Array | ["EFB53F11-7BA2-2001-3418-85865EA58E47","101AAA42-B2E0-42D0-92D9-8B74D3DE993F"] | +1 | ||
| username | Array | ["operator","user001"] | +1 | ||
| active | Number | 1 | |||
| first_name | Array | ["operator",null] | +1 | ||
| last_name | Array | ["default",null] | +1 | ||
| address | Null | ||||
| comment | Null | ||||
| company | Array | ["",null] | +1 | ||
| create_time | Number | 1726105702 | +1 | ||
| builtin | Number | 1 | +1 | ||
| domain_id | Null | ||||
| roles | Array | ||||
| id | Number | 3 | |||
| user_id | Number | 3 | |||
| role_id | Number | 3 | |||
| name | String | operator | |||
| is_system | Number | 1 | |||
| allow_new_user | Number | 1 | |||
| display_name | String | Operator | |||
| description | String | Operation Clerk | |||
| dynamic_perms | Number | 1 | |||
| biz_admin_view | Number | 0 | |||
| total | Number | 2 | |||
| track_login_attempts | Boolean | true |