套餐监控 package-monitor

仅管理员:近 1 分钟各用户套餐的带宽与连接数。

点击任一接口,右侧显示对应的调用示例。

套餐鉴权: 仅管理员2 个接口

鉴权

请求头带 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-monitor套餐监控

鉴权: 仅管理员

查询参数

字段类型说明
pageinteger 页码,从 1 开始。
默认 1
page_sizeinteger 每页条数。
默认 20
sortstring 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。
tenant_idinteger 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。
tenant_idsstring 仅管理员可用:只看这些租户,逗号分隔的正整数,去重后至多 200 个(超了或格式错 422);只选 1 个也可用。只做过滤、不切换请求作用域,与 tenant_id 及其他条件取交集;租户凭据带了非空值回 403。
user_package_idinteger 按用户套餐 id 过滤。
node_idinteger 节点 ID
upidsstring 只看这些用户套餐:逗号分隔的正整数,去重后至多 200 个(超了或格式错 422);与 user_package_id 同给取交集。
node_idsstring 只看这些节点:逗号分隔的正整数,去重后至多 200 个(超了或格式错 422);与 node_id 同给取交集。

套餐监控对象

字段类型说明
bandwidth_bpsinteger 最近 1 分钟各节点出站带宽之和(bit/s)。
bandwidth_limit_mbpsinteger 有效带宽额度(含扩展包);-1 不限。
connectionsinteger 最近 1 分钟各节点连接数峰值之和。
connections_limitinteger 有效连接数额度(含扩展包);-1 不限。
itemsPackageMonitorNode[] 本页条目
namestring 名称
tenant_idinteger 所属租户(用户)ID
user_package_idinteger 已购套餐 ID。

返回与错误

成功直接回资源 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"
}
开始使用

体验在线演示

访问在线演示,或联系我们获取报价与安装命令