港云网络 · API 参考文档
财务系统对接 · 数据同步与业务操作接口
本接口用于 港云网络 财务系统之间的数据同步与业务操作对接。通过统一的入口接收请求,根据 action 参数路由到对应的处理方法。
appid(用户ID)和 appkey(API密钥)。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid |
string | 是 | 用户ID |
appkey |
string | 是 | API密钥 |
action |
string | 是 | 接口方法名(如 getzones、server_start 等) |
guid |
string | 否 | 数据标识,自动去除前缀(支持下划线格式) |
其他参数 |
mixed | 视接口而定 | 各 action 特有的参数 |
application/x-www-form-urlencoded 或 multipart/form-data。
所有接口返回统一 JSON 格式:
以下接口返回系统公共基础数据,适用于所有服务器业务类型。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | getcolumn |
| 字段 | 类型 | 说明 |
|---|---|---|
id | int | 地域ID |
status | int | 状态 0禁用 1正常 |
sort | int | 排序 |
name | string | 地域名称 |
content | string | 备注 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | getzones |
| 字段 | 类型 | 说明 |
|---|---|---|
column_id | int | 所属地域ID |
status | int | 状态 0禁用 1正常 |
guid | string | 可用区GUID |
name | string | 可用区名称 |
identityStatus | int | 强制实名认证 1:是 0:否 |
whiteListStatus | int | 强制提交白名单 1:是 0:否 |
sort | int | 排序 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | getsystems |
| 字段 | 类型 | 说明 |
|---|---|---|
type_id | int | 操作系统类型ID(1Windows 2Linux等) |
status | int | 状态 0禁用 1正常 |
guid | string | 系统GUID |
name | string | 系统名称 |
login_name | string | 默认登录名称(administrator/root) |
login_password | string | 默认登录密码 |
port | string | 远程登录端口 |
mirror_name | string | 镜像名称 |
cpu_limit | int | CPU最低限制(0为不限制) |
ram_limit | int | 内存最低限制(0为不限制) |
type | string | 支持的操作类型(create创建, install重装) |
system_harddisk | int | 系统盘大小(GB) |
support | string | 支持的业务类型(server云服务器, lease物理服务器, idc托管) |
lines | string | 可用区GUID列表(JSON数组) |
sort | int | 排序 |
create_time | datetime | 创建时间 |
update_time | datetime | 更新时间 |
type_name | string | 操作系统类型名称(如Windows、Linux) |
zone_names | string | 可用区名称(多个用"、"分隔) |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | getlines |
| 字段 | 类型 | 说明 |
|---|---|---|
guid | string | 线路GUID |
line_guid | string | 可用区GUID |
name | string | 线路名称 |
descript | string | 线路描述 |
introUrl | string | 机房介绍链接 |
buyStatus | int | 购买状态 1开放 0关闭 |
upgradeStatus | int | 升级状态 1开放 0关闭 |
renewStatus | int | 续费状态 1开放 0关闭 |
harddiskMinNum | int | 磁盘可挂载数量最小值 |
harddiskMaxNum | int | 磁盘可挂载数量最大值 |
harddiskMinSize | int | 磁盘最小容量(G) |
harddiskMaxSize | int | 磁盘最大容量(G) |
harddiskStep | int | 磁盘容量步长 |
harddiskPrice | decimal | 磁盘单价(元/1G) |
harddisk_free_size | int | 赠送硬盘容量 |
bandwidthMinSize | int | 带宽最小值(M) |
bandwidthMaxSize | int | 带宽最大值(M) |
bandwidth_free_size | int | 赠送带宽(M) |
bandwidth_in_type | int | 下行限制类型 1固定值 2对等阈值 |
bandwidth_in_value | int | 带宽下行限制值(M) |
bandwidth6Price | decimal | 5-6M带宽价格(元/月) |
bandwidth_stairs_price | text | 带宽阶梯价格JSON |
defenseMinSize | int | 防御最小值(G) |
defenseMaxSize | int | 防御最大值(G) |
defenseFreeSize | int | 免费防御值(G) |
defense_size | varchar | 防御值可选合集 |
defensePrice | decimal | 每G防御价格 |
months | string | 可购买月份数(1,2,3,6,12,24,36) |
status | int | 状态 1启用 0禁用 |
markup | decimal | 销售折扣 |
discount | text | 折扣配置JSON |
lines_product_type | string | 线路类型 1弹性 2套餐 |
core_price_data | text | 核心配置JSON |
core_list | text | 价格参数JSON 核心数=cpu,内存=ram,售价=price,status=0关闭,status=1开启 |
append_ip_status | tinyint | 是否支持附加IP(1=支持) |
append_ip_price | decimal | 附加IP单价(元/个/月) |
max_ip | int | 最大IP数量 |
functions | varchar | 支持功能 VNC=setvnc,监控=resource_display,安全组=security_policy |
retention_days | int | 到期保留天数 |
vnc_status(弃用) | tinyint | VNC 是否可用(0不可用,1可用) |
vnc_url(弃用) | varchar | VNC 地址 |
server_lines 中 open_api = 1 的线路数据。
返回 server_lines 中 open_api = 1 的线路数据。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | getproduct |
| 字段 | 类型 | 说明 |
|---|---|---|
name | string | 套餐名称 |
cpu | int | CPU核心数 |
memory | int | 内存大小(GB) |
systemdisk | int | 系统盘大小(GB) |
harddisk | int | 数据盘大小(GB) |
ipnum | int | IP数量 |
bandwidth | int | 带宽(Mbps) |
defense | int | 防御值(G) |
price | decimal | 套餐价格(元/月) |
description | string | 产品描述 |
sort | int | 排序(数值越小越靠前) |
status | int | 状态 0禁用 1正常 |
lines_guid | string | 所属线路GUID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | getserver |
guid | int | 是 | 订单ID |
| 字段 | 类型 | 说明 |
|---|---|---|
id | int | 订单ID |
client_user_id | int | 客户方用户ID |
need_reset_vnc | int | 是否需要重置VNC |
line_guid | string | 线路GUID |
lineID | int | 线路ID |
system_guid | string | 操作系统GUID |
ip | string | IP地址 |
localIP | string | 内网IP |
cpu | int | CPU核心数 |
memory | int | 内存大小(GB) |
harddisks | string | 磁盘大小(逗号分隔) |
bandwidth | int | 带宽(Mbps) |
in_bandwidth | string | 下行带宽值 |
defense | int | 防御值(G) |
loginName | string | 远程登录用户名 |
loginPassword | string | 登录密码 |
buyTime | datetime | 购买时间 |
endTime | datetime | 到期时间 |
orderStatus | int | 业务状态 -2已删除 -1已回收 0开通中 1正常 3已过期 |
runStatus | int | 运行状态 -2已锁定 -1已关机 1运行中 |
actStatus | int | 操作状态 0正常 3启动中 4关机中 5重启中 |
snapStatus | int | 快照状态 0正常 1快照中 2恢复中 |
vnc_port | int | VNC端口 |
share_type | int | 共享类型 0独享 1共享 |
login_port | int | 登录端口 |
share_ip | string | 共享业务时的公网IP:端口 |
append_ip | text | 附加IP列表JSON |
securityPolicyList | text | 安全策略信息JSON |
port | text | 端口转发记录JSON |
api_type | string | API接口类型 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | getservers |
page | int | 否 | 页码,每页100条 |
| 字段 | 类型 | 说明 |
|---|---|---|
pages | int | 总页数 |
servers | array | 服务器订单列表(字段同getserver) |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | create_order |
obj_type | string | 是 | create_server |
user_id | int | 是 | 客户用户ID |
order_id | string | 是 | 客户订单号 |
content | object | 是 | JSON对象,包含以下子字段: |
content.cpu | int | 是 | CPU核心数 |
content.ram | int | 是 | 内存大小(GB) |
content.bandwidth | int | 是 | 带宽(Mbps) |
content.harddisksValues | string | 是 | 硬盘数据,格式如 "40,80"(逗号分隔多块硬盘大小GB) |
content.defense | int | 是 | 防御值(G) |
content.ip_num | int | 否 | IP数量,默认1 |
content.months | int | 否 | 购买月数,默认1 |
content.number | int | 否 | 购买数量,默认1 |
content.renew_auto | int | 否 | 是否自动续费,默认0 |
content.loginPassword | string | 否 | 登录密码,不传则自动生成 |
line_guid | string | 是 | 线路GUID |
system_guid | string | 是 | 系统GUID |
说明:content 字段为一个完整的 JSON 对象,需整体传入,如上表所示。示例:{"cpu":4,"ram":8,"bandwidth":10,"harddisksValues":"40,80","defense":5,"ip_num":1}
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | server_start |
guid | int | 是 | 订单ID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | server_stop |
guid | int | 是 | 订单ID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | server_restart |
guid | int | 是 | 订单ID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | server_install |
guid | int | 是 | 订单ID |
systemID | string | 是 | 系统GUID |
password | string | 是 | 新密码 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | server_upgrade |
guid | int | 是 | 订单ID |
cpu | int | 是 | 新CPU(不低于原值) |
memory | int | 是 | 新内存GB |
bandwidth | int | 是 | 新带宽Mbps |
defense | int | 是 | 新防御G |
harddisks | string | 是 | 新硬盘(逗号分隔) |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | server_renew |
guid | int | 是 | 订单ID |
renewLength | int | 是 | 续费月数 |
client_order_id | string | 是 | 客户方订单号 |
client_user_id | int | 是 | 客户方用户ID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | server_getvncurl |
guid | int | 是 | 订单ID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | server_setpsw |
guid | int | 是 | 订单ID |
password | string | 是 | 新密码 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | server_setvnc |
guid | int | 是 | 订单ID |
password | string | 是 | 新VNC密码 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | get_server_chart |
guid | int | 是 | 订单ID |
start_time | string | 是 | 开始时间(毫秒级时间戳) |
end_time | string | 是 | 结束时间(毫秒级时间戳) |
| 字段 | 类型 | 说明 |
|---|---|---|
date | array | 时间点列表,如 ["2026-05-25 10:00","2026-05-25 10:05",...] |
in | array | 入流量数据列表(bps),与date一一对应 |
out | array | 出流量数据列表(bps),与date一一对应 |
start_time | string | 查询开始时间 |
end_time | string | 查询结束时间 |
unit | string | 流量单位,固定为 bps |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | get_security_policy |
guid | int | 是 | 订单ID |
| 字段 | 类型 | 说明 |
|---|---|---|
id | int | 安全组ID |
product_id | int | 关联产品ID |
guid | string | 安全组GUID |
name | string | 安全组规则名称 |
weight | int | 优先级顺序(数值越小优先级越高) |
direction | string | 方向:Inbound(入方向)、Outbound(出方向) |
protocol | string | 协议:tcp、udp、icmp |
action | string | 行为:allow(允许)、deny(拒绝) |
remote_ip | string | 授权IP地址或IP段 |
local_port | string | 本地端口 |
service_type | string | 业务类型(server等) |
status | int | 状态 |
create_time | datetime | 创建时间 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | server_add_hardpolicy |
guid | int | 是 | 订单ID |
name | string | 是 | 规则名称 |
weight | int | 是 | 权重 |
direction | string | 是 | Inbound/Outbound |
operation | string | 是 | allow/deny |
protocol | string | 是 | tcp/udp/icmp |
remote_ip | string | 是 | 授权IP |
local_port | string | 是 | 端口 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | server_del_hardpolicy |
guid | int | 是 | 订单ID |
policy_guid | string | 是 | 安全组GUID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | server_refund |
guid | int | 是 | 订单ID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | lease_lines |
| 字段 | 类型 | 说明 |
|---|---|---|
guid | string | 线路GUID |
line_guid | string | 可用区GUID |
status | int | 状态 1启用 0禁用 |
name | string | 线路名称 |
descript | string | 线路描述 |
buy_status | int | 购买状态 |
renew_status | int | 续费状态 |
upgrade_status | int | 升级状态 |
bandwidth_price | decimal | 带宽价格(元/M/月) |
ip_price | decimal | IP价格(元/月) |
defense_price | string | 防御价格(元/G/月) |
months | string | 可购买月份数 |
retention_days | int | 到期保留天数 |
discount1 | decimal | 满一年折扣 |
discount2 | decimal | 满两年折扣 |
discount3 | decimal | 满三年折扣 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | lease_harddisk |
| 字段 | 类型 | 说明 |
|---|---|---|
guid | string | 硬盘GUID |
type | string | 磁盘类型(SSD/HDD/SATA/SAS) |
size | int | 硬盘大小(GB) |
status | int | 状态 1显示 0隐藏 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | lease_product |
| 字段 | 类型 | 说明 |
|---|---|---|
product_type | string | 机型类型(local自产/zkeys/niaoyun) |
guid | string | 机型GUID |
name | string | 机型名称 |
line_guid | string | 线路GUID |
cpu_value | int | CPU总核心数 |
cpu | string | CPU型号 |
cpu_num | int | CPU个数 |
memory | string | 内存型号 |
ipnum | string | IP数量 |
bandwidth | int | 带宽(Mbps) |
defense | int | 防御值(G) |
price | decimal | 月付价格(元) |
size | int | 机箱尺寸(1=1U 2=2U) |
status | int | 状态 0禁用 1正常 |
upgrade_status | int | 升级开关 0不支持 1支持 |
line_names | string | 线路名称(多个用"、"分隔) |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | getlease |
guid | int | 是 | 订单ID |
| 字段 | 类型 | 说明 |
|---|---|---|
id | int | 订单ID |
product_guid | string | 机型GUID |
line_guid | string | 线路GUID |
name | string | 服务器名称 |
size | int | 机型尺寸 1=1U 2=2U |
cabinet_sn | string | 机柜ID |
main_board | string | 主机型号 |
cpu_value | int | CPU总核心数 |
cpu | string | CPU型号 |
cpu_num | int | CPU个数 |
memory | string | 内存型号 |
memory_num | int | 内存数量(GB) |
bandwidth | int | 带宽(Mbps) |
defense | int | 防御值(G) |
ipnum | int | IP数量 |
login_name | string | 登录用户名 |
login_password | string | 登录密码 |
system_port | string | 远程端口 |
buy_time | datetime | 购买时间 |
end_time | datetime | 到期时间 |
order_status | int | 订单状态 0开通中 1正常 3已过期 -2已删除 |
run_status | int | 运行状态 -2已锁定 -1已关机 1运行中 |
act_status | int | 操作状态 0无操作 1重启中 2重装中 3密码重设中 |
ip | text | IP信息集合JSON |
api_type | string | API接口类型 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | lease_orders |
page | int | 否 | 页码 |
| 字段 | 类型 | 说明 |
|---|---|---|
pages | int | 总页数 |
servers | array | 物理机列表(字段同getlease) |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | create_order |
obj_type | string | 是 | create_lease |
user_id | int | 是 | 客户用户ID |
order_id | string | 是 | 客户订单号 |
content | object | 是 | JSON对象,包含以下子字段: |
content.bandwidth | int | 是 | 带宽(Mbps) |
content.defense | int | 是 | 防御值(G) |
content.ip_num | int | 否 | IP数量,默认1 |
content.months | int | 否 | 购买月数,默认1 |
content.number | int | 否 | 购买数量,默认1 |
content.renew_auto | int | 否 | 是否自动续费,默认0 |
content.loginPassword | string | 否 | 登录密码,不传则自动生成 |
line_guid | string | 是 | 线路GUID |
product_guid | string | 是 | 机型GUID |
system_guid | string | 是 | 系统GUID |
说明:content 字段为一个完整的 JSON 对象,需整体传入。示例:{"bandwidth":100,"defense":10,"ip_num":1}
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | lease_start |
guid | int | 是 | 订单ID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | lease_stop |
guid | int | 是 | 订单ID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | lease_restart |
guid | int | 是 | 订单ID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | lease_install |
guid | int | 是 | 订单ID |
systemID | string | 是 | 系统GUID |
port | int | 是 | 系统端口 |
password | string | 是 | 新密码 |
system_partition | string | 是 | 分区类型 |
system_partition_size | int | 是 | 分区大小GB |
install_reason | string | 是 | 重装原因 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | lease_setpsw |
guid | int | 是 | 订单ID |
password | string | 是 | 新密码 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | lease_upgrade |
guid | int | 是 | 订单ID |
ipnumAdd | int | 是 | IP增加数量 |
bandwidthAdd | int | 是 | 带宽增加量 |
defenseAdd | int | 是 | 防御增加量 |
client_order_id | string | 是 | 客户方订单号 |
client_user_id | int | 是 | 客户方用户ID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | lease_renew |
guid | int | 是 | 订单ID |
months | int | 是 | 续费月数 |
client_order_id | string | 是 | 客户方订单号 |
client_user_id | int | 是 | 客户方用户ID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | lease_getvncurl |
guid | int | 是 | 订单ID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | get_lease_chart |
guid | int | 是 | 订单ID |
start_time | string | 是 | 开始时间(毫秒级时间戳) |
end_time | string | 是 | 结束时间(毫秒级时间戳) |
| 字段 | 类型 | 说明 |
|---|---|---|
date | array | 时间点列表 |
in | array | 入流量数据列表(bps) |
out | array | 出流量数据列表(bps) |
start_time | string | 查询开始时间 |
end_time | string | 查询结束时间 |
unit | string | 流量单位,固定为 bps |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | lease_refund |
guid | int | 是 | 订单ID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | idc_lines |
| 字段 | 类型 | 说明 |
|---|---|---|
guid | string | 线路GUID |
line_guid | string | 可用区GUID |
status | int | 状态 0禁用 1正常 |
name | string | 线路名称 |
descript | string | 线路描述 |
bandwidth_price | decimal | 带宽基础价格(元/M/月) |
bandwidth_stairs_price | text | 带宽阶梯价格JSON |
bandwidth_max_size | int | 带宽最大可选值(Mbps) |
ip_price | decimal | IP单价(元/个/月) |
ip_min_size | int | IP最少购买数量 |
ip_max_size | int | IP最多购买数量 |
ip_free_size | int | 免费IP数量 |
ip_num_list | string | 可选IP数量列表(逗号分隔) |
defense_price | string | 防御价格(元/G/月) |
defense_max_size | int | 防御最大可选值(G) |
defense_num_list | string | 可选防御值列表(逗号分隔) |
defense_step | int | 防御递增步长(G) |
months | string | 可购买月份数(逗号分隔) |
retention_days | int | 到期保留天数 |
discount1 | decimal | 12个月折扣(0~1) |
discount2 | decimal | 24个月折扣(0~1) |
discount3 | decimal | 36个月折扣(0~1) |
buy_status | int | 购买状态 0不可购买 1可购买 |
sort | int | 排序权重 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | idc_product |
| 字段 | 类型 | 说明 |
|---|---|---|
product_type | int | 托管类型 |
guid | string | 产品GUID |
name | string | 产品名称(1U/2U等) |
line_guid | string | 线路GUID |
power | text | 电力规格JSON |
bandwidth | int | 带宽(Mbps) |
defense | int | 防御值(G) |
ipnum | string | IP数量 |
price | decimal | 月付价格(元) |
status | int | 状态 0禁用 1正常 |
market_status | int | 库存状态 0售罄 1正常 |
line_names | string | 线路名称(多个用"、"分隔) |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | getidc |
guid | int | 是 | 订单ID |
| 字段 | 类型 | 说明 |
|---|---|---|
id | int | 订单ID |
product_guid | string | 产品GUID |
line_guid | string | 线路GUID |
name | string | 服务器名称 |
product_type | int | 托管类型 |
size | string | 规格(1U/2U) |
power | string | 电力规格 |
bandwidth | int | 带宽(Mbps) |
defense | int | 防御值(G) |
ipnum | int | IP数量 |
buy_time | datetime | 购买时间 |
end_time | datetime | 到期时间 |
order_status | int | 订单状态 0开通中 1正常 3已过期 -2已删除 |
run_status | int | 运行状态 |
act_status | int | 操作状态 |
ip | text | IP信息JSON |
login_name | string | 登录用户名 |
login_password | string | 登录密码 |
api_type | string | API接口类型 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | idc_orders |
page | int | 否 | 页码 |
| 字段 | 类型 | 说明 |
|---|---|---|
pages | int | 总页数 |
servers | array | 托管订单列表(字段同getidc) |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | create_order |
obj_type | string | 是 | create_idc |
user_id | int | 是 | 客户用户ID |
order_id | string | 是 | 客户订单号 |
content | object | 是 | JSON对象,包含以下子字段: |
content.bandwidth | int | 是 | 带宽(Mbps) |
content.power | string | 是 | 电力规格 |
content.defense | int | 是 | 防御值(G) |
content.ipnum | int | 否 | IP数量,默认1 |
content.months | int | 否 | 购买月数,默认1 |
content.number | int | 否 | 购买数量,默认1 |
content.renew_auto | int | 否 | 是否自动续费,默认0 |
line_guid | string | 是 | 线路GUID |
product_guid | string | 是 | 产品GUID |
说明:content 字段为一个完整的 JSON 对象,需整体传入。示例:{"bandwidth":100,"power":"0.5A/220V","defense":5,"ipnum":1}
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | idc_start |
guid | int | 是 | 订单ID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | idc_stop |
guid | int | 是 | 订单ID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | idc_restart |
guid | int | 是 | 订单ID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | idc_install |
guid | int | 是 | 订单ID |
systemID | string | 是 | 系统GUID |
port | int | 是 | 端口 |
password | string | 是 | 新密码 |
system_partition | string | 是 | 分区类型 |
system_partition_size | int | 是 | 分区大小GB |
install_reason | string | 是 | 重装原因 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | idc_setpsw |
guid | int | 是 | 订单ID |
password | string | 是 | 新密码 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | idc_upgrade |
guid | int | 是 | 订单ID |
ipnumAdd | int | 是 | IP增加 |
bandwidthAdd | int | 是 | 带宽增加 |
defenseAdd | int | 是 | 防御增加 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | idc_renew |
guid | int | 是 | 订单ID |
months | int | 是 | 续费月数 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | idc_refund |
guid | int | 是 | 订单ID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | idc_getvncurl |
guid | int | 是 | 订单ID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | get_idc_chart |
guid | int | 是 | 订单ID |
start_time | string | 是 | 开始时间(毫秒级时间戳) |
end_time | string | 是 | 结束时间(毫秒级时间戳) |
| 字段 | 类型 | 说明 |
|---|---|---|
date | array | 时间点列表 |
in | array | 入流量数据列表(bps) |
out | array | 出流量数据列表(bps) |
start_time | string | 查询开始时间 |
end_time | string | 查询结束时间 |
unit | string | 流量单位,固定为 bps |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | hosting_lines |
| 字段 | 类型 | 说明 |
|---|---|---|
guid | string | 线路GUID |
name | string | 主机名/线路名称 |
domain | string | 赠送域名 |
ip | string | 解析地址IP |
status | int | 状态 0禁用 1正常 |
stock | int | 库存 0无货 1有货 |
descript | string | 线路描述 |
cname | string | 解析地址别名(CNAME) |
sort | int | 排序权重 |
white | int | 是否白名单 0否 1是 |
renew | int | 续费状态 0不可续费 1可续费 |
retention_days | int | 到期保留天数 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | hosting_product |
| 字段 | 类型 | 说明 |
|---|---|---|
guid | string | 产品GUID |
name | string | 套餐名称 |
lines_guid | string | 线路GUID列表(多个用逗号分隔) |
desc | string | 简短描述 |
price | decimal | 月付价格(元) |
months | string | 可购买月份数(逗号分隔) |
discount | text | 多月优惠折扣JSON |
disk | int | 网页空间大小(MB) |
db | int | 数据库大小(MB) |
domain | int | 可绑定域名数量 |
domainsub | int | 可绑定子域名数量 |
flow | int | 月流量(GB) |
max_flow | int | 月流量上限(GB) |
up_flow | int | 流量叠加包大小(GB/步长) |
up_flow_price | decimal | 流量叠加包价格(元) |
def | int | 默认配置标识 |
buy_limit | int | 购买数量限制 |
is_limit_rate | int | 是否限制速率 0不限 1限制 |
perserver | int | 每服务器限制数 |
perip | int | 每IP限制数 |
limit_rate | int | 速率限制值 |
timeout | int | 超时时间(秒) |
sort | int | 排序权重 |
stock | int | 库存 0无货 1有货 |
status | int | 状态 0禁用 1正常 |
suggest | int | 推荐标识 0不推荐 1推荐 |
upgradation | int | 是否支持升级 0不支持 1支持 |
line_names | string | 线路名称(多个用"、"分隔) |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | gethosting |
guid | int | 是 | 订单ID |
| 字段 | 类型 | 说明 |
|---|---|---|
id | int | 订单ID |
client_user_id | int | 客户用户ID |
name | string | 主机名称 |
product_guid | string | 产品GUID |
line_guid | string | 线路GUID |
domain | string | 赠送域名 |
domain_list | text | 绑定域名列表JSON |
path | string | 网站路径 |
use_disk | int | 已使用空间(MB) |
disk | int | 总空间大小(MB) |
db_size | int | 数据库大小(MB) |
db_type | string | 数据库类型(mysql等) |
db_code | string | 数据库编码(utf8、gbk等) |
program | string | 程序语言(php等) |
program_version | string | 语言版本(php81等) |
analysis_url | string | 解析地址 |
use_flow | int | 已使用流量(MB) |
flow | int | 总月流量(GB) |
ftpport | int | FTP端口号 |
ftp_id | int | FTP用户ID |
ftp_status | int | FTP状态 0禁用 1正常 |
ftp_name | string | FTP登录账号 |
ftp_password | string | FTP密码 |
buy_time | datetime | 购买时间 |
start_time | datetime | 开始时间 |
end_time | datetime | 到期时间 |
order_status | int | 订单状态 0开通中 1正常 3已过期 -2已删除 |
run_status | int | 运行状态 -1已停止 1运行中 |
remarks | string | 备注信息 |
renew_auto | int | 是否自动续费 0否 1是 |
renew_price | decimal | 续费价格(元) |
buymonths | int | 购买月数 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | hosting_orders |
page | int | 否 | 页码,从1开始,默认1 |
| 字段 | 类型 | 说明 |
|---|---|---|
pages | int | 总页数 |
servers | array | 虚拟主机订单列表,每项字段同 gethosting 返回字段 |
根据线路 GUID 获取该线路节点支持的 PHP 版本列表。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | get_php_version |
line_guid | string | 是 | 线路GUID(hosting_lines 表的 guid) |
| 字段 | 类型 | 说明 |
|---|---|---|
- | array | PHP版本列表,每项包含 name(版本名称,如 PHP 8.1)和 version(版本号,如 81) |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | create_order |
obj_type | string | 是 | create_hosting |
user_id | int | 是 | 客户用户ID |
order_id | string | 是 | 客户订单号 |
content | object | 是 | JSON对象,包含以下子字段: |
content.program | string | 是 | 程序语言类型(php、asp等) |
content.program_version | string | 是 | 程序版本(如 php81、asp_net 等) |
content.db | string | 是 | 数据库类型(mysql、sqlserver等) |
content.code | string | 是 | 网站编码(utf8、gbk等) |
content.flow | int | 否 | 月流量(GB),不传则使用产品默认值 |
content.months | int | 否 | 购买月数,默认1 |
content.number | int | 否 | 购买数量,默认1 |
content.renew_auto | int | 否 | 是否自动续费,默认0 |
prefix | string | 是 | FTP前缀 |
pwd | string | 是 | FTP密码 |
line_guid | string | 是 | 线路GUID |
product_guid | string | 是 | 产品GUID |
说明:content 字段为一个完整的 JSON 对象,需整体传入。示例:{"program":"php","program_version":"php81","db":"mysql","code":"utf8"}
查询虚拟主机站点可用的软件/工具地址,如 phpMyAdmin 数据库管理工具的访问链接。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | hosting_get_soft_find |
line_guid | string | 是 | 线路GUID(hosting_lines 表的 guid),用于定位节点 |
sNname | string | 是 | 软件名称,如 phpmyadmin |
| 字段 | 类型 | 说明 |
|---|---|---|
ext | object | 扩展信息,包含 url(软件/工具访问地址)等 |
入口:POST action = hosting_operate,所有子操作共用以下公共参数 + 各自的专用参数:▶ 调试
| 公共参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | hosting_operate |
guid | int | 是 | 虚拟主机订单ID |
operate | string | 是 | 操作类型(见下方各子操作) |
name 必填 — 新的主机名称ftp_password 必填 — 新的FTP登录密码version 必填 — PHP版本号(如 php81、php74 等)| 字段 | 类型 | 说明 |
|---|---|---|
domains | string/array | 允许访问的域名白名单,多个用换行或逗号分隔 |
fix | string | 防盗链文件后缀,如 .jpg|.png|.gif|.mp4 |
status | int | 防盗链状态 0关闭 1开启 |
http_status | string | 阻断HTTP状态码,如 403、404 等(Linux系统专用) |
none | string | 阻断HTTP状态码(Windows系统专用) |
{
"code": 1,
"msg": "获取成功",
"data": {
"domains": "test.com\ntest2.com",
"fix": ".jpg|.png|.gif|.mp4|.wmv|.avi|.doc|.pdf|.xls|.rar|.zip|.mp3",
"status": 1,
"http_status": "403",
"none": "403"
}
}
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
fix | string | 是 | 防盗链文件后缀,格式如 .jpg|.png|.gif,多个用 | 分隔 |
domains | string | 是 | 允许访问的域名白名单,多个域名用换行(\n)分隔 |
statusSecurity | int | 是 | 防盗链状态 0关闭 1开启 |
http_status | string | 是 | 阻断时返回的HTTP状态码,如 403、404 等 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | 是 | 插件/功能名称,如 get_index、get_site_config_byname |
s | string | 是 | 子操作标识,支持:get_index(获取站点首页信息)、get_site_config_byname(获取站点WAF配置) |
| s取值 | 返回字段 | 说明 |
|---|---|---|
| get_index | siteName | 站点域名 |
| get_index | index | 默认首页文件名 |
| get_index | runPath | 网站运行目录 |
| get_site_config_byname | cc | CC防护配置信息 |
| get_site_config_byname | user_agent | User-Agent拦截规则 |
| get_site_config_byname | retry | 攻击拦截次数配置 |
{
"code": 1,
"data": {
"siteName": "test.jhgf.gyhost.cn",
"index": "index.html,index.php",
"runPath": "/"
}
}
返回数据示例(s=get_site_config_byname):
{
"code": 1,
"data": {
"cc": {"status": 1, "mode": "hard"},
"user_agent": {"status": 1},
"retry": {"status": 1, "count": 300}
}
}
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | 是 | 插件功能名称;支持 set_site_status(防篡改)、set_site_obj_open(WAF功能开关) |
s | string | 是 | 子操作标识,与 name 对应 |
status | int | 是 | 目标状态:1开启 0关闭 |
obj | string | 可选 | WAF功能对象名。当 s=set_site_obj_open 时必填,支持:readonly(护网模式)、cdn、spider_status、scan_open、drop_china、drop_abroad、cookie、user-agent、get、file_upload、rce_injection、xss_injection、sql_injection、cc 等 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
post | object | 是 | JSON对象,包含以下子字段: |
post.name | string | 是 | 插件功能名称 |
post.s | string | 是 | 子操作标识 |
post.cc_mode | int | 是 | CC防护模式(0=标准 1=增强 2=严格) |
post.cycle | int | 是 | 统计周期(秒) |
post.limit | int | 是 | 周期内访问次数限制 |
post.endtime | int | 是 | 封禁时间(秒) |
post.is_open_global | int | 是 | 是否全局模式:0关闭 1开启 |
post.increase | int | 是 | 周期内访问次数递增步长 |
post.increase_wu_heng | int | 是 | 无痕浏览递增步长 |
post.cc_increase_type | int | 是 | 递增类型 |
post.cc_type_status | int | 是 | CC类型状态 |
post.is_cc_url | int | 是 | 是否CC拦截URL:0否 1是 |
post.cc_ip_max | object | 是 | IP最大连接数配置,如 {"open":1,"ip_max":50,"static":0} |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
post | object | 是 | JSON对象,包含以下子字段: |
post.name | string | 是 | 插件功能名称 |
post.s | string | 是 | 子操作标识 |
post.retry | int | 是 | 周期内允许的最大攻击次数 |
post.retry_time | int | 是 | 超过次数后封禁时间(秒) |
post.retry_cycle | int | 是 | 统计周期(秒) |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
part_type | string | 是 | 统计类型,如 site_total(站点统计)、visit_total(访问统计)等 |
start_date | string | 是 | 开始日期,格式 Y-m-d |
end_date | string | 是 | 结束日期,格式 Y-m-d |
| 字段 | 类型 | 说明 |
|---|---|---|
list | array | 统计数据列表,每项包含时间点和对应数值 |
total | int | 总记录数 |
{
"code": 1,
"msg": "获取成功",
"data": {
"list": [
{"time": "2026-05-25 00:00", "count": 150},
{"time": "2026-05-25 01:00", "count": 230},
{"time": "2026-05-25 02:00", "count": 180}
],
"total": 24
}
}
{
"code": 1,
"data": [
{
"id": "1",
"sitename": "test.jhgf.gyhost.cn",
"proxyname": "myproxy",
"cache": 1,
"cachetime": 24,
"proxydir": "/api",
"proxysite": "https://api.example.com",
"todomain": "api.example.com",
"advanced": 1,
"type": 1,
"subfilter": "[]"
}
]
}
proxyData 必填 — JSON对象,包含以下子字段:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
proxyData.cache | int | 是 | 是否缓存:0关闭 1开启 |
proxyData.proxyname | string | 是 | 代理名称(唯一标识) |
proxyData.cachetime | int | 是 | 缓存时长(小时) |
proxyData.proxydir | string | 是 | 代理目录,如 /api |
proxyData.proxysite | string | 是 | 反代目标URL,如 https://api.example.com |
proxyData.todomain | string | 是 | 目标域名(源站域名) |
proxyData.advanced | int | 是 | 高级功能-开启代理目录:0关闭 1开启 |
proxyData.subfilter | string | 是 | 文本替换规则JSON,如 [{"sub1":"旧文本","sub2":"新文本"}] |
proxyData.type | int | 是 | 开启或关闭:0关闭 1开启 |
proxyData 必填 — JSON对象,字段同创建代理
proxyname 必填 — 代理名称
proxyname 必填 — 代理名称
返回数据示例:
{
"code": 1,
"data": {
"content": "#PROXY-START myproxy\nlocation /api {\n proxy_pass https://api.example.com;\n proxy_set_header Host api.example.com;\n}\n#PROXY-END myproxy",
"status": true
}
}
{
"code": 1,
"data": [
{
"id": "1",
"sitename": "test.jhgf.gyhost.cn",
"redirectname": "redirect_1",
"redirectdomain": ["old-domain.com"],
"redirectpath": "/old-path",
"redirecttype": 1,
"type": 1,
"domainorpath": "domain",
"holdpath": 0,
"tourl": "https://new-domain.com"
}
]
}
post 必填 — JSON对象:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
post.redirectdomain | string | 是 | 匹配域名(逗号分隔多个) |
post.redirectpath | string | 是 | 匹配路径(domainorpath=path时有效) |
post.redirecttype | int | 是 | 重定向类型:0=正向代理 301=永久重定向 302=临时重定向 |
post.type | int | 是 | 状态:0关闭 1开启 |
post.domainorpath | string | 是 | 匹配模式:domain(按域名)或 path(按路径) |
post.holdpath | int | 是 | 是否保留路径:0不保留 1保留 |
post.tourl | string | 是 | 目标URL,如 https://new-domain.com |
post 必填 — JSON对象,字段同创建重定向,额外增加:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
post.redirectname | string | 是 | 重定向名称(用于定位要修改的规则) |
post.topath | string | 可选 | 目标路径(路径重定向时使用) |
post.errorpage | int | 可选 | 自定义错误页面:0关闭 1开启 |
redirectname 必填 — 重定向名称
redirectname 必填 — 重定向名称
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
path | string | 是 | 文件保存路径(规则名或完整路径) |
text | string | 是 | 文件内容(重定向配置内容) |
{
"code": 1,
"data": [
{
"id": "1",
"pid": "1",
"name": "test.jhgf.gyhost.cn",
"port": "80",
"addtime": "2024-01-01 00:00:00"
},
{
"id": "2",
"pid": "1",
"name": "www.example.com",
"port": "443",
"addtime": "2024-01-02 00:00:00"
}
]
}
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
domainText | string | 是 | 要添加的域名,多个用换行符\n分隔;格式:域名:端口,80端口可省略端口 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | 是 | 要删除的域名 |
port | string | 是 | 域名端口号,如 80、443 |
{
"code": 1,
"data": [
{
"id": "1",
"pid": "1",
"type": "0",
"name": "backup_20240101.tar.gz",
"filename": "www_test_jhgf_20240101.tar.gz",
"size": "1048576",
"addtime": "2024-01-01 00:00:00"
}
]
}
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
guid | string | 是 | 备份记录ID(备份列表中的id字段值) |
| 字段 | 类型 | 说明 |
|---|---|---|
status | bool | SSL是否已部署 |
startDate | string | 证书生效日期 |
endDate | string | 证书到期日期 |
issuer | string | 证书颁发者 |
dns | array | 证书包含的域名列表 |
{
"code": 1,
"data": {
"status": true,
"startDate": "2024-01-01",
"endDate": "2025-01-01",
"issuer": "Let's Encrypt",
"dns": ["test.jhgf.gyhost.cn"]
}
}
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
type | int | 是 | 证书类型 |
key | string | 是 | SSL私钥内容(-----BEGIN PRIVATE KEY----- ...) |
csr | string | 是 | SSL证书内容(PEM格式,-----BEGIN CERTIFICATE----- ...) |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | 是 | 证书名称(用于IIS未识别证书部署) |
password | string | 是 | 证书密码 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
domain | string | 是 | 域名(纯域名,不含http://) |
path | string | 是 | 证书文件(.pfx/.p12)在服务器上的完整路径 |
| 字段 | 类型 | 说明 |
|---|---|---|
userini | string | 三项配置状态(防跨站、日志、密码访问),JSON字符串 |
{
"code": 1,
"msg": "获取成功",
"data": {
"userini": "{\"open_basedir\":1,\"log_access\":0,\"password_access\":0}"
}
}
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
status | int | 是 | 状态:1开启防跨站 0关闭防跨站 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
runPath | string | 是 | 运行目录路径,如 /public、/web 等 |
{
"code": 1,
"data": [
{"name": "thinkphp", "title": "ThinkPHP"},
{"name": "laravel", "title": "Laravel"},
{"name": "wordpress", "title": "WordPress"},
{"name": "ecshop", "title": "ECShop"}
]
}
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
rewrite | string | 是 | 伪静态文件名(如 thinkphp、wordpress)或完整路径 |
path | string | 可选 | 自定义文件路径;不传则从内置规则模板或站点伪静态目录读取 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
file_type | int | 是 | 文件类型标识:0使用系统默认路径(/vhost/rewrite/) 1自定义完整路径 |
path | string | 是 | 文件保存路径;file_type=0时为规则名,file_type=1时为完整路径 |
text | string | 是 | 文件内容 |
{
"code": 1,
"data": {
"index": "index.html,index.php"
}
}
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
indexText | string | 是 | 首页文件名列表,多个用逗号分隔,优先级从前到后,如 index.html,index.php,default.html |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
path | string | 是 | 文件完整路径(含文件名),如 /www/wwwroot/test/index.html |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
path | string | 是 | 目录完整路径,如 /www/wwwroot/test/newdir |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
path | string | 是 | 目录路径,如 /www/wwwroot/test |
{
"code": 1,
"data": [
{
"filename": "index.php",
"type": "file",
"size": "1024",
"modify_time": "2024-01-01 00:00:00"
},
{
"filename": "public",
"type": "dir",
"size": "4096",
"modify_time": "2024-01-01 00:00:00"
}
]
}
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
path | string | 是 | 目录路径 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
filename | string | 是 | 源文件/目录名(sfile参数,要压缩的文件或目录名) |
path | string | 是 | 要压缩的路径(源文件所在目录) |
z_type | string | 是 | 压缩类型,如 zip、tar.gz |
dfile | string | 是 | 目标压缩包文件名(含路径) |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
path | string | 是 | 解压目标路径(sfile参数) |
dfile | string | 是 | 压缩包文件路径 |
password | string | 是 | 解压密码(无密码传空字符串) |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
path | string | 是 | 要删除的文件或目录完整路径 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
path | string | 是 | 目录路径 |
type | string | 是 | 操作类型:Delete(删除)、Copy(复制标记)、Cut(剪切标记) |
arr | array | 是 | 文件名数组,如 ["file1.txt","dir1"] |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
sfile | string | 是 | 源文件完整路径 |
dfile | string | 是 | 目标文件完整路径 |
rename | string | 是 | 是否重命名:true(仅重命名,不移动目录) false(移动文件) |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
contents_path | string | 是 | 目标目录路径(BT接口dfile参数) |
filename | string | 可选 | 要检查的文件名,不传则检查目录下所有文件 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
type | string | 是 | 操作类型:copy(复制) cut(剪切/移动) |
sfile | string | 是 | 源文件完整路径(已通过set_batch_data标记过) |
dfile | string | 是 | 目标目录路径 |
isOverride | string | 可选 | 是否覆盖已存在的文件:true覆盖 false跳过 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
contents_path | string | 是 | 目标路径(粘贴到哪个目录) |
type | string | 是 | 操作类型:copy(复制) cut(剪切/移动) |
skip | string | 是 | 要跳过的文件名(已存在不覆盖的文件名,逗号分隔) |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
files | array | 是 | 文件名列表,如 ["file1.zip","file2.zip"] |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
contents_path | string | 是 | 上传目标目录路径 |
start | int | 是 | 分片起始位置(字节),首次传0,续传传已上传大小 |
file | file | 是 | 文件数据(实际为上传文件流,通过HTTP multipart/form-data提交) |
newEndTimeStr 必填 — 新到期时间(Y-m-d H:i:s格式) renewLength 可选 — 续费月数(不传则从时间差自动推算) coupon_id 可选 — 优惠券IDflow 可选 — 升级月流量(GB) new_product_guid 可选 — 升级目标产品GUID coupon_id 可选 — 优惠券ID注:flow和new_product_guid至少传一个,同时传时先处理流量升级再处理规格升级
db_password 必填 — 数据库密码 db_type 可选 — 数据库类型(默认mysql)| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | sql_product |
| 字段 | 类型 | 说明 |
|---|---|---|
guid | string | 产品GUID |
name | string | 产品名称 |
lines_guid | string | 线路GUID列表(多个用逗号分隔) |
desc | string | 产品描述 |
price | decimal | 月付价格(元) |
months | string | 可购买月份数(逗号分隔) |
discount | text | 优惠折扣JSON |
db | int | 数据库大小(MB) |
buy_limit | int | 购买数量限制 |
timeout | int | 超时时间(秒) |
sort | int | 排序权重 |
stock | int | 库存 0无货 1有货 |
status | int | 状态 0禁用 1正常 |
suggest | int | 推荐标识 0不推荐 1推荐 |
upgradation | int | 是否支持升级 0不支持 1支持 |
line_names | string | 线路名称(多个用"、"分隔) |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | getsql |
guid | int | 是 | 订单ID |
| 字段 | 类型 | 说明 |
|---|---|---|
id | int | 订单ID |
client_user_id | int | 客户用户ID |
hosting_id | int | 关联虚拟主机ID(独立数据库时为0) |
name | string | 数据库名称 |
product_guid | string | 产品GUID |
line_guid | string | 线路GUID |
use_disk | int | 已使用空间(MB) |
db_size | int | 数据库大小(MB) |
db_type | string | 数据库类型(mysql等) |
db_code | string | 数据库编码(utf8mb4等) |
db_name | string | 数据库名称 |
db_user | string | 数据库用户名 |
db_password | string | 数据库密码 |
buy_time | datetime | 购买时间 |
start_time | datetime | 开始时间 |
end_time | datetime | 到期时间 |
order_status | int | 订单状态 0开通中 1正常 3已过期 -2已删除 |
run_status | int | 运行状态 -1已停止 1运行中 |
remarks | string | 备注信息 |
renew_auto | int | 是否自动续费 0否 1是 |
renew_price | decimal | 续费价格(元) |
buymonths | int | 购买月数 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | sql_orders |
page | int | 否 | 页码,从1开始,默认1 |
| 字段 | 类型 | 说明 |
|---|---|---|
pages | int | 总页数 |
servers | array | 数据库订单列表,每项字段同 getsql 返回字段 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | create_order |
obj_type | string | 是 | create_database |
user_id | int | 是 | 客户用户ID |
order_id | string | 是 | 客户订单号 |
content | object | 是 | JSON对象,包含以下子字段: |
content.db | string | 是 | 数据库大小(如 "1000" 表示1000MB) |
content.code | string | 是 | 数据库编码(utf8mb4、utf8、gbk等) |
content.months | int | 否 | 购买月数,默认1 |
content.number | int | 否 | 购买数量,默认1 |
content.renew_auto | int | 否 | 是否自动续费,默认0 |
prefix | string | 是 | 数据库前缀 |
pwd | string | 是 | 数据库密码 |
line_guid | string | 是 | 线路GUID |
product_guid | string | 是 | 产品GUID |
说明:content 字段为一个完整的 JSON 对象,需整体传入。示例:{"db":"1000","code":"utf8mb4"}
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appid | string | 是 | 用户ID |
appkey | string | 是 | API密钥 |
action | string | 是 | sql_operate |
guid | int | 是 | 数据库订单ID |
operate | string | 是 | 操作类型(见下方各操作说明) |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | 是 | 新的备注名称(仅更新本地数据库记录,不调用节点API) |
| 字段 | 类型 | 说明 |
|---|---|---|
status | bool | 是否获取成功 |
msg | string | 当前访问权限描述,如 %(所有IP)、127.0.0.1(仅本地)或指定IP |
{
"code": 1,
"data": {
"status": true,
"msg": "%"
}
}
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
dataAccess | string | 是 | 访问权限类型:%(所有IP)、127.0.0.1(仅本地)、ip(指定IP列表) |
access | string | 是 | 当 dataAccess=ip 时,填写允许访问的IP列表(多IP用换行符分隔) |
address | string | 可选 | 允许访问的附加IP地址 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
password | string | 是 | 新密码 |
{
"code": 1,
"data": [
{
"id": "1",
"pid": "1",
"type": "1",
"name": "db_test_20240101.sql.gz",
"filename": "db_test_20240101_123456.sql.gz",
"size": "204800",
"addtime": "2024-01-01 00:00:00"
}
]
}
{
"code": 1,
"data": {
"status": true,
"msg": "备份中"
}
}
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
bak_guid | int | 是 | 备份记录ID(备份列表中的id字段) |
{
"code": 1,
"data": {
"status": true,
"msg": "75%"
}
}
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
file | string | 是 | 备份文件在服务器上的完整路径,如 /www/backup/database/db_test.sql.gz |
{
"code": 1,
"data": {
"status": true,
"msg": "导入中"
}
}
{
"code": 1,
"data": {
"status": true,
"msg": "50%"
}
}
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
newEndTimeStr | string | 是 | 新到期时间,格式 Y-m-d H:i:s |
renewLength | int | 可选 | 续费月数(不传则从时间差自动推算) |
coupon_id | int | 可选 | 优惠券ID |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
new_product_guid | string | 是 | 升级目标产品GUID(sql_product 返回的 guid) |
coupon_id | int | 可选 | 优惠券ID |
| 返回 code | 说明 |
|---|---|
1 | 请求成功,data 中包含返回数据 |
0 | 请求失败,msg 中包含错误描述 |
| 错误信息 | 可能原因 |
|---|---|
| 缺少必要参数 | 未传递 appid/appkey/action 或某必填参数 |
| 权限不足 | appid 或 appkey 错误,或用户未开通API权限 |
| 请求错误 | action 方法不存在 |
| 该线路节点不存在或已下架 | 线路GUID无效或线路已下架 |
| 余额不足 | 用户余额+授信额度不足以支付 |
| 未找到产品记录 | 订单ID不存在或不属于该用户 |
| 产品超出可退款时间 | 已超过无理由退款期限 |