方法路径摘要认证
GET/v1/package-usage查询当前用户套餐用量登录会话
GET/v1/package-usage/search当前租户整体用量曲线(带宽/流量按时间桶聚合)登录会话

契约文件:api/control-package-usage.openapi.yaml

接口详情

GET /v1/package-usage

查询当前用户套餐用量

operationId
queryTenantPackageUsage
认证
  • 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
所需权限

契约没有单独标注权限码,权限要求见下方说明与 403 响应。

参数

queryTenantPackageUsage 参数
名称位置类型必填说明
subscription_idquerystring(uuid)是—
site_idquerystring(uuid)否—
fromquerystring(date-time)是—
toquerystring(date-time)是—
timezonequerystring是—
bucketquerystring: hour / day是—
limitqueryinteger否—
cursorquerystring否—

响应

queryTenantPackageUsage 响应
状态码说明
200使用冻结数据快照计算的套餐用量

字段:metric_schema_version: string subscription_id: string(uuid) site_id?: string(uuid) from: string(date-time) to: string(date-time) timezone: string bucket: string: hour / day traffic_bytes: string http_traffic_bytes: string l4_traffic_bytes: string peak_bandwidth_bps: string bandwidth_95th_bps: string connections: string source_watermark: string finalized_through: string(date-time) delayed: boolean series: array<PackageUsagePoint> next_cursor?: string

400稳定错误信封
401稳定错误信封
403稳定错误信封
404稳定错误信封
408稳定错误信封
502稳定错误信封
503稳定错误信封

失败时怎么办

  • 400 按字段说明修正参数或请求体再发;不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。
  • 404 资源不存在或不属于当前租户。
  • 503 依赖暂不可用:稍后用原 Idempotency-Key 重试。

↑ 回到列表

GET /v1/package-usage/search

当前租户整体用量曲线(带宽/流量按时间桶聚合)

operationId
searchTenantPackageUsage
认证
  • 登录会话:主控登录后的 Bearer 会话,由客户本人在自己的主控里使用;插件不能要求客户交出会话。
所需权限

契约没有单独标注权限码,权限要求见下方说明与 403 响应。

说明(契约原文)

仅 tenant 作用域且具有 package_subscriptions.read(或 platform.admin)权限;只统计调用者自己的租户作用域。 口径与 /v1/admin/package-usage/search 相同(access_metering_facts_v1 + l4_session_facts_v1,不新建账本), 不接受 user_ids / subscription_ids(传入返回400);service_type、domains、listen_ports 同管理员接口。

参数

searchTenantPackageUsage 参数
名称位置类型必填说明
fromquerystring(date-time)是—
toquerystring(date-time)是—
timezonequerystring是—
bucketquerystring: hour / day是—
X-Request-IDheaderstring是—
service_typequerystring: all / site / stream否—
domainsquerystring否—
listen_portsquerystring否—

响应

searchTenantPackageUsage 响应
状态码说明
200有界结果;filters.user_ids 与 subscription_ids 恒为空数组。

字段:schema: string from: string(date-time) to: string(date-time) timezone: string bucket: string: hour / day filters: UsageSearchFilters bandwidth_basis: string has_data: boolean traffic_bytes: string peak_bandwidth_bps: string bandwidth_95th_bps: string series: array<UsageSearchPoint>

400稳定错误信封
401稳定错误信封
403稳定错误信封
408稳定错误信封
502稳定错误信封
503稳定错误信封

失败时怎么办

  • 400 按字段说明修正参数或请求体再发;不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域;不要换更高权限账号绕过。
  • 503 依赖暂不可用:稍后用原 Idempotency-Key 重试。

↑ 回到列表