方法路径摘要认证
GET/v1/admin/dashboardRead the platform administrator dashboard登录会话

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

接口详情

GET /v1/admin/dashboard

Read the platform administrator dashboard

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

全部需要:platform.admin

说明(契约原文)

Requires a live platform session and platform.admin. The calendar window is constructed in timezone, converted to a left-closed, right-open UTC window, and must remain hour aligned and no longer than 31 local calendar days (745 elapsed hours across a fall-back). Every query parameter is required, single-valued, and strict; unknown parameters and tenant_id are rejected.

参数

getAdminDashboard 参数
名称位置类型必填说明
rangequerystring: seven_days / thirty_days / previous_month是Platform calendar range in the requested timezone.
timezonequerystring是IANA timezone name other than Local. Calendar boundaries converted to UTC must be hour aligned; zones with a non-hour boundary offset are rejected rather than rounded.
site_idquerystring(uuid)否Optional canonical site UUID for ClickHouse drill-down; tenant scope remains session-derived.
node_idquerystring(uuid)否Optional canonical node UUID for ClickHouse drill-down; tenant scope remains session-derived.
X-Request-IDheaderstring否Optional safe correlation ID; invalid values are replaced.

响应

getAdminDashboard 响应
状态码说明
200Version 2 platform dashboard snapshot.

字段:dashboard_version: integer meta: DashboardMeta accounts: object | UnavailableSection subscriptions: object | UnavailableSection billing: object | UnavailableSection resources: object | UnavailableSection operations: object | UnavailableSection operation_charts?: object | UnavailableSection entitlement: object | UnavailableSection node_health: object | UnavailableSection analytics_health: object | UnavailableSection account_security: object | UnavailableSection network: object | UnavailableSection analytics: object | UnavailableSection

400dashboard_invalid_request
401dashboard_authentication_required
403dashboard_scope_forbidden or dashboard_permission_denied
408dashboard_request_cancelled
500dashboard_internal_error
502dashboard_response_too_large
503dashboard_storage_unavailable; no zero-value data is substituted.
504dashboard_query_timeout

失败时怎么办

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

↑ 回到列表