Sidra API module: Management¶
This module contains endpoints for retrieving information about the Sidra installation: notifications, logs, configuration values, etc.
App¶
It allows to retrieve the list of Client Applications, also known as Apps, registered in the installation. More information about Client Apps can be found in this section.
Configuration¶
It contains CRUD endpoints to Configuration
table. More information about management tables can be found in this section.
DataFactoryMetricLogs¶
It allows to retrieve the logs of Data Factory pipelines executions applying different sets of filters. The logs are retrieved from the Util.DataFactoryMetricLog
table in the Log database in Core.
Image¶
It allows to retrieve the image associated to a provider, entity or app by its identifier. The valid values for the type are: entity
, provider
, app
.
Logs¶
It allows to retrieve the logs of the platform applying different sets of filters. The logs are retrieved from the Util.Log
table in the Log database in Core. The severity is the value stored in the Level
field. It is an open field but usual values are: Error
, Warning
, Fatal
, Information
and Debug
.
Notifications¶
It allows to retrieve information about the notifications:
- Get the number of notifications that are pending to read of each type:
all
,general
,intake
,app
. - Get the notifications pending to read of a specific type.
- Mark a set of notifications as read by theirs ids.
These are the available notification types:
Id | NotificationType |
---|---|
1 | General |
2 | Intake |
3 | App |
ReleaseNotes¶
It allows to retrieve the release notes of all the Sidra versions and the version number of the installed one.
Service¶
It allows to retrieve generic information about the status of the installation:
- Get the list of clusters, theirs type and status.
- Get the list of all the services provided by Sidra platform an which ones are actived in the installation.
- Get the list of DSUs configured in the installation.
- Get the latest errors. Errors are entries of the
Util.Log
table with theLevel
field setup toError
. - Get the latest warnings. Warnings are entries of the
Util.Log
table with theLevel
field setup toWarning
. - Get the number of entries in the
Util.Log
table filtered by a severity -which means a specific value in theLevel
field- an grouped by severity. - Get the number of errors filtered by a minimun id.
- Get the number of warnings filtered by a minimun id.
- Get a list of the selected measures about the installation with the type of measure it is.
- Get a list of the selected measures during the selected dates.
These are the available measures:
Id | MeasureName |
---|---|
0 | TotalApps |
1 | StorageVolume |
2 | LastDayVolume |
3 | TotalEntities |
4 | TotalRows |
5 | TotalStreamingSources |
6 | TotalAssets |
7 | TotalDataLakeRegions |
8 | TotalProviders |
These are the available measure types:
Id | MeasureUnit |
---|---|
0 | Bytes |
1 | Count |
2 | Seconds |
3 | Date |
4 | Text |
5 | Bool |
These are the available measures for the selection using dates:
Id | DatedMeasureName |
---|---|
0 | ValidationErrors |
1 | LoadVolume |
The information provided by these endpoints is used in the dashboard section of the Sidra Manager website.