Click or drag to resize
IQMS2GetDistributionGroupsDefinition Method
Gets QDS loadbalancer group definition for specific QDS.

Namespace: PIX.Services.V12.Api2
Assembly: 
Syntax
IEnumerable<DistributionConfigValues> GetDistributionGroupsDefinition(
	Guid qdsId
)

Parameters

qdsId
Type: SystemGuid
The ID of the QDS.

Return Value

Type: IEnumerableDistributionConfigValues
QDS load balancer group definition for the specific QDS.
Remarks
Security note Security Note

Requires membership of local group QlikView Management API.

Examples
The following code example uses the QMS API to get QDS load balancer group definition for the specific QDS. If everything goes well it prints a success message. 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.

C#
 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 QDS load balancer distribution groups for the first QDS in the list
            DistributionConfigValues[]  configs = apiClient.GetDistributionGroupsDefinition(qdsServices[0].ID);

            Console.WriteLine("Success! Group definitions retrieved.");
         }
         catch(Exception e)
         {
             Console.WriteLine("An error occured: " + e.Message);
         }
         // wait for user to press any key
         Console.ReadLine();
     }
}
See Also