GetServerDetails

General

URL

https://{host}/attunityenterprisemanager/api/v1/servers/[server]

Description

Retrieves details about the specified server.

HTTP method

GET

Required user role

See Required Enterprise Manager permissions.

Request parameters

Request parameters
Location	Name	Required	Example
URL	host [string]	Yes	computer.network.net
URL	ServerName [string]	Yes	myrepsrv1
Header	EnterpriseManager.APISessionID [string]	Yes	wCo0_KvjEUFROvfHF5KGrw

Response body

{

"serverDetails":{

"$type":"{string}",

"name":"{string}",

"description":"{string}",

"configuration":{

"host":"{string}",

"platform":"{enum server_platform}",

"port":"{string}",

"username":"{string}"

"state":"{enum server_state}",

"message": "{string}",

"version": "{string}",

"license":{

"issue_date":"{string}",

"state":"{enum license_state}",

"expiration":"{string}",

"days_to_expiration":"{int32}"

"last_connection":"{string}",

"task_summary":{

"total":"{int32}",

"running":"{int32}",

"stopped":"{int32}",

"recovering":"{int32}",

"error":"{int32}"

"resource_utilization":{

"disk_usage_mb":"{int64}",

"memory_mb":"{int64}",

"attunity_cpu_percentage":"{int32}",

"machine_cpu_percentage":"{int32}"

}

Response parameters

General parameters
Name	Description
$type	The server's type, which can either be ReplicateServerDetails or ComposeServerDetails.
Name	The name of the server in Qlik Enterprise Manager.
Description	The server description

configuration parameters
Name	Description
host	The host name or IP address of the Replicate/Compose Server machine.
platform	The platform on which the Replicate/Compose Server machine is installed.
port	The port through which the Replicate/Compose Server machine is accessed.
user name	The user name for connecting to the Replicate/Compose Server machine.
State	The current monitoring state of the Replicate/Compose Server machine.
message	The error message if Qlik Enterprise Manager fails to connect to the Replicate/Compose Server machine.
version	The Replicate/Compose Server version.

license parameters
Name	Description
issue_date	When the license was issued.
state	The current license state (for example, valid, expired, and so on.).
expiration	The expiration date of the server license.
days_to_expiration	The number of days left before the license expires.
last_connection	The date and time of the last successful sync/retrieval of tasks and messages.

task_summary parameters
Name	Description
total	The total number of tasks, regardless of state.
running	The number of running tasks.
stopped	The number of stopped tasks.
recovering	The number of recovering tasks.
error	The number of tasks that encountered a fatal error.

resource_utilization parameters
Name	Description
disk_usage_mb	The amount of disk space that the server is currently consuming, in MB. This is the sum of disk usage for all tasks on this server.
memory_mb	The amount of memory that the server is currently consuming, in MB. This is the sum of memory usage for all active tasks on this server, excluding stopped tasks.
attunity_cpu_percentage	The current CPU usage of the Replicate server process + all task processes.
machine_cpu_percentage	The current total CPU usage of all the processes running on the machine.

The return value -1 means N/A.
Parameters related to Disk, Memory, Qlik CPU, and Machine CPU usage are not available for Compose servers. For Compose servers, these parameters will be returned as -1.
Parameters related to Qlik CPU and Machine CPU usage are only available for Replicate 6.2 and above. For earlier Replicate versions, these parameters will be returned as -1.
For servers that are in an error state or not monitored, parameters related to Disk and Memory usage will be returned as -1.

cURL example

Request:

curl -i -k --header "EnterpriseManager.APISessionID: wCo0_KvjEUFROvfHF5KGrw" https://computer.network.net/attunityenterprisemanager/api/v1/
servers/myrepsrv1

Response:

Headers:
HTTP/1.1 200 OK
Cache-Control: no-cache, no-store
Content-Length: 1658
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Date: Mon, 26 Dec 2016 13:18:27 GMT
Payload:
{
"serverDetails":{
	"$type": "ReplicateServerDetails",
	"name":"myrepsrv1",
	"description":"My daily replication tasks",
	"configuration":{
		"host":"computer.network.net",
		"platform":"WINDOWS",
		"port":"443",
		"username":"Administrator"
	 },
	"state":"MONITORED",
	"message": "",
	"version": "5.2.0.156",
	"license":{       
		"issue_date":"2016-12-31",
		"state":"LICENSE_VALID",
		"expiration":"2017-12-31",
		"days_to_expiration":"30"                        
         },
       "last_connection":"2016-12-18T02:23:30",     
	"task_summary":{
		"total":50,
		"running":20,
		"stopped":10,
		"recovering":12,
		"error":8
	},
	"resource_utilization":{
		"disk_usage_mb":500,
		"memory_mb":112832,
               "attunity_cpu_percentage":30,
               "machine_cpu_percentage":50
	},
}

Error response

Error responses
HTTP Code	Enterprise Manager Code	Text	Description
500	AEM_SERVER_NOT_FOUND	Replicate server {server} could not be found.	Server name unknown to Qlik Enterprise Manager.
403	See Error handling.	-	-
440	See Error handling.	-	-

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here