文档中心 > 云业务管理系统（国内版）> 开发者中心> 裸金属API文档
下载PDF

裸金属API文档

最后更新时间：2022-04-29 11:38:53

调用方式

请求地址

http://您阿帕云引擎域名/api

请求方法

POST

Content-Type 类型：application/x-www-form-urlencoded

公共参数

说明：公共请求参数与返回数据说明，再具体接口中不再重复列出和说明。

参数 必选 类型/长度 示例值 说明
module 是 string baremetal 业务类型
action 是 string getzones 操作名称，后续接口中，替换此参数
userid 是 int 1 会员ID
time 是 int 1471331587 当前UNIX时间戳
sign 是 string ebb198fa8f884f9544b94bb16e8e3af3 权限令牌，生成规则如下： sign = md5(module+ 'zkeys.api@2019'+action + userid + API秘钥 + time)，API秘钥请登录控制台，在代理分销>API设置中查看/修改。
taskid 是 int 12 您本地请求的任务编号，异步回调时返回会携带该参数
dataType 否 string json 返回格式，XML/JSON（可选），默认json
version 是 string 6.0.1 阿帕云引擎版本，如自行对接，可固定：9.9.9
system_type 是 string zkeys_web 阿帕云引擎类型，如自行对接，可固定：zkeys_web
vtime 是 string 20220303 当天日期，格式：YYYYMMDD

获取可用区

请求参数

参数 必选 类型 示例值 说明
action 是 string getzones 接口名称

返回示例

{
    "code": 0,
    "message": "success",
    "data": {
        "zones": [
            {
                "guid": "1625139389577044",
                "name": "Hyper-V 2",
                "max_year": "3",
                "identityStatus": "1",
                "whiteListStatus": "0",
                "icp_status": "0"
            },
            {
                "guid": "1650521653823448",
                "name": "\u4e2d\u56fd\u5185\u8499",
                "max_year": "3",
                "identityStatus": "1",
                "whiteListStatus": "1",
                "icp_status": "1"
            }
        ]
    }
}

返回值

参数 类型/长度 示例值 说明
code int 0 返回状态 0:成功 , 1:失败
message string success 反馈信息
data json json 返回的可用区结构体
data.zones array 可用区数据 可用区数据
data.zones.guid string 1625139389577044 可用区GUID
data.zones.name string 深圳一区 可用区名称
data.zones.max_year string 3 可用区年限
data.zones.identityStatus string 1 本可用区强制实名认证 1：是 0：否
data.zones.whiteListStatus string 1 本可用区强制提交白名单 1：是 0：否
data.zones.icp_status string 1 本可用区支持提交备案 1：是 0：否

获取线路

请求参数

参数 必选 类型 示例值 说明
action 是 string sync_line 接口名称

返回示例

{
  "code":0,
  "message":"success",
  "data":[
    {
      "id":"1",
      "line_type":"local",
      "guid":"1665907446560259",
      "api_guid":"1665907446560259",
      "line_guid":"1665906481931673",
      "type_guid":"0",
      "status":"1",
      "name":"\u88f84.0ZH-\u88f84.0ZH",
      "code":null,
      "descript":null,
      "intro_url":"",
      "buy_status":"1",
      "renew_status":"1",
      "upgrade_status":"1",
      "defense_status":"1",
      "buy_order_max_num":"10",
      "auto_user_dns":null,
      "sort_id":"17",
      "life_time":"3",
      "bandwidth_share_size":"0",
      "bandwidth_share_price":"0.00",
      "bandwidth_price_api":"0.00",
      "bandwidth_price":"10.00",
      "bandwidth_max_size":"300",
      "ip_min_size":"0",
      "ip_max_size":"200",
      "ip_free_size":"0",
      "ip_price":"10.00",
      "ip_price_api":"0.00",
      "ip_num_list":"1,8,16,32,64,128,256",
      "defense_price_api":"0.00",
      "defense_price":"10.00",
      "defense_max_size":"300",
      "defense_num_list":null,
      "defense_step":"5",
      "release_hour":"0",
      "months":"1,2,3,4,5,6,12,24,36",
      "ipmi_server_id":"0",
      "idc_line_id":"0",
      "move_status":"0",
      "ip_upgrade_type":"1,2",
      "user_vnc":"0",
      "retention_days":"1",
      "bandwidth_in_type":"1",
      "bandwidth_in_value":"0",
      "discount1":"1.00",
      "discount2":"1.00",
      "discount3":"1.00",
      "line_auth":"0",
      "ip_bandwidth_rate":"0.500",
      "reservation_degrade_status":"1",
      "reservation_degrade_valid_limit":"15"
    }]
}

返回值

参数 类型/长度 示例值 说明
code int 0 返回状态 0:成功 , 1:失败
message string success 反馈信息
data json json 返回的可用区结构体 可能存在多条线路
data.id string 1 线路特殊id
data.line_type string local 线路类型： niaoyun 小鸟云 local 本地资源 zkeys
data.guid string 1665907446560259 线路GUID
data.api_guid string 1665907446560259 API线路GUID
data.line_guid string 1665906481931673 可用区GUID
data.type_guid string 0 所属地域GUID
data.status string 1 状态：0隐藏 1显示 -1删除
data.name string 裸金属线路 线路名称
data.code string no_1 线路编号
data.descript string 深圳一区 线路描述
data.intro_url string 机房介绍链接
data.buy_status string 1 购买状态 1开放购买 0 禁止购买
data.renew_status string 1 续费状态 1开放续费 0 禁止续费
data.upgrade_status string 1 升级状态 1开放升级 0 禁止升级
data.defense_status string 1 防御升级开关，0不开放升级 1开放升级
data.buy_order_max_num string 10 每个订单最多一次可创建台数
data.auto_user_dns string 8.8.8.8 客户机DNS
data.sort_id string 1 排序数字(数值越小越靠前)
data.life_time string 3 线路存活时长（允许业务最长保留时长，单位年）
data.bandwidth_share_size string 3 共享带宽大小
data.bandwidth_share_price string 3 共享带宽价格
data.bandwidth_price_api string 3 API的带宽价格
data.bandwidth_price string 3 带宽价格 元/M/月
data.bandwidth_max_size string 300 带宽允许最大值
data.ip_min_size string 0 IP最小数量
data.ip_max_size string 200 IP最大数量
data.ip_free_size string 0 IP免费赠送数量
data.ip_price string 10 IP价格元/月
data.ip_price_api string 10 api的IP价格
data.ip_num_list string 1,8,16,32,64,128,256 IP数量可选项允许设置的IP选项，多个用英文逗号隔开，如果设置了，则前台购买升级IP值只能是这里设置的选项之一，没有设置则默认为1
data.defense_price_api string 10 防御的API价格
data.defense_price string 10 防御价格，单位 元/G/月
data.defense_max_size string 300 允许的最大防御值 单位 G
data.defense_num_list string 5，10，20 防御（可忽略）
data.defense_step string 5 防御步长
data.release_hour string 5 过期释放时间，业务过期多少小时后释放资源
data.months string 1,2,3,6,12,24,36 时长设置(1,2,3,6,12,24,36）
data.ipmi_server_id string 0 IPMI机房控制器ID
data.idc_line_id string 0 关联托管线路的ID
data.move_status string 0 是否已迁移
data.ip_upgrade_type string 1，2 升级IP类型 1单IP，2子网，1,2混合可选
data.user_vnc string 0 用户中心vnc设置 0不开放 1物理机内置VNC 2noVNC kvm终端
data.retention_days string 2 业务到期后保留天数
data.bandwidth_in_type string 2 带宽下行限制类型 1固定值 2对等阈值
data.discount1 string 1.00 满一年折扣
data.discount2 string 0.85 满两年折扣 85折
data.discount3 string 0.85 满三年折扣 85折
data.line_auth string 0 线路查看权限：0不限制（默认值） 1仅限本站会员 2仅限下级代理
data.ip_bandwidth_rate string 0.500 IP与带宽配比，值为 带宽除IP 的结果，0为不开启配比 大于0则需满足业务带宽除IP大于等于这个值
data.reservation_degrade_status string 0 是否支持降配预约 0不支持 1支持
data.reservation_degrade_valid_limit string 30 降配预约默认天数

获取操作系统

请求参数

参数 必选 类型 示例值 说明
action 是 string getsystems 接口名称
page_mode 是 string 1 页码
page_length 是 string 50 单页的数量

返回示例

{
    "code": 0,
    "message": "success",
    "data": {
        "zones": [
            {
                "guid": "1625139389577044",
                "name": "Hyper-V 2",
                "max_year": "3",
                "identityStatus": "1",
                "whiteListStatus": "0",
                "icp_status": "0"
            },
            {
                "guid": "1650521653823448",
                "name": "\u4e2d\u56fd\u5185\u8499",
                "max_year": "3",
                "identityStatus": "1",
                "whiteListStatus": "1",
                "icp_status": "1"
            }
        ]
    }
}

返回值

参数 类型/长度 示例值 说明
code int 0 返回状态 0:成功 , 1:失败
message string success 反馈信息
data json json 返回的可用区结构体
data.pages int 1 页码数
data.items int 116 总数
data.systems array [] 操作系统信息
data.systems.distinct_id string 1 特殊id
data.systems.id string 1 特殊id
data.systems.guid string 1695196885222115 操作系统GUID
data.systems.class_guid string 1666193469952094 操作系统类型GUID
data.systems.name string 6.8 64位 操作系统名称
data.systems.login_name string root 操作系统登陆名称
data.systems.port string 22 操作系统登陆端口
data.systems.mirror_name string root 镜像名称
data.systems.cpu_limit string 0 cpu限制 购买业务时 会判断购买的业务的配置是否符合操作系统的最低限制 0 限制
data.systems.ram_limit string 0 内存限制 购买业务时 会判断购买的业务的配置是否符合操作系统的最低限制 0 限制
data.systems.type string create 支持的类型 create 创建,install重装
data.systems.system_harddisk string 30 系统盘大小
data.systems.support string server 支持的业务类型 server 云服务器,idc托管,baremetal裸金属
data.systems.boot_menu_contents json {"19":"","250":""} 引导菜单内容
data.systems.ghost_url json {"19":"","250":""} ghost文件网络存储位置
data.systems.lines array ["1683665299911682"] 线路GUID 操作系统关联的线路

获取硬盘型号

请求参数

参数 必选 类型 示例值 说明
action 是 string sync_harddisk 获取硬盘型号

返回示例

    {
      "code":0,
      "message":"success",
      "data":[
        {
          "id":"1",
          "line_type":"local",
          "guid":"1623164939837722",
          "api_guid":"1623164939837722",
          "type":"SSD",
          "size":"1200",
          "status":"1"
        },
        {
          "id":"54",
          "line_type":"local",
          "guid":"1695288616986859",
          "api_guid":"1695288616986859",
          "type":"SSD",
          "size":"3",
          "status":"1"
        }]
    }

返回值

参数 类型/长度 示例值 说明
code int 0 返回状态 0:成功 , 1:失败
message string success 反馈信息
data json json 返回的可用区结构体
data.id string 1 硬盘型号id
data.line_type string local 硬盘型号类型
data.guid string 1623164939837722 唯一GUID
data.api_guid string 1623164939837722 API 唯一GUID
data.type string SSD 磁盘类型 磁盘型号 SSD HHD SATA SAS 等
data.size string 1000 硬盘大小 单位 GB
data.status string 1 状态 1显示 0隐藏 -1删除

获取机型

请求参数

参数 必选 类型 示例值 说明
action 是 string sync_product 获取机型

返回示例

    {
      "code":0,
      "message":"success",
      "data":[
        {
          "id":"55",
          "product_type":"local",
          "guid":"1665907642748705",
          "api_guid":"1665907642748705",
          "name":"zhzy4.0",
          "line_guid":"1665907446560259",
          "line_guid_api":null,
          "cpu_value":"4",
          "cpu":"CPU\u578b\u53f7-4",
          "cpu_num":"8",
          "cpu_max_num":"16",
          "memory":"\u5185\u5b58\u6df7\u5408\u578b\u53f7-max64",
          "memory_num":"500",
          "memory_max_num":"64",
          "harddisk_guid":"1623164948719896,1623164948719896,1623164939837722",
          "harddisk_max_num":"3",
          "system_partition_size":"50",
          "system_partition_support":"1",
          "raid_tips":"\u652f\u6301",
          "ipnum":"1",
          "bandwidth":"5",
          "defense":"5",
          "sort_id":"26",
          "main_board":"\u6807\u51c6\u578b\u4e3b\u677f\u578b\u53f71-1",
          "price":"500.00",
          "price_api":"0.00",
          "size":"2",
          "description":"\u56de\u5f52\u6d4b\u8bd5",
          "status":"1",
          "upgrade_status":"1",
          "recommend_status":"1",
          "stock_type":"1",
          "cpu_ids":null,
          "memory_ids":null,
          "harddisk_ids":null,
          "cpu_threads":null
        }
      ]
    }

返回值

参数 类型/长度 示例值 说明
code int 0 返回状态 0:成功 , 1:失败
message string success 反馈信息
data json json 返回的可用区结构体
data.id string 1 硬盘型号id
data.product_type string local 机型类型
data.guid string 1623164939837722 机型唯一GUID
data.api_guid string 1623164939837722 API机型唯一GUID
data.name string ES_32G 机型名称
data.line_guid string 1665907446560259 线路GUID
data.line_guid_api string NULL API线路GUID
data.cpu_value string 4 CPU总核心数
data.cpu string CPU_S1 CPU型号
data.cpu_num string 8 CPU个数
data.cpu_max_num string 16 CPU支持最大个数
data.memory string MEMORY_1 内存型号
data.memory_num string 500 内存数量（单位G）
data.memory_max_num string 64 内存支持最大数量（单位：G）
data.harddisk_guid string 1623164948719896,1623164948719896,1623164939837722 硬盘信息，对应套餐磁盘表的guid号，多块磁盘用1,2,3表示 一个机型支持多个磁盘型号
data.harddisk_max_num string 4 硬盘支持最大块数
data.system_partition_size string 50 系统分区的大小，以GB为单位，一般windows需要
data.system_partition_support string 1 是否支持分区：0不支持 1支持
data.raid_tips string 否 raid支持提示
data.ipnum string 否 ip数量
data.bandwidth string 5 带宽
data.defense string 5 防御值
data.sort_id string 26 排序，越小越前
data.main_board string 主板参数 主板参数
data.price string 500 月付价格
data.price string 0 api的获取价格
data.size string 1 机箱尺寸
data.description string api接口测试 产品描述
data.status string 1 状态 0禁用 1正常 -1删除
data.upgrade_status string 1 升级开关 0不支持 1支持 (该字段为预留，暂不起作用)
data.recommend_status string 1 推荐状态 0不推荐 1推荐 按sortId顺序排列
data.stock_type string 1 库存销售模式 0无库存纯人工方式 1采用库存销售
data.cpu_ids string null 多个值，机型表的id，类型：cpu
data.memory_ids string null 多个值，机型表的id，类型：cpu
data.harddisk_ids string null 多个值，机型表的id，类型：cpu
data.cpu_threads string null CPU线程

创建裸金属

请求参数

参数 必选 类型 示例值 说明
action 是 string create 创建
lineGuid 是 string 1665907446560259 线路GUID
productGuid 是 string 1665907642748705 机型GUID
systemGuid 是 string 1633652801461868 操作系统GUID
loginName 是 string root 系统名称
loginPassword 是 string QWE1MzUwMjkyNzkh base64_encode 之后的值
buyRemarks 是 string 购买的备注
months 是 string 1 月份
clientOrderNo 是 string 18369 客户端订单id
clientUserId 是 string 1100123 客户userid
num 是 string 1 数量
system_partition_size 是 string -1 不分区 -1表示不分区 51200 表示使用第一分区5G
agent_order_no 是 string 590682534662098123 客户端订单GUID
auth_client_user_id 否 string 1 授权认证的客户端id
auth_name 否 string 小鸟云 授权认证用户名
auth_mobile 否 string 137xxxxxxxx 授权认证手机号(11位手机号)
auth_idnum 否 string 421xxxxxxxxxxxxx 授权认证身份证
auth_from_ip 否 string 421xxxxxxxxxxxxx 授权端本地ip
auth_qq 否 string 4210xxxxx 授权认证qq

返回示例

     {
      "code":0,
      "message":"success",
      "data":[
        {
          "id":"1029",
          "guid":"1708330228791024",
          "product_guid":"1665907642748705",
          "stock_id":"56",
          "cabinet_sn":"zhzy_561-2",
          "name":"APIzhzy4.0",
          "line_guid":"1665907446560259",
          "size":"2",
          "main_board":"\u6807\u51c6\u578b\u4e3b\u677f\u578b\u53f71-1",
          "cpu_value":"4",
          "cpu":"CPU\u578b\u53f7-4",
          "cpu_num":"8",
          "cpu_max_num":"16",
          "memory":"\u5185\u5b58\u6df7\u5408\u578b\u53f7-max64",
          "memory_num":"500",
          "memory_max_num":"64",
          "harddisk_guid":"1623164948719896,1623164948719896,1623164939837722",
          "harddisk_max_num":"3",
          "raid_tips":"\u652f\u6301",
          "bandwidth":"5",
          "defense":"5",
          "ipnum":"1",
          "system_id":"160",
          "login_name":"root",
          "login_password":"b86sWRX\/2ibpVbKnf0w+LQ==",
          "ssh_public_key":null,
          "system_partition":null,
          "system_partition_size":"-1",
          "buy_time":"2021-08-17 16:57:43",
          "start_time":"2021-08-17 16:57:43",
          "end_time":"2021-09-17 16:57:43",
          "order_status":"0",
          "run_status":"1",
          "act_status":"0",
          "sync_status":"0",
          "sync_time":null,
          "renew_notice":"0",
          "renew_notice_time":null,
          "buy_remarks":"",
          "push_status":"0",
          "is_agent":"1",
          "stock_type":"1",
          "ipmi_ip":"",
          "ipmi_user":null,
          "ipmi_pass":null,
          "renew_price":"0.00",
          "renew_price_setting":"0",
          "renew_price_remark":null,
          "lock_vnc":"0",
          "is_upgrade":"0",
          "lock_status":"0",
          "lock_reason":"",
          "lock_time":null,
          "install_mode":"1",
          "renew_auto":"0",
          "ip":[
            {
              "ip":"192.168.12.48",
              "status":"1",
              "mask":"255.255.255.0",
              "gateway":"192.168.12.254",
              "create_time":"2021-08-17 16:57:43",
              "ip_num":"1",
              "is_default":"1",
              "net_type":"ip"
            }]
        }]
    }

返回值

参数 类型/长度 示例值 说明
code int 0 返回状态 0:成功 , 1:失败
message string success 反馈信息
data json json 返回的可用区结构体
data.id string 1 业务特殊id
data.guid string 1708330228791024 业务唯一GUID
data.product_guid string 1623164939837722 机型GUID
data.stock_id string 56 库存id
data.cabinet_sn string zhzy_561-2 机柜id
data.name string APIzhzy4.0 业务名称
data.line_guid string 1665907446560259 线路GUID
data.size string 2 机型尺寸 1 1U 2 2U
data.main_board string 主机1 主机型号
data.cpu_value string 4 CPU总核心数
data.cpu string CPU-4 cpu型号
data.cpu_num string 8 CPU个数
data.cpu_max_num string 16 CPU支持最大个数
data.memory string memory_64 内存型号
data.memory_num string 500 内存数量（单位G）
data.memory_max_num string 64 内存支持最大数量（单位：G）
data.harddisk_guid string 1623164948719896,1623164948719896,1623164939837722 硬盘信息，对应套餐磁盘表的guid号，多块磁盘用1,2,3表示 一个机型支持多个磁盘型号
data.harddisk_max_num string 4 硬盘支持最大块数
data.raid_tips string 否 raid支持提示
data.bandwidth string 5 带宽
data.defense string 5 防御值
data.ipnum string 否 ip数量
data.login_name string root 登陆名称
data.login_password string b86sWRX/2ibpVbKnf0w+LQ== 登陆密码 base64之后的值
data.ssh_public_key string ssh公钥
data.system_partition string 分区
data.system_partition_size string 50 系统分区的大小，以GB为单位，一般windows需要
data.buy_time string 2021-08-17 16:57:43 购买时间
data.start_time string 2021-08-17 16:57:43 业务开始时间
data.end_time string 2021-09-17 16:57:43 业务结束时间
data.order_status string 0 订单状态：0开通中 ； 1正常 ; 3已过期 ; -2已删除
data.run_status string 1 运行状态运行状态：-2 已锁定（关机状态，不能自行启动，用于过期、管理员锁定，可设置几天后自动解锁）；-1 已关机；1 运行中
data.act_status string 0 操作状态0 无操作；1 重启中;2 重装中；3 密码重设中；4 升级中；5开机中；6关机中
data.sync_status string 0 同步状态 0未同步 1已同步
data.sync_time string 0 与API最后的同步时间
data.renew_notice string 0 到期续费提醒次数
data.renew_notice_time string null 最后一次提醒时间
data.buy_remarks string null 客户新购时提出的备注需求
data.push_status string 0 push状态 0正常 1push中
data.is_agent string 1 api代理创建
data.stock_type string 1 库存销售模式 0无库存纯人工方式 1采用库存销售
data.ipmi_ip string null IPMI的IP地址(针对无库存业务)
data.ipmi_user string null IPMI用户名(针对无库存业务)
data.ipmi_pass string null IPMI密码(针对无库存业务)
data.renew_price string 1.00 固定月续费价格，在设置为固定续费价格的情况下有效，renew_price_setting为1是2位内的小数，为2时是json串
data.renew_price_setting string 1 固定价格续费设置 0 按系统自动结算 1 按月固定续费价格结算 2按自定义时长结算
data.renew_price_remark string 备注 固定价格续费设置备注
data.lock_vnc string 0 vnc锁定状态，0未锁定，1锁定
data.is_upgrade string 0 是否允许用户中心自助升级 0不允许 1允许（会同时设置固定续费价格为自动计算）
data.lock_status string 0 锁定状态：0未锁定 1已锁定
data.lock_reason string 锁定原因
data.lock_time string null 锁定时间
data.install_mode string 2 安装方式 1bios 2uefi
data.renew_auto string 2 是否自动续费 0否 1是
data.ip array [] 业务赠送的ip信息 可能存在多个
data.ip.ip string 192.168.12.48 业务赠送的ip信息
data.ip.status string 1 状态： 1 正常
data.ip.mask string 255.255.255.0 掩码
data.ip.gateway string 192.168.12.254 网关
data.ip.create_time string 2021-08-17 16:57:43 创建时间
data.ip.ip_num string 1 ip数量
data.ip.is_default string 1 是否主IP，0否1是，1台服务器只能存在1个主IP，按段的IP不能作为主IP
data.ip.net string 1 IP类型： ip 可用IP、gateway 网关、network 网络地址、broadcast广播地址

获取多个业务

请求参数

参数 必选 类型 示例值 说明
action 是 string sync_baremetal 获取单个业务
page 是 string 1 页码数
number 是 string 10 单页的数量

返回示例

    {
      "code":0,
      "message":"success",
      "data":{
        "total_number":"77",
        "total_page":1,
        "baremetal":[
            {
              "guid":"1708330228791024",
              "product_guid":"1665907642748705",
              "line_guid":"1665907446560259",
              "cabinet_sn":"zhzy_561-2",
              "name":"APIzhzy4.0",
              "size":"2",
              "main_board":"\u6807\u51c6\u578b\u4e3b\u677f\u578b\u53f71-1",
              "cpu":"CPU\u578b\u53f7-4",
              "cpu_value":"4",
              "cpu_num":"8",
              "cpu_max_num":"16",
              "memory":"\u5185\u5b58\u6df7\u5408\u578b\u53f7-max64",
              "memory_num":"500",
              "memory_max_num":"64",
              "harddisk_guid":"1623164948719896,1623164948719896,1623164939837722",
              "harddisk_max_num":"3",
              "raid_tips":"\u652f\u6301",
              "bandwidth":"5",
              "defense":"5",
              "ipnum":"1",
              "system_id":"160",
              "login_name":"root",
              "buy_time":"2021-08-17 16:57:43",
              "start_time":"2021-08-17 16:57:43",
              "end_time":"2021-09-17 16:57:43",
              "order_status":"1",
              "run_status":"1",
              "act_status":"0",
              "buy_remarks":"",
              "ip":[
                {
                  "ip":"192.168.12.48",
                  "status":"1",
                  "mask":"255.255.255.0",
                  "gateway":"192.168.12.254",
                  "create_time":"2021-08-17 16:57:43",
                  "ip_num":"1",
                  "is_default":"1",
                  "net_type":"ip"
                }],
              "system_guid":"1633652801461868",
              "upgrade":[
                     {
                      "type":"ipnum",
                      "degrade_guid":null,
                      "nums":"8",
                      "value":"114.114.8.16-23",
                      "status":"1",
                      "order_no_api":"160682598814128134",
                      "create_time":"2021-08-18 10:46:54"
                    }
              ],
              "degrades":[
                  {
                      "id":"122",
                      "guid":"1708398791975293",
                      "baremetal_guid":"1708330228791024",
                      "item":"bandwidth",
                      "status":"0",
                      "reason":"\u9884\u7ea6\u964d\u914d\uff1a\u5e26\u5bbd",
                      "apply_time":"2021-09-02 11:03:00",
                      "create_time":"2021-08-18 11:07:30",
                      "finish_time":null,
                      "value":"1",
                      "new_value":"5",
                      "old_value":"6"
                    }
              ]
            }
        ]
      }
    }

返回值

参数 类型/长度 示例值 说明
code int 0 返回状态 0:成功 , 1:失败
message string success 反馈信息
data json json 返回的可用区结构体
data.total_number string 1 页码数
data.total_page string 77 总数
data.baremetal.guid string 1708330228791024 业务唯一GUID
data.baremetal.product_guid string 1623164939837722 机型GUID
data.baremetal.cabinet_sn string zhzy_561-2 机柜id
data.baremetal.name string APIzhzy4.0 业务名称
data.baremetal.line_guid string 1665907446560259 线路GUID
data.baremetal.size string 2 机型尺寸 1 1U 2 2U
data.baremetal.main_board string 主机1 主机型号
data.baremetal.cpu_value string 4 CPU总核心数
data.baremetal.cpu string CPU-4 cpu型号
data.baremetal.cpu_num string 8 CPU个数
data.baremetal.memory string memory_64 内存型号
data.baremetal.memory_num string 500 内存数量（单位G）
data.baremetal.memory_max_num string 64 内存支持最大数量（单位：G）
data.baremetal.harddisk_guid string 1623164948719896,1623164948719896,1623164939837722 硬盘信息，对应套餐磁盘表的guid号，多块磁盘用1,2,3表示 一个机型支持多个磁盘型号
data.harddisk_max_num string 4 硬盘支持最大块数
data.baremetal.raid_tips string 否 raid支持提示
data.baremetal.bandwidth string 5 带宽
data.baremetal.defense string 5 防御值
data.baremetal.ipnum string 否 ip数量
data.baremetal.login_name string root 登陆名称
data.baremetal.buy_time string 2021-08-17 16:57:43 购买时间
data.baremetal.start_time string 2021-08-17 16:57:43 业务开始时间
data.baremetal.end_time string 2021-09-17 16:57:43 业务结束时间
data.baremetal.order_status string 0 订单状态：0开通中 ； 1正常 ; 3已过期 ; -2已删除
data.baremetal.run_status string 1 运行状态运行状态：-2 已锁定（关机状态，不能自行启动，用于过期、管理员锁定，可设置几天后自动解锁）；-1 已关机；1 运行中
data.baremetal.act_status string 0 操作状态0 无操作；1 重启中;2 重装中；3 密码重设中；4 升级中；5开机中；6关机中
data.baremetal.buy_remarks string null 客户新购时提出的备注需求
data.baremetal.ip array [] 业务赠送的ip信息 可能存在多个
data.baremetal.ip.ip string 192.168.12.48 业务赠送的ip信息
data.baremetal.ip.status string 1 状态： 1 正常
data.baremetal.ip.mask string 255.255.255.0 掩码
data.baremetal.ip.gateway string 192.168.12.254 网关
data.baremetal.ip.create_time string 2021-08-17 16:57:43 创建时间
data.baremetal.ip.ip_num string 1 ip数量
data.baremetal.ip.is_default string 1 是否主IP，0否1是，1台服务器只能存在1个主IP，按段的IP不能作为主IP
data.baremetal.ip.net string 1 IP类型： ip 可用IP、gateway 网关、network 网络地址、broadcast广播地址data.baremetal.upgrade
data.baremetal.upgrade.type string ipnum 升级类型：bandwidth带宽，defense防御，ip ipnum
data.baremetal.upgrade.degrade_guid string null 对应的裸金属降配表guid（可能作为升级记录的唯一表示）
data.baremetal.upgrade.nums string 8 升级的数量
data.baremetal.upgrade.value string 114.114.8.16-23 可能是ip信息 也可能是值
data.baremetal.upgrade.status string 1 状态 1生效 0无效
data.baremetal.upgrade.order_no_api string 160682598814128134 上级返回的订单编号（可能作为升级记录的唯一表示）
data.baremetal.create_time string 160682598814128134 订单创建时间
data.baremetal.degrades json {} 降配信息的集合
data.baremetal.degrades.id string 122 降配信息的id
data.baremetal.degrades.guid string 1708398791975293 降配的唯一guid
data.baremetal.degrades.baremetal_guid string 1708330228791024 业务的GUID
data.baremetal.degrades.item sring bandwidth 降配项目 bandwidth带宽 defense防御 ip
data.baremetal.degrades.status sring 0 状态 0：待执行 1：处理完成 -1：已取消
data.baremetal.degrades.reason sring 降配的信息 备注
data.baremetal.degrades.apply_time sring 2021-09-02 11:03:00 申请执行时间
data.baremetal.degrades.create_time sring 2021-08-18 11:07:30 创建时间
data.baremetal.degrades.finish_time sring null 完成时间
data.baremetal.degrades.value sring 1 降配值
data.baremetal.degrades.new_value sring 5 降配后的值
data.baremetal.degrades.old_value sring 6 降配前的值

获取单个业务

请求参数

参数 必选 类型 示例值 说明
action 是 string sync_baremetal 获取单个业务
guid 是 string 1708330228791024 业务GUID
page 是 string 1 页面数
page_size 是 string 10 页面尺寸

返回示例

    {
      "code":0,
      "message":"success",
      "data":{
        "baremetal":{
          "guid":"1708330228791024",
          "product_guid":"1665907642748705",
          "line_guid":"1665907446560259",
          "cabinet_sn":"zhzy_561-2",
          "client_user_id":1601638,
          "size":"2",
          "main_board":"\u6807\u51c6\u578b\u4e3b\u677f\u578b\u53f71-1",
          "cpu":"CPU\u578b\u53f7-4",
          "cpu_value":"4",
          "cpu_num":"8",
          "cpu_max_num":"16",
          "memory":"\u5185\u5b58\u6df7\u5408\u578b\u53f7-max64",
          "memory_num":"500",
          "memory_max_num":"64",
          "harddisk_guid":"1623164948719896,1623164948719896,1623164939837722",
          "harddisk_max_num":"3",
          "raid_tips":"\u652f\u6301",
          "bandwidth":"5",
          "defense":"5",
          "ipnum":"1",
          "system_id":"160",
          "login_name":"root",
          "buy_time":"2021-08-17 16:57:43",
          "start_time":"2021-08-17 16:57:43",
          "end_time":"2021-09-17 16:57:43",
          "order_status":"1",
          "run_status":"1",
          "act_status":"0",
          "buy_remarks":"",
          "ip":[
            {
              "ip":"192.168.12.48",
              "status":"1",
              "mask":"255.255.255.0",
              "gateway":"192.168.12.254",
              "create_time":"2021-08-17 16:57:43",
              "ip_num":"1",
              "is_default":"1",
              "net_type":"ip"
            }],
          "system_guid":"1633652801461868",
          "upgrade":[
                 {
                  "type":"ipnum",
                  "degrade_guid":null,
                  "nums":"8",
                  "value":"114.114.8.16-23",
                  "status":"1",
                  "order_no_api":"160682598814128134",
                  "create_time":"2021-08-18 10:46:54"
                }
          ],
          "degrades":[
              {
                  "id":"122",
                  "guid":"1708398791975293",
                  "baremetal_guid":"1708330228791024",
                  "item":"bandwidth",
                  "status":"0",
                  "reason":"\u9884\u7ea6\u964d\u914d\uff1a\u5e26\u5bbd",
                  "apply_time":"2021-09-02 11:03:00",
                  "create_time":"2021-08-18 11:07:30",
                  "finish_time":null,
                  "value":"1",
                  "new_value":"5",
                  "old_value":"6"
                }
          ]
        }
      }
    }

返回值

参数 类型/长度 示例值 说明
code int 0 返回状态 0:成功 , 1:失败
message string success 反馈信息
data json json 返回的可用区结构体
data.baremetal json json 业务信息的结构体
data.baremetal.guid string 1708330228791024 业务唯一GUID
data.baremetal.product_guid string 1623164939837722 机型GUID
data.baremetal.cabinet_sn string zhzy_561-2 机柜id
data.baremetal.line_guid string 1665907446560259 线路GUID
data.baremetal.size string 2 机型尺寸 1 1U 2 2U
data.baremetal.main_board string 主机1 主机型号
data.baremetal.cpu_value string 4 CPU总核心数
data.baremetal.cpu string CPU-4 cpu型号
data.baremetal.cpu_num string 8 CPU个数
data.baremetal.memory string memory_64 内存型号
data.baremetal.memory_num string 500 内存数量（单位G）
data.baremetal.memory_max_num string 64 内存支持最大数量（单位：G）
data.baremetal.harddisk_guid string 1623164948719896,1623164948719896,1623164939837722 硬盘信息，对应套餐磁盘表的guid号，多块磁盘用1,2,3表示 一个机型支持多个磁盘型号
data.harddisk_max_num string 4 硬盘支持最大块数
data.baremetal.raid_tips string 否 raid支持提示
data.baremetal.bandwidth string 5 带宽
data.baremetal.defense string 5 防御值
data.baremetal.ipnum string 否 ip数量
data.baremetal.login_name string root 登陆名称
data.baremetal.buy_time string 2021-08-17 16:57:43 购买时间
data.baremetal.start_time string 2021-08-17 16:57:43 业务开始时间
data.baremetal.end_time string 2021-09-17 16:57:43 业务结束时间
data.baremetal.order_status string 0 订单状态：0开通中 ； 1正常 ; 3已过期 ; -2已删除
data.baremetal.run_status string 1 运行状态运行状态：-2 已锁定（关机状态，不能自行启动，用于过期、管理员锁定，可设置几天后自动解锁）；-1 已关机；1 运行中
data.baremetal.act_status string 0 操作状态0 无操作；1 重启中;2 重装中；3 密码重设中；4 升级中；5开机中；6关机中
data.baremetal.buy_remarks string null 客户新购时提出的备注需求
data.baremetal.ip array [] 业务赠送的ip信息 可能存在多个
data.baremetal.ip.ip string 192.168.12.48 业务赠送的ip信息
data.baremetal.ip.status string 1 状态： 1 正常
data.baremetal.ip.mask string 255.255.255.0 掩码
data.baremetal.ip.gateway string 192.168.12.254 网关
data.baremetal.ip.create_time string 2021-08-17 16:57:43 创建时间
data.baremetal.ip.ip_num string 1 ip数量
data.baremetal.ip.is_default string 1 是否主IP，0否1是，1台服务器只能存在1个主IP，按段的IP不能作为主IP
data.baremetal.ip.net string 1 IP类型： ip 可用IP、gateway 网关、network 网络地址、broadcast广播地址data.baremetal.upgrade
data.baremetal.upgrade.type string ipnum 升级类型：bandwidth带宽，defense防御，ip ipnum
data.baremetal.upgrade.degrade_guid string null 对应的裸金属降配表guid（可能作为升级记录的唯一表示）
data.baremetal.upgrade.nums string 8 升级的数量
data.baremetal.upgrade.value string 114.114.8.16-23 可能是ip信息 也可能是值
data.baremetal.upgrade.status string 1 状态 1生效 0无效
data.baremetal.upgrade.order_no_api string 160682598814128134 上级返回的订单编号（可能作为升级记录的唯一表示）
data.baremetal.create_time string 160682598814128134 订单创建时间
data.baremetal.degrades json {} 降配信息的集合
data.baremetal.degrades.id string 122 降配信息的id
data.baremetal.degrades.guid string 1708398791975293 降配的唯一guid
data.baremetal.degrades.baremetal_guid string 1708330228791024 业务的GUID
data.baremetal.degrades.item sring bandwidth 降配项目 bandwidth带宽 defense防御 ip
data.baremetal.degrades.status sring 0 状态 0：待执行 1：处理完成 -1：已取消
data.baremetal.degrades.reason sring 降配的信息 备注
data.baremetal.degrades.apply_time sring 2021-09-02 11:03:00 申请执行时间
data.baremetal.degrades.create_time sring 2021-08-18 11:07:30 创建时间
data.baremetal.degrades.finish_time sring null 完成时间
data.baremetal.degrades.value sring 1 降配值
data.baremetal.degrades.new_value sring 5 降配后的值
data.baremetal.degrades.old_value sring 6 降配前的值

升级

特殊限制说明

  • 升级的内容，带宽，ip,防御不能同时为空；
  • 业务+升级数据等到总升级数据，其中带宽，防御，ip 和不能超出线路的最大值的限制，防御还受步长的限制；
  • 业务处于未删除状态，并且非push状态，操作状态处于正常；
  • 需要满足 ip 与带宽的比例，即 带宽/ip >= 线路 ip_bandwidth_rate；

请求参数

参数 必选 类型 示例值 说明
action 是 string upgrade 升级
guid 是 string 1708330228791024 业务GUID
defense 是 string 5 升级的防御配置
bandwidth 是 string 1 升级的带宽配置
ip_type 是 string 2 1为单ip ；2为子网
ipnum 是 string 8 升级的ip数量配置
clientOrderNo 是 string 18369 客户端订单id
clientUserId 是 string 1100123 客户userid
agent_order_no 是 string 590682534662098123 客户端订单GUID

返回示例

     {
      "code":0,
      "message":"success",
      "data":{
        "order_no_api":"160682598814128134",
        "ip":[
          {
            "id":"11866",
            "ip":"114.114.8.16",
            "mask":"255.255.255.248",
            "gateway":"114.114.8.17",
            "net_type":"network"
          },
          {
            "id":"11867",
            "ip":"114.114.8.17",
            "mask":"255.255.255.248",
            "gateway":"114.114.8.17",
            "net_type":"gateway"
          },
          {
            "id":"11868",
            "ip":"114.114.8.18",
            "mask":"255.255.255.248",
            "gateway":"114.114.8.17",
            "net_type":"ip"
          },
          {
            "id":"11869",
            "ip":"114.114.8.19",
            "mask":"255.255.255.248",
            "gateway":"114.114.8.17",
            "net_type":"ip"
          },
          {
            "id":"11870",
            "ip":"114.114.8.20",
            "mask":"255.255.255.248",
            "gateway":"114.114.8.17",
            "net_type":"ip"
          },
          {
            "id":"11871",
            "ip":"114.114.8.21",
            "mask":"255.255.255.248",
            "gateway":"114.114.8.17",
            "net_type":"ip"
          },
          {
            "id":"11872",
            "ip":"114.114.8.22",
            "mask":"255.255.255.248",
            "gateway":"114.114.8.17",
            "net_type":"ip"
          },
          {
            "id":"11873",
            "ip":"114.114.8.23",
            "mask":"255.255.255.248",
            "gateway":"114.114.8.17",
            "net_type":"broadcast"
          }]
      }
    }

返回值

参数 类型/长度 示例值 说明
code int 0 返回状态 0:成功 , 1:失败
message string success 反馈信息
data json json 返回的结构体
data.order_no_api string 160682598814128134 api返回的订单号
data.ip json json 返回的ip集合
data.id string 11866 ip特殊id
data.ip string 114.114.8.16 ip信息
data.mask string 255.255.255.248 mask地址
data.gateway string 114.114.8.16 网关地址
data.net_type string network IP类型： ip 可用IP、gateway 网关、network 网络地址、broadcast广播地址

获取可降配ip列表

请求参数

参数 必选 类型 示例值 说明
action 是 string degrade_ip_list 获取降配ip列表
guid 是 string 1708330228791024 业务GUID

返回示例

    {
      "code":0,
      "message":"success",
      "data":[
        {
          "ip":"192.168.12.48",
          "mask":"255.255.255.0",
          "gateway":"192.168.12.254"
        },
        {
          "ip":"114.114.8.16-23",
          "mask":"255.255.255.248",
          "gateway":"114.114.8.17"
        }]
    }

返回值

参数 类型/长度 示例值 说明
code int 0 返回状态 0:成功 , 1:失败
message string success 反馈信息
data json json 返回的结构体
data.ip string 114.114.8.16-23 可降配的ip信息
data.mask string 255.255.255.248 mask地址
data.gateway string 114.114.8.17 网关

预约降配

降配限制说明

  • 降配的数据，都是与升级记录一一对应，必须先有过升级记录才可以降配，例如：升级5M带宽 才能对应降配5M带宽
  • 降配的内容，带宽，ip,防御不能同时为空；
  • 需要满足 ip 与带宽的比例，即 带宽/ip >= 线路 ip_bandwidth_rate；
  • 业务处于未删除状态，并且非push状态，操作状态处于正常；

请求参数

{
  "userid":"1100134",
  "action":"degrade",
  "dataType":"json",
  "sign":"35b7bda33d096982d4f299e9a082062e",
  "module":"baremetal",
  "time":1629256049,
  "guid":"1708330228791024",
  "defense":5,
  "bandwidth":1,
  "ipnum":8,
  "param":[
    {
      "item":"bandwidth",
      "value":1,
      "date":"2021-09-02 11:03:00",
      "old_value":6,
      "new_value":"5"
    },
    {
      "item":"ip",
      "value":[
        "114.114.8.16-23"],
      "date":"2021-09-02 11:03:00",
      "new_value":8
    },
    {
      "item":"defense",
      "value":5,
      "date":"2021-09-02 11:03:00",
      "old_value":10,
      "new_value":"5"
    }],
  "version":"9.9.9",
  "__version__":"9.9.9",
  "__system_type__":"zkeys_agent_multi",
  "vtime":"20210713"
}
参数 必选 类型 示例值 说明
action 是 string degrade 降配
guid 是 string 1708330228791024 业务GUID
defense 是 string 5 降配的防御配置
bandwidth 是 string 1 降配的带宽配置
ipnum 是 string 8 降配的ip数量配置
param 是 array [] 降配的信息集合
param.item 是 string bandwidth 具体配置 bandwidth 带宽；ip ip配置；defense 防御
param.value 是 string ["114.114.8.16-23","114.114.8.24"] 降配具体的值，如果是IP则是具体降配ip的信息
param.date 是 string 2021-09-02 11:03:00 执行降配的日期
param.old_value 是 string 6 降配之前的值
param.new_value 是 string 5 降配之后的值
auth_client_user_id 否 string 1 授权认证的客户端id
auth_name 否 string 小鸟云 授权认证用户名
auth_mobile 否 string 137xxxxxxxx 授权认证手机号(11位手机号)
auth_idnum 否 string 421xxxxxxxxxxxxx 授权认证身份证
auth_from_ip 否 string 421xxxxxxxxxxxxx 授权端本地ip
auth_qq 否 string 4210xxxxx 授权认证qq

返回示例

     {
      "code":0,
      "message":"success",
      "data":{
        "result":true,
        "text":"success",
        "data":{
          "bandwidth":"1708398791975293",
          "ip":"1708398791979180",
          "defense":"1708398791985048"
        }
      }
    }

返回值

参数 类型/长度 示例值 说明
code int 0 返回状态 0:成功 , 1:失败
message string success 反馈信息
data json json 返回的结构体
data.data json json 返回的结构体
data.data.bandwidth string 1708398791975293 api生成带宽降配的唯一GUID (获取单个业务也可以获取该降配信息)
data.data.ip string 1708398791979180 api生成ip降配的唯一GUID (获取单个业务也可以获取该降配信息)
data.data.defense string 1708398791985048 api生成防御降配的唯一GUID (获取单个业务也可以获取该降配信息)

取消降配

请求参数

参数 必选 类型 示例值 说明
action 是 string degrade_cancel 取消降配
guid 是 string 1708330228791024 业务GUID
degrade_guid 是 string 1708398791985048 降配的GUID,申请预约降配时，api返回的信息

返回示例

     {
      "code":0,
      "message":"success",
      "data":{
      }
    }

返回值

参数 类型/长度 示例值 说明
code int 0 返回状态 0:成功 , 1:失败
message string success 反馈信息
data json json 返回的结构体

关机

特殊限制说明

  • 业务操作状态必须处于正常才可以操作

请求参数

参数 必选 类型 示例值 说明
action 是 string stop 关机
guid 是 string 1708330228791024 业务GUID

返回示例

     {
          "code":0,
          "message":"success",
          "data":{
          }
     }

返回值

参数 类型/长度 示例值 说明
code int 0 返回状态 0:成功 , 1:失败
message string success 反馈信息
data json json 返回的结构体

开机

特殊限制说明

  • 关机状态下可操作

请求参数

参数 必选 类型 示例值 说明
action 是 string start 开机
guid 是 string 1708330228791024 业务GUID

返回示例

     {
          "code":0,
          "message":"success",
          "data":{
          }
     }

返回值

参数 类型/长度 示例值 说明
code int 0 返回状态 0:成功 , 1:失败
message string success 反馈信息
data json json 返回的结构体

重启

特殊限制说明

  • 业务状态正常下 可操作

请求参数

参数 必选 类型 示例值 说明
action 是 string restart 重启
guid 是 string 1708330228791024 业务GUID

返回示例

     {
          "code":0,
          "message":"success",
          "data":{
          }
     }

返回值

参数 类型/长度 示例值 说明
code int 0 返回状态 0:成功 , 1:失败
message string success 反馈信息
data json json 返回的结构体

续费

特殊限制说明

  • 关机状态下可操作

请求参数

参数 必选 类型 示例值 说明
action 是 string renew 续费
guid 是 string 1708330228791024 业务GUID
months 是 string 1 月份数
clientOrderNo 是 string 440682612532605123 客户端订单号
agent_order_no 是 string 440682612532605123 客户端订单号

返回示例

     {
          "code":0,
          "message":"success",
          "data":{
            "end_time":"2021-10-17 16:57:43"
          }
     }

返回值

参数 类型/长度 示例值 说明
code int 0 返回状态 0:成功 , 1:失败
message string success 反馈信息
data json json 返回的结构体
data string end_time 2021-10-17 16:57:43

重设密码

特殊限制说明

  • 关机状态下可操作

请求参数

参数 必选 类型 示例值 说明
action 是 string setpass 重设密码
guid 是 string 1708330228791024 业务GUID
loginPassword 是 string YTUzNTAyOTI3OSE= base64之后的密码

返回示例

{
    "code":0,
    "message":"success",
    "data":{
    }
}

返回值

参数 类型/长度 示例值 说明
code int 0 返回状态 0:成功 , 1:失败
message string success 反馈信息
data json json 返回的结构体
data string end_time 2021-10-17 16:57:43

重装系统

特殊限制说明

  • 关机状态或者业务状态正常下可操作

请求参数

参数 必选 类型 示例值 说明
action 是 string install 重装
guid 是 string 1708330228791024 业务GUID
systemGuid 是 string 1633652801461868 操作系统的GUID
loginPassword 是 string YTUzNTAyOTI3OSE= 操作设置的密码 base64之后的数据
system_partition_size 是 string 0 等于-1 表示全盘分区 0 表示使用第一分区；其它表示自定义分区，具体的磁盘大小 M单位
installType 是 string install 重装类型 重新分区或者操作系统类型不一致时，需要replace,否则install
install_mode 是 string 1 默认引导方式 目前只支持1

返回示例

{
    "code":0,
    "message":"success",
    "data":{
    }
}

返回值

参数 类型/长度 示例值 说明
code int 0 返回状态 0:成功 , 1:失败
message string success 反馈信息
data json json 返回的结构体

退款

请求参数

参数 必选 类型 示例值 说明
module 是 string common 模块 （替换公共参数中的module值）
action 是 string refund 续费
guid 是 string 1708330228791024 业务GUID
productType 是 string baremetal 业务类型 裸金属

返回示例

     {
          "code":0,
          "message":"success",
          "data":{
          }
     }

返回值

参数 类型/长度 示例值 说明
code int 0 返回状态 0:成功 , 1:失败
message string success 反馈信息
data json json 返回的结构体