CDNHAO使用文档

基础套餐列表

GET /v1/packages
pageinteger
当前页码
limitinteger
单页显示数量
enableboolean
启用或禁用
groupinteger
所属套餐组
region_idinteger
所属区域ID
mine
设置时，只显示专属套餐
{
    "code": 0,
    "count": 1,
    "data": [
        {
            "backup_node_group": null,
            "backup_node_group_name": null,
            "before_exp_days_renew": 10,
            "buy_num_limit": -1,
            "cname_domain": "",
            "cname_hostname2": "",
            "cname_mode": "site",
            "create_at": null,
            "create_at2": "2021-12-19 16:47:05",
            "custom_cc_rule": 0,
            "des": "",
            "domain": 10,
            "enable": 1,
            "expire": null,
            "expire2": null,
            "groups": "11",
            "http_port": 10,
            "id": 647,
            "id_verify": 0,
            "month_price": 1,
            "name": "aa",
            "node_group_id": 833,
            "node_group_name": "aa",
            "owner": "",
            "quarter_price": 0,
            "region_id": 1098,
            "region_name": "test",
            "sort": 100,
            "stream_port": 0,
            "traffic": 100,
            "update_at": null,
            "websocket": 0,
            "year_price": 0
        }
    ]
}

新增基础套餐

POST /v1/packages
name
required套餐名称
des
备注
region_idinteger
required区域ID
node_group_idinteger
required线路组ID
backup_node_group
备用线路组
cname_domain
cname域名ID
cname_hostname2
cname主机名
cname_mode
默认为site，可选site,package。当为site时，每个网站单独一个cname地址，当为package时，每一个用户套餐分配一个cname地址
trafficinteger
限制的流量数，单位为G，默认0，当为-1时，表示不限制
bandwidth
带宽限制，可选单位为Mbps,Gbps，当为-1时，表示不限制
connectioninteger
连接数限制，当为-1时，表示不限制
domaininteger
限制添加的域名数，默认为0，当为-1时，表示不限制
http_portinteger
网站监听的非标端口数量，即除80和443之外的端口数，默认为0，当为-1时，表示不限制
stream_portinteger
四层转发端口数，默认为0，当为-1时，表示不限制
custom_cc_ruleboolean
是否可以自定义cc规则，默认为False
websocketboolean
是否支持websocket，默认为False
expire
套餐过期时间，即到期后，套餐不可购买，格式为2021-12-01 12:00:00
buy_num_limitinteger
限制同一个用户购买的套餐数量，-1为不限制
id_verifyboolean
是否需要实名认证，默认为False
before_exp_days_renewinteger
限制当套餐剩余天数超过此值时，不允许续费，默认为-1不限制
sortinteger
排序，默认为100
owner
指定的用户才允许购买此套餐，填用户ID，多个以逗号分隔
month_price
required月付价格，单元为元
quarter_price
required季付价格，单元为元
year_price
required年付价格，单元为元
enableboolean
启用或禁用，默认启用
groups
required所属的套餐组，多个以逗号分隔
{
  "code":0, 
  "data": "2", 
  "msg": "套餐添加成功"
}
{
	"name": "高防套餐",
	"region_id": 1,
	"node_group_id": 1,
	"month_price": 10,
	"quarter_price": 30,
	"year_price": 100,
	"groups": 1
}

批量修改基础套餐 (数据格式为数组)

PUT /v1/packages
idinteger
required套餐ID
name
套餐名称
des
备注
region_idinteger
区域ID
node_group_idinteger
线路组ID
backup_node_group
备用线路组
cname_domain
cname主域名，留空时，使用dns设置的主域名
cname_hostname2
cname主机名
cname_mode
默认为site，可选site,package。当为site时，每个网站单独一个cname地址，当为package时，每一个用户套餐分配一个cname地址
trafficinteger
限制的流量数，单位为G，默认0，当为-1时，表示不限制
connectioninteger
连接数限制，当为-1时，表示不限制
domaininteger
限制添加的域名数，默认为0，当为-1时，表示不限制
domaininteger
限制添加的域名数，默认为0，当为-1时，表示不限制
http_portinteger
网站监听的非标端口数量，即除80和443之外的端口数，默认为0，当为-1时，表示不限制
stream_portinteger
四层转发端口数，默认为0，当为-1时，表示不限制
custom_cc_ruleboolean
是否可以自定义cc规则，默认为False
websocketboolean
是否支持websocket，默认为False
expire
套餐过期时间，即到期后，套餐不可购买，格式为2021-12-01 12:00:00
buy_num_limitinteger
限制同一个用户购买的套餐数量，-1为不限制
id_verifyboolean
是否需要实名认证，默认为False
before_exp_days_renewinteger
限制当套餐剩余天数超过此值时，不允许续费，默认为-1不限制
sortinteger
排序，默认为100
owner
指定的用户才允许购买此套餐，填用户ID，多个以逗号分隔
month_price
月付价格，单元为元
quarter_price
季付价格，单元为元
year_price
年付价格，单元为元
enableboolean
启用或禁用，默认启用
groups
所属的套餐组，多个以逗号分隔
sync-item
需要同步数据到用户套餐的项目。当修改基础套餐时，不会同步到已售套餐，如果想同步，可以指定此项。支持同步的项目为name，node_group_id，cname_domain，cname_hostname2，cname_mode，traffic，domain，http_port，stream_port，custom_cc_rule，websocket，month_price，quarter_price，year_price。
{
  "code":0, 
  "data": "", 
  "msg": "套餐修改成功"
}
[{
	"id": 1,
	"enable": 0
}, {
	"id": 2,
	"enable": 0
}]

获取指定基础套餐

GET /v1/packages/<套餐ID> 
{
    "code": 0,
    "data": {
        "backup_node_group": null,
        "before_exp_days_renew": 10,
        "buy_num_limit": -1,
        "cname_domain": "",
        "cname_hostname2": "",
        "cname_mode": "site",
        "create_at": null,
        "custom_cc_rule": 0,
        "des": "",
        "domain": 10,
        "enable": 1,
        "expire": null,
        "http_port": 10,
        "id": 647,
        "id_verify": 0,
        "month_price": 1,
        "name": "aa",
        "node_group_id": 833,
        "owner": "",
        "quarter_price": 0,
        "region_id": 1098,
        "sort": 100,
        "stream_port": 0,
        "traffic": 100,
        "update_at": null,
        "websocket": 0,
        "year_price": 0
    },
    "msg": ""
}

修改指定基础套餐

PUT /v1/packages/<套餐ID>
name
套餐名称
des
备注
region_idinteger
区域ID
node_group_idinteger
线路组ID
backup_node_group
备用线路组
cname_domain
cname主域名，留空时，使用dns设置的主域名
cname_hostname2
cname主机名
cname_mode
默认为site，可选site,package。当为site时，每个网站单独一个cname地址，当为package时，每一个用户套餐分配一个cname地址
trafficinteger
限制的流量数，单位为G，默认0，当为-1时，表示不限制
domaininteger
限制添加的域名数，默认为0，当为-1时，表示不限制
http_portinteger
网站监听的非标端口数量，即除80和443之外的端口数，默认为0，当为-1时，表示不限制
stream_portinteger
四层转发端口数，默认为0，当为-1时，表示不限制
custom_cc_ruleboolean
是否可以自定义cc规则，默认为False
websocketboolean
是否支持websocket，默认为False
expire
套餐过期时间，即到期后，套餐不可购买，格式为2021-12-01 12:00:00
buy_num_limitinteger
限制同一个用户购买的套餐数量，-1为不限制
id_verifyboolean
是否需要实名认证，默认为False
before_exp_days_renewinteger
限制当套餐剩余天数超过此值时，不允许续费，默认为-1不限制
sortinteger
排序，默认为100
owner
指定的用户才允许购买此套餐，填用户ID，多个以逗号分隔
month_price
月付价格，单元为元
quarter_price
季付价格，单元为元
year_price
年付价格，单元为元
enableboolean
启用或禁用，默认启用
groups
所属的套餐组，多个以逗号分隔
sync-item
需要同步数据到用户套餐的项目。当修改基础套餐时，不会同步到已售套餐，如果想同步，可以指定此项。支持同步的项目为name，node_group_id，cname_domain，cname_hostname2，cname_mode，traffic，domain，http_port，stream_port，custom_cc_rule，websocket，month_price，quarter_price，year_price。
{
  "code":0, 
  "data": "", 
  "msg": "套餐修改成功"
}
{
	"name": "新套餐名称"
}

删除基础套餐

DELETE /v1/packages/<套餐ID，多个以逗号分隔> 
{
  "code": 0, 
  "data": "", 
  "msg": "套餐删除成功"
}