REST API - GET Index Servers

Updated

This operation returns a list of index servers.

Request

Syntax

GET <webservice>/IndexServers?cloudId={cloudId}&cloudType={cloudType}&roleIds={roleIds}&roleOp={roleOp}&permissionId={permissionId} HTTP/1.1
Host: <host name>
Accept: {application/xml | application/json}
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

cloudId

The cloud ID for the index server.

If the cloud ID is not known, use the View Index Servers (REST API: GET) to retrieve it.

No

cloudType

The input cloud type for the index server.

Valid values are:

  • 1, Returns a standalone index server

  • 4, Returns a CVSolr index server

  • 5, Returns a cloud index server

No

roleIds

The role ID for the role.

Valid values are:

  • 2, Data Analytics role

  • 3, Log Monitoring role

  • 4, Download Center role

  • 7, EDGE Drive role

  • 8, Review Set role

  • 9, Web Analytics role

  • 11, NAS Array Reporting role

  • 12, Exchange Index role

  • 13, NFS Index role

  • 15, FileSystem Index role

  • 19, SharePoint Index role

  • 22, OneDrive Index role

No

roleOp

The OR operator is a default connective operator. The OR operator links two role IDs and finds a matching role ID, if either of the role IDs exist in the index server. If no Boolean operator is present between two role IDs, the OR operator is used.

The AND operator matches role IDs where both role IDs exist anywhere in the index server.

Valid values are:

  • OR

  • AND

No

permissionId

The permission ID for the permission. If you do not know the ID for a permission, you can find the permission name and ID in the UMPermissions table.

Valid values are:

  • 0, Lists the entities that the user or user group has any permission on

  • permission ID, Lists the entities that the user or user group has the defined permission on

No

Request Headers

Name

Description

Host

The host name of the Web Server or the Web Console that is used in the API request.

Accept

The format of the response.

Valid values are:

  • application/xml

  • application/json

Authtoken

The authentication token that is received after a successful log on. For detailed information about receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

clusterType

The cluster type for the index server.

indexServers

cloudId

The cloud ID for the index server.

indexServers

Type

The type of the operating system.

osInfo

SubType

The subtype of the operating system.

osInfo

osId

The ID of the operating system.

osInfo

clientId

The system-generated ID that is assigned to the client.

clients

clientName

The name of the client.

clients

Examples

Sample Request

GET <webservice>/IndexServers
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
    

Sample Response

This is the response when parameters are not used. All index servers with the View permission are returned.

<App_IndexServerListResp>
  <indexServers clusterType="1" cloudId="2">
    <osInfo Type="Unix" SubType="Linux" osId="98" />
    <clients clientId="5" clientName="adminadmin_AnalyticsServer" />
  </indexServers>
</App_IndexServerListResp>
    

This is the response when the roleIds parameter is set to 4,5,6.

<App_IndexServerListResp>
  <indexServers clusterType="1" cloudId="1">
    <osInfo Type="Unix" SubType="Linux" osId="98" />
    <clients clientId="4" clientName="IS_dvdpse" />
  </indexServers>
<App_IndexServerListResp>