DBMS request parameters

Prev Next

Retrieves the list of databases.

Service

dbms

Permission

DBMS XML API

Version

4.6.0 or later

Parameter

Definition

HH$Id

Long

HH$Name

String

HH$VaConfigured

Boolean — Search for DBMSs configured for VA

HH$MonitorStatus

DAM monitoring status: FULL, PARTIAL, and NONE

HH$Agents

Comma-separated list of Agent IDs

HH$Description

String

HH$MajorVersion

String — Version of the DBMS

HH$DbType

String — One of the database types

HH$$RuleStats

Boolean — If set to false, then the total number of rules (custom and predefined) are not calculated

Note

The default value is true

HH$$ScanStats

Boolean — If set to false, then the scan summary is not included

Note

The default value is true

HH$pageSize

Long — The maximum number of results per call. The default value is -1 (ALL)

HH$pageNum

Long — The number of the page to return. The default value is 0

Examples

Note

The port number mentioned here varies depending on the Database Security configuration.

  • To get a list of DBMSs with VA enabled:

    https://127.0.0.1:8443/xmlapi.svc?service=dbms&HH$VaConfigured=true

  • To get the list of database without calculating the total number of rules:

    https://127.0.0.1:8443/xmlapi.svc?service=dbms&HH$$RuleStats=false

Note

The parameters HH$$RuleStats and HH$$ScanStats are helpful when the time consumed for the completion of service call is very high. It eliminates rules and scans statistics from the database output, since these operation can take long time when the network connection to the back-end database is slow.