REST API - GET Index Servers for a Client

This operation returns the list of index servers that are associated with a client.

Request

Syntax

GET webservice/AnayticsServers/indexserverclient/clientId HTTP/1.1
Host: host name
Accept: application/xml
Authtoken: authentication token

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name	Description	Required
indexserverclientId	The client ID for the client. If the client ID is not known, use the GET Client API to retrieve it.	Yes

Request Headers

Name	Description
Host	The host name of the Web Server or the Command Center used in the API request.
Accept	The format of the response. Valid values are: application/xml or application/json.
Authtoken	The authentication token received after successfully logging on. For information about receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter	Description	Element
hostName	The host name of the index server.	listOfCIServer
internalCloudName	The internal name of the index server.	listOfCIServer
clientName	The name of the client.	listOfCIServer
cIServerURL	The URL for the content indexing server.	listOfCIServer
type	The type of the search server (Fast/SOLR).	listOfCIServer
basePort	The port number of the index server.	listOfCIServer
clientId	The client ID of the node that is associated with the index server.	listOfCIServer
version	The version of the analytics engine.	listOfCIServer
cloudID	The system-generated ID of the index server.	listOfCIServer
serverType	The index server type, such as standalone index server and cloud mode index server.	listOfCIServer
engineName	The name of analytics engine.	listOfCIServer
indexServerClientId	The system-generated ID of the index server client.	listOfCIServer

Examples

Sample Request

GET webservice/AnalyticsServers/indexserverclient/60
Host: client.mydomain.com
Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

{
  "listOfCIServer":[
    {
      "hostName": "172.19.111.176",
      "internalCloudName": "centos7indexserver",
      "clientName": "dm2perf4_centos7",
      "cIServerURL": "http://172.19.111.176:20000",
      "type": 3,
      "basePort": 20000,
      "clientId": 4,
      "version": "Analytics 1.0",
      "cloudID": 2,
      "serverType": 1,
      "engineName": "centos7_indexserver",
      "indexServerClientId": 60
    },
      ]