v1
- Account
- Admin
- AdminUpload
- Analysis
- AnalysisPreview
- ApiResource
- ApiScope
- Assets
- AuditLog
- Auth
- AuthToken
- Avatar
- BatchDownloadDocuments
- CacheMeta
- Caching
- CheckUpdate
- ClaimMapping
- Client
- Collections
- Config
- CustomizeProperties
- Dashboard
- DashboardView
- DataFileEntryPreview
- DataMonitoring
- DataProvider
- DataSource
- DataSourceAPI
- DataSourceFile
- DataSourcePreview
- Dataset
- DatasetExport
- DatasetPreview
- Design
- DesignApi
- DesignTemplates
- DingTalkAuthentication
- DocumentBinder
- Documents
- EmbededReport
- Export
- ExportTemplate
- ExternalLoginProvider
- ExternalUser
- FloorPlanView
- GraphQl
- Group
- HealthCheck
- Heartbeat
- Hierarchy
- Home
- Identity-Token
- IdentityResource
- Import
- Integration
- InternalDocuments
- LanguagePackage
- LanguageResource
- License
- LocalDeployment
- ModelDrafts
- ModelEditor
- Node
- NotebookView
- 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
- ThirdParty
- Token
- Upload
- UploadTheme
- User
- UserFunctions
- View
- VisualSandbox
- WeChat4WorkAuthentication
- WebPages
- WorkerJob
- WorkersRegistrar
- overview
v2

Node

[POST] /api/node

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

Responses

[200] Success

SharedMessages.Actors.SerializationData.Result`1[[SharedMessages.Actors.SerializationData.NodeData, SharedMessages, Version=1.90.102.0, Culture=neutral, PublicKeyToken=null]]

Type: [text/plain], [application/json], [text/json]

[PUT] /api/node/{nodeId}

Parameters

Name	In	Type
nodeIdRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

ClusterNodeForm

Responses

[200] Success

SharedMessages.Actors.SerializationData.Result`1[[SharedMessages.Actors.SerializationData.NodeData, SharedMessages, Version=1.90.102.0, Culture=neutral, PublicKeyToken=null]]

Type: [text/plain], [application/json], [text/json]

[DELETE] /api/node/{nodeId}

Parameters

Name	In	Type
nodeIdRequired	path	string

Responses

[200] Success

SharedMessages.Actors.SerializationData.Result`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Type: [text/plain], [application/json], [text/json]

[GET] /api/node/list

Responses

[200] Success

SharedMessages.Actors.SerializationData.Result`1[[System.Collections.Generic.IEnumerable`1[[SharedMessages.Actors.SerializationData.NodeData, SharedMessages, Version=1.90.102.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Type: [text/plain], [application/json], [text/json]

[GET] /api/node/{id}/info

Parameters

Name	In	Type
idRequired	path	string

Responses

[200] Success

SharedMessages.Actors.SerializationData.Result`1[[SharedMessages.Actors.SerializationData.NodeData, SharedMessages, Version=1.90.102.0, Culture=neutral, PublicKeyToken=null]]

Type: [text/plain], [application/json], [text/json]

[GET] /api/node/{id}/install/{moduleName}

Parameters

Name	In	Type
idRequired	path	string
moduleNameRequired	path

Responses

[200] Success

SharedMessages.Actors.SerializationData.Result`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Type: [text/plain], [application/json], [text/json]

[GET] /api/node/{id}/uninstall/{moduleName}

Parameters

Name	In	Type
idRequired	path	string
moduleNameRequired	path

Responses

[200] Success

SharedMessages.Actors.SerializationData.Result`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Type: [text/plain], [application/json], [text/json]

[GET] /api/node/{id}/start/{moduleName}

Parameters

Name	In	Type
idRequired	path	string
moduleNameRequired	path

Responses

[200] Success

SharedMessages.Actors.SerializationData.Result`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Type: [text/plain], [application/json], [text/json]

[GET] /api/node/{id}/stop/{moduleName}

Parameters

Name	In	Type
idRequired	path	string
moduleNameRequired	path

Responses

[200] Success

SharedMessages.Actors.SerializationData.Result`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Type: [text/plain], [application/json], [text/json]

[GET] /api/node/{id}/enable/{moduleName}

Parameters

Name	In	Type
idRequired	path	string
moduleNameRequired	path

Responses

[200] Success

SharedMessages.Actors.SerializationData.Result`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Type: [text/plain], [application/json], [text/json]

[GET] /api/node/{id}/disable/{moduleName}

Parameters

Name	In	Type
idRequired	path	string
moduleNameRequired	path

Responses

[200] Success

SharedMessages.Actors.SerializationData.Result`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Type: [text/plain], [application/json], [text/json]

[GET] /api/node/{id}/installed/services

Parameters

Name	In	Type
idRequired	path	string

Responses

[200] Success

SharedMessages.Actors.SerializationData.Result`1[[SharedMessages.Actors.SerializationData.Result`1[[System.Collections.Generic.IEnumerable`1[[SharedMessages.Actors.SerializationData.ServiceInfo, SharedMessages, Version=1.90.102.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], SharedMessages, Version=1.90.102.0, Culture=neutral, PublicKeyToken=null]]

Type: [text/plain], [application/json], [text/json]

[GET] /api/node/{id}/config

Parameters

Name	In	Type
idRequired	path	string

Responses

[200] Success

Type: [text/plain], [application/json], [text/json]

[PUT] /api/node/{id}/config

Parameters

Name	In	Type
idRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

NodeConfigRequestModel

Responses

[200] Success

SharedMessages.Actors.SerializationData.Result`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Type: [text/plain], [application/json], [text/json]

[PUT] /api/node/global/config

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

NodeConfigRequestModel

Responses

[200] Success

SharedMessages.Actors.SerializationData.Result`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Type: [text/plain], [application/json], [text/json]

[GET] /api/node/{id}/download

Parameters

Name	In	Type
idRequired	path	string
secret	query	string

Responses

[200] Success

binary

Type: [text/plain], [application/json], [text/json]

[GET] /api/node/download/logs

Parameters

Name	In	Type
nodeIds	query	array
modules	query	array
pattern	query	string
isDownSystemConf	query	boolean
isDownSystemInfo	query	boolean

Responses

[200] Success

binary

Type: [text/plain], [application/json], [text/json]

[GET] /api/node/metrics

Parameters

Name	In	Type
nodeId	query	string
timeRange	query

Responses

[200] Success

SharedMessages.Actors.SerializationData.Result`1[[System.Collections.Generic.Dictionary`2[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.Collections.Generic.Dictionary`2[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.Collections.Generic.IEnumerable`1[[SharedMessages.Metrics.ServiceMetricsItem, SharedMessages, Version=1.90.102.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Type: [text/plain], [application/json], [text/json]

Models

Ƭ SharedMessages.Actors.SerializationData.Result`1[[SharedMessages.Actors.SerializationData.NodeData, SharedMessages, Version=1.90.102.0, Culture=neutral, PublicKeyToken=null]]

Name	Type
success	Boolean
errorsNullable	`Array<ResultError>`
data	NodeData

Ƭ ResultError

Name	Type
errorCodeNullable	string
errorMessageNullable	string
errorMessageContextNullable	any
exceptionNullable	any

Ƭ NodeData

Name	Type
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	`Array<ServiceInfo>`
configurationNullable	ConfigurationValue

Ƭ ServiceInfo

Name	Type
nameNullable	string
versionNullable	string
disabled	Boolean
configured	Boolean
statusNullable	string

Ƭ ClusterNodeForm

Name	Type
nameNullable	string
descriptionNullable	string
hostNullable	string
portNullable	string

Ƭ SharedMessages.Actors.SerializationData.Result`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Name	Type
success	Boolean
errorsNullable	`Array<ResultError>`
data	Boolean

Ƭ SharedMessages.Actors.SerializationData.Result`1[[System.Collections.Generic.IEnumerable`1[[SharedMessages.Actors.SerializationData.NodeData, SharedMessages, Version=1.90.102.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Name	Type
success	Boolean
errorsNullable	`Array<ResultError>`
dataNullable	`Array<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
StylesCache

Ƭ SharedMessages.Actors.SerializationData.Result`1[[SharedMessages.Actors.SerializationData.Result`1[[System.Collections.Generic.IEnumerable`1[[SharedMessages.Actors.SerializationData.ServiceInfo, SharedMessages, Version=1.90.102.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], SharedMessages, Version=1.90.102.0, Culture=neutral, PublicKeyToken=null]]

Name	Type
success	Boolean
errorsNullable	`Array<ResultError>`
data	SharedMessages.Actors.SerializationData.Result`1[[System.Collections.Generic.IEnumerable`1[[SharedMessages.Actors.SerializationData.ServiceInfo, SharedMessages, Version=1.90.102.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Ƭ SharedMessages.Actors.SerializationData.Result`1[[System.Collections.Generic.IEnumerable`1[[SharedMessages.Actors.SerializationData.ServiceInfo, SharedMessages, Version=1.90.102.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Name	Type
success	Boolean
errorsNullable	`Array<ResultError>`
dataNullable	`Array<ServiceInfo>`

Ƭ SharedMessages.Actors.SerializationData.Result`1[[System.Collections.Generic.Dictionary`2[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[SharedMessages.Actors.SerializationData.ConfigurationValue, SharedMessages, Version=1.90.102.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Name	Type
success	Boolean
errorsNullable	`Array<ResultError>`
dataNullable	ConfigurationValue

Ƭ NodeConfigRequestModel

Name	Type
configurationNullable	any
restart	Boolean

Ƭ MetricHistogramType

Enum:

Min_1
Min_15
Min_30

Ƭ SharedMessages.Actors.SerializationData.Result`1[[System.Collections.Generic.Dictionary`2[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.Collections.Generic.Dictionary`2[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.Collections.Generic.IEnumerable`1[[SharedMessages.Metrics.ServiceMetricsItem, SharedMessages, Version=1.90.102.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Name	Type
success	Boolean
errorsNullable	`Array<ResultError>`
dataNullable	`Array<ServiceMetricsItem>`