开放接口

`/v1/admin/package-usage`

1 个接口

← 全部分组 · 第一次调用？先看教程：认证、权限、请求与响应、常见失败

方法	路径	摘要	认证
GET	`/v1/admin/package-usage`	查询指定租户套餐用量	登录会话

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

接口详情

GET `/v1/admin/package-usage`

查询指定租户套餐用量

operationId

queryAdminPackageUsage

认证

登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。

所需权限

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

参数

queryAdminPackageUsage 参数
名称	位置	类型	必填	说明
`tenant_id`	query	`string(uuid)`	否	Optional for platform administrators. When omitted, the control API resolves the subscription's owning tenant from subscription_id before authorizing the usage query.
`subscription_id`	query	`string(uuid)`	是	—
`site_id`	query	`string(uuid)`	否	—
`from`	query	`string(date-time)`	是	—
`to`	query	`string(date-time)`	是	—
`timezone`	query	`string`	是	—
`bucket`	query	`string: hour / day`	是	—
`limit`	query	`integer`	否	—
`cursor`	query	`string`	否	—

响应

queryAdminPackageUsage 响应
状态码	说明
`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 重试。

↑ 回到列表