Purpose

Returns the logs for a data source.

URL

https://<myserver>:<port>/api/mgmt/datasources/{DatasourceId}/logs

Method

GET

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <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 {DatasourceId} parameter must also be specified in the URL.

Parameter Description Valid Values
{DatasourceId} The ID of the data source. The ID is auto-generated when the data source is created and cannot be changed.

Sample Server Success Response


      Status code: 200
      Successful response

A zip file named dslogs_id.zip is downloaded to your machine. The zip file contains tar.gz files associated with the node or nodes in the Hybrid Data Pipeline deployment. The names of the tar.gz files take the format nodeId_HDPuserName-datasourceName-log.timestamp.tar.gz. The tar.gz file contain the logs for the data source.

Note: If allowed by your browser, you may enter the URL in the address field. You will be prompted for credentials. After you enter your credentials, the logs will be downloaded. If you are using an API tool, you may need to select a download option to ensure that the logs are downloaded. For example, if you are using the Postman GUI client, you must select Send and Download from the Send dropdown.

Sample Server Failure Response 

{
   "error":{
      "code":222209027,
      "message":{
         "lang":"en-US",
         "value":"There is no datasource with that id: 1234"
      }
   }
}

Authentication

Basic Authentication using Login ID and Password.

Authorization

The user must have the MgmtAPI (11) and ViewDataSource (2) permissions.