- V2
-
V1
- Account
- Admin
- AdminUpload
- Analysis
- ApiResource
- ApiScope
- Assets
- AuditLog
- Auth
- AuthToken
- Avatar
- BatchDownloadDocuments
- CacheMeta
- Caching
- CheckUpdate
- ClaimMapping
- Client
- Collections
- Config
- CustomizeProperties
- Dashboard
- DashboardView
- DataMonitoring
- DataProvider
- DataSource
- DataSourceAPI
- DataSourceFile
- DataSourcePreview
- Dataset
- DatasetExport
- DatasetPreview
- Design
- DesignApi
- DesignTemplates
- DocumentBinder
- Documents
- EmbededReport
- Export
- ExportTemplate
- ExternalLoginProvider
- ExternalUser
- FloorPlanView
- GraphQl
- Group
- HealthCheck
- Heartbeat
- Hierarchy
- Home
- IdentityResource
- Import
- Integration
- InternalDocuments
- LanguagePackage
- LanguageResource
- LocalDeployment
- ModelDrafts
- ModelEditor
-
Node
- Notification
- Permission
- Pivot
- PluginAssets
- Preview
- PushDataset
- QueryEndpoint
- QueueMonitor
- ReferenceResolving
- Reports
- Resource
- Resources
- Role
- RoleDocumentColumns
- SceneView
- Schedule
- ScheduleTemplate
- SchedulesApi
- SecurityProvider
- Semantic
- Session
- Settings
- SharedResources
- StreamingDatasetApi
- SystemConfig
- SystemConfigs
- Tenant
- TenantModification
- Theme
- ThemeFiles
- Token
- Upload
- UploadTheme
- User
- UserFunctions
- View
- VisualSandbox
- WebPages
- WorkerJob
- WorkersRegistrar
- overview
Node
Node
[POST] /api/node
Request Schema
Response
Status Code: 200
Success
[PUT] /api/node/{nodeId}
Parameters
Name | Type | Located In |
---|---|---|
nodeIdRequired | string | path |
Request Schema
Response
Status Code: 200
Success
[DELETE] /api/node/{nodeId}
Parameters
Name | Type | Located In |
---|---|---|
nodeIdRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/node/list
Response
Status Code: 200
Success
[GET] /api/node/{id}/info
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/node/{id}/install/{moduleName}
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
moduleNameRequired | DownloadableModuleName | path |
Response
Status Code: 200
Success
[GET] /api/node/{id}/uninstall/{moduleName}
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
moduleNameRequired | DownloadableModuleName | path |
Response
Status Code: 200
Success
[GET] /api/node/{id}/start/{moduleName}
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
moduleNameRequired | DownloadableModuleName | path |
Response
Status Code: 200
Success
[GET] /api/node/{id}/stop/{moduleName}
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
moduleNameRequired | DownloadableModuleName | path |
Response
Status Code: 200
Success
[GET] /api/node/{id}/enable/{moduleName}
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
moduleNameRequired | DownloadableModuleName | path |
Response
Status Code: 200
Success
[GET] /api/node/{id}/disable/{moduleName}
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
moduleNameRequired | DownloadableModuleName | path |
Response
Status Code: 200
Success
[GET] /api/node/{id}/installed/services
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/node/{id}/config
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
Response
Status Code: 200
Success
[PUT] /api/node/{id}/config
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
Request Schema
any
Response
Status Code: 200
Success
[PUT] /api/node/global/config
Request Schema
any
Response
Status Code: 200
Success
[GET] /api/node/{id}/download
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
secret | string | query |
Response
Status Code: 200
Success
binary
[GET] /api/node/download/logs
Parameters
Name | Type | Located In |
---|---|---|
nodeIds | Array<string> |
query |
modules | DownloadableModuleName | query |
pattern | string | query |
isDownSystemConf | Boolean | query |
isDownSystemInfo | Boolean | query |
Response
Status Code: 200
Success
binary
[GET] /api/node/metrics
Parameters
Name | Type | Located In |
---|---|---|
nodeId | string | query |
timeRange | MetricHistogramType | query |
Response
Status Code: 200
Success
Models
Ƭ SharedMessages.Actors.SerializationData.Result`1[[SharedMessages.Actors.SerializationData.NodeData, SharedMessages, Version=1.70.5.0, Culture=neutral, PublicKeyToken=null]]
Name | Type | Description | Example |
---|---|---|---|
success | Boolean | ||
errorsNullable | ResultError | ||
data | NodeData |
Ƭ ResultError
Name | Type | Description | Example |
---|---|---|---|
errorCodeNullable | string | ||
errorMessageNullable | string | ||
errorMessageContextNullable | any | ||
exceptionNullable | any |
Ƭ NodeData
Name | Type | Description | Example |
---|---|---|---|
idNullable | string | ||
nameNullable | string | ||
descriptionNullable | string | ||
secretNullable | string | ||
roleNullable | string | ||
createDate | ISO DateTime Sting | ||
lastModifyDate | ISO DateTime Sting | ||
hostNullable | string | ||
portNullable | string | ||
statusNullable | string | ||
servicesNullable | ServiceInfo | ||
configurationNullable | any |
Ƭ ServiceInfo
Name | Type | Description | Example |
---|---|---|---|
nameNullable | string | ||
versionNullable | string | ||
disabled | Boolean | ||
configured | Boolean | ||
statusNullable | string |
Ƭ ClusterNodeForm
Name | Type | Description | Example |
---|---|---|---|
nameNullable | string | ||
descriptionNullable | string | ||
hostNullable | string | ||
portNullable | string |
Ƭ SharedMessages.Actors.SerializationData.Result`1[[System.Boolean, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Name | Type | Description | Example |
---|---|---|---|
success | Boolean | ||
errorsNullable | ResultError | ||
data | Boolean |
Ƭ SharedMessages.Actors.SerializationData.Result`1[[System.Collections.Generic.IEnumerable`1[[SharedMessages.Actors.SerializationData.NodeData, SharedMessages, Version=1.70.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Name | Type | Description | Example |
---|---|---|---|
success | Boolean | ||
errorsNullable | ResultError | ||
dataNullable | NodeData |
Ƭ DownloadableModuleName
Enum:
Monitor
All
ReportingWorker
CotWorker
DashboardWorker
MonitorUpdater
Server
Account
AnalysisModel
Dashboard
Dataset
Reporting
DataMonitoring
SchedulerService
AnalysisDBService
DataSourceService
MemoryDBService
Logs
ServerLog
SystemLog
ReportingWorkerLog
CotWorkerLog
DashboardWorkerLog
JavaDatasourceLog
MemoryDBLog
SchedulerServiceLog
Ƭ SharedMessages.Actors.SerializationData.Result`1[[SharedMessages.Actors.SerializationData.Result`1[[System.Collections.Generic.IEnumerable`1[[SharedMessages.Actors.SerializationData.ServiceInfo, SharedMessages, Version=1.70.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], SharedMessages, Version=1.70.5.0, Culture=neutral, PublicKeyToken=null]]
Ƭ SharedMessages.Actors.SerializationData.Result`1[[System.Collections.Generic.IEnumerable`1[[SharedMessages.Actors.SerializationData.ServiceInfo, SharedMessages, Version=1.70.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Name | Type | Description | Example |
---|---|---|---|
success | Boolean | ||
errorsNullable | ResultError | ||
dataNullable | ServiceInfo |
Ƭ SharedMessages.Actors.SerializationData.Result`1[[System.Collections.Generic.Dictionary`2[[System.String, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.Object, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Name | Type | Description | Example |
---|---|---|---|
success | Boolean | ||
errorsNullable | ResultError | ||
dataNullable | any |
Ƭ MetricHistogramType
Enum:
Min_1
Min_15
Min_30
Ƭ SharedMessages.Actors.SerializationData.Result`1[[System.Collections.Generic.Dictionary`2[[System.String, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.Collections.Generic.Dictionary`2[[System.String, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.Collections.Generic.IEnumerable`1[[SharedMessages.Metrics.ServiceMetricsItem, SharedMessages, Version=1.70.5.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Name | Type | Description | Example |
---|---|---|---|
success | Boolean | ||
errorsNullable | ResultError | ||
dataNullable | ServiceMetricsItem |