API reference

`/v1/admin/package-traffic-coverage`

1 operations

← All groups · First call? Read the tutorial: auth, permissions, requests and responses, common failures

Method	Path	Summary	Auth
GET	`/v1/admin/package-traffic-coverage`	查询用户套餐每个周期由全局流量包覆盖的流量（最近周期在前）	Session

Contract file：api/control-package-usage.openapi.yaml

Operation details

GET `/v1/admin/package-traffic-coverage`

查询用户套餐每个周期由全局流量包覆盖的流量（最近周期在前）

operationId

listAdminPackageTrafficCoverage

Auth

Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.

Required permissions

The contract has no separate permission annotation; see the description below and the 403 response.

Parameters

listAdminPackageTrafficCoverage Parameters
Name	In	Type	Required	Description
`tenant_id`	query	`string(uuid)`	No	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)`	Yes	—
`limit`	query	`integer`	No	返回的周期数，默认 12

Responses

listAdminPackageTrafficCoverage Responses
Status	Description
`200`	每个周期由流量包覆盖的流量（字节，十进制字符串）与扣量批次 Fields：`subscription_id: string(uuid)` `items: array<PackageTrafficCoverageCycle>`
`400`	稳定错误信封
`401`	稳定错误信封
`403`	稳定错误信封
`404`	稳定错误信封
`408`	稳定错误信封
`503`	稳定错误信封

What to do on failure

400 Fix the parameters or body per the field list; do not retry unchanged.
401 Check the credential format and whether it expired or was rotated.
403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.
404 The resource does not exist or belongs to another tenant.
503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list