CDNCA

API reference

/v1/admin/system-db-pool

1 operations

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

MethodPathSummaryAuth
GET/v1/admin/system-db-poolRead the answering control-api's database pool, last hour, resident connections and alert stateSession

Contract file：api/control-system-db-pool.openapi.yaml

Operation details

GET /v1/admin/system-db-pool

Read the answering control-api's database pool, last hour, resident connections and alert state

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

All of：control.upgrades.read

Description (from the contract)

Platform identity with control.upgrades.read or platform.admin (the maintenance page). The figures come from the memory of the control-api process that answers, sampled every 10 seconds: a cycle is bad when in use reaches max_conns - saturation_margin, the average acquire wait exceeds slow_acquire_ms, or an acquire gave up while the pool was full or queued (canceled_acquire, which alerts at once). enter_cycles consecutive bad cycles notify the platform members holding control.upgrades.read or platform.admin (control.db_pool.saturated, also in the administrator message center); recover_cycles consecutive clean cycles send control.db_pool.recovered. An alert entered within dedup_minutes of the last notified one is not sent (notified=false) unless it is still firing once that window has passed. Notifications are written on a connection outside the pool. Only the session check reads the database. Read-only, not audited.

Responses

readControlDBPool Responses
StatusDescription
200The pool monitor of the answering process.

Fields：instance: string interval_seconds: integer thresholds: object current: DBPoolSample | null series: array<DBPoolSample> residents: array<Resident> firing: boolean firing_since: string(date-time) | null(date-time) firing_reasons: array<string: saturated / slow_acquire / canceled_acquire> notified: boolean last_notified_at: string(date-time) | null(date-time) pending_notifications: integer

401Authentication failed or the session is invalid.
403Not a platform identity with control.upgrades.read or platform.admin.
405Only GET is supported.

What to do on failure

  • 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.

↑ Back to list