Api开发文档

007idc大约 49 分钟

Api开发文档

Base URLs:

Authentication

apiServer/管理员类

POST 管理员全局搜索

POST /v1/admin/search

Body 请求参数

key: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» key	body	string	否	关键字检索

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

apiServer/管理员类/管理员登录注册

POST 管理员注册

POST /v1/admin/register

Body 请求参数

username: test
password: "1234"
phone: string
email: string

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» username	body	string	是	用户名
» password	body	string	是	密码
» phone	body	string	否	手机号码
» email	body	string	否	电子邮箱

返回示例

200 Response

null

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	undefined

POST 管理员登录

POST /v1/admin/login

Body 请求参数

username: test
password: "1234"

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» username	body	string	是	用户名，可以为（用户名、邮箱、手机号码）
» password	body	string	是	密码

返回示例

200 Response

{
  "code": 0,
  "data": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	登录失败	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none		none
» data	string	true	none		none

apiServer/管理员类/容器卷信息

GET 查询容器所有卷信息

GET /v1/admin/volume/get_volume_list

请求参数

名称	位置	类型	必选	说明
container_id	query	string	否	容器id
Authorization	header	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 查询单个卷信息

POST /v1/admin/volume/get_volume_detail

Body 请求参数

volume_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» volume_id	body	string	否	容器卷id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 新增卷

POST /v1/admin/volume/add_volume

Body 请求参数

size: string
user_id: string
container_id: string
mount_path: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» size	body	string	否	容器卷大小
» user_id	body	string	否	用户id
» container_id	body	string	否	容器id
» mount_path	body	string	否	挂载路径

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 修改卷信息

POST /v1/admin/volume/update_volume

Body 请求参数

volume_id: string
size: string
user_id: string
container_id: string
mount_path: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	是	none
body	body	object	否	none
» volume_id	body	string	否	数据卷id
» size	body	string	否	数据卷大小
» user_id	body	string	否	用户id
» container_id	body	string	否	容器id
» mount_path	body	string	否	挂载路径

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 删除数据卷

POST /v1/admin/volume/delete_volume

Body 请求参数

volume_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» volume_id	body	string	否	数据卷id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

apiServer/管理员类/用户管理

GET 获取用户列表

GET /v1/admin/users/get_user_list

请求参数

名称	位置	类型	必选	说明
page	query	string	否	页码，默认 1
count	query	string	否	数量，默认 10
key	query	string	否	关键字检索
Authorization	header	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 查询指定用户

POST /v1/admin/users/select_user

Body 请求参数

user_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» user_id	body	string	是	用户id

返回示例

200 Response

{
  "code": 0,
  "data": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none		none
» data	string	true	none		none

POST 添加用户

POST /v1/admin/users/add_user

Body 请求参数

username: string
password: string
phone: string
email: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» username	body	string	是	用户名
» password	body	string	是	密码
» phone	body	string	否	手机号码
» email	body	string	否	电子邮件

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 修改用户信息

POST /v1/admin/users/update_user

Body 请求参数

user_id: string
username: string
phone: string
email: string
user_type: 0
name: string
card_id: string
real_name_state: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» user_id	body	string	是	用户id
» username	body	string	否	用户名
» phone	body	string	否	手机号码
» email	body	string	否	电子邮箱
» user_type	body	integer	否	用户类型（0：普通用户；1：管理员）
» name	body	string	否	用户姓名
» card_id	body	string	否	用户身份证
» real_name_state	body	string	否	实名状态 0、未实名

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 修改用户余额

POST /v1/admin/users/update_user_balance

Body 请求参数

user_id: string
balance: 0

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» user_id	body	string	否	用户id
» balance	body	integer	否	余额数量

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 删除用户

POST /v1/admin/users/del_user

Body 请求参数

user_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» user_id	body	string	是	用户id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 修改用户密码

POST /v1/admin/users/update_user_password

Body 请求参数

user_id: string
password: string

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» user_id	body	string	否	用户id
» password	body	string	否	密码

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 修改用户头像

POST /v1/admin/users/upload_user_avatar

Body 请求参数

user_id: string
file: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» user_id	body	string	否	用户id
» file	body	string(binary)	否	用户头像

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 修改用户实名状态

POST /v1/admin/users/update_user_real_name

Body 请求参数

user_id: string
real_name_state: string

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» user_id	body	string	否	用户id
» real_name_state	body	string	否	实名状态 0、未实名

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

apiServer/管理员类/服务器管理

GET 查询服务器列表

GET /v1/admin/server/get_server_list

请求参数

名称	位置	类型	必选	说明
page	query	string	否	页码，默认 1
count	query	string	否	数量，默认 10
key	query	string	否	搜索关键字
Authorization	header	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 查询指定服务器

POST /v1/admin/server/select_server

Body 请求参数

server_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» server_id	body	string	是	服务器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 删除指定服务器

POST /v1/admin/server/delete_server

Body 请求参数

server_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» server_id	body	string	是	服务器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 修改服务器信息

POST /v1/admin/server/update_server

Body 请求参数

server_id: string
name: string
ip: string
location: string
bandwidth: string
disk: string
memory: string
cpu: string
html: string
console_url: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» server_id	body	string	否	服务器id
» name	body	string	否	名称
» ip	body	string	否	服务器ip
» location	body	string	否	服务器地点
» bandwidth	body	string	否	带宽
» disk	body	string	否	硬盘
» memory	body	string	否	内存
» cpu	body	string	否	CPU
» html	body	string	否	服务器卡片html内容
» console_url	body	string	否	控制台url

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 新增服务器

POST /v1/admin/server/add_server

Body 请求参数

name: string
ip: string
location: string
bandwidth: string
disk: string
memory: string
cpu: string
html: string
console_url: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» name	body	string	是	名称
» ip	body	string	是	服务器ip
» location	body	string	否	服务器地点
» bandwidth	body	string	否	带宽
» disk	body	string	否	硬盘
» memory	body	string	否	内存
» cpu	body	string	否	CPU
» html	body	string	否	服务器卡片html内容
» console_url	body	string	否	控制台url

返回示例

成功

{
  "code": 200,
  "data": {
    "bandwidth": "131",
    "cpu": "11",
    "created_at": "2024-04-08T08:03:14",
    "disk": "111",
    "ip": "312",
    "location": "313",
    "memory": "111",
    "name": "12",
    "server_id": "60b4b18b-054f-426b-a9e6-ea743514a64a",
    "state": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» data	object	true	none	none
»» bandwidth	string	true	none	none
»» cpu	string	true	none	none
»» created_at	string	true	none	none
»» disk	string	true	none	none
»» ip	string	true	none	none
»» location	string	true	none	none
»» memory	string	true	none	none
»» name	string	true	none	none
»» server_id	string	true	none	none
»» state	integer	true	none	none

apiServer/管理员类/服务器套餐

GET 获取服务器所有套餐

GET /v1/admin/container_plan/get_server_plan_list

请求参数

名称	位置	类型	必选	说明
page	query	string	否	页码，默认 1
count	query	string	否	数量，默认 10
server_id	query	string	是	服务器id
Authorization	header	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 获取单个套餐信息

POST /v1/admin/container_plan/get_server_plan_detail

Body 请求参数

plan_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	是	none
body	body	object	否	none
» plan_id	body	string	否	套餐id

返回示例

成功

{
  "code": 200,
  "data": {
    "bandwidth_rx": "11.00",
    "bandwidth_tx": "11.00",
    "cpu": "11",
    "created_at": "2024-04-08T08:04:01",
    "description": "普通套餐",
    "disk": "11",
    "memory": "12",
    "name": "普通套餐",
    "number": 12,
    "plan_id": 1,
    "price": "111.00",
    "server_id": "60b4b18b-054f-426b-a9e6-ea743514a64a",
    "threshold_rx": "11.00",
    "threshold_tx": "11.00"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» data	object	true	none	none
»» bandwidth_rx	string	true	none	none
»» bandwidth_tx	string	true	none	none
»» cpu	string	true	none	none
»» created_at	string	true	none	none
»» description	string	true	none	none
»» disk	string	true	none	none
»» memory	string	true	none	none
»» name	string	true	none	none
»» number	integer	true	none	none
»» plan_id	integer	true	none	none
»» price	string	true	none	none
»» server_id	string	true	none	none
»» threshold_rx	string	true	none	none
»» threshold_tx	string	true	none	none

POST 新增套餐

POST /v1/admin/container_plan/add_server_plan

Body 请求参数

server_id: string
name: string
memory: string
disk: string
cpu: string
price: string
bandwidth_rx: string
bandwidth_tx: string
threshold_rx: string
threshold_tx: string
number: string
description: string
volume_price: string
must_real_name: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	是	none
body	body	object	否	none
» server_id	body	string	否	服务器id
» name	body	string	否	套餐名称
» memory	body	string	否	内存限制
» disk	body	string	否	硬盘空间限制
» cpu	body	string	否	CPU 限制
» price	body	string	否	价格
» bandwidth_rx	body	string	否	下行带宽 Mbps
» bandwidth_tx	body	string	否	上行带宽 Mbps
» threshold_rx	body	string	否	流量阈值下行 Gib/minute
» threshold_tx	body	string	否	流量阈值上行 Gib/minute
» number	body	string	否	套餐剩余数量
» description	body	string	否	套餐描述
» volume_price	body	string	否	数据卷价格
» must_real_name	body	string	否	是否需要实名 0、不需要 1、需要

返回示例

成功

{
  "code": 200,
  "data": {
    "bandwidth_rx": "11.00",
    "bandwidth_tx": "11.00",
    "cpu": "11",
    "created_at": "2024-04-08T08:04:01",
    "description": "普通套餐",
    "disk": "11",
    "memory": "12",
    "name": "普通套餐",
    "number": 12,
    "plan_id": 1,
    "price": "111.00",
    "server_id": "60b4b18b-054f-426b-a9e6-ea743514a64a",
    "threshold_rx": "11.00",
    "threshold_tx": "11.00"
  }
}

500 Response

{
  "code": 0,
  "description": "string",
  "name": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline
500	Internal Server Error	服务器错误	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» data	object	true	none	none
»» bandwidth_rx	string	true	none	none
»» bandwidth_tx	string	true	none	none
»» cpu	string	true	none	none
»» created_at	string	true	none	none
»» description	string	true	none	none
»» disk	string	true	none	none
»» memory	string	true	none	none
»» name	string	true	none	none
»» number	integer	true	none	none
»» plan_id	integer	true	none	none
»» price	string	true	none	none
»» server_id	string	true	none	none
»» threshold_rx	string	true	none	none
»» threshold_tx	string	true	none	none

状态码 500

名称	类型	必选	约束	说明
» code	integer	true	none	none
» description	string	true	none	none
» name	string	true	none	none

POST 修改套餐信息

POST /v1/admin/container_plan/update_server_plan

Body 请求参数

plan_id: string
name: string
memory: string
disk: string
cpu: string
price: string
bandwidth_rx: string
bandwidth_tx: string
threshold_rx: string
threshold_tx: string
number: string
description: string
volume_price: string
must_real_name: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	是	none
body	body	object	否	none
» plan_id	body	string	是	套餐id
» name	body	string	否	名称
» memory	body	string	否	内存限制
» disk	body	string	否	硬盘空间限制
» cpu	body	string	否	CPU 限制
» price	body	string	否	价格
» bandwidth_rx	body	string	否	下行带宽 Mbps
» bandwidth_tx	body	string	否	上行带宽 Mbps
» threshold_rx	body	string	否	流量阈值下行 Gib/minute
» threshold_tx	body	string	否	流量阈值上行 Gib/minute
» number	body	string	否	套餐剩余数量
» description	body	string	否	套餐描述
» volume_price	body	string	否	数据卷价格 /MB
» must_real_name	body	string	否	是否需要实名 0、不需要 1、需要

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 删除套餐信息

POST /v1/admin/container_plan/delete_server_plan

Body 请求参数

plan_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» plan_id	body	string	否	套餐id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

apiServer/管理员类/容器管理

GET 获取容器列表

GET /v1/admin/container/get_container_list

Body 请求参数

{}

请求参数

名称	位置	类型	必选	说明
server_id	query	string	是	服务器id
user_id	query	string	否	用户id（若查询者为用户，则仅可查询自身数据）
page	query	integer	否	页码，默认 1
count	query	integer	否	查询数量，默认 10
key	query	string	否	关键字检索
Authorization	header	string	否	登录后获取的cookie值
body	body	object	否	none

返回示例

成功

{
  "code": 200,
  "data": [
    {
      "become_time": "2024-04-08T16:45:16",
      "container_id": "1dd2570f-c48d-436f-8fed-3613718ae404",
      "container_state": 0,
      "created_at": "2024-04-08T08:48:28",
      "pay": "12.50",
      "plan_id": 1,
      "server_id": "60b4b18b-054f-426b-a9e6-ea743514a64a",
      "user_id": 1
    },
    {
      "become_time": "2024-04-08T16:45:16",
      "container_id": "b67935e2-53dd-447c-8ff4-ec7805a912ec",
      "container_state": 0,
      "created_at": "2024-04-08T08:49:23",
      "pay": "12.50",
      "plan_id": 1,
      "server_id": "60b4b18b-054f-426b-a9e6-ea743514a64a",
      "user_id": 1
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» data	[object]	true	none	none
»» become_time	string	true	none	none
»» container_id	string	true	none	none
»» container_state	integer	true	none	none
»» created_at	string	true	none	none
»» pay	string	true	none	none
»» plan_id	integer	true	none	none
»» server_id	string	true	none	none
»» user_id	integer	true	none	none

POST 查询指定容器

POST /v1/admin/container/get_container_detail

Body 请求参数

container_id: "123"

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id

返回示例

200 Response

{
  "code": 0,
  "data": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	主机不存在	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none		none
» data	string	true	none		none

POST 新增容器

POST /v1/admin/container/add_container

Body 请求参数

user_id: string
server_id: string
plan_id: string
pay: 0
become_time: 0
image_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» user_id	body	string	是	用户id
» server_id	body	string	是	服务器id
» plan_id	body	string	是	容器套餐id
» pay	body	number	是	购买价格
» become_time	body	integer	是	到期时间，时间戳
» image_id	body	string	否	镜像id

返回示例

成功

{
  "code": 200,
  "data": {
    "become_time": "2024-04-08T16:45:16",
    "container_id": "1dd2570f-c48d-436f-8fed-3613718ae404",
    "container_state": 0,
    "created_at": "2024-04-08T08:48:28",
    "pay": "12.50",
    "plan_id": 1,
    "server_id": "60b4b18b-054f-426b-a9e6-ea743514a64a",
    "user_id": 1
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» data	object	true	none	none
»» become_time	string	true	none	none
»» container_id	string	true	none	none
»» container_state	integer	true	none	none
»» created_at	string	true	none	none
»» pay	string	true	none	none
»» plan_id	integer	true	none	none
»» server_id	string	true	none	none
»» user_id	integer	true	none	none

POST 修改容器信息

POST /v1/admin/container/update_container

Body 请求参数

container_id: string
user_id: string
server_id: string
plan_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	是	容器id
» user_id	body	string	否	用户id
» server_id	body	string	否	服务器id
» plan_id	body	string	否	套餐id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 删除指定容器

POST /v1/admin/container/delete_container

Body 请求参数

container_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 启动容器

POST /v1/admin/container/start_container

Body 请求参数

container_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 获取容器状态

POST /v1/admin/container/get_container_status

Body 请求参数

container_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 开通容器

POST /v1/admin/container/open_container

Body 请求参数

container_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 获取容器日志

POST /v1/admin/container/get_container_log

Body 请求参数

container_id: string
page: string
count: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id
» page	body	string	否	页码，默认 1
» count	body	string	否	数量，默认 20

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 重启容器

POST /v1/admin/container/reboot_container

Body 请求参数

container_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 停止容器

POST /v1/admin/container/stop_container

Body 请求参数

container_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 获取容器控制台

POST /v1/admin/container/get_container_console

Body 请求参数

container_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 清除容器流量

POST /v1/admin/container/clear_container_traffic

Body 请求参数

container_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 修改容器到期时间

POST /v1/admin/container/update_container_expire_time

Body 请求参数

container_id: string
expire_time: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id
» expire_time	body	string	否	到期时间（时间戳）

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 修改容器价格

POST /v1/admin/container/update_container_price

Body 请求参数

container_id: string
pay: string

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» container_id	body	string	否	容器id
» pay	body	string	否	容器续费金额

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 重装容器

POST /v1/admin/container/reinstall_container

Body 请求参数

container_id: string
image_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id
» image_id	body	string	否	镜像id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

apiServer/管理员类/全局设置管理

GET 获取所有设置

GET /v1/admin/settings/get_settings

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 变更设置

POST /v1/admin/settings/update_settings

Body 请求参数

setting_id: string
name: string
value: string
authority: 0
notes: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» setting_id	body	string	否	设置 id
» name	body	string	否	设置名
» value	body	string	否	设置值
» authority	body	integer	否	设置访问权限：0、共有，1、私有
» notes	body	string	否	设置备注

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 新增配置

POST /v1/admin/settings/add_settings

Body 请求参数

name: string
value: string
authority: string
notes: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» name	body	string	否	设置名
» value	body	string	否	设置值
» authority	body	string	否	设置访问权限：0、共有，1、私有
» notes	body	string	否	设置备注

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取单项配置

GET /v1/admin/settings/get_setting

请求参数

名称	位置	类型	必选	说明
name	query	string	否	配置名称
names	query	string	否	配置名称(可同时获取多项配置)
Authorization	header	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 删除设置

POST /v1/admin/settings/delete_settings

Body 请求参数

setting_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» setting_id	body	string	否	设置id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

apiServer/管理员类/网络操作

GET 获取容器网络信息

GET /v1/container/proxy/get_container_proxy

Body 请求参数

container_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 添加容器网络

POST /v1/container/proxy/add_container_proxy

Body 请求参数

container_id: string
proxy_data: "[\r

  \    {    \r

  \        \"type\": \"port_forward\",\r

  \        \"container_port\": 容器内部端口号 int,\r

  \        \"container_id\": 容器id\r

  \    },\r

  \    {\r

  \        \"type\": \"nginx\",\r

  \        \"container_port\": 容器内部端口号 int,\r

  \        \"container_id\": 容器id,\r

  \        \"domain\": 域名\r

  \    },\r

  \    {\r

  \        \"type\": \"floating_ip\"\r

  \    }\r

  ]"

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id
» proxy_data	body	string	否	网络信息

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

apiServer/管理员类/浮动ip管理

GET 获取服务器的floating_ip列表

GET /v1/admin/floating_ip/get_list

Body 请求参数

{}

请求参数

名称	位置	类型	必选	说明
server_id	query	string	否	服务器id
page	query	string	否	页码，默认 1
count	query	string	否	数量，默认 10
Authorization	header	string	否	none
body	body	object	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 新增floating_ip

POST /v1/admin/floating_ip/add

Body 请求参数

server_id: string
floating_ip: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» server_id	body	string	否	服务器id
» floating_ip	body	string	否	浮动ip

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 删除floating_ip

POST /v1/admin/floating_ip/delete

Body 请求参数

id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» id	body	string	否	浮动ip的id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 批量添加浮动ip

POST /v1/admin/floating_ip/add_list

Body 请求参数

server_id: string
start_floating_ip: string
end_floating_ip: string

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» server_id	body	string	否	服务器id
» start_floating_ip	body	string	否	起始浮动ip
» end_floating_ip	body	string	否	结束浮动ip

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

apiServer/管理员类/订单管理

GET 查询订单列表

GET /v1/admin/trades/get_trades

Body 请求参数

{}

请求参数

名称	位置	类型	必选	说明
page	query	string	是	页码默认1
count	query	string	是	获取数量默认10
user_id	query	string	否	用户id
Authorization	header	string	否	none
body	body	object	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 修改订单信息

POST /v1/admin/trades/update_trades

Body 请求参数

trade_id: string
trade_type: string
price: string
trade_state: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» trade_id	body	string	是	订单id
» trade_type	body	string	否	订单类型
» price	body	string	否	订单价格
» trade_state	body	string	否	订单状态

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 新增订单

POST /v1/admin/trades/add_trade

Body 请求参数

user_id: string
trade_type: string
trade_table: string
price: string
good_become_time: string
trade_table_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» user_id	body	string	否	用户id
» trade_type	body	string	否	订单类型
» trade_table	body	string	否	订单所属表
» price	body	string	否	订单价格
» good_become_time	body	string	否	完成订单后，商品的到期时间
» trade_table_id	body	string	否	订单所属商品id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 删除订单

POST /v1/admin/trades/delete_trade

Body 请求参数

trade_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» trade_id	body	string	否	订单id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 查询指定订单

POST /v1/admin/trades/select_trade

Body 请求参数

trade_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» trade_id	body	string	否	订单id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

apiServer/管理员类/消息管理

POST 添加消息

POST /v1/messages/add_message

Body 请求参数

title: string
content: string
message_type: "站内消息\r

  活动通知\r

  官方公告\r

  官方政策\r

  新闻资讯\r

  疑难杂症"

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» title	body	string	否	标题
» content	body	string	否	消息内容
» message_type	body	string	否	消息类型

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 删除消息

POST /v1/messages/delete_message

Body 请求参数

message_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» message_id	body	string	否	消息id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 修改消息

POST /v1/messages/update_message

Body 请求参数

message_id: string
title: string
content: string
message_type: 站内消息 活动通知 官方公告 官方政策 新闻资讯 疑难杂症

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» message_id	body	string	否	消息id
» title	body	string	否	消息标题
» content	body	string	否	消息内容
» message_type	body	string	否	消息类型

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

apiServer/管理员类/附件管理

POST 上传附件

POST /v1/attachment/add_attachment

Body 请求参数

message_id: string
sheet_id: string
file: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» message_id	body	string	否	消息id（与工单id二选一）
» sheet_id	body	string	否	工单id（与消息id二选一）
» file	body	string(binary)	否	文件

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 下载附件

GET /v1/attachment/get_attachment

请求参数

名称	位置	类型	必选	说明
aid	query	string	否	附件id
Authorization	header	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 删除附件

GET /v1/attachment/delete_attachment

Body 请求参数

{}

请求参数

名称	位置	类型	必选	说明
aid	query	string	否	附件id
Authorization	header	string	否	none
body	body	object	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取附件列表

GET /v1/attachment/get_attachment_list

Body 请求参数

{}

请求参数

名称	位置	类型	必选	说明
page	query	string	否	页码，默认 1
count	query	string	否	数量，默认 10
key	query	string	否	关键字检索
user_type	query	string	否	用户类型，不传为所有，0：用户；1：管理员
Authorization	header	string	否	none
body	body	object	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

apiServer/管理员类/镜像管理

GET 获取镜像列表

GET /v1/image/list

请求参数

名称	位置	类型	必选	说明
server_id	query	string	否	服务器id
Authorization	header	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 发送镜像拉取请求

POST /v1/image/pull

Body 请求参数

server_id: string
name: string
show_name: string
description: string
plan_id: string
proxy: string
image_ico: string
tag: string
env: "{\r

  \    \"key1\": \"value1\",\r

  \    \"key2\": \"value2\",\r

  \    \"key3\": \"value3\"\r

  \    ...\r

  }"

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» server_id	body	string	否	服务器id
» name	body	string	否	镜像名称
» show_name	body	string	否	镜像别名
» description	body	string	否	镜像描述
» plan_id	body	string	否	镜像推荐套餐id
» proxy	body	string	否	镜像推荐网络规则(json格式，参考网络信息操作)
» image_ico	body	string	否	镜像图标
» tag	body	string	否	镜像标签
» env	body	string	否	镜像默认环境变量，json

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 删除镜像

POST /v1/image/delete

Body 请求参数

server_id: string
image_id: string

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» server_id	body	string	否	服务器id
» image_id	body	string	否	镜像id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 编辑镜像信息

POST /v1/image/update

Body 请求参数

image_id: string
show_name: string
name: string
description: string
plan_id: string
proxy: string
image_ico: string
env: |-
  {
      "key1": "value1",
      "key2": "value2",
      "key3": "value3"
      ...
  }

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» image_id	body	string	否	镜像id
» show_name	body	string	否	镜像别名
» name	body	string	否	镜像名称
» description	body	string	否	镜像描述
» plan_id	body	string	否	镜像推荐套餐id
» proxy	body	string	否	镜像推荐网络规则(json格式，参考网络信息操作)
» image_ico	body	string	否	镜像图标
» env	body	string	否	镜像默认环境变量，json

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 与服务器镜像同步

GET /v1/image/sync

请求参数

名称	位置	类型	必选	说明
server_id	query	string	否	服务器id
Authorization	header	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

apiServer/用户类/用户流程接口

GET 获取服务器列表

GET /v1/user/procedure/get_server_list

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取服务器套餐列表

GET /v1/user/procedure/get_server_plan_list

请求参数

名称	位置	类型	必选	说明
server_id	query	string	否	服务器id
Authorization	header	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 提交续费订单

POST /v1/user/procedure/update_container_renew

Body 请求参数

container_id: string
pay_months: string
pay_type: "0、支付宝支付\r\n1、微信支付\r\n2、QQ支付\r\n3、其他"

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» container_id	body	string	否	容器id
» pay_months	body	string	否	续费时长 /月
» pay_type	body	string	否	支付类型

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 提交容器订单

POST /v1/user/procedure/update_plan_info

Body 请求参数

server_id: string
plan_id: string
volume_size: string
pay_months: string
proxy: "[\r

  \    {    \r

  \        \"type\": \"port_forward\",\r

  \        \"container_port\": 容器内部端口号 int\r

  \    },\r

  \    {\r

  \        \"type\": \"nginx\",\r

  \        \"container_port\": 容器内部端口号 int,\r

  \        \"domain\": 域名\r

  \    },\r

  \    {\r

  \        \"type\": \"floating_ip\"\r

  \    }\r

  ]"
pay_type: "0、支付宝支付\r\n1、微信支付\r\n2、QQ支付\r\n3、其他"
image_id: string
env: "{\r

  \    \"key1\": \"value1\",\r

  \    \"key2\": \"value2\",\r

  \    \"key3\": \"value3\"\r

  \    ...\r

  }"

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» server_id	body	string	是	服务器id
» plan_id	body	string	是	套餐id
» volume_size	body	string	否	额外数据盘大小默认0
» pay_months	body	string	是	购买时间 /月
» proxy	body	string	是	网络信息
» pay_type	body	integer	否	支付类型
» image_id	body	string	否	镜像id
» env	body	string	否	环境变量 json

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 查询订单列表

GET /v1/user/procedure/get_trade_list

请求参数

名称	位置	类型	必选	说明
page	query	string	否	页码，默认 1
count	query	string	否	数量，默认 10
Authorization	header	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取完整订单信息

GET /v1/user/procedure/get_trade_info

请求参数

名称	位置	类型	必选	说明
trade_id	query	string	否	订单id
Authorization	header	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 提交配置升级订单

POST /v1/user/procedure/update_container

Body 请求参数

container_id: string
plan_id: string
pay_type: "0、支付宝支付\r\n1、微信支付\r\n2、QQ支付\r\n3、其他"

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id
» plan_id	body	string	否	套餐id
» pay_type	body	string	否	支付类型

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取自身信息

GET /v1/user/procedure/get_user_info

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 提交充值订单

POST /v1/user/procedure/update_container_recharge

Body 请求参数

pay_price: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» pay_price	body	string	否	充值金额

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取用户所有操作日志

GET /v1/user/procedure/get_user_log

请求参数

名称	位置	类型	必选	说明
page	query	string	否	页码，默认 1
count	query	string	否	数量，默认 20
user_id	query	string	否	用户id
Authorization	header	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 获取订单金额

POST /v1/user/procedure/get_price

Body 请求参数

server_id: string
plan_id: string
volume_size: string
pay_months: string
proxy: |-
  [
      {    
          "type": "port_forward",
          "container_port": 容器内部端口号 int
      },
      {
          "type": "nginx",
          "container_port": 容器内部端口号 int,
          "domain": 域名
      },
      {
          "type": "floating_ip"
      }
  ]

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» server_id	body	string	是	服务器id
» plan_id	body	string	是	套餐id
» volume_size	body	string	否	额外数据盘大小默认0
» pay_months	body	string	是	购买时间 /月
» proxy	body	string	是	网络信息

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取简略订单信息

GET /v1/user/procedure/get_low_trade_info

Body 请求参数

trade_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» trade_id	body	string	否	订单id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 提交新增容器网络订单

POST /v1/user/procedure/add_network

Body 请求参数

container_id: string
proxy: string
pay_type: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id
» proxy	body	string	否	网络信息
» pay_type	body	string	否	支付类型

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 获取新增容器网络价格

POST /v1/user/procedure/get_price_network

Body 请求参数

container_id: string
proxy: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id
» proxy	body	string	否	网络信息

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

apiServer/用户类/对外暴露接口

POST 实名认证

POST /v1/external/real_name

Body 请求参数

real_name_type: string
name: string
phone: string
card_id: string
enterprise_name: string
enterprise_code: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» real_name_type	body	string	否	认证类型：1.个人，2.企业
» name	body	string	否	真实姓名
» phone	body	string	否	手机号码
» card_id	body	string	否	身份证号码
» enterprise_name	body	string	否	企业名称
» enterprise_code	body	string	否	营业执照

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 发送短信

POST /v1/external/send_message

Body 请求参数

message_type: string
send_to: string
user_id: string
code: string
hcode: string

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» message_type	body	string	否	短信类型
» send_to	body	string	否	短信接收手机号
» user_id	body	string	否	用户id
» code	body	string	否	图形验证码
» hcode	body	string	否	图形校验码（获取图形验证码返回的hcode）

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 发送邮件

POST /v1/external/send_email

Body 请求参数

message_type: string
send_to: string
user_id: string
code: string
hcode: string

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» message_type	body	string	否	邮件类型
» send_to	body	string	否	邮件接收手机号
» user_id	body	string	否	用户id
» code	body	string	否	图形验证码
» hcode	body	string	否	图形校验码（获取图形验证码返回的hcode）

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 支付请求

POST /v1/external/pay

Body 请求参数

trade_id: string
pay_type: 0
pay_price: 0
param: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» trade_id	body	string	否	订单id
» pay_type	body	integer	否	支付类型，仅在充值余额时使用
» pay_price	body	integer	否	充值金额，如果提交参数订单默认为充值订单
» param	body	string	否	成功回调时需要接收的返回值

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

apiServer/用户类/容器管理

GET 获取容器列表

GET /v1/user/container/list

Body 请求参数

{}

请求参数

名称	位置	类型	必选	说明
key	query	string	否	关键字检索
page	query	string	否	页码，默认 1
count	query	string	否	数量，默认 10
server_id	query	string	否	服务器id
Authorization	header	string	否	none
body	body	object	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 启动容器

POST /v1/user/container/start

Body 请求参数

container_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 停止容器

POST /v1/user/container/stop

Body 请求参数

container_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 重启容器

POST /v1/user/container/reboot

Body 请求参数

container_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 获取容器控制台

POST /v1/user/container/console

Body 请求参数

container_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 获取容器状态

POST /v1/user/container/status

Body 请求参数

container_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 获取容器操作日志

POST /v1/user/container/logs

Body 请求参数

container_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取容器完整信息

GET /v1/user/container/detail

请求参数

名称	位置	类型	必选	说明
container_id	query	string	否	容器id
Authorization	header	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 获取容器运行日志

POST /v1/user/container/run_logs

Body 请求参数

container_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 删除容器

POST /v1/user/container/delete

Body 请求参数

container_id: string
password: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id
» password	body	string	否	用户密码

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 删除容器网络

POST /v1/user/container/delete_connect

Body 请求参数

container_id: string
connect_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id
» connect_id	body	string	否	网络id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 重装容器

POST /v1/user/container/reinstall

Body 请求参数

image_id: string
connect_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» image_id	body	string	否	镜像id
» connect_id	body	string	否	容器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

apiServer/用户类/用户登录注册

POST 用户注册

POST /v1/user/register

Body 请求参数

username: string
password: string
phone: string
email: string
code: string

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» username	body	string	是	用户名
» password	body	string	是	密码
» phone	body	string	否	手机号码
» email	body	string	否	电子邮箱
» code	body	string	是	验证码

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 用户登录

POST /v1/user/login

Body 请求参数

username: string
password: string

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» username	body	string	否	用户名（可以为用户名、邮箱、手机号）
» password	body	string	否	密码

返回示例

200 Response

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取图形验证码

GET /v1/user/check/get_code_img

返回示例

200 Response

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 校验图形验证码

GET /v1/user/check/check_code_img

Body 请求参数

{}

请求参数

名称	位置	类型	必选	说明
code	query	string	否	验证码
body	body	object	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

apiServer/用户类/用户信息接口

GET 获取用户自身信息

GET /v1/user/info/get_user_info

Body 请求参数

{}

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 修改用户密码

POST /v1/user/info/update_user_password

Body 请求参数

password: string
new_password: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» password	body	string	否	原密码
» new_password	body	string	否	新密码

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 获取修改手机校验码

POST /v1/user/info/ask_update_user_phone

Body 请求参数

phone: string
code: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» phone	body	string	否	原手机号码
» code	body	string	否	短信验证码

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 修改手机号码

POST /v1/user/info/update_user_phone

Body 请求参数

phone: string
code: string
ask_code: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» phone	body	string	否	新手机号码
» code	body	string	否	短信验证码
» ask_code	body	string	否	手机校验码

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 获取修改邮箱校验码

POST /v1/user/info/ask_update_user_email

Body 请求参数

email: string
code: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» email	body	string	否	原邮箱
» code	body	string	否	邮箱验证码

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 修改邮箱

POST /v1/user/info/update_user_email

Body 请求参数

email: string
code: string
ask_code: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» email	body	string	否	新邮箱
» code	body	string	否	验证码
» ask_code	body	string	否	邮箱校验码

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 申请绑定手机号码

POST /v1/user/info/ask_bind_user_phone

Body 请求参数

phone: string
code: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» phone	body	string	否	手机号码
» code	body	string	否	验证码

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 申请绑定邮箱

POST /v1/user/info/ask_bind_user_email

Body 请求参数

email: string
code: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» email	body	string	否	邮箱
» code	body	string	否	验证码

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 修改用户头像

POST /v1/user/info/upload_user_avatar

Body 请求参数

file: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» file	body	string(binary)	是	用户头像

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 忘记用户密码_手机号码

POST /v1/user/info/forget_user_password_phone

Body 请求参数

phone: string
password: string
code: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» phone	body	string	否	手机号码
» password	body	string	否	密码
» code	body	string	否	验证码

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 忘记用户密码_邮箱

POST /v1/user/info/forget_user_password_email

Body 请求参数

email: string
password: string
code: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» email	body	string	否	邮箱
» password	body	string	否	密码
» code	body	string	否	验证码

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

apiServer/用户类/消息获取

GET 获取消息列表

GET /v1/messages/get_message_list

请求参数

名称	位置	类型	必选	说明
page	query	string	否	页码，默认 1
count	query	string	否	数量，默认 10
message_type	query	string	否	消息类型
Authorization	header	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取单条消息

GET /v1/messages/get_message

请求参数

名称	位置	类型	必选	说明
message_id	query	string	否	消息id
Authorization	header	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

apiServer/公用类/工单管理

GET 获取工单列表

GET /v1/workSheet/get_list

Body 请求参数

user_id: string
page: string
count: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» user_id	body	string	否	用户id
» page	body	string	否	页码，默认 1
» count	body	string	否	数量，默认 10

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

GET 获取工单信息

GET /v1/workSheet/select

Body 请求参数

{}

请求参数

名称	位置	类型	必选	说明
sheet_id	query	string	否	工单id
Authorization	header	string	否	none
body	body	object	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 创建工单

POST /v1/workSheet/submit

Body 请求参数

container_id: string
title: string
content: string
sheet_type: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» container_id	body	string	否	容器id
» title	body	string	否	工单标题
» content	body	string	否	工单内容
» sheet_type	body	string	否	工单内容

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 回复工单

POST /v1/workSheet/reply

Body 请求参数

content: string
sheet_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» content	body	string	否	工单回复内容
» sheet_id	body	string	否	工单id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 修改工单状态

POST /v1/workSheet/retype

Body 请求参数

sheet_id: string
state: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» sheet_id	body	string	否	工单id
» state	body	string	否	状态类型

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 删除工单

POST /v1/workSheet/delete

Body 请求参数

sheet_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» sheet_id	body	string	否	工单id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

apiServer/公用类/容器文件管理

GET 获取容器文件列表

GET /v1/file/list

请求参数

名称	位置	类型	必选	说明
container_id	query	string	否	容器id
path	query	string	否	文件夹路径
Authorization	header	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 删除文件或文件夹

POST /v1/file/delete

Body 请求参数

path: string
container_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» path	body	string	否	文件路径
» container_id	body	string	否	容器id

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 写入文件

POST /v1/file/write

Body 请求参数

path: string
content: string
container_id: string

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	否	none
body	body	object	否	none
» path	body	string	否	文件路径
» content	body	string	否	文件内容（非文本转为base64）
» container_id	body	string	否	容器id