Purpose

Returns the system logs for a node.

URL

https://<myserver>:<port>/api/admin/system/nodes/{id}/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 URL parameter {id} described in the following table is required.

Parameter Description Valid Values
{id} The ID of the node. The ID is auto-generated when the node is created. The ID of a node cannot be changed.

Sample Server Success Response


      Status code: 200
      Successful response

A tar.gz file, containing the system logs of the specified node, is downloaded to your machine. The name of the file will have the format d2c_logs.datetimestamp.tar.gz.

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 Node with that id: 1234"
      }
   }
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the Administrator (12) permission.