版本 2.4.7.20261116085428 · 最新
扩展包 package-upgrades
在基础套餐之上按份加购的额度或功能。
点击任一接口,右侧显示对应的调用示例。
套餐鉴权: 仅管理员5 个接口
鉴权
请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。
X-API-Key
鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。
约定
分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。
时间一律 RFC 3339(UTC);金额单位为分。
写操作成功回 200/201/204;重复提交按资源唯一键回 409。
GET
/api/v2/package-upgrades列出扩展包
鉴权: 仅管理员
查询参数
| 字段 | 类型 | 说明 |
|---|---|---|
page | integer | 页码,从 1 开始。 |
page_size | integer | 每页条数。 |
sort | string | 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。 |
POST
/api/v2/package-upgrades创建扩展包
鉴权: 仅管理员
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
amount | integer | 每份加多少;功能类(custom_cc_rule/websocket)恒为 1 |
bind_packages | integer[] | 只许这些基础套餐加购;空 = 不限 |
des | string | 备注说明 |
enabled | boolean | 是否启用 |
name必填 | string | 名称 |
price_cents必填 | integer | 每份每月价格,分 |
prices | UpgradePrice[] | 分币种价目;须含基准币一行(mode=base,价 = price_cents)。mode=manual 用固定价,mode=auto 由基准价按汇率现算。写入不带 prices 则非基准行不动。套餐目录(/package-catalog)按购买口径出:缺行按 auto 现算补,汇率未就绪的币不出行;管理端只出存行。 |
type必填 | string | 加购项:流量 GB、域名数、非标端口数、四层端口数、自定义 CC、带宽 Mbps、连接数、WebSocket、独立 IP 数 |
PUT
/api/v2/package-upgrades/{id}修改扩展包
鉴权: 仅管理员
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
amount | integer | 每份加多少;功能类(custom_cc_rule/websocket)恒为 1 |
bind_packages | integer[] | 只许这些基础套餐加购;空 = 不限 |
des | string | 备注说明 |
enabled | boolean | 是否启用 |
name必填 | string | 名称 |
price_cents必填 | integer | 每份每月价格,分 |
prices | UpgradePrice[] | 分币种价目;须含基准币一行(mode=base,价 = price_cents)。mode=manual 用固定价,mode=auto 由基准价按汇率现算。写入不带 prices 则非基准行不动。套餐目录(/package-catalog)按购买口径出:缺行按 auto 现算补,汇率未就绪的币不出行;管理端只出存行。 |
type必填 | string | 加购项:流量 GB、域名数、非标端口数、四层端口数、自定义 CC、带宽 Mbps、连接数、WebSocket、独立 IP 数 |
扩展包对象
| 字段 | 类型 | 说明 |
|---|---|---|
active_count | integer | 在用份数:未到期用户套餐上加购的份数合计。只在管理端列表返回。 |
amount | integer | 每份加多少;功能类(custom_cc_rule/websocket)恒为 1 |
bind_packages | integer[] | 只许这些基础套餐加购;空 = 不限 |
created_at | string | 创建时间 |
des | string | 备注说明 |
enabled | boolean | 是否启用 |
id | integer | 记录 ID |
name | string | 名称 |
price_cents | integer | 每份每月价格,分 |
prices | UpgradePrice[] | 分币种价目;须含基准币一行(mode=base,价 = price_cents)。mode=manual 用固定价,mode=auto 由基准价按汇率现算。写入不带 prices 则非基准行不动。套餐目录(/package-catalog)按购买口径出:缺行按 auto 现算补,汇率未就绪的币不出行;管理端只出存行。 |
recent_30d | integer | 近 30 天新购份数:近 30 天加购订单的份数合计(0 元加购不计)。只在管理端列表返回。 |
type | string | 加购项:流量 GB、域名数、非标端口数、四层端口数、自定义 CC、带宽 Mbps、连接数、WebSocket、独立 IP 数 |
updated_at | string | 更新时间 |
user_package_count | integer | 加购过此扩展包的用户套餐数(含已到期);大于 0 时不能删除,只能停用。只在管理端列表返回。 |
返回与错误
成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。
成功
{
"id": 1,
"name": "example"
}列表
{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}失败
{
"code": "validation_failed",
"detail": "请求参数不合法",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name 必填"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}