en US development local run

System, operations, and node APIs

Use this layer to inspect platform health, nodes, configuration, logs, and operational jobs. Business applications normally read status; administrators own configuration and lifecycle changes.

This page covers 168 operations. Each row states the endpoint, purpose, timing, completion check, and caller identity. Use the matching OpenAPI file for exact field schemas.

Business APIs may be called by the WebUI or an authorized integration. Administrator APIs require an admin session. Internal APIs and callbacks are only for trusted product components.

系统与健康

Endpoint	Plain meaning	When to use it	How to confirm	Audience / permission	Main input
GET /api/v2/config/center	Read config / center.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Administrator API system.config.view	No business input
PUT /api/v2/config/center	Update config / center.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Administrator API system.config.manage	AkConfigurationPatchRequest
GET /api/v2/config/raw	Read config / raw.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Administrator API system.config.raw.manage	fileName
PUT /api/v2/config/raw	Update config / raw.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Administrator API system.config.raw.manage	AkRawConfigurationApplyRequest
POST /api/v2/config/raw/plan	Create or run config / raw / plan.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Administrator API system.config.raw.manage	AkRawConfigurationPlanRequest
GET /api/v2/config/runtime	Read config / runtime.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Administrator API system.config.view	No business input
PUT /api/v2/config/runtime	Update config / runtime.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Administrator API system.config.manage	AkRuntimeConfigurationApplyRequest
POST /api/v2/config/runtime/plan	Create or run config / runtime / plan.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Administrator API system.config.manage	AkRuntimeConfigurationPlanRequest
GET /api/v2/events/outbox	Read events / outbox.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.logs.view	page, pageSize
GET /api/v2/events/runtime/info	Read events / runtime / info.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API authenticated	No business input
GET /api/v2/events/runtime/ws	Read events / runtime / ws.	Use it when loading a page, refreshing state, or searching current data.	Handle authentication, disconnects, reconnects, and event sequence numbers after the WebSocket upgrade.	Business API authenticated	No business input
GET /api/v2/setup/catalog	Read setup / catalog.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	First-time setup only setup-token	X-AK-Setup-Token (required)
POST /api/v2/setup/complete	Create or run setup / complete.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	First-time setup only setup-token	X-AK-Setup-Token (required), FirstRunInstallationRequest
POST /api/v2/setup/database/test	Create or run setup / database / test.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	First-time setup only setup-token	X-AK-Setup-Token (required), FirstRunDatabaseInput
GET /api/v2/setup/detect/network	Read setup / detect / network.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	First-time setup only setup-token	X-AK-Setup-Token (required)
POST /api/v2/setup/detect/nginx	Create or run setup / detect / nginx.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	First-time setup only setup-token	X-AK-Setup-Token (required), FirstRunEnvironmentDetectionRequest
POST /api/v2/setup/files/browse	Create or run setup / files / browse.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	First-time setup only setup-token	X-AK-Setup-Token (required), FirstRunPathRequest
POST /api/v2/setup/files/directories	Create or run setup / files / directories.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	First-time setup only setup-token	X-AK-Setup-Token (required), FirstRunDirectoryCreateRequest
GET /api/v2/setup/files/roots	Read setup / files / roots.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	First-time setup only setup-token	X-AK-Setup-Token (required)
POST /api/v2/setup/files/validate	Create or run setup / files / validate.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	First-time setup only setup-token	X-AK-Setup-Token (required), FirstRunPathRequest
GET /api/v2/setup/media/build/inspect	Read setup / media / build / inspect.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	First-time setup only setup-token	sourceMode, X-AK-Setup-Token (required)
POST /api/v2/setup/media/build/start	Create or run setup / media / build / start.	Use it when the user submits this action or configuration change.	An HTTP success means accepted; poll or subscribe until the resource reaches a final state.	First-time setup only setup-token	X-AK-Setup-Token (required), FirstRunMediaBuildRequest
GET /api/v2/setup/media/build/status	Read setup / media / build / status.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	First-time setup only 专用流程	No business input
POST /api/v2/setup/notifications/test	Create or run setup / notifications / test.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	First-time setup only setup-token	X-AK-Setup-Token (required), FirstRunNotificationInput
POST /api/v2/setup/preflight	Create or run setup / preflight.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	First-time setup only setup-token	X-AK-Setup-Token (required), FirstRunInstallationRequest
GET /api/v2/setup/status	Read setup / status.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Public entry 专用流程	No business input
GET /api/v2/system/api-docs	Read system / api docs.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Diagnostic API system.view	No business input
GET /api/v2/system/background-tasks	Read system / background tasks.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.view	No business input
POST /api/v2/system/config/deploy	Create or run system / config / deploy.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Administrator API system.config.manage	SystemConfigDeployRequest
GET /api/v2/system/config/effective	Read system / config / effective.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Administrator API system.config.view	scopeType, scopeId
POST /api/v2/system/config/plan	Create or run system / config / plan.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Administrator API system.config.manage	SystemConfigPlanRequest
GET /api/v2/system/config/revisions	Read system / config / revisions.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Administrator API system.config.view	scopeType, scopeId, limit
POST /api/v2/system/config/rollback	Create or run system / config / rollback.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Administrator API system.config.manage	SystemConfigRollbackRequest
GET /api/v2/system/config/scopes	Read system / config / scopes.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Administrator API system.config.view	No business input
POST /api/v2/system/config/wizard/apply	Create or run system / config / wizard / apply.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Administrator API system.config.manage	ConfigurationWizardApplyRequest
GET /api/v2/system/config/wizard/assessment	Read system / config / wizard / assessment.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Administrator API system.config.view	nodeId
GET /api/v2/system/config/wizard/catalog	Read system / config / wizard / catalog.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Administrator API system.config.view	nodeId
POST /api/v2/system/config/wizard/plan	Create or run system / config / wizard / plan.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Administrator API system.config.manage	ConfigurationWizardPlanRequest
POST /api/v2/system/config/wizard/recommend	Create or run system / config / wizard / recommend.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Administrator API system.config.manage	ConfigurationWizardRecommendRequest
GET /api/v2/system/console/summary	Read system / console / summary.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.view	No business input
GET /api/v2/system/data-retention/cleanup/preview	Read system / data retention / cleanup / preview.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.config.view	actor, reason
POST /api/v2/system/data-retention/cleanup/run-once	Create or run system / data retention / cleanup / run once.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	DataRetentionCleanupRunRequest
GET /api/v2/system/database-schema-audit	Read system / database schema audit.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.view	includeDdl, maxDdlChars
POST /api/v2/system/filesystem/directories	Create or run system / filesystem / directories.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Administrator API system.config.manage	SystemDirectoryCreateRequest
GET /api/v2/system/filesystem/entries	Read system / filesystem / entries.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Administrator API system.config.manage	fieldPath (required), path
GET /api/v2/system/filesystem/roots	Read system / filesystem / roots.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Administrator API system.config.manage	fieldPath (required)
POST /api/v2/system/filesystem/validate	Create or run system / filesystem / validate.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Administrator API system.config.manage	SystemPathValidationRequest
GET /api/v2/system/info	Read system / info.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.view	No business input
GET /api/v2/system/lifecycle/agents	Read system / lifecycle / agents.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Administrator API system.lifecycle.view	No business input
POST /api/v2/system/lifecycle/agents/{nodeId}/enrollment	Create or run system / lifecycle / agents / the selected nodeId / enrollment.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Administrator API system.lifecycle.manage	nodeId (required), CreateNodeAgentEnrollmentRequest
GET /api/v2/system/lifecycle/operations	Read system / lifecycle / operations.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Administrator API system.lifecycle.view	nodeId, limit
POST /api/v2/system/lifecycle/operations	Create or run system / lifecycle / operations.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Administrator API system.lifecycle.manage	CreateNodeLifecycleOperationRequest
POST /api/v2/system/logs/agent/sessions	Create or run system / logs / agent / sessions.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.logs.view	LogDiagnosticAgentStartRequest
GET /api/v2/system/logs/agent/sessions/{id}	Read system / logs / agent / sessions / the selected id.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.logs.view	id (required)
POST /api/v2/system/logs/agent/sessions/{id}/cancel	Create or run system / logs / agent / sessions / the selected id / cancel.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.logs.view	id (required)
GET /api/v2/system/logs/agent/sessions/{id}/events	Read system / logs / agent / sessions / the selected id / events.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.logs.view	id (required), after
POST /api/v2/system/logs/agent/sessions/{id}/messages	Create or run system / logs / agent / sessions / the selected id / messages.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.logs.view	id (required), LogDiagnosticAgentMessageRequest
GET /api/v2/system/logs/analysis/status	Read system / logs / analysis / status.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.logs.view	No business input
POST /api/v2/system/logs/analyze	Create or run system / logs / analyze.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.logs.view	LogAnalysisRequest
GET /api/v2/system/logs/files/{fileId}/download	Read system / logs / files / the selected fileId / download.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.logs.download	fileId (required)
GET /api/v2/system/logs/query	Read system / logs / query.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.logs.view	Source (required), FileId, Level, Keyword, TraceId, From, To, TailLines
GET /api/v2/system/logs/sources	Read system / logs / sources.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.logs.view	No business input
GET /api/v2/system/logs/stream	Read system / logs / stream.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.logs.view	after, sessionId, tail, nodeIds, mediaServerIds
GET /api/v2/system/migration-audit	Read system / migration audit.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.view	clusterId, includeSamples, sampleSize, includePassed
POST /api/v2/system/migration-audit/removed-protocol-residues/cleanup	Create or run system / migration audit / removed protocol residues / cleanup.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	RemovedProtocolResidueCleanupRequest
POST /api/v2/system/notifications/email/test	Create or run system / notifications / email / test.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.view	SystemEmailTestRequest
GET /api/v2/system/openapi-audit	Read system / openapi audit.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Diagnostic API system.view	onlyProblems
GET /api/v2/system/parity-audit	Read system / parity audit.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.view	clusterId, checkDatabase, includeDetails, includePassed
GET /api/v2/system/readiness	Read system / readiness.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.view	checkDatabase, checkZlm
GET /api/v2/system/roles	Read system / roles.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.view	No business input
GET /api/v2/system/runtime/diagnostics	Read system / runtime / diagnostics.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.view	No business input
GET /api/v2/system/runtime/ports	Read system / runtime / ports.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.view	No business input
GET /api/v2/system/runtime/tuning	Read system / runtime / tuning.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.view	No business input
PUT /api/v2/system/runtime/tuning	Update system / runtime / tuning.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.host.manage	HostTuningApplyRequest
POST /api/v2/system/runtime/tuning/plan	Create or run system / runtime / tuning / plan.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.host.manage	HostTuningPlanRequest
GET /api/v2/system/source-documentation-audit	Read system / source documentation audit.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Diagnostic API system.view	onlyProblems, checkParameterAndReturnTags, maxResults
GET /api/v2/system/swagger	Read system / swagger.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Diagnostic API system.view	No business input
GET /api/v2/system/tasks	Read system / tasks.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.tasks.view	No business input
POST /api/v2/system/tasks/{taskName}/run	Create or run system / tasks / the selected taskName / run.	Use it when the user submits this action or configuration change.	An HTTP success means accepted; poll or subscribe until the resource reaches a final state.	Business API system.tasks.execute	taskName (required), RunSystemTaskRequest
GET /api/v2/system/tls/acme	Read system / tls / acme.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.config.view	No business input
POST /api/v2/system/tls/acme/apply-nginx	Create or run system / tls / acme / apply nginx.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	No business input
PUT /api/v2/system/tls/acme/automation	Update system / tls / acme / automation.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	AcmeAutomationRequest
POST /api/v2/system/tls/acme/complete	Create or run system / tls / acme / complete.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	AcmeCompleteRequest
POST /api/v2/system/tls/acme/issue	Create or run system / tls / acme / issue.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	AcmeCertificateRequest
POST /api/v2/system/tls/acme/preflight	Create or run system / tls / acme / preflight.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	AcmeCertificateRequest
POST /api/v2/system/tls/acme/prepare	Create or run system / tls / acme / prepare.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	AcmeCertificateRequest
POST /api/v2/system/tls/acme/renew	Create or run system / tls / acme / renew.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	AcmeRenewRequest
GET /api/v2/system/tls/deployment	Read system / tls / deployment.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.config.view	No business input
POST /api/v2/system/tls/nginx/reload	Create or run system / tls / nginx / reload.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	NginxReloadRequest
POST /api/v2/system/tls/nginx/template	Create or run system / tls / nginx / template.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	NginxTemplateRequest
POST /api/v2/system/tls/nginx/validate	Create or run system / tls / nginx / validate.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	No business input
GET /api/v2/system/upgrades	Read system / upgrades.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.upgrade.view	No business input
GET /api/v2/system/upgrades/{id}	Read system / upgrades / the selected id.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.upgrade.view	id (required)
POST /api/v2/system/upgrades/{id}/start	Create or run system / upgrades / the selected id / start.	Use it when the user submits this action or configuration change.	An HTTP success means accepted; poll or subscribe until the resource reaches a final state.	Business API system.upgrade.manage	id (required), StartSystemUpgradeRequest
POST /api/v2/system/upgrades/packages	Create or run system / upgrades / packages.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.upgrade.manage	No business input
GET /api/v2/system/version	Read system / version.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.view	No business input
GET /api/v2/system/webhooks/catalog	Read system / webhooks / catalog.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.view	No business input
POST /api/v2/system/webhooks/deliveries/{id}/retry	Create or run system / webhooks / deliveries / the selected id / retry.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	id (required)
POST /api/v2/system/webhooks/outbox/{id}/retry	Create or run system / webhooks / outbox / the selected id / retry.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	id (required)
GET /api/v2/system/webhooks/status	Read system / webhooks / status.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.view	No business input
GET /api/v2/system/webhooks/subscriptions	Read system / webhooks / subscriptions.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.view	includeArchived
POST /api/v2/system/webhooks/subscriptions	Create or run system / webhooks / subscriptions.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	OutboundWebhookSubscriptionRequest
PUT /api/v2/system/webhooks/subscriptions/{id}	Update system / webhooks / subscriptions / the selected id.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	id (required), OutboundWebhookSubscriptionRequest
POST /api/v2/system/webhooks/subscriptions/{id}/archive	Create or run system / webhooks / subscriptions / the selected id / archive.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	id (required)
GET /api/v2/system/webhooks/subscriptions/{id}/deliveries	Read system / webhooks / subscriptions / the selected id / deliveries.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.view	id (required), page, pageSize
POST /api/v2/system/webhooks/subscriptions/{id}/test	Create or run system / webhooks / subscriptions / the selected id / test.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	id (required), OutboundWebhookTestRequest
POST /api/v2/system/webhooks/test	Create or run system / webhooks / test.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	OutboundWebhookTestRequest
POST /api/v2/system/zlm-configuration/apply	Create or run system / zlm configuration / apply.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	MediaServiceConfigurationApplyRequest
GET /api/v2/system/zlm-configuration/operations/{id}	Read system / zlm configuration / operations / the selected id.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	id (required)
POST /api/v2/system/zlm-configuration/plan	Create or run system / zlm configuration / plan.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.manage	MediaServiceConfigurationPlanRequest
POST /api/v2/system/zlm-configuration/read	Create or run system / zlm configuration / read.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API nodes.view	MediaServiceConfigurationContext
GET /health	Read health.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Public entry *	No business input

日志与安全

Endpoint	Plain meaning	When to use it	How to confirm	Audience / permission	Main input
GET /api/v2/logging/level	Read logging / level.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.logs.view	No business input
PUT /api/v2/logging/level	Update logging / level.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.logs.manage	GlobalLogLevelRequest
POST /api/v2/logging/overrides	Create or run logging / overrides.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.logs.manage	LogLevelOverrideRequest
DELETE /api/v2/logging/overrides/{scope}/{key}	Delete logging / overrides / the selected scope / the selected key.	Use it only after the user has reviewed and confirmed the affected data.	Read the target resource again and verify both saved and runtime state.	Business API system.logs.manage	scope (required), key (required)
PUT /api/v2/logging/zlm-module-output	Update logging / zlm module output.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.logs.manage	MediaServiceModuleOutputLogRequest
PUT /api/v2/logging/zlm-process-output	Update logging / zlm process output.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.logs.manage	MediaServiceProcessOutputLogRequest

集群与节点

Endpoint	Plain meaning	When to use it	How to confirm	Audience / permission	Main input
GET /api/v2/cluster/monitoring	Read cluster / monitoring.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	clusterId, historyMinutes, historyNodeId, historyStart, historyEnd, historyBucketSeconds
GET /api/v2/cluster/monitoring/current	Read cluster / monitoring / current.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	clusterId
GET /api/v2/cluster/monitoring/local-runtime	Read cluster / monitoring / local runtime.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	No business input
GET /api/v2/cluster/status	Read cluster / status.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	clusterId
GET /api/v2/media-servers	Read media servers.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	clusterId
GET /api/v2/media-servers/{mediaServerId}/references	Read media servers / the selected mediaServerId / references.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	mediaServerId (required), clusterId, sampleSize
POST /api/v2/media-servers/{mediaServerId}/retire	Create or run media servers / the selected mediaServerId / retire.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API nodes.manage	mediaServerId (required), clusterId, RetireMediaServerRequest
GET /api/v2/node/commands	Read node / commands.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	page, pageSize, nodeId, zlmNodeId, status, commandType, requestedBy, localOnly, from, to, sinceHours, keyword
GET /api/v2/node/commands/{commandId}	Read node / commands / the selected commandId.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	commandId (required)
GET /api/v2/node/commands/{commandId}/detail	Read node / commands / the selected commandId / detail.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	commandId (required)
GET /api/v2/node/commands/local	Read node / commands / local.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	status
GET /api/v2/node/commands/stats	Read node / commands / stats.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	nodeId, zlmNodeId, status, commandType, requestedBy, localOnly, from, to, sinceHours, keyword
GET /api/v2/node/ffmpeg-templates	Read node / ffmpeg templates.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	mediaServerId
POST /api/v2/node/ffmpeg-templates	Create or run node / ffmpeg templates.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API nodes.manage	SaveFfmpegTemplateRequest
DELETE /api/v2/node/ffmpeg-templates/{templateName}	Delete node / ffmpeg templates / the selected templateName.	Use it only after the user has reviewed and confirmed the affected data.	Read the target resource again and verify both saved and runtime state.	Business API nodes.manage	templateName (required), mediaServerId
PUT /api/v2/node/ffmpeg-templates/{templateName}	Update node / ffmpeg templates / the selected templateName.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API nodes.manage	templateName (required), SaveFfmpegTemplateRequest
GET /api/v2/node/rtp/leases	Read node / rtp / leases.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	status, direction
POST /api/v2/node/rtp/leases	Create or run node / rtp / leases.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API nodes.manage	RtpPortLeaseRequest
POST /api/v2/node/rtp/leases/{leaseId}/release	Create or run node / rtp / leases / the selected leaseId / release.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API nodes.manage	leaseId (required), RtpPortReleaseRequest
POST /api/v2/node/rtp/ports/{port}/release	Create or run node / rtp / ports / the selected port / release.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API nodes.manage	port (required), direction, RtpPortReleaseRequest
GET /api/v2/node/zlm/config	Read node / zlm / config.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	No business input
POST /api/v2/node/zlm/config/apply	Create or run node / zlm / config / apply.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API nodes.manage	No business input
POST /api/v2/node/zlm/config/plan	Create or run node / zlm / config / plan.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API nodes.manage	No business input
GET /api/v2/node/zlm/config/raw	Read node / zlm / config / raw.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.config.raw.manage	No business input
PUT /api/v2/node/zlm/config/raw	Update node / zlm / config / raw.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.raw.manage	MediaServiceRawConfigurationApplyRequest
POST /api/v2/node/zlm/config/raw/plan	Create or run node / zlm / config / raw / plan.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API system.config.raw.manage	MediaServiceRawConfigurationPlanRequest
GET /api/v2/node/zlm/core-settings	Read node / zlm / core settings.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	No business input
PUT /api/v2/node/zlm/core-settings	Update node / zlm / core settings.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API nodes.manage	SaveMediaServiceCoreSettingsRequest
GET /api/v2/node/zlm/process	Read node / zlm / process.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	No business input
POST /api/v2/node/zlm/process/reload	Create or run node / zlm / process / reload.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API nodes.manage	No business input
POST /api/v2/node/zlm/process/restart	Create or run node / zlm / process / restart.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API nodes.manage	No business input
POST /api/v2/node/zlm/process/start	Create or run node / zlm / process / start.	Use it when the user submits this action or configuration change.	An HTTP success means accepted; poll or subscribe until the resource reaches a final state.	Business API nodes.manage	No business input
POST /api/v2/node/zlm/process/stop	Create or run node / zlm / process / stop.	Use it when the user submits this action or configuration change.	An HTTP success means accepted; poll or subscribe until the resource reaches a final state.	Business API nodes.manage	No business input
GET /api/v2/nodes	Read nodes.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	clusterId
POST /api/v2/nodes/{nodeId}/commands	Create or run nodes / the selected nodeId / commands.	Use it when the user submits this action or configuration change.	An HTTP success means accepted; poll or subscribe until the resource reaches a final state.	Business API nodes.manage	nodeId (required), clusterId, CreateNodeCommandRequest
POST /api/v2/nodes/self/heartbeat	Create or run nodes / self / heartbeat.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API nodes.manage	firstPost

MediaServer 适配

Endpoint	Plain meaning	When to use it	How to confirm	Audience / permission	Main input
GET /api/v2/zlm/nodes	Read zlm / nodes.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	No business input
GET /api/v2/zlm/nodes/{nodeId}/apis	Read zlm / nodes / the selected nodeId / apis.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	nodeId (required)
GET /api/v2/zlm/nodes/{nodeId}/capabilities	Read zlm / nodes / the selected nodeId / capabilities.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	nodeId (required)
GET /api/v2/zlm/nodes/{nodeId}/recording-status	Read zlm / nodes / the selected nodeId / recording status.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	nodeId (required), vhost, app, stream, type
GET /api/v2/zlm/nodes/{nodeId}/version	Read zlm / nodes / the selected nodeId / version.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API nodes.view	nodeId (required)
GET /api/v2/zlm/webhook-inbox	Read zlm / webhook inbox.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API system.logs.view	page, pageSize, hookName, mediaServerId, status, businessStatus

Other APIs

Endpoint	Plain meaning	When to use it	How to confirm	Audience / permission	Main input
GET /api/v2/display-wall/programs	Read display wall / programs.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API display-wall.view	No business input
POST /api/v2/display-wall/programs	Create or run display wall / programs.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API display-wall.manage	SaveDisplayWallProgramRequest
DELETE /api/v2/display-wall/programs/{id}	Delete display wall / programs / the selected id.	Use it only after the user has reviewed and confirmed the affected data.	Read the target resource again and verify both saved and runtime state.	Business API display-wall.manage	id (required)
GET /api/v2/display-wall/programs/{id}	Read display wall / programs / the selected id.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API display-wall.view	id (required)
PUT /api/v2/display-wall/programs/{id}	Update display wall / programs / the selected id.	Use it when the user submits this action or configuration change.	Read the target resource again and verify both saved and runtime state.	Business API display-wall.manage	id (required), SaveDisplayWallProgramRequest
GET /api/v2/display-wall/runtime	Read display wall / runtime.	Use it when loading a page, refreshing state, or searching current data.	Use the returned data, paging totals, and current resource state.	Business API display-wall.view	No business input
POST /api/v2/display-wall/runtime/start	Create or run display wall / runtime / start.	Use it when the user submits this action or configuration change.	An HTTP success means accepted; poll or subscribe until the resource reaches a final state.	Business API display-wall.manage	StartDisplayWallProgramRequest
POST /api/v2/display-wall/runtime/stop	Create or run display wall / runtime / stop.	Use it when the user submits this action or configuration change.	An HTTP success means accepted; poll or subscribe until the resource reaches a final state.	Business API display-wall.manage	No business input

Fields and examples

This page keeps business purpose readable. When coding, use the OpenAPI and Postman assets shipped with the deployed version for request bodies, response bodies, enums, file types, and examples. Do not use a newer website contract against an older service.