skip to main content
Hybrid Data Pipeline API reference : Administrators API : Logging API : Update logging levels for a data source
  

Try Now
Update logging levels for a data source

Purpose

Updates the logging levels for a data source.

URL

https://<myserver>:<port>/api/admin/users/{userid}/datasources/{datasourceid}/logging

Method

PUT

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a standalone installation, or the machine hosting the load balancer for a load balancer installation. For a standalone installation, <port> is the port number specified as the Server Access Port during installation. For a load balancer installation, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.
The URL parameters "userid" and "datasourceid" described in the following table are required.
Parameter
Description
Valid Values
"userid"
The ID of the user account.
The ID is auto-generated when the user account is created and cannot be changed.
"datasourceid"
The ID of the data source.
The ID is auto-generated when the data source is created and cannot be changed.

Request Payload Definition

The request takes the following format. The properties of the request are described in the table that follows.
{
"dasLogLevel": "logging_level",
"privacyLevel": "privacy_level",
"driverLogConfig": [
{
"name": "ADAPTER",
"logLevel": "adapter_level"
},
{
"name": "CLOUD",
"logLevel": "cloud_level"
},
{
"name": "DRIVERCOMMUNICATION",
"logLevel": "drivercom_level"
},
{
"name": "SQL",
"logLevel": "sql_level"
}
]
}
Property
Description
Valid Values
"dasLogLevel"
Determines the level of detail to be included in the data source activity log.
"privacyLevel"
Determines the type of information that gets logged.
"driverLogConfig"
Driver loggers available for non-relational data sources and the corresponding setting for each. When these loggers are enabled, information related to the internal SQL engine is passed to the data source activity log.

Sample Payload Request

{
"dasLogLevel": "CONFIG",
"privacyLevel": "AllowSQL",
"driverLogConfig": [
{
"name": "ADAPTER",
"logLevel": "SEVERE"
},
{
"name": "CLOUD",
"logLevel": "SEVERE"
},
{
"name": "DRIVERCOMMUNICATION",
"logLevel": "SEVERE"
},
{
"name": "SQL",
"logLevel": "SEVERE"
}
]
}

Sample Server Success Response


Status code: 200
Successful response
{
"dasLogLevel": "CONFIG",
"privacyLevel": "AllowSQL",
"driverLogConfig": [
{
"name": "ADAPTER",
"logLevel": "SEVERE"
},
{
"name": "CLOUD",
"logLevel": "SEVERE"
},
{
"name": "DRIVERCOMMUNICATION",
"logLevel": "SEVERE"
},
{
"name": "SQL",
"logLevel": "SEVERE"
}
]
}

Sample Server Failure Response

{
"error":{
"code":222207936,
"message":{
"lang":"en-US",
"value":"Invalid Driver Logger name: abc. Allowed Values are adapter, sql,
drivercommunication, cloud (case insensitive)."
}
}
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the Administrator (12) permission; or the user must have the Logging (24) permission and administrative access on the tenant to which the users and data sources belong.