ENTERPRISE Daemon API

Verwendung

Die ENTERPRISE Daemon API (EDA) ist die Web-Service-Schnittstelle des CLARC ENTEPRRISE Services (ccenterprisesrv.exe).

Über die Schnittstelle können u.a. Informationen zu Diensten und dem Systemstatus abgefragt werden. Darüber hinaus können beispielsweise einzelne Dienste gestartet oder beendet werden.

Minimale Server-Version

Die minimale Version ist die 5.0.2.x.

Url Parameter

Jeder Aufruf benötigt folgenden Parameter:

authcode=<InstanceToken des enterprise daemons> 

Der Wert kann aus C4 ermittelt werden: 

/clarc/Software/clarc enterprise daemon/Cluster/Node 0

Fester AuthCode für den ENTERPRISE Daemon

Der AuthCode/InstanceToken wird einmalig beim Start des Dienstes festgelegt. Dieser kann vor dem Start des Dienstes neu generiert werden, indem der InstanceToken geleert wird. Ansonsten wird der generierte Code weiterhin verwendet.

Die Rückgabe ist immer ein XML im CLARC Fast XML Format bei HTTP 200 OK.

Aufbau einer Url mit Beispiel:

http(s)://<server>:<port>/ccedapi_getsystemstate&authcode=<InstanceToken> 

CCEDAPI_GETSYSTEMSTATE

Abruf des allgemeinen Systemstatus.

ParameterHinweis
VersionInstallierte Produktversion
LicenseeLizenznehmer
ProxyJa/Nein
ProxyInstanceJa/Nein
ClusterNodeNur bei Proxy = false
StartTimeStartzeit des Enterprise daemons (yyyy-mm-dd hh:nn:ss)
ServerTimeDatum Uhrzeit vom Server (yyyy-mm-dd hh:nn:ss)
UptimeIn Sekunden
ServicesAnzahl
CloudServicesAvailabletrue/false
WarningsAnzahl der Warnungen (insgesamt)
Errors...
Criticals...

CCEDAPI_GETRELEASEINFO

Informationen zum installierten Release (Cloud Services müssen verfügbar sein  - also Internetverbindung).

ParameterHinweis
Versionz.B. 5.0.0.705
DateReleasedatum (z.B. 01.01.2015)
SupportedSupportete Version?
ProductiveProduktive Version oder Test?
AboutHinweise zum Release
AlertsWarnungen zum Release
LatestReleaseAktuell verfügbarste Version

CCEDAPI_GETSERVICES

Übersicht aller registrierten Services im enterprise daemon.

ParameterAttributHinweis
<ServiceName>
Inhalt ist der Infotext zum Service

IdInstanceId (0,1,...)

TokenInstanceToken - wird für weitere Methoden benötigt

StatusSVC_Stop_Pending,SVC_Start_Pending,SVC_Stopped,SVC_Running

ProcessStateWindows Prozess aktiv (BOOL)

InterfaceStateWeb-Interface verfügbar (BOOL)

DisplayNameAnzeigename für den Service

CriticalsAnzahl der kritischen Fehler (z.B. Zugriffsverletzungen)

ErrorsAnzahl

WarningsAnzahl

RestartsAnzahl
 ...

CCEDAPI_GETSERVICEDETAILS

Details zu einem spezifischen Service.

Benötigt als Url Parameter token=<InstanceToken>.

ParameterHinweis
NameTechnischer Name
InfoBeschreibungstext
c4NodeKnoten im c4
DisabledService wurde deaktiviert (z.B. wegen zu vieler Restarts)
StoppedByUserService von einem Benutzer beendet?
StatusSVC_Running, SVC_Start_Pending, SVC_Stop_Pending, SVC_Stopped (0,1,2,...)
UptimeUptime in Sekunden
CreationDateAngelegt am (DateTime Wert) (besser yyyy-mm-dd hh:nn:ss ???)
ChangeDateGeändert am (DateTime Wert)
StartDateStartdatum (DateTime Wert)
RestartsAnzahl der Neustarts
PortTCP Port
PrimaryPortPrimärport (bei Instanz > 0 abweichend)
UrlBasis-Url des Services
InstanceId0,1,2,... (0 ~ Primärinstanz)
InstanceTokenU.a. für Zugriff (authcode)
MasterInstanceInstanceId = 0 (true/false)
MutexNameintern
DisplayNameAnzeigename des Services
ProcessStatetrue/false (false ~ inaktiv)
InterfaceStatetrue/false (false ~ nicht verfügbar oder noch nicht bekannt)
CPUPlatform32 oder 64 bit (String)
MemoryUsageSpeichernutzung in Byte
CurrentErrorsAnzahl der Fehler heute
CurrentWarnings...
CurrentCriticals...
CurrentDocuments...
OverallErrorsGesamtanzahl der Fehler über die Laufzeit des Enterprise daemons
OverallWarnings...
OverallCriticals...
OverallDocuments...
ServicePathPfad zur Service .exe (z.B. c:\clarc\sys\)
ServiceFileNameDateiname des Services (z.B. ccasesrv.exe)
ServiceStartParamsOptionale Startparameter
ServiceFileCompanyNameDetailinformationen aus den Dateieigenschaften
ServiceFileDescription...
ServiceFileVersion...
ServiceFileInternalName...
ServiceFileLegalCopyright...
ServiceFileLegalTrademarks...
ServiceFileOriginalName...
ServiceFileProductName...
ServiceFileProductVersion...
ServiceFileComment...
Raw_...Ungefilterte Statusinformationen vom jeweiligen Dienst (nach Raw_ kommt der eigentliche Name der Property)
Raw_......
usw.

CCEDAPI_GETSERVICELOG

Live-Log (die letzten n Einträge) zu einem spezifischen Service.

Benötigt als Url Parameter token=<InstanceToken>.

ParameterHinweis
LogRaw Logtext einer Zeile (analog zum Aufbau im Logfile)
...

CCEDAPI_GETLICENSELOG

Live-Log (die letzten n Einträge) des License-Daemons.

ParameterHinweis
LogRaw Logtext einer Zeile (analog zum Aufbau im Logfile)
...

CCEDAPI_CHECKSERVICESINTERFACE

Veranlasst den Enterprise Daemon dazu alle Services Schnittstellen zu prüfen. Dies geschieht asynchron.

ParameterHinweis
Resulttrue

CCEDAPI_STOPSERVICE

Stoppt den angegebenen Dienst - Rückgabe erfolgt erst wenn der Dienst beendet wurde oder ein Fehler vorliegt.

Parallel dazu kann der Dienststatus oder die Dienstübersicht abgerufen werden (bez. Stop-Pending Info etc.).

Benötigt als Url Parameter token=<InstanceToken>.

ParameterHinweis
Resulttrue/false

CCEDAPI_STARTSERVICE

Startet den angegebenen Dienst - Rückgabe erfolgt erst wenn der Dienst gestartet wurde oder ein Fehler vorliegt.

Parallel dazu kann der Dienststatus oder die Dienstübersicht abgerufen werden (bez. Start-Pending Info etc.).

Benötigt als Url Parameter token=<InstanceToken>.

ParameterHinweis
Resulttrue/false

CCEDAPI_GETLICENSEINFO

Liefert die Basis-Lizenzinformationen zurück (es können n Lizenzen zurückgeliefert werden).

ParameterAttributHinweis
LicenseIdLizenznummer

VendorHersteller-Firma

DistributorDistributor-Firma

PartnerPartner-Firma

LicenseeLizenznehmer (Endkunde)

InfoLizenzinformationen

LocationOrt

CountryLand

CreationErstellungsdatum (TimeStamp)

ValidityGültigkeitsdatum (TimeStamp)

ActivatedLizenz aktiviert (bool)

ActivationAvailLizenzaktivierung möglich (bool)

ModulesAnzahl der Module

ModeLizenzmodus (Internal, Demo, DemoVM oder Default)
...

CCEDAPI_GETLICENSEMODULES

Liefert eine Übersicht zu allen lizenzierten Modulen und deren Status zurück.

ParameterAttributHinweis
<ModulName>LicensesAnzahl der Lizenzen (gesamt)

FreeVerfügbare (freie) Lizenzen

ValidityGültigkeit des einzelnen Moduls (TimeStamp)

MaintenanceWartung für das Modul (bool) - derzeit nicht verwendet

MajorVersionVersionsnummer (Major)

MinorVersionVersionsnummer (Minor)

LicNumberLizenzzugehörigkeit / Lizenznummer (Id s.o.)
...


CCEDAPI_GETLICENSESESSIONS

Liefert eine Übersicht zu allen aktiven Lizenzsitzungen zurück.

Die Funktion benötigt als Url Parameter module=<Modulname>.

ParameterAttributHinweis
SessionUserBenutzer

ComputerClient-Rechner

IPVon welchem Rechner kam die Lizenzanfrage (IP)

BuildVersionsnummer der Client-Anwendung

RegistrationStartdatum/Uhrzeit der Sitzung (TimeStamp)
...

CCEDAPI_REFRESHPERMISSIONS

Aktualisiert die Berechtigungen (derzeit den ASE Service).

ParameterHinweis
Resulttrue/false

CCEDAPI_REFRESHSERVICES

Aktualisiert alle Services (analog zum Refresh Button im c4).

Es wird jedoch nicht auf die Fertigstellung der Aktualisierung gewartet. Das kann jedoch rein mit c4 Mitteln realisiert werden.

ParameterHinweis
Resulttrue/false