GetDistributionGroups Method
Overloads
GetDistributionGroups(Guid) |
Gets QDS loadbalancer groups for specific QDS. |
GetDistributionGroups(Guid)
Gets QDS loadbalancer groups for specific QDS.
Declaration
IEnumerable<string> GetDistributionGroups(Guid qdsId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | qdsId |
The ID of the QDS |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> |
Collection of all the distribution groups for the specific QDS. |
Remarks
security
Requires membership of local group QlikView Management API.
Examples
The following code example uses the QMS API to get all distribution groups for the specific QDS. If everything goes well it prints the number of groups. If anything goes wrong it prints an error message.
The service key injection is assumed to be handled behind the scenes. For an example of how to inject the service key, see Samples.
using System;
using System.Collections.Generic;
using System.Linq;
using QMSAPI;
class Program
{
static void Main(string[] args)
{
try
{
// create a QMS API client
IQMS2 apiClient = new QMS2Client();
//retrieve a time limited service key
ServiceKeyClientMessageInspector.ServiceKey = apiClient.GetTimeLimitedServiceKey();
//get all QDS services
ServiceInfo[] qdsServices = apiClient.GetServices(ServiceTypes.QlikViewDistributionService);
//get all distribution groups for the first QDS in the list
IEnumerable<string> groups = apiClient.GetDistributionGroups(qdsServices[0].ID);
Console.WriteLine("There are " + groups.Count() + " distribution groups for the QDS with the ID: " + qdsServices[0].ID);
}
catch(Exception e)
{
Console.WriteLine("An error occured: " + e.Message);
}
// wait for user to press any key
Console.ReadLine();
}
}
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 – let us know how we can improve!