版本 2.4.8 · 最新
已售套餐用户 user-package-owners
仅管理员:按用户归组的已售套餐列表(套餐数、到期统计、页签计数)。
点击任一接口,右侧显示对应的调用示例。
套餐鉴权: 仅管理员1 个接口
鉴权
请求头带 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/user-package-owners按用户列出已售套餐
鉴权: 仅管理员
查询参数
| 字段 | 类型 | 说明 |
|---|---|---|
page | integer | 页码,从 1 开始。 |
page_size | integer | 每页条数。 |
tab | string | 页签:all 全部、week 7 天内到期(未过期)、month 30 天内到期(未过期)、expired 已过期、customized 已定制(单独改过额度或不跟随基础套餐);缺省 all。 |
q | string | 关键词:用户名、套餐名称或基础套餐名称包含(% _ 按字面匹配),或等于用户 ID / 套餐 ID。 |
已售套餐用户对象
| 字段 | 类型 | 说明 |
|---|---|---|
avatar_ver | integer | 头像版本,每次上传变大,作取头像的缓存键;没有头像时缺省。 |
expired_count | integer | 其中已过期的套餐数。 |
expiring_count | integer | 其中 7 天内到期(未过期)的套餐数。 |
next_end_at | string | 页签内最近一个未过期套餐的到期时间;全部已过期时缺省。 |
nickname | string | 昵称;没设时缺省(界面显示登录名)。 |
package_count | integer | 页签内的套餐数。 |
user_id | integer | 用户 ID(即租户 ID)。 |
username | string | 登录名。 |
返回与错误
成功直接回资源 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"
}