MethodPathSummaryAuth
GET/v1/admin/package-resource-monitor查询所有当前有效用户套餐的带宽与连接数资源状态Session
GET/v1/admin/package-resource-monitor/nodes查询一个当前有效用户套餐的节点资源状态Session

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

Operation details

GET /v1/admin/package-resource-monitor

查询所有当前有效用户套餐的带宽与连接数资源状态

operationId
listAdminPackageResources
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

listAdminPackageResources Parameters
NameInTypeRequiredDescription
query_versionqueryinteger: 1 / 2No默认版本 1 仅返回旧字段;版本 2 返回稳定 subscription_display_id 并支持数字套餐 ID 筛选。
subscription_display_idsquerystringNo仅版本 2;逗号分隔的持久化用户套餐数字编号,不得重复,最多 100 个,单个不超过 9223372036854775807。不能与 subscription_ids 同时使用。
pagequeryintegerNo—
limitqueryinteger: 10 / 30 / 100 / 300No—
order_byquerystring: bandwidth / connectionsNo—
user_idquerystringNo—
subscription_idsquerystringNo逗号分隔、不得重复的套餐 UUID,最多 100 个
node_idsquerystringNo逗号分隔、不得重复的节点显示 ID,最多 100 个

Responses

listAdminPackageResources Responses
StatusDescription
200套餐不可变快照、用户显示 ID 与权威监控观测组成的分页结果

Fields:count: integer items: array<PackageResourceMonitorItem>

400稳定错误信封
401稳定错误信封
403稳定错误信封
408稳定错误信封
502稳定错误信封
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.
  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list

GET /v1/admin/package-resource-monitor/nodes

查询一个当前有效用户套餐的节点资源状态

operationId
listAdminPackageResourceNodes
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

listAdminPackageResourceNodes Parameters
NameInTypeRequiredDescription
subscription_idquerystring(uuid)Yes—

Responses

listAdminPackageResourceNodes Responses
StatusDescription
200ClickHouse 当前节点维度遥测;缺少任一指标时明确返回 unknown

Fields:items: array<PackageResourceMonitorNode>

400稳定错误信封
401稳定错误信封
403稳定错误信封
404稳定错误信封
408稳定错误信封
502稳定错误信封
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