cdnca

开放接口

/v1/admin/package-resource-monitor

2 个接口

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

方法路径摘要认证
GET/v1/admin/package-resource-monitor查询所有当前有效用户套餐的带宽与连接数资源状态登录会话
GET/v1/admin/package-resource-monitor/nodes查询一个当前有效用户套餐的节点资源状态登录会话

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

接口详情

GET /v1/admin/package-resource-monitor

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

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

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

参数

listAdminPackageResources 参数
名称位置类型必填说明
query_versionqueryinteger: 1 / 2否默认版本 1 仅返回旧字段；版本 2 返回稳定 subscription_display_id 并支持数字套餐 ID 筛选。
subscription_display_idsquerystring否仅版本 2；逗号分隔的持久化用户套餐数字编号，不得重复，最多 100 个，单个不超过 9223372036854775807。不能与 subscription_ids 同时使用。
pagequeryinteger否—
limitqueryinteger: 10 / 30 / 100 / 300否—
order_byquerystring: bandwidth / connections否—
user_idquerystring否—
subscription_idsquerystring否逗号分隔、不得重复的套餐 UUID，最多 100 个
node_idsquerystring否逗号分隔、不得重复的节点显示 ID，最多 100 个

响应

listAdminPackageResources 响应
状态码说明
200套餐不可变快照、用户显示 ID 与权威监控观测组成的分页结果

字段：count: integer items: array<PackageResourceMonitorItem>

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

失败时怎么办

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

↑ 回到列表

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

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

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

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

参数

listAdminPackageResourceNodes 参数
名称位置类型必填说明
subscription_idquerystring(uuid)是—

响应

listAdminPackageResourceNodes 响应
状态码说明
200ClickHouse 当前节点维度遥测；缺少任一指标时明确返回 unknown

字段：items: array<PackageResourceMonitorNode>

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

失败时怎么办

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

↑ 回到列表