API V3 Documentation – DGN
Diese Dokumentation gibt es nur auf Englisch.
Vorschau: Diese Dokumentation beschreibt PQFORCE 4.26.6, das noch nicht veröffentlicht ist.
Endpoints
GET /API/V3/DGN/ServerStatus
Returns generic status items of an overall server status
HTTP syntax
GET /API/V3/DGN/ServerStatus
<- application/json : ServerStatusResult
This endpoint returns the following data: ServerStatus
Data types
DGN.ConfigurationAudit
This is a structure data contract.
Contains the audit of the security and performance relevant configuration settings
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
compliant |
boolean | True if every audited setting is within its bounds | ||
entries |
array of ConfigurationAuditEntry | The audited settings, one entry per setting | null;non-null (The array is optional. Each element must not be null.) |
DGN.ConfigurationAuditCategory
This is an enumeration data contract.
Describes the category of an audited configuration setting
Enum values
| ID | Description |
|---|---|
Security |
The setting is security relevant |
Performance |
The setting is performance relevant |
DGN.ConfigurationAuditEntry
This is a structure data contract.
Describes one audited configuration setting (without its effective value)
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
category |
ConfigurationAuditCategory | The category of the setting | ||
key |
string | The configuration key of the setting | ||
bounds |
string | The bounds the effective value has to meet | ||
compliant |
boolean | True if the effective value is within its bounds |
DGN.ErrorLog
This is a structure data contract.
Contains an error log with full failure information, suitable for developers
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
tenant |
UUID | Contains the tenant ID where this error happened | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
|
alias |
string | Contains the tenant's alias (used for starting PQFORCE) | ||
id |
UUID | Contains the ID of the error log (hashed, so that the same error results in the same ID) | matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.) |
|
subsystem |
string | The subsystem of PQFORCE that reported this error | ||
type |
string | The type of error that happened (subsystem- and environment-specific) | ||
method |
string | The HTTP method of the call that was involved (if applicable) | ||
url |
string | The URL of the call that was involved (if applicable) | ||
statusCode |
string | The status code of the call that was involved (if applicable) | ||
message |
string | The error message that describes the error | ||
details |
string | Additional details like a stack trace that may help developers to reproduce, identify and fix the issue | ||
serverVersion |
string | The server version string | ||
clientVersion |
string | The client version string (if applicable) | ||
browser |
string | The user agent string that has been sent by the browser (if applicable) | ||
clientIp |
string | The IP address of the client that invoked the request (if applicable) | ||
firstOccurrence |
datetime | The timestamp when this error first occurred | ||
lastOccurrence |
datetime | The timestamp when this error last occurred |
DGN.EventHistory
This is a structure data contract.
Describes the historic counters of an event
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
func |
string | The event | ||
timeline |
array of double | Counts how many times per second the event occurred (the oldest value first) | null;non-null (The array is optional. Each element must not be null.) |
DGN.KeyValuePair
This is a structure data contract.
A simple key value pair combination
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
key |
string | A key | ||
value |
string | A value |
DGN.MinMax
This is a structure data contract.
Describes a range of values
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
min |
long | Minimal value, inclusive | ||
max |
long | Maximal value, inclusive |
DGN.PerformanceCounter
This is a structure data contract.
Describes the performance of a process or event
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
func |
string | The process or event | ||
count |
long | Counts how many times the process was executed or event occurred | ||
avg |
int | The average time in milliseconds that it took to process | ||
min |
int | The minimal time in milliseconds that it took to process | ||
max |
int | The maximal time in milliseconds that it took to process |
DGN.PerformanceGcInfo
This is a structure data contract.
Contains information about the garbage collection process
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
lastRun |
PerformanceGcLastRun | Contains information about the last run, if any | ||
stats1h |
PerformanceCounter | Contains GC stats over the last hour | ||
stats24h |
PerformanceCounter | Contains GC stats over the last 24 hours |
DGN.PerformanceGcLastRun
This is a structure data contract.
Contains information about the last garbage collection process
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
name |
string | The name of the garbage collector | ||
cause |
string | Contains the cause that lead to garbage collection | ||
action |
string | Contains the action that was performed | ||
usedBefore |
long | Contains the number of bytes that were used before collection | ||
usedAfter |
long | Contains the number of bytes that were used after collection | ||
at |
datetime | The point in time of the run |
DGN.PerformanceIndicators
This is a structure data contract.
Contains information about the performance of PQFORCE
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
snapshot |
datetime | The point in time when the performance snapshot was acquired | ||
memorySize |
long | The memory size in bytes | ||
heapSize |
long | The java heap size in bytes | ||
processorLoad |
double | The processor load (0 - 1) | ||
memoryLoad |
double | The memory load (0 - 1) | ||
heapLoad |
double | The heap load (0 - 1) | ||
startUp |
datetime | The point in time when PQFORCE was started | ||
counters1h |
array of PerformanceCounter | Performance counters for different processes and events over the last hour | null;non-null (The array is optional. Each element must not be null.) |
|
counters24h |
array of PerformanceCounter | Performance counters for different processes and events over the last 24h | null;non-null (The array is optional. Each element must not be null.) |
|
events24h |
array of EventHistory | Counter history for different events over the last 24h | null;non-null (The array is optional. Each element must not be null.) |
|
queues24h |
array of QueueHistory | Queue size history for different queues over the last 24h | null;non-null (The array is optional. Each element must not be null.) |
|
gcInfo |
PerformanceGcInfo | Contains information about the garbage collection process |
DGN.QueueHistory
This is a structure data contract.
Describes the historic sizes of a queue
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
func |
string | The queue | ||
timeline |
array of MinMax | Contains the queue sizes over time (the oldest value first) | null;non-null (The array is optional. Each element must not be null.) |
DGN.ServerEnvironment
This is a structure data contract.
Describes the server environment PQFORCE is running on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
snapshot |
datetime | Contains the timestamp when this environment snapshot was created | ||
osName |
string | Contains the name of the operating system | ||
osArch |
string | Contains the architecture of the system | ||
osVersion |
string | Contains the version string as provided by the operating system | ||
processorCount |
int | Contains the number of logical processors present | ||
memorySize |
long | Contains the memory size in bytes | ||
java |
string | Contains the java version string | ||
time |
datetime | Contains the current time | ||
datastore |
ServerEnvironmentDataStore | Contains information about the datastore |
DGN.ServerEnvironmentDataStore
This is a structure data contract.
Contains information about the datastore
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
productName |
string | The name of the database product | ||
productVersion |
string | The version of the data store product | ||
host |
string | The host name of the data store | ||
location |
string | The name of the data store | ||
settings |
array of KeyValuePair | Different settings that apply, if any | null;non-null (The array is optional. Each element must not be null.) |
DGN.ServerStatus
This is a structure data contract.
Describes the current status of the application and connections
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
application |
StatusItem | describes the status of the application server | ||
database |
StatusItem | describes the status of the database | ||
mail |
StatusItem | describes the status of the mail service (SMTP) |
DGN.StatusItem
This is an enumeration data contract.
Describes the state of a single aspect of the overall application status
Enum values
| ID | Description |
|---|---|
Ok |
Everything OK |
Warning |
Something is in abnormal state |
Error |
Something is in an error state |