Cloudera Documentation

Cloudera Streams Messaging Manager REST API Reference

AggregatedMetricOperations

getAllConsumerGroupMetrics

Get all consumer group details.


/api/v2/admin/metrics/aggregated/groups

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/metrics/aggregated/groups?duration=&from=&to=&state=&includeProducerMetrics=&includeAssignments="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AggregatedMetricOperationsApi;

import java.io.File;
import java.util.*;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Client
        Boolean includeProducerMetrics = true; // Boolean | Include Producer Metrics
        Boolean includeAssignments = true; // Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info
        try {
            array[AggrConsumerMetrics] result = apiInstance.getAllConsumerGroupMetrics(duration, from, to, state, includeProducerMetrics, includeAssignments);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getAllConsumerGroupMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AggregatedMetricOperationsApi;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Client
        Boolean includeProducerMetrics = true; // Boolean | Include Producer Metrics
        Boolean includeAssignments = true; // Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info
        try {
            array[AggrConsumerMetrics] result = apiInstance.getAllConsumerGroupMetrics(duration, from, to, state, includeProducerMetrics, includeAssignments);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getAllConsumerGroupMetrics");
            e.printStackTrace();
        }
    }
}
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *state = state_example; // State of the Client (optional)
Boolean *includeProducerMetrics = true; // Include Producer Metrics (optional)
Boolean *includeAssignments = true; // Include Individual ConsumerInstance to TopicPartition Assignment Info (optional)

AggregatedMetricOperationsApi *apiInstance = [[AggregatedMetricOperationsApi alloc] init];

// Get all consumer group details.
[apiInstance getAllConsumerGroupMetricsWith:duration
    from:from
    to:to
    state:state
    includeProducerMetrics:includeProducerMetrics
    includeAssignments:includeAssignments
              completionHandler: ^(array[AggrConsumerMetrics] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AggregatedMetricOperationsApi()
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'state': state_example, // {{String}} State of the Client
  'includeProducerMetrics': true, // {{Boolean}} Include Producer Metrics
  'includeAssignments': true // {{Boolean}} Include Individual ConsumerInstance to TopicPartition Assignment Info
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllConsumerGroupMetrics(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllConsumerGroupMetricsExample
    {
        public void main()
        {

            var apiInstance = new AggregatedMetricOperationsApi();
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var state = state_example;  // String | State of the Client (optional) 
            var includeProducerMetrics = true;  // Boolean | Include Producer Metrics (optional) 
            var includeAssignments = true;  // Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info (optional) 

            try
            {
                // Get all consumer group details.
                array[AggrConsumerMetrics] result = apiInstance.getAllConsumerGroupMetrics(duration, from, to, state, includeProducerMetrics, includeAssignments);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AggregatedMetricOperationsApi.getAllConsumerGroupMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAggregatedMetricOperationsApi();
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$state = state_example; // String | State of the Client
$includeProducerMetrics = true; // Boolean | Include Producer Metrics
$includeAssignments = true; // Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info

try {
    $result = $api_instance->getAllConsumerGroupMetrics($duration, $from, $to, $state, $includeProducerMetrics, $includeAssignments);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AggregatedMetricOperationsApi->getAllConsumerGroupMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AggregatedMetricOperationsApi;

my $api_instance = WWW::SwaggerClient::AggregatedMetricOperationsApi->new();
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $state = state_example; # String | State of the Client
my $includeProducerMetrics = true; # Boolean | Include Producer Metrics
my $includeAssignments = true; # Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info

eval { 
    my $result = $api_instance->getAllConsumerGroupMetrics(duration => $duration, from => $from, to => $to, state => $state, includeProducerMetrics => $includeProducerMetrics, includeAssignments => $includeAssignments);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AggregatedMetricOperationsApi->getAllConsumerGroupMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AggregatedMetricOperationsApi()
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
state = state_example # String | State of the Client (optional)
includeProducerMetrics = true # Boolean | Include Producer Metrics (optional)
includeAssignments = true # Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info (optional)

try: 
    # Get all consumer group details.
    api_response = api_instance.get_all_consumer_group_metrics(duration=duration, from=from, to=to, state=state, includeProducerMetrics=includeProducerMetrics, includeAssignments=includeAssignments)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AggregatedMetricOperationsApi->getAllConsumerGroupMetrics: %s\n" % e)

Parameters

Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
state
String
State of the Client
includeProducerMetrics
Boolean
Include Producer Metrics
includeAssignments
Boolean
Include Individual ConsumerInstance to TopicPartition Assignment Info

Responses

Status: 200 - successful operation


getAllProducerMetrics

Get producer metrics for all the alive producers


/api/v2/admin/metrics/aggregated/producers

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/metrics/aggregated/producers?duration=&from=&to=&state="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AggregatedMetricOperationsApi;

import java.io.File;
import java.util.*;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Client
        try {
            array[AggrProducerMetrics] result = apiInstance.getAllProducerMetrics(duration, from, to, state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getAllProducerMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AggregatedMetricOperationsApi;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Client
        try {
            array[AggrProducerMetrics] result = apiInstance.getAllProducerMetrics(duration, from, to, state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getAllProducerMetrics");
            e.printStackTrace();
        }
    }
}
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *state = state_example; // State of the Client (optional)

AggregatedMetricOperationsApi *apiInstance = [[AggregatedMetricOperationsApi alloc] init];

// Get producer metrics for all the alive producers
[apiInstance getAllProducerMetricsWith:duration
    from:from
    to:to
    state:state
              completionHandler: ^(array[AggrProducerMetrics] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AggregatedMetricOperationsApi()
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'state': state_example // {{String}} State of the Client
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllProducerMetrics(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllProducerMetricsExample
    {
        public void main()
        {

            var apiInstance = new AggregatedMetricOperationsApi();
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var state = state_example;  // String | State of the Client (optional) 

            try
            {
                // Get producer metrics for all the alive producers
                array[AggrProducerMetrics] result = apiInstance.getAllProducerMetrics(duration, from, to, state);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AggregatedMetricOperationsApi.getAllProducerMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAggregatedMetricOperationsApi();
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$state = state_example; // String | State of the Client

try {
    $result = $api_instance->getAllProducerMetrics($duration, $from, $to, $state);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AggregatedMetricOperationsApi->getAllProducerMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AggregatedMetricOperationsApi;

my $api_instance = WWW::SwaggerClient::AggregatedMetricOperationsApi->new();
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $state = state_example; # String | State of the Client

eval { 
    my $result = $api_instance->getAllProducerMetrics(duration => $duration, from => $from, to => $to, state => $state);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AggregatedMetricOperationsApi->getAllProducerMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AggregatedMetricOperationsApi()
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
state = state_example # String | State of the Client (optional)

try: 
    # Get producer metrics for all the alive producers
    api_response = api_instance.get_all_producer_metrics(duration=duration, from=from, to=to, state=state)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AggregatedMetricOperationsApi->getAllProducerMetrics: %s\n" % e)

Parameters

Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
state
String
State of the Client

Responses

Status: 200 - successful operation


getBrokerDetails1

Get broker details with metrics for a given brokerId


/api/v2/admin/metrics/aggregated/brokers/{brokerId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/metrics/aggregated/brokers/{brokerId}?duration=&from=&to=&includeClientDetails="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AggregatedMetricOperationsApi;

import java.io.File;
import java.util.*;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        Integer brokerId = 56; // Integer | Broker setId
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        Boolean includeClientDetails = true; // Boolean | Flag to request client details
        try {
            BrokerDetails result = apiInstance.getBrokerDetails1(brokerId, duration, from, to, includeClientDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getBrokerDetails1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AggregatedMetricOperationsApi;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        Integer brokerId = 56; // Integer | Broker setId
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        Boolean includeClientDetails = true; // Boolean | Flag to request client details
        try {
            BrokerDetails result = apiInstance.getBrokerDetails1(brokerId, duration, from, to, includeClientDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getBrokerDetails1");
            e.printStackTrace();
        }
    }
}
Integer *brokerId = 56; // Broker setId
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
Boolean *includeClientDetails = true; // Flag to request client details (optional) (default to false)

AggregatedMetricOperationsApi *apiInstance = [[AggregatedMetricOperationsApi alloc] init];

// Get broker details with metrics for a given brokerId
[apiInstance getBrokerDetails1With:brokerId
    duration:duration
    from:from
    to:to
    includeClientDetails:includeClientDetails
              completionHandler: ^(BrokerDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AggregatedMetricOperationsApi()
var brokerId = 56; // {{Integer}} Broker setId
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'includeClientDetails': true // {{Boolean}} Flag to request client details
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBrokerDetails1(brokerId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBrokerDetails1Example
    {
        public void main()
        {

            var apiInstance = new AggregatedMetricOperationsApi();
            var brokerId = 56;  // Integer | Broker setId
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var includeClientDetails = true;  // Boolean | Flag to request client details (optional)  (default to false)

            try
            {
                // Get broker details with metrics for a given brokerId
                BrokerDetails result = apiInstance.getBrokerDetails1(brokerId, duration, from, to, includeClientDetails);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AggregatedMetricOperationsApi.getBrokerDetails1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAggregatedMetricOperationsApi();
$brokerId = 56; // Integer | Broker setId
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$includeClientDetails = true; // Boolean | Flag to request client details

try {
    $result = $api_instance->getBrokerDetails1($brokerId, $duration, $from, $to, $includeClientDetails);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AggregatedMetricOperationsApi->getBrokerDetails1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AggregatedMetricOperationsApi;

my $api_instance = WWW::SwaggerClient::AggregatedMetricOperationsApi->new();
my $brokerId = 56; # Integer | Broker setId
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $includeClientDetails = true; # Boolean | Flag to request client details

eval { 
    my $result = $api_instance->getBrokerDetails1(brokerId => $brokerId, duration => $duration, from => $from, to => $to, includeClientDetails => $includeClientDetails);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AggregatedMetricOperationsApi->getBrokerDetails1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AggregatedMetricOperationsApi()
brokerId = 56 # Integer | Broker setId
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
includeClientDetails = true # Boolean | Flag to request client details (optional) (default to false)

try: 
    # Get broker details with metrics for a given brokerId
    api_response = api_instance.get_broker_details1(brokerId, duration=duration, from=from, to=to, includeClientDetails=includeClientDetails)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AggregatedMetricOperationsApi->getBrokerDetails1: %s\n" % e)

Parameters

Path parameters
Name Description
brokerId*
Integer (int32)
Broker setId
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
includeClientDetails
Boolean
Flag to request client details

Responses

Status: 200 - successful operation


getClusterWithBrokerMetrics

Get cluster with broker metrics


/api/v2/admin/metrics/aggregated/brokers

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/metrics/aggregated/brokers?duration=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AggregatedMetricOperationsApi;

import java.io.File;
import java.util.*;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            ClusterWithBrokerMetrics result = apiInstance.getClusterWithBrokerMetrics(duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getClusterWithBrokerMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AggregatedMetricOperationsApi;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            ClusterWithBrokerMetrics result = apiInstance.getClusterWithBrokerMetrics(duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getClusterWithBrokerMetrics");
            e.printStackTrace();
        }
    }
}
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)

AggregatedMetricOperationsApi *apiInstance = [[AggregatedMetricOperationsApi alloc] init];

// Get cluster with broker metrics
[apiInstance getClusterWithBrokerMetricsWith:duration
    from:from
    to:to
              completionHandler: ^(ClusterWithBrokerMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AggregatedMetricOperationsApi()
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789 // {{Long}} End of the time period. Provide '-1' to fetch the latest value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getClusterWithBrokerMetrics(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getClusterWithBrokerMetricsExample
    {
        public void main()
        {

            var apiInstance = new AggregatedMetricOperationsApi();
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 

            try
            {
                // Get cluster with broker metrics
                ClusterWithBrokerMetrics result = apiInstance.getClusterWithBrokerMetrics(duration, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AggregatedMetricOperationsApi.getClusterWithBrokerMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAggregatedMetricOperationsApi();
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value

try {
    $result = $api_instance->getClusterWithBrokerMetrics($duration, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AggregatedMetricOperationsApi->getClusterWithBrokerMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AggregatedMetricOperationsApi;

my $api_instance = WWW::SwaggerClient::AggregatedMetricOperationsApi->new();
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value

eval { 
    my $result = $api_instance->getClusterWithBrokerMetrics(duration => $duration, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AggregatedMetricOperationsApi->getClusterWithBrokerMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AggregatedMetricOperationsApi()
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)

try: 
    # Get cluster with broker metrics
    api_response = api_instance.get_cluster_with_broker_metrics(duration=duration, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AggregatedMetricOperationsApi->getClusterWithBrokerMetrics: %s\n" % e)

Parameters

Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value

Responses

Status: 200 - successful operation


getClusterWithTopicMetrics

Get cluster with topic metrics


/api/v2/admin/metrics/aggregated/topics

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/metrics/aggregated/topics?duration=&from=&to=&state=&includeClientDetails=&includePartitionDetails="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AggregatedMetricOperationsApi;

import java.io.File;
import java.util.*;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Client
        Boolean includeClientDetails = true; // Boolean | Flag to request client details
        Boolean includePartitionDetails = true; // Boolean | Flag to request partition metrics
        try {
            ClusterWithTopicMetrics result = apiInstance.getClusterWithTopicMetrics(duration, from, to, state, includeClientDetails, includePartitionDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getClusterWithTopicMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AggregatedMetricOperationsApi;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Client
        Boolean includeClientDetails = true; // Boolean | Flag to request client details
        Boolean includePartitionDetails = true; // Boolean | Flag to request partition metrics
        try {
            ClusterWithTopicMetrics result = apiInstance.getClusterWithTopicMetrics(duration, from, to, state, includeClientDetails, includePartitionDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getClusterWithTopicMetrics");
            e.printStackTrace();
        }
    }
}
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *state = state_example; // State of the Client (optional)
Boolean *includeClientDetails = true; // Flag to request client details (optional) (default to false)
Boolean *includePartitionDetails = true; // Flag to request partition metrics (optional) (default to false)

AggregatedMetricOperationsApi *apiInstance = [[AggregatedMetricOperationsApi alloc] init];

// Get cluster with topic metrics
[apiInstance getClusterWithTopicMetricsWith:duration
    from:from
    to:to
    state:state
    includeClientDetails:includeClientDetails
    includePartitionDetails:includePartitionDetails
              completionHandler: ^(ClusterWithTopicMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AggregatedMetricOperationsApi()
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'state': state_example, // {{String}} State of the Client
  'includeClientDetails': true, // {{Boolean}} Flag to request client details
  'includePartitionDetails': true // {{Boolean}} Flag to request partition metrics
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getClusterWithTopicMetrics(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getClusterWithTopicMetricsExample
    {
        public void main()
        {

            var apiInstance = new AggregatedMetricOperationsApi();
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var state = state_example;  // String | State of the Client (optional) 
            var includeClientDetails = true;  // Boolean | Flag to request client details (optional)  (default to false)
            var includePartitionDetails = true;  // Boolean | Flag to request partition metrics (optional)  (default to false)

            try
            {
                // Get cluster with topic metrics
                ClusterWithTopicMetrics result = apiInstance.getClusterWithTopicMetrics(duration, from, to, state, includeClientDetails, includePartitionDetails);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AggregatedMetricOperationsApi.getClusterWithTopicMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAggregatedMetricOperationsApi();
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$state = state_example; // String | State of the Client
$includeClientDetails = true; // Boolean | Flag to request client details
$includePartitionDetails = true; // Boolean | Flag to request partition metrics

try {
    $result = $api_instance->getClusterWithTopicMetrics($duration, $from, $to, $state, $includeClientDetails, $includePartitionDetails);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AggregatedMetricOperationsApi->getClusterWithTopicMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AggregatedMetricOperationsApi;

my $api_instance = WWW::SwaggerClient::AggregatedMetricOperationsApi->new();
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $state = state_example; # String | State of the Client
my $includeClientDetails = true; # Boolean | Flag to request client details
my $includePartitionDetails = true; # Boolean | Flag to request partition metrics

eval { 
    my $result = $api_instance->getClusterWithTopicMetrics(duration => $duration, from => $from, to => $to, state => $state, includeClientDetails => $includeClientDetails, includePartitionDetails => $includePartitionDetails);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AggregatedMetricOperationsApi->getClusterWithTopicMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AggregatedMetricOperationsApi()
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
state = state_example # String | State of the Client (optional)
includeClientDetails = true # Boolean | Flag to request client details (optional) (default to false)
includePartitionDetails = true # Boolean | Flag to request partition metrics (optional) (default to false)

try: 
    # Get cluster with topic metrics
    api_response = api_instance.get_cluster_with_topic_metrics(duration=duration, from=from, to=to, state=state, includeClientDetails=includeClientDetails, includePartitionDetails=includePartitionDetails)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AggregatedMetricOperationsApi->getClusterWithTopicMetrics: %s\n" % e)

Parameters

Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
state
String
State of the Client
includeClientDetails
Boolean
Flag to request client details
includePartitionDetails
Boolean
Flag to request partition metrics

Responses

Status: 200 - successful operation


getConsumerGroupMetrics

Get consumer group details for the given groupName.


/api/v2/admin/metrics/aggregated/groups/{groupName}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/metrics/aggregated/groups/{groupName}?duration=&from=&to=&state=&includeProducerMetrics=&includeAssignments="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AggregatedMetricOperationsApi;

import java.io.File;
import java.util.*;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String groupName = groupName_example; // String | Name of the consumer group
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Producer
        Boolean includeProducerMetrics = true; // Boolean | Include Producer Metrics
        Boolean includeAssignments = true; // Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info
        try {
            AggrConsumerMetrics result = apiInstance.getConsumerGroupMetrics(groupName, duration, from, to, state, includeProducerMetrics, includeAssignments);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getConsumerGroupMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AggregatedMetricOperationsApi;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String groupName = groupName_example; // String | Name of the consumer group
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Producer
        Boolean includeProducerMetrics = true; // Boolean | Include Producer Metrics
        Boolean includeAssignments = true; // Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info
        try {
            AggrConsumerMetrics result = apiInstance.getConsumerGroupMetrics(groupName, duration, from, to, state, includeProducerMetrics, includeAssignments);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getConsumerGroupMetrics");
            e.printStackTrace();
        }
    }
}
String *groupName = groupName_example; // Name of the consumer group
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *state = state_example; // State of the Producer (optional)
Boolean *includeProducerMetrics = true; // Include Producer Metrics (optional)
Boolean *includeAssignments = true; // Include Individual ConsumerInstance to TopicPartition Assignment Info (optional)

AggregatedMetricOperationsApi *apiInstance = [[AggregatedMetricOperationsApi alloc] init];

// Get consumer group details for the given groupName.
[apiInstance getConsumerGroupMetricsWith:groupName
    duration:duration
    from:from
    to:to
    state:state
    includeProducerMetrics:includeProducerMetrics
    includeAssignments:includeAssignments
              completionHandler: ^(AggrConsumerMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AggregatedMetricOperationsApi()
var groupName = groupName_example; // {{String}} Name of the consumer group
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'state': state_example, // {{String}} State of the Producer
  'includeProducerMetrics': true, // {{Boolean}} Include Producer Metrics
  'includeAssignments': true // {{Boolean}} Include Individual ConsumerInstance to TopicPartition Assignment Info
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerGroupMetrics(groupName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerGroupMetricsExample
    {
        public void main()
        {

            var apiInstance = new AggregatedMetricOperationsApi();
            var groupName = groupName_example;  // String | Name of the consumer group
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var state = state_example;  // String | State of the Producer (optional) 
            var includeProducerMetrics = true;  // Boolean | Include Producer Metrics (optional) 
            var includeAssignments = true;  // Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info (optional) 

            try
            {
                // Get consumer group details for the given groupName.
                AggrConsumerMetrics result = apiInstance.getConsumerGroupMetrics(groupName, duration, from, to, state, includeProducerMetrics, includeAssignments);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AggregatedMetricOperationsApi.getConsumerGroupMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAggregatedMetricOperationsApi();
$groupName = groupName_example; // String | Name of the consumer group
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$state = state_example; // String | State of the Producer
$includeProducerMetrics = true; // Boolean | Include Producer Metrics
$includeAssignments = true; // Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info

try {
    $result = $api_instance->getConsumerGroupMetrics($groupName, $duration, $from, $to, $state, $includeProducerMetrics, $includeAssignments);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AggregatedMetricOperationsApi->getConsumerGroupMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AggregatedMetricOperationsApi;

my $api_instance = WWW::SwaggerClient::AggregatedMetricOperationsApi->new();
my $groupName = groupName_example; # String | Name of the consumer group
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $state = state_example; # String | State of the Producer
my $includeProducerMetrics = true; # Boolean | Include Producer Metrics
my $includeAssignments = true; # Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info

eval { 
    my $result = $api_instance->getConsumerGroupMetrics(groupName => $groupName, duration => $duration, from => $from, to => $to, state => $state, includeProducerMetrics => $includeProducerMetrics, includeAssignments => $includeAssignments);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AggregatedMetricOperationsApi->getConsumerGroupMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AggregatedMetricOperationsApi()
groupName = groupName_example # String | Name of the consumer group
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
state = state_example # String | State of the Producer (optional)
includeProducerMetrics = true # Boolean | Include Producer Metrics (optional)
includeAssignments = true # Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info (optional)

try: 
    # Get consumer group details for the given groupName.
    api_response = api_instance.get_consumer_group_metrics(groupName, duration=duration, from=from, to=to, state=state, includeProducerMetrics=includeProducerMetrics, includeAssignments=includeAssignments)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AggregatedMetricOperationsApi->getConsumerGroupMetrics: %s\n" % e)

Parameters

Path parameters
Name Description
groupName*
String
Name of the consumer group
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
state
String
State of the Producer
includeProducerMetrics
Boolean
Include Producer Metrics
includeAssignments
Boolean
Include Individual ConsumerInstance to TopicPartition Assignment Info

Responses

Status: 200 - successful operation


getProducerMetrics

Get producer metrics for the given producerClientId


/api/v2/admin/metrics/aggregated/producers/{producerClientId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/metrics/aggregated/producers/{producerClientId}?duration=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AggregatedMetricOperationsApi;

import java.io.File;
import java.util.*;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String producerClientId = producerClientId_example; // String | Producer client identifier
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            AggrProducerMetrics result = apiInstance.getProducerMetrics(producerClientId, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getProducerMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AggregatedMetricOperationsApi;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String producerClientId = producerClientId_example; // String | Producer client identifier
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            AggrProducerMetrics result = apiInstance.getProducerMetrics(producerClientId, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getProducerMetrics");
            e.printStackTrace();
        }
    }
}
String *producerClientId = producerClientId_example; // Producer client identifier
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)

AggregatedMetricOperationsApi *apiInstance = [[AggregatedMetricOperationsApi alloc] init];

// Get producer metrics for the given producerClientId
[apiInstance getProducerMetricsWith:producerClientId
    duration:duration
    from:from
    to:to
              completionHandler: ^(AggrProducerMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AggregatedMetricOperationsApi()
var producerClientId = producerClientId_example; // {{String}} Producer client identifier
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789 // {{Long}} End of the time period. Provide '-1' to fetch the latest value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProducerMetrics(producerClientId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProducerMetricsExample
    {
        public void main()
        {

            var apiInstance = new AggregatedMetricOperationsApi();
            var producerClientId = producerClientId_example;  // String | Producer client identifier
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 

            try
            {
                // Get producer metrics for the given producerClientId
                AggrProducerMetrics result = apiInstance.getProducerMetrics(producerClientId, duration, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AggregatedMetricOperationsApi.getProducerMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAggregatedMetricOperationsApi();
$producerClientId = producerClientId_example; // String | Producer client identifier
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value

try {
    $result = $api_instance->getProducerMetrics($producerClientId, $duration, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AggregatedMetricOperationsApi->getProducerMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AggregatedMetricOperationsApi;

my $api_instance = WWW::SwaggerClient::AggregatedMetricOperationsApi->new();
my $producerClientId = producerClientId_example; # String | Producer client identifier
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value

eval { 
    my $result = $api_instance->getProducerMetrics(producerClientId => $producerClientId, duration => $duration, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AggregatedMetricOperationsApi->getProducerMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AggregatedMetricOperationsApi()
producerClientId = producerClientId_example # String | Producer client identifier
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)

try: 
    # Get producer metrics for the given producerClientId
    api_response = api_instance.get_producer_metrics(producerClientId, duration=duration, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AggregatedMetricOperationsApi->getProducerMetrics: %s\n" % e)

Parameters

Path parameters
Name Description
producerClientId*
String
Producer client identifier
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value

Responses

Status: 200 - successful operation


getTopicMetrics

Get topic metrics for the given topic


/api/v2/admin/metrics/aggregated/topics/{topicName}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/metrics/aggregated/topics/{topicName}?duration=&from=&to=&state="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AggregatedMetricOperationsApi;

import java.io.File;
import java.util.*;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String topicName = topicName_example; // String | Name of the topic
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Client
        try {
            AggrTopicMetrics result = apiInstance.getTopicMetrics(topicName, duration, from, to, state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getTopicMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AggregatedMetricOperationsApi;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String topicName = topicName_example; // String | Name of the topic
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Client
        try {
            AggrTopicMetrics result = apiInstance.getTopicMetrics(topicName, duration, from, to, state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getTopicMetrics");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // Name of the topic
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *state = state_example; // State of the Client (optional)

AggregatedMetricOperationsApi *apiInstance = [[AggregatedMetricOperationsApi alloc] init];

// Get topic metrics for the given topic
[apiInstance getTopicMetricsWith:topicName
    duration:duration
    from:from
    to:to
    state:state
              completionHandler: ^(AggrTopicMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AggregatedMetricOperationsApi()
var topicName = topicName_example; // {{String}} Name of the topic
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'state': state_example // {{String}} State of the Client
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicMetrics(topicName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTopicMetricsExample
    {
        public void main()
        {

            var apiInstance = new AggregatedMetricOperationsApi();
            var topicName = topicName_example;  // String | Name of the topic
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var state = state_example;  // String | State of the Client (optional) 

            try
            {
                // Get topic metrics for the given topic
                AggrTopicMetrics result = apiInstance.getTopicMetrics(topicName, duration, from, to, state);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AggregatedMetricOperationsApi.getTopicMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAggregatedMetricOperationsApi();
$topicName = topicName_example; // String | Name of the topic
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$state = state_example; // String | State of the Client

try {
    $result = $api_instance->getTopicMetrics($topicName, $duration, $from, $to, $state);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AggregatedMetricOperationsApi->getTopicMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AggregatedMetricOperationsApi;

my $api_instance = WWW::SwaggerClient::AggregatedMetricOperationsApi->new();
my $topicName = topicName_example; # String | Name of the topic
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $state = state_example; # String | State of the Client

eval { 
    my $result = $api_instance->getTopicMetrics(topicName => $topicName, duration => $duration, from => $from, to => $to, state => $state);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AggregatedMetricOperationsApi->getTopicMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AggregatedMetricOperationsApi()
topicName = topicName_example # String | Name of the topic
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
state = state_example # String | State of the Client (optional)

try: 
    # Get topic metrics for the given topic
    api_response = api_instance.get_topic_metrics(topicName, duration=duration, from=from, to=to, state=state)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AggregatedMetricOperationsApi->getTopicMetrics: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Name of the topic
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
state
String
State of the Client

Responses

Status: 200 - successful operation


AlertNotifications

getAlertNotifications

Get the Alert notifications from the given `offset`, up to the given `limit`. If the offset is `-1`, it will return `limit` number of latest notifications, If the offset is `-2`, it will return `limit` number of earliest notifications.Default value of offset param is -1.


/api/v1/admin/alert/notifications

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/alert/notifications?limit=&startOffset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertNotificationsApi;

import java.io.File;
import java.util.*;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        Integer limit = 56; // Integer | limit value should be greater than zero
        Long startOffset = 789; // Long | start offset should be greater than or equal to -2 (-2 is to fetch earliest notifications/ -1 is to fetch latest notifications)
        try {
            AlertNotifications result = apiInstance.getAlertNotifications(limit, startOffset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#getAlertNotifications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertNotificationsApi;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        Integer limit = 56; // Integer | limit value should be greater than zero
        Long startOffset = 789; // Long | start offset should be greater than or equal to -2 (-2 is to fetch earliest notifications/ -1 is to fetch latest notifications)
        try {
            AlertNotifications result = apiInstance.getAlertNotifications(limit, startOffset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#getAlertNotifications");
            e.printStackTrace();
        }
    }
}
Integer *limit = 56; // limit value should be greater than zero (optional)
Long *startOffset = 789; // start offset should be greater than or equal to -2 (-2 is to fetch earliest notifications/ -1 is to fetch latest notifications) (optional) (default to -1)

AlertNotificationsApi *apiInstance = [[AlertNotificationsApi alloc] init];

// Get the Alert notifications from the given `offset`, up to the given `limit`. If the offset is `-1`, it will return `limit` number of latest notifications, If the offset is `-2`, it will return `limit` number of earliest notifications.Default value of offset param is -1.
[apiInstance getAlertNotificationsWith:limit
    startOffset:startOffset
              completionHandler: ^(AlertNotifications output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertNotificationsApi()
var opts = { 
  'limit': 56, // {{Integer}} limit value should be greater than zero
  'startOffset': 789 // {{Long}} start offset should be greater than or equal to -2 (-2 is to fetch earliest notifications/ -1 is to fetch latest notifications)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAlertNotifications(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAlertNotificationsExample
    {
        public void main()
        {

            var apiInstance = new AlertNotificationsApi();
            var limit = 56;  // Integer | limit value should be greater than zero (optional) 
            var startOffset = 789;  // Long | start offset should be greater than or equal to -2 (-2 is to fetch earliest notifications/ -1 is to fetch latest notifications) (optional)  (default to -1)

            try
            {
                // Get the Alert notifications from the given `offset`, up to the given `limit`. If the offset is `-1`, it will return `limit` number of latest notifications, If the offset is `-2`, it will return `limit` number of earliest notifications.Default value of offset param is -1.
                AlertNotifications result = apiInstance.getAlertNotifications(limit, startOffset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertNotificationsApi.getAlertNotifications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertNotificationsApi();
$limit = 56; // Integer | limit value should be greater than zero
$startOffset = 789; // Long | start offset should be greater than or equal to -2 (-2 is to fetch earliest notifications/ -1 is to fetch latest notifications)

try {
    $result = $api_instance->getAlertNotifications($limit, $startOffset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertNotificationsApi->getAlertNotifications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertNotificationsApi;

my $api_instance = WWW::SwaggerClient::AlertNotificationsApi->new();
my $limit = 56; # Integer | limit value should be greater than zero
my $startOffset = 789; # Long | start offset should be greater than or equal to -2 (-2 is to fetch earliest notifications/ -1 is to fetch latest notifications)

eval { 
    my $result = $api_instance->getAlertNotifications(limit => $limit, startOffset => $startOffset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertNotificationsApi->getAlertNotifications: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertNotificationsApi()
limit = 56 # Integer | limit value should be greater than zero (optional)
startOffset = 789 # Long | start offset should be greater than or equal to -2 (-2 is to fetch earliest notifications/ -1 is to fetch latest notifications) (optional) (default to -1)

try: 
    # Get the Alert notifications from the given `offset`, up to the given `limit`. If the offset is `-1`, it will return `limit` number of latest notifications, If the offset is `-2`, it will return `limit` number of earliest notifications.Default value of offset param is -1.
    api_response = api_instance.get_alert_notifications(limit=limit, startOffset=startOffset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertNotificationsApi->getAlertNotifications: %s\n" % e)

Parameters

Query parameters
Name Description
limit
Integer (int32)
limit value should be greater than zero
startOffset
Long (int64)
start offset should be greater than or equal to -2 (-2 is to fetch earliest notifications/ -1 is to fetch latest notifications)

Responses

Status: 200 - successful operation


getAlertNotificationsByEntityType

Get all the Alert notifications for a given entity type


/api/v1/admin/alert/notifications/entity/{entityType}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/alert/notifications/entity/{entityType}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertNotificationsApi;

import java.io.File;
import java.util.*;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        String entityType = entityType_example; // String | Type of the entity
        try {
            map['String', array[AlertNotificationContext]] result = apiInstance.getAlertNotificationsByEntityType(entityType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#getAlertNotificationsByEntityType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertNotificationsApi;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        String entityType = entityType_example; // String | Type of the entity
        try {
            map['String', array[AlertNotificationContext]] result = apiInstance.getAlertNotificationsByEntityType(entityType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#getAlertNotificationsByEntityType");
            e.printStackTrace();
        }
    }
}
String *entityType = entityType_example; // Type of the entity

AlertNotificationsApi *apiInstance = [[AlertNotificationsApi alloc] init];

// Get all the Alert notifications for a given entity type
[apiInstance getAlertNotificationsByEntityTypeWith:entityType
              completionHandler: ^(map['String', array[AlertNotificationContext]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertNotificationsApi()
var entityType = entityType_example; // {{String}} Type of the entity

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAlertNotificationsByEntityType(entityType, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAlertNotificationsByEntityTypeExample
    {
        public void main()
        {

            var apiInstance = new AlertNotificationsApi();
            var entityType = entityType_example;  // String | Type of the entity

            try
            {
                // Get all the Alert notifications for a given entity type
                map['String', array[AlertNotificationContext]] result = apiInstance.getAlertNotificationsByEntityType(entityType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertNotificationsApi.getAlertNotificationsByEntityType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertNotificationsApi();
$entityType = entityType_example; // String | Type of the entity

try {
    $result = $api_instance->getAlertNotificationsByEntityType($entityType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertNotificationsApi->getAlertNotificationsByEntityType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertNotificationsApi;

my $api_instance = WWW::SwaggerClient::AlertNotificationsApi->new();
my $entityType = entityType_example; # String | Type of the entity

eval { 
    my $result = $api_instance->getAlertNotificationsByEntityType(entityType => $entityType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertNotificationsApi->getAlertNotificationsByEntityType: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertNotificationsApi()
entityType = entityType_example # String | Type of the entity

try: 
    # Get all the Alert notifications for a given entity type
    api_response = api_instance.get_alert_notifications_by_entity_type(entityType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertNotificationsApi->getAlertNotificationsByEntityType: %s\n" % e)

Parameters

Path parameters
Name Description
entityType*
String
Type of the entity
Required

Responses

Status: 200 - successful operation


getAlertNotificationsByEntityTypeAndName

Get the Alert notifications for the given entity type and resource name


/api/v1/admin/alert/notifications/entity/{entityType}/{entityName}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/alert/notifications/entity/{entityType}/{entityName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertNotificationsApi;

import java.io.File;
import java.util.*;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        String entityType = entityType_example; // String | Type of the entity
        String entityName = entityName_example; // String | Name of the entity
        try {
            array[AlertNotificationContext] result = apiInstance.getAlertNotificationsByEntityTypeAndName(entityType, entityName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#getAlertNotificationsByEntityTypeAndName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertNotificationsApi;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        String entityType = entityType_example; // String | Type of the entity
        String entityName = entityName_example; // String | Name of the entity
        try {
            array[AlertNotificationContext] result = apiInstance.getAlertNotificationsByEntityTypeAndName(entityType, entityName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#getAlertNotificationsByEntityTypeAndName");
            e.printStackTrace();
        }
    }
}
String *entityType = entityType_example; // Type of the entity
String *entityName = entityName_example; // Name of the entity

AlertNotificationsApi *apiInstance = [[AlertNotificationsApi alloc] init];

// Get the Alert notifications for the given entity type and resource name
[apiInstance getAlertNotificationsByEntityTypeAndNameWith:entityType
    entityName:entityName
              completionHandler: ^(array[AlertNotificationContext] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertNotificationsApi()
var entityType = entityType_example; // {{String}} Type of the entity
var entityName = entityName_example; // {{String}} Name of the entity

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAlertNotificationsByEntityTypeAndName(entityType, entityName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAlertNotificationsByEntityTypeAndNameExample
    {
        public void main()
        {

            var apiInstance = new AlertNotificationsApi();
            var entityType = entityType_example;  // String | Type of the entity
            var entityName = entityName_example;  // String | Name of the entity

            try
            {
                // Get the Alert notifications for the given entity type and resource name
                array[AlertNotificationContext] result = apiInstance.getAlertNotificationsByEntityTypeAndName(entityType, entityName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertNotificationsApi.getAlertNotificationsByEntityTypeAndName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertNotificationsApi();
$entityType = entityType_example; // String | Type of the entity
$entityName = entityName_example; // String | Name of the entity

try {
    $result = $api_instance->getAlertNotificationsByEntityTypeAndName($entityType, $entityName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertNotificationsApi->getAlertNotificationsByEntityTypeAndName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertNotificationsApi;

my $api_instance = WWW::SwaggerClient::AlertNotificationsApi->new();
my $entityType = entityType_example; # String | Type of the entity
my $entityName = entityName_example; # String | Name of the entity

eval { 
    my $result = $api_instance->getAlertNotificationsByEntityTypeAndName(entityType => $entityType, entityName => $entityName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertNotificationsApi->getAlertNotificationsByEntityTypeAndName: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertNotificationsApi()
entityType = entityType_example # String | Type of the entity
entityName = entityName_example # String | Name of the entity

try: 
    # Get the Alert notifications for the given entity type and resource name
    api_response = api_instance.get_alert_notifications_by_entity_type_and_name(entityType, entityName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertNotificationsApi->getAlertNotificationsByEntityTypeAndName: %s\n" % e)

Parameters

Path parameters
Name Description
entityType*
String
Type of the entity
Required
entityName*
String
Name of the entity
Required

Responses

Status: 200 - successful operation


markAlertNotifications

Mark the Alert notifications as read


/api/v1/admin/alert/notifications/read

Usage and SDK Samples

curl -X PUT\
"//api/v1/admin/alert/notifications/read?offsets="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertNotificationsApi;

import java.io.File;
import java.util.*;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        array[Long] offsets = ; // array[Long] | notification offset
        try {
            apiInstance.markAlertNotifications(offsets);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#markAlertNotifications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertNotificationsApi;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        array[Long] offsets = ; // array[Long] | notification offset
        try {
            apiInstance.markAlertNotifications(offsets);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#markAlertNotifications");
            e.printStackTrace();
        }
    }
}
array[Long] *offsets = ; // notification offset (optional)

AlertNotificationsApi *apiInstance = [[AlertNotificationsApi alloc] init];

// Mark the Alert notifications as read
[apiInstance markAlertNotificationsWith:offsets
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertNotificationsApi()
var opts = { 
  'offsets':  // {{array[Long]}} notification offset
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.markAlertNotifications(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class markAlertNotificationsExample
    {
        public void main()
        {

            var apiInstance = new AlertNotificationsApi();
            var offsets = new array[Long](); // array[Long] | notification offset (optional) 

            try
            {
                // Mark the Alert notifications as read
                apiInstance.markAlertNotifications(offsets);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertNotificationsApi.markAlertNotifications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertNotificationsApi();
$offsets = ; // array[Long] | notification offset

try {
    $api_instance->markAlertNotifications($offsets);
} catch (Exception $e) {
    echo 'Exception when calling AlertNotificationsApi->markAlertNotifications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertNotificationsApi;

my $api_instance = WWW::SwaggerClient::AlertNotificationsApi->new();
my $offsets = []; # array[Long] | notification offset

eval { 
    $api_instance->markAlertNotifications(offsets => $offsets);
};
if ($@) {
    warn "Exception when calling AlertNotificationsApi->markAlertNotifications: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertNotificationsApi()
offsets =  # array[Long] | notification offset (optional)

try: 
    # Mark the Alert notifications as read
    api_instance.mark_alert_notifications(offsets=offsets)
except ApiException as e:
    print("Exception when calling AlertNotificationsApi->markAlertNotifications: %s\n" % e)

Parameters

Query parameters
Name Description
offsets
array[Long] (int64)
notification offset

Responses

Status: default - successful operation


unmarkAlertNotifications

Mark the alert notifications as unread


/api/v1/admin/alert/notifications/unread

Usage and SDK Samples

curl -X PUT\
"//api/v1/admin/alert/notifications/unread?offsets="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertNotificationsApi;

import java.io.File;
import java.util.*;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        array[Long] offsets = ; // array[Long] | notification offset
        try {
            apiInstance.unmarkAlertNotifications(offsets);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#unmarkAlertNotifications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertNotificationsApi;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        array[Long] offsets = ; // array[Long] | notification offset
        try {
            apiInstance.unmarkAlertNotifications(offsets);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#unmarkAlertNotifications");
            e.printStackTrace();
        }
    }
}
array[Long] *offsets = ; // notification offset (optional)

AlertNotificationsApi *apiInstance = [[AlertNotificationsApi alloc] init];

// Mark the alert notifications as unread
[apiInstance unmarkAlertNotificationsWith:offsets
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertNotificationsApi()
var opts = { 
  'offsets':  // {{array[Long]}} notification offset
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.unmarkAlertNotifications(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class unmarkAlertNotificationsExample
    {
        public void main()
        {

            var apiInstance = new AlertNotificationsApi();
            var offsets = new array[Long](); // array[Long] | notification offset (optional) 

            try
            {
                // Mark the alert notifications as unread
                apiInstance.unmarkAlertNotifications(offsets);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertNotificationsApi.unmarkAlertNotifications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertNotificationsApi();
$offsets = ; // array[Long] | notification offset

try {
    $api_instance->unmarkAlertNotifications($offsets);
} catch (Exception $e) {
    echo 'Exception when calling AlertNotificationsApi->unmarkAlertNotifications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertNotificationsApi;

my $api_instance = WWW::SwaggerClient::AlertNotificationsApi->new();
my $offsets = []; # array[Long] | notification offset

eval { 
    $api_instance->unmarkAlertNotifications(offsets => $offsets);
};
if ($@) {
    warn "Exception when calling AlertNotificationsApi->unmarkAlertNotifications: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertNotificationsApi()
offsets =  # array[Long] | notification offset (optional)

try: 
    # Mark the alert notifications as unread
    api_instance.unmark_alert_notifications(offsets=offsets)
except ApiException as e:
    print("Exception when calling AlertNotificationsApi->unmarkAlertNotifications: %s\n" % e)

Parameters

Query parameters
Name Description
offsets
array[Long] (int64)
notification offset

Responses

Status: default - successful operation


AlertPolicyOperations

addAlertPolicy

Add an alert policy.


/api/v1/admin/alertPolicy

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: */*"\
"//api/v1/admin/alertPolicy"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertPolicyOperationsApi;

import java.io.File;
import java.util.*;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        AlertPolicy body = ; // AlertPolicy | 
        try {
            Long result = apiInstance.addAlertPolicy(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#addAlertPolicy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertPolicyOperationsApi;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        AlertPolicy body = ; // AlertPolicy | 
        try {
            Long result = apiInstance.addAlertPolicy(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#addAlertPolicy");
            e.printStackTrace();
        }
    }
}
AlertPolicy *body = ; //  (optional)

AlertPolicyOperationsApi *apiInstance = [[AlertPolicyOperationsApi alloc] init];

// Add an alert policy.
[apiInstance addAlertPolicyWith:body
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertPolicyOperationsApi()
var opts = { 
  'body':  // {{AlertPolicy}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addAlertPolicy(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addAlertPolicyExample
    {
        public void main()
        {

            var apiInstance = new AlertPolicyOperationsApi();
            var body = new AlertPolicy(); // AlertPolicy |  (optional) 

            try
            {
                // Add an alert policy.
                Long result = apiInstance.addAlertPolicy(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertPolicyOperationsApi.addAlertPolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertPolicyOperationsApi();
$body = ; // AlertPolicy | 

try {
    $result = $api_instance->addAlertPolicy($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertPolicyOperationsApi->addAlertPolicy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertPolicyOperationsApi;

my $api_instance = WWW::SwaggerClient::AlertPolicyOperationsApi->new();
my $body = WWW::SwaggerClient::Object::AlertPolicy->new(); # AlertPolicy | 

eval { 
    my $result = $api_instance->addAlertPolicy(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertPolicyOperationsApi->addAlertPolicy: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertPolicyOperationsApi()
body =  # AlertPolicy |  (optional)

try: 
    # Add an alert policy.
    api_response = api_instance.add_alert_policy(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertPolicyOperationsApi->addAlertPolicy: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - successful operation


deleteAlertPolicy

Delete an existing alert policy.


/api/v1/admin/alertPolicy/{id}

Usage and SDK Samples

curl -X DELETE\
"//api/v1/admin/alertPolicy/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertPolicyOperationsApi;

import java.io.File;
import java.util.*;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        try {
            apiInstance.deleteAlertPolicy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#deleteAlertPolicy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertPolicyOperationsApi;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        try {
            apiInstance.deleteAlertPolicy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#deleteAlertPolicy");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // 

AlertPolicyOperationsApi *apiInstance = [[AlertPolicyOperationsApi alloc] init];

// Delete an existing alert policy.
[apiInstance deleteAlertPolicyWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertPolicyOperationsApi()
var id = 789; // {{Long}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAlertPolicy(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAlertPolicyExample
    {
        public void main()
        {

            var apiInstance = new AlertPolicyOperationsApi();
            var id = 789;  // Long | 

            try
            {
                // Delete an existing alert policy.
                apiInstance.deleteAlertPolicy(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertPolicyOperationsApi.deleteAlertPolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertPolicyOperationsApi();
$id = 789; // Long | 

try {
    $api_instance->deleteAlertPolicy($id);
} catch (Exception $e) {
    echo 'Exception when calling AlertPolicyOperationsApi->deleteAlertPolicy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertPolicyOperationsApi;

my $api_instance = WWW::SwaggerClient::AlertPolicyOperationsApi->new();
my $id = 789; # Long | 

eval { 
    $api_instance->deleteAlertPolicy(id => $id);
};
if ($@) {
    warn "Exception when calling AlertPolicyOperationsApi->deleteAlertPolicy: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertPolicyOperationsApi()
id = 789 # Long | 

try: 
    # Delete an existing alert policy.
    api_instance.delete_alert_policy(id)
except ApiException as e:
    print("Exception when calling AlertPolicyOperationsApi->deleteAlertPolicy: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Required

Responses

Status: default - successful operation


disableAlertPolicy

Disable an existing alert policy.


/api/v1/admin/alertPolicy/{id}/disable

Usage and SDK Samples

curl -X PUT\
"//api/v1/admin/alertPolicy/{id}/disable"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertPolicyOperationsApi;

import java.io.File;
import java.util.*;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        try {
            apiInstance.disableAlertPolicy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#disableAlertPolicy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertPolicyOperationsApi;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        try {
            apiInstance.disableAlertPolicy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#disableAlertPolicy");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // 

AlertPolicyOperationsApi *apiInstance = [[AlertPolicyOperationsApi alloc] init];

// Disable an existing alert policy.
[apiInstance disableAlertPolicyWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertPolicyOperationsApi()
var id = 789; // {{Long}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.disableAlertPolicy(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class disableAlertPolicyExample
    {
        public void main()
        {

            var apiInstance = new AlertPolicyOperationsApi();
            var id = 789;  // Long | 

            try
            {
                // Disable an existing alert policy.
                apiInstance.disableAlertPolicy(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertPolicyOperationsApi.disableAlertPolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertPolicyOperationsApi();
$id = 789; // Long | 

try {
    $api_instance->disableAlertPolicy($id);
} catch (Exception $e) {
    echo 'Exception when calling AlertPolicyOperationsApi->disableAlertPolicy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertPolicyOperationsApi;

my $api_instance = WWW::SwaggerClient::AlertPolicyOperationsApi->new();
my $id = 789; # Long | 

eval { 
    $api_instance->disableAlertPolicy(id => $id);
};
if ($@) {
    warn "Exception when calling AlertPolicyOperationsApi->disableAlertPolicy: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertPolicyOperationsApi()
id = 789 # Long | 

try: 
    # Disable an existing alert policy.
    api_instance.disable_alert_policy(id)
except ApiException as e:
    print("Exception when calling AlertPolicyOperationsApi->disableAlertPolicy: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Required

Responses

Status: default - successful operation


enableAlertPolicy

Enable an existing alert policy.


/api/v1/admin/alertPolicy/{id}/enable

Usage and SDK Samples

curl -X PUT\
"//api/v1/admin/alertPolicy/{id}/enable"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertPolicyOperationsApi;

import java.io.File;
import java.util.*;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        try {
            apiInstance.enableAlertPolicy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#enableAlertPolicy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertPolicyOperationsApi;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        try {
            apiInstance.enableAlertPolicy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#enableAlertPolicy");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // 

AlertPolicyOperationsApi *apiInstance = [[AlertPolicyOperationsApi alloc] init];

// Enable an existing alert policy.
[apiInstance enableAlertPolicyWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertPolicyOperationsApi()
var id = 789; // {{Long}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.enableAlertPolicy(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class enableAlertPolicyExample
    {
        public void main()
        {

            var apiInstance = new AlertPolicyOperationsApi();
            var id = 789;  // Long | 

            try
            {
                // Enable an existing alert policy.
                apiInstance.enableAlertPolicy(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertPolicyOperationsApi.enableAlertPolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertPolicyOperationsApi();
$id = 789; // Long | 

try {
    $api_instance->enableAlertPolicy($id);
} catch (Exception $e) {
    echo 'Exception when calling AlertPolicyOperationsApi->enableAlertPolicy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertPolicyOperationsApi;

my $api_instance = WWW::SwaggerClient::AlertPolicyOperationsApi->new();
my $id = 789; # Long | 

eval { 
    $api_instance->enableAlertPolicy(id => $id);
};
if ($@) {
    warn "Exception when calling AlertPolicyOperationsApi->enableAlertPolicy: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertPolicyOperationsApi()
id = 789 # Long | 

try: 
    # Enable an existing alert policy.
    api_instance.enable_alert_policy(id)
except ApiException as e:
    print("Exception when calling AlertPolicyOperationsApi->enableAlertPolicy: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Required

Responses

Status: default - successful operation


getAlertPolicy

Get the alert policy for a given id.


/api/v1/admin/alertPolicy/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/alertPolicy/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertPolicyOperationsApi;

import java.io.File;
import java.util.*;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        try {
            AlertPolicy result = apiInstance.getAlertPolicy(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#getAlertPolicy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertPolicyOperationsApi;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        try {
            AlertPolicy result = apiInstance.getAlertPolicy(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#getAlertPolicy");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // 

AlertPolicyOperationsApi *apiInstance = [[AlertPolicyOperationsApi alloc] init];

// Get the alert policy for a given id.
[apiInstance getAlertPolicyWith:id
              completionHandler: ^(AlertPolicy output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertPolicyOperationsApi()
var id = 789; // {{Long}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAlertPolicy(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAlertPolicyExample
    {
        public void main()
        {

            var apiInstance = new AlertPolicyOperationsApi();
            var id = 789;  // Long | 

            try
            {
                // Get the alert policy for a given id.
                AlertPolicy result = apiInstance.getAlertPolicy(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertPolicyOperationsApi.getAlertPolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertPolicyOperationsApi();
$id = 789; // Long | 

try {
    $result = $api_instance->getAlertPolicy($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertPolicyOperationsApi->getAlertPolicy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertPolicyOperationsApi;

my $api_instance = WWW::SwaggerClient::AlertPolicyOperationsApi->new();
my $id = 789; # Long | 

eval { 
    my $result = $api_instance->getAlertPolicy(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertPolicyOperationsApi->getAlertPolicy: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertPolicyOperationsApi()
id = 789 # Long | 

try: 
    # Get the alert policy for a given id.
    api_response = api_instance.get_alert_policy(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertPolicyOperationsApi->getAlertPolicy: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Required

Responses

Status: 200 - successful operation


getAllAlertPolicies

Get all the alert policies register.


/api/v1/admin/alertPolicy

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/alertPolicy"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertPolicyOperationsApi;

import java.io.File;
import java.util.*;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        try {
            AlertPolicies result = apiInstance.getAllAlertPolicies();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#getAllAlertPolicies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertPolicyOperationsApi;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        try {
            AlertPolicies result = apiInstance.getAllAlertPolicies();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#getAllAlertPolicies");
            e.printStackTrace();
        }
    }
}

AlertPolicyOperationsApi *apiInstance = [[AlertPolicyOperationsApi alloc] init];

// Get all the alert policies register.
[apiInstance getAllAlertPoliciesWithCompletionHandler: 
              ^(AlertPolicies output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertPolicyOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllAlertPolicies(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllAlertPoliciesExample
    {
        public void main()
        {

            var apiInstance = new AlertPolicyOperationsApi();

            try
            {
                // Get all the alert policies register.
                AlertPolicies result = apiInstance.getAllAlertPolicies();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertPolicyOperationsApi.getAllAlertPolicies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertPolicyOperationsApi();

try {
    $result = $api_instance->getAllAlertPolicies();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertPolicyOperationsApi->getAllAlertPolicies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertPolicyOperationsApi;

my $api_instance = WWW::SwaggerClient::AlertPolicyOperationsApi->new();

eval { 
    my $result = $api_instance->getAllAlertPolicies();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertPolicyOperationsApi->getAllAlertPolicies: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertPolicyOperationsApi()

try: 
    # Get all the alert policies register.
    api_response = api_instance.get_all_alert_policies()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertPolicyOperationsApi->getAllAlertPolicies: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


getAutoCompleteAutomata

Returns Autocomplete automata for alert policy.


/api/v1/admin/alertPolicy/automata/{version}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/alertPolicy/automata/{version}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertPolicyOperationsApi;

import java.io.File;
import java.util.*;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Integer version = 56; // Integer | 
        try {
            PolicyAutoCompleteAutomata result = apiInstance.getAutoCompleteAutomata(version);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#getAutoCompleteAutomata");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertPolicyOperationsApi;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Integer version = 56; // Integer | 
        try {
            PolicyAutoCompleteAutomata result = apiInstance.getAutoCompleteAutomata(version);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#getAutoCompleteAutomata");
            e.printStackTrace();
        }
    }
}
Integer *version = 56; // 

AlertPolicyOperationsApi *apiInstance = [[AlertPolicyOperationsApi alloc] init];

// Returns Autocomplete automata for alert policy.
[apiInstance getAutoCompleteAutomataWith:version
              completionHandler: ^(PolicyAutoCompleteAutomata output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertPolicyOperationsApi()
var version = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAutoCompleteAutomata(version, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAutoCompleteAutomataExample
    {
        public void main()
        {

            var apiInstance = new AlertPolicyOperationsApi();
            var version = 56;  // Integer | 

            try
            {
                // Returns Autocomplete automata for alert policy.
                PolicyAutoCompleteAutomata result = apiInstance.getAutoCompleteAutomata(version);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertPolicyOperationsApi.getAutoCompleteAutomata: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertPolicyOperationsApi();
$version = 56; // Integer | 

try {
    $result = $api_instance->getAutoCompleteAutomata($version);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertPolicyOperationsApi->getAutoCompleteAutomata: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertPolicyOperationsApi;

my $api_instance = WWW::SwaggerClient::AlertPolicyOperationsApi->new();
my $version = 56; # Integer | 

eval { 
    my $result = $api_instance->getAutoCompleteAutomata(version => $version);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertPolicyOperationsApi->getAutoCompleteAutomata: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertPolicyOperationsApi()
version = 56 # Integer | 

try: 
    # Returns Autocomplete automata for alert policy.
    api_response = api_instance.get_auto_complete_automata(version)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertPolicyOperationsApi->getAutoCompleteAutomata: %s\n" % e)

Parameters

Path parameters
Name Description
version*
Integer (int32)
Required

Responses

Status: 200 - successful operation


updateAlertPolicy

Update an existing alert policy.


/api/v1/admin/alertPolicy/{id}

Usage and SDK Samples

curl -X PUT\
-H "Content-Type: */*"\
"//api/v1/admin/alertPolicy/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertPolicyOperationsApi;

import java.io.File;
import java.util.*;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        AlertPolicy body = ; // AlertPolicy | 
        try {
            apiInstance.updateAlertPolicy(id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#updateAlertPolicy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertPolicyOperationsApi;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        AlertPolicy body = ; // AlertPolicy | 
        try {
            apiInstance.updateAlertPolicy(id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#updateAlertPolicy");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // 
AlertPolicy *body = ; //  (optional)

AlertPolicyOperationsApi *apiInstance = [[AlertPolicyOperationsApi alloc] init];

// Update an existing alert policy.
[apiInstance updateAlertPolicyWith:id
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertPolicyOperationsApi()
var id = 789; // {{Long}} 
var opts = { 
  'body':  // {{AlertPolicy}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateAlertPolicy(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateAlertPolicyExample
    {
        public void main()
        {

            var apiInstance = new AlertPolicyOperationsApi();
            var id = 789;  // Long | 
            var body = new AlertPolicy(); // AlertPolicy |  (optional) 

            try
            {
                // Update an existing alert policy.
                apiInstance.updateAlertPolicy(id, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertPolicyOperationsApi.updateAlertPolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertPolicyOperationsApi();
$id = 789; // Long | 
$body = ; // AlertPolicy | 

try {
    $api_instance->updateAlertPolicy($id, $body);
} catch (Exception $e) {
    echo 'Exception when calling AlertPolicyOperationsApi->updateAlertPolicy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertPolicyOperationsApi;

my $api_instance = WWW::SwaggerClient::AlertPolicyOperationsApi->new();
my $id = 789; # Long | 
my $body = WWW::SwaggerClient::Object::AlertPolicy->new(); # AlertPolicy | 

eval { 
    $api_instance->updateAlertPolicy(id => $id, body => $body);
};
if ($@) {
    warn "Exception when calling AlertPolicyOperationsApi->updateAlertPolicy: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertPolicyOperationsApi()
id = 789 # Long | 
body =  # AlertPolicy |  (optional)

try: 
    # Update an existing alert policy.
    api_instance.update_alert_policy(id, body=body)
except ApiException as e:
    print("Exception when calling AlertPolicyOperationsApi->updateAlertPolicy: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
Body parameters
Name Description
body

Responses

Status: default - successful operation


ApplicationContextRelatedOperations

getSMMVersion

Returns version of SMM service


/api/v1/admin/version

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/version"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationContextRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class ApplicationContextRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        ApplicationContextRelatedOperationsApi apiInstance = new ApplicationContextRelatedOperationsApi();
        try {
            SMMVersion result = apiInstance.getSMMVersion();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationContextRelatedOperationsApi#getSMMVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationContextRelatedOperationsApi;

public class ApplicationContextRelatedOperationsApiExample {

    public static void main(String[] args) {
        ApplicationContextRelatedOperationsApi apiInstance = new ApplicationContextRelatedOperationsApi();
        try {
            SMMVersion result = apiInstance.getSMMVersion();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationContextRelatedOperationsApi#getSMMVersion");
            e.printStackTrace();
        }
    }
}

ApplicationContextRelatedOperationsApi *apiInstance = [[ApplicationContextRelatedOperationsApi alloc] init];

// Returns version of SMM service
[apiInstance getSMMVersionWithCompletionHandler: 
              ^(SMMVersion output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ApplicationContextRelatedOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSMMVersion(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSMMVersionExample
    {
        public void main()
        {

            var apiInstance = new ApplicationContextRelatedOperationsApi();

            try
            {
                // Returns version of SMM service
                SMMVersion result = apiInstance.getSMMVersion();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationContextRelatedOperationsApi.getSMMVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApplicationContextRelatedOperationsApi();

try {
    $result = $api_instance->getSMMVersion();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationContextRelatedOperationsApi->getSMMVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationContextRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::ApplicationContextRelatedOperationsApi->new();

eval { 
    my $result = $api_instance->getSMMVersion();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApplicationContextRelatedOperationsApi->getSMMVersion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ApplicationContextRelatedOperationsApi()

try: 
    # Returns version of SMM service
    api_response = api_instance.get_smm_version()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationContextRelatedOperationsApi->getSMMVersion: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


Authentication

getAccess

Get the Authentication status.


/api/v1/admin/auth/access

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/auth/access"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticationApi;

import java.io.File;
import java.util.*;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        
        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            AuthenticationResponse result = apiInstance.getAccess();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#getAccess");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthenticationApi;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            AuthenticationResponse result = apiInstance.getAccess();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#getAccess");
            e.printStackTrace();
        }
    }
}

AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];

// Get the Authentication status.
[apiInstance getAccessWithCompletionHandler: 
              ^(AuthenticationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AuthenticationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccess(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccessExample
    {
        public void main()
        {

            var apiInstance = new AuthenticationApi();

            try
            {
                // Get the Authentication status.
                AuthenticationResponse result = apiInstance.getAccess();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.getAccess: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthenticationApi();

try {
    $result = $api_instance->getAccess();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->getAccess: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthenticationApi;

my $api_instance = WWW::SwaggerClient::AuthenticationApi->new();

eval { 
    my $result = $api_instance->getAccess();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthenticationApi->getAccess: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthenticationApi()

try: 
    # Get the Authentication status.
    api_response = api_instance.get_access()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->getAccess: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


login

Get the login response


/api/v1/admin/auth/login

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"//api/v1/admin/auth/login"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticationApi;

import java.io.File;
import java.util.*;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        
        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            AuthenticationResponse result = apiInstance.login();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#login");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthenticationApi;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            AuthenticationResponse result = apiInstance.login();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#login");
            e.printStackTrace();
        }
    }
}

AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];

// Get the login response
[apiInstance loginWithCompletionHandler: 
              ^(AuthenticationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AuthenticationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.login(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class loginExample
    {
        public void main()
        {

            var apiInstance = new AuthenticationApi();

            try
            {
                // Get the login response
                AuthenticationResponse result = apiInstance.login();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.login: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthenticationApi();

try {
    $result = $api_instance->login();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->login: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthenticationApi;

my $api_instance = WWW::SwaggerClient::AuthenticationApi->new();

eval { 
    my $result = $api_instance->login();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthenticationApi->login: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthenticationApi()

try: 
    # Get the login response
    api_response = api_instance.login()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->login: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


logout

Get the logout success


/api/v1/admin/auth/logout

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/auth/logout"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticationApi;

import java.io.File;
import java.util.*;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        
        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            AuthenticationResponse result = apiInstance.logout();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#logout");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthenticationApi;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            AuthenticationResponse result = apiInstance.logout();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#logout");
            e.printStackTrace();
        }
    }
}

AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];

// Get the logout success
[apiInstance logoutWithCompletionHandler: 
              ^(AuthenticationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AuthenticationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.logout(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class logoutExample
    {
        public void main()
        {

            var apiInstance = new AuthenticationApi();

            try
            {
                // Get the logout success
                AuthenticationResponse result = apiInstance.logout();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.logout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthenticationApi();

try {
    $result = $api_instance->logout();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->logout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthenticationApi;

my $api_instance = WWW::SwaggerClient::AuthenticationApi->new();

eval { 
    my $result = $api_instance->logout();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthenticationApi->logout: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthenticationApi()

try: 
    # Get the logout success
    api_response = api_instance.logout()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->logout: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


BrokerMetricsOperations

getBrokerMetrics

Get broker metrics for given brokerId.


/api/v1/admin/metrics/brokers/{brokerId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/metrics/brokers/{brokerId}?duration=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrokerMetricsOperationsApi;

import java.io.File;
import java.util.*;

public class BrokerMetricsOperationsApiExample {

    public static void main(String[] args) {
        
        BrokerMetricsOperationsApi apiInstance = new BrokerMetricsOperationsApi();
        Integer brokerId = 56; // Integer | Broker identifier
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            BrokerMetrics result = apiInstance.getBrokerMetrics(brokerId, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrokerMetricsOperationsApi#getBrokerMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BrokerMetricsOperationsApi;

public class BrokerMetricsOperationsApiExample {

    public static void main(String[] args) {
        BrokerMetricsOperationsApi apiInstance = new BrokerMetricsOperationsApi();
        Integer brokerId = 56; // Integer | Broker identifier
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            BrokerMetrics result = apiInstance.getBrokerMetrics(brokerId, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrokerMetricsOperationsApi#getBrokerMetrics");
            e.printStackTrace();
        }
    }
}
Integer *brokerId = 56; // Broker identifier
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)

BrokerMetricsOperationsApi *apiInstance = [[BrokerMetricsOperationsApi alloc] init];

// Get broker metrics for given brokerId.
[apiInstance getBrokerMetricsWith:brokerId
    duration:duration
    from:from
    to:to
              completionHandler: ^(BrokerMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.BrokerMetricsOperationsApi()
var brokerId = 56; // {{Integer}} Broker identifier
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789 // {{Long}} End of the time period. Provide '-1' to fetch the latest value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBrokerMetrics(brokerId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBrokerMetricsExample
    {
        public void main()
        {

            var apiInstance = new BrokerMetricsOperationsApi();
            var brokerId = 56;  // Integer | Broker identifier
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 

            try
            {
                // Get broker metrics for given brokerId.
                BrokerMetrics result = apiInstance.getBrokerMetrics(brokerId, duration, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BrokerMetricsOperationsApi.getBrokerMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBrokerMetricsOperationsApi();
$brokerId = 56; // Integer | Broker identifier
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value

try {
    $result = $api_instance->getBrokerMetrics($brokerId, $duration, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BrokerMetricsOperationsApi->getBrokerMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BrokerMetricsOperationsApi;

my $api_instance = WWW::SwaggerClient::BrokerMetricsOperationsApi->new();
my $brokerId = 56; # Integer | Broker identifier
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value

eval { 
    my $result = $api_instance->getBrokerMetrics(brokerId => $brokerId, duration => $duration, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BrokerMetricsOperationsApi->getBrokerMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BrokerMetricsOperationsApi()
brokerId = 56 # Integer | Broker identifier
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)

try: 
    # Get broker metrics for given brokerId.
    api_response = api_instance.get_broker_metrics(brokerId, duration=duration, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BrokerMetricsOperationsApi->getBrokerMetrics: %s\n" % e)

Parameters

Path parameters
Name Description
brokerId*
Integer (int32)
Broker identifier
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value

Responses

Status: 200 - successful operation


BrokersMetadataOperations

getBroker

Returns broker node in the cluster with the given broker Id.


/api/v1/admin/brokers/{brokerId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/brokers/{brokerId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrokersMetadataOperationsApi;

import java.io.File;
import java.util.*;

public class BrokersMetadataOperationsApiExample {

    public static void main(String[] args) {
        
        BrokersMetadataOperationsApi apiInstance = new BrokersMetadataOperationsApi();
        Integer brokerId = 56; // Integer | 
        try {
            BrokerNode result = apiInstance.getBroker(brokerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrokersMetadataOperationsApi#getBroker");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BrokersMetadataOperationsApi;

public class BrokersMetadataOperationsApiExample {

    public static void main(String[] args) {
        BrokersMetadataOperationsApi apiInstance = new BrokersMetadataOperationsApi();
        Integer brokerId = 56; // Integer | 
        try {
            BrokerNode result = apiInstance.getBroker(brokerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrokersMetadataOperationsApi#getBroker");
            e.printStackTrace();
        }
    }
}
Integer *brokerId = 56; // 

BrokersMetadataOperationsApi *apiInstance = [[BrokersMetadataOperationsApi alloc] init];

// Returns broker node in the cluster with the given broker Id.
[apiInstance getBrokerWith:brokerId
              completionHandler: ^(BrokerNode output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.BrokersMetadataOperationsApi()
var brokerId = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBroker(brokerId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBrokerExample
    {
        public void main()
        {

            var apiInstance = new BrokersMetadataOperationsApi();
            var brokerId = 56;  // Integer | 

            try
            {
                // Returns broker node in the cluster with the given broker Id.
                BrokerNode result = apiInstance.getBroker(brokerId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BrokersMetadataOperationsApi.getBroker: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBrokersMetadataOperationsApi();
$brokerId = 56; // Integer | 

try {
    $result = $api_instance->getBroker($brokerId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BrokersMetadataOperationsApi->getBroker: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BrokersMetadataOperationsApi;

my $api_instance = WWW::SwaggerClient::BrokersMetadataOperationsApi->new();
my $brokerId = 56; # Integer | 

eval { 
    my $result = $api_instance->getBroker(brokerId => $brokerId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BrokersMetadataOperationsApi->getBroker: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BrokersMetadataOperationsApi()
brokerId = 56 # Integer | 

try: 
    # Returns broker node in the cluster with the given broker Id.
    api_response = api_instance.get_broker(brokerId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BrokersMetadataOperationsApi->getBroker: %s\n" % e)

Parameters

Path parameters
Name Description
brokerId*
Integer (int32)
Required

Responses

Status: 200 - successful operation


getBrokers

Returns all broker nodes in the cluster with the given brokerIds if they exist.


/api/v1/admin/brokers

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/brokers?brokerIds="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrokersMetadataOperationsApi;

import java.io.File;
import java.util.*;

public class BrokersMetadataOperationsApiExample {

    public static void main(String[] args) {
        
        BrokersMetadataOperationsApi apiInstance = new BrokersMetadataOperationsApi();
        String brokerIds = brokerIds_example; // String | Comma separated broker identifiers
        try {
            array[BrokerNode] result = apiInstance.getBrokers(brokerIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrokersMetadataOperationsApi#getBrokers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BrokersMetadataOperationsApi;

public class BrokersMetadataOperationsApiExample {

    public static void main(String[] args) {
        BrokersMetadataOperationsApi apiInstance = new BrokersMetadataOperationsApi();
        String brokerIds = brokerIds_example; // String | Comma separated broker identifiers
        try {
            array[BrokerNode] result = apiInstance.getBrokers(brokerIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrokersMetadataOperationsApi#getBrokers");
            e.printStackTrace();
        }
    }
}
String *brokerIds = brokerIds_example; // Comma separated broker identifiers (optional)

BrokersMetadataOperationsApi *apiInstance = [[BrokersMetadataOperationsApi alloc] init];

// Returns all broker nodes in the cluster with the given brokerIds if they exist.
[apiInstance getBrokersWith:brokerIds
              completionHandler: ^(array[BrokerNode] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.BrokersMetadataOperationsApi()
var opts = { 
  'brokerIds': brokerIds_example // {{String}} Comma separated broker identifiers
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBrokers(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBrokersExample
    {
        public void main()
        {

            var apiInstance = new BrokersMetadataOperationsApi();
            var brokerIds = brokerIds_example;  // String | Comma separated broker identifiers (optional) 

            try
            {
                // Returns all broker nodes in the cluster with the given brokerIds if they exist.
                array[BrokerNode] result = apiInstance.getBrokers(brokerIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BrokersMetadataOperationsApi.getBrokers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBrokersMetadataOperationsApi();
$brokerIds = brokerIds_example; // String | Comma separated broker identifiers

try {
    $result = $api_instance->getBrokers($brokerIds);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BrokersMetadataOperationsApi->getBrokers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BrokersMetadataOperationsApi;

my $api_instance = WWW::SwaggerClient::BrokersMetadataOperationsApi->new();
my $brokerIds = brokerIds_example; # String | Comma separated broker identifiers

eval { 
    my $result = $api_instance->getBrokers(brokerIds => $brokerIds);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BrokersMetadataOperationsApi->getBrokers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BrokersMetadataOperationsApi()
brokerIds = brokerIds_example # String | Comma separated broker identifiers (optional)

try: 
    # Returns all broker nodes in the cluster with the given brokerIds if they exist.
    api_response = api_instance.get_brokers(brokerIds=brokerIds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BrokersMetadataOperationsApi->getBrokers: %s\n" % e)

Parameters

Query parameters
Name Description
brokerIds
String
Comma separated broker identifiers

Responses

Status: 200 - successful operation


CMKafkaInfo

getKafkaRoleInfo

Fetch Kafka cluster Role information from the Cloudera Manager environment


/api/v1/admin/cluster/cmKafkaClusterRolesInfo

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/cluster/cmKafkaClusterRolesInfo"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMKafkaInfoApi;

import java.io.File;
import java.util.*;

public class CMKafkaInfoApiExample {

    public static void main(String[] args) {
        
        CMKafkaInfoApi apiInstance = new CMKafkaInfoApi();
        try {
            KafkaClusterRolesInfo result = apiInstance.getKafkaRoleInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMKafkaInfoApi#getKafkaRoleInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMKafkaInfoApi;

public class CMKafkaInfoApiExample {

    public static void main(String[] args) {
        CMKafkaInfoApi apiInstance = new CMKafkaInfoApi();
        try {
            KafkaClusterRolesInfo result = apiInstance.getKafkaRoleInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMKafkaInfoApi#getKafkaRoleInfo");
            e.printStackTrace();
        }
    }
}

CMKafkaInfoApi *apiInstance = [[CMKafkaInfoApi alloc] init];

// Fetch Kafka cluster Role information from the Cloudera Manager environment
[apiInstance getKafkaRoleInfoWithCompletionHandler: 
              ^(KafkaClusterRolesInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.CMKafkaInfoApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getKafkaRoleInfo(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getKafkaRoleInfoExample
    {
        public void main()
        {

            var apiInstance = new CMKafkaInfoApi();

            try
            {
                // Fetch Kafka cluster Role information from the Cloudera Manager environment
                KafkaClusterRolesInfo result = apiInstance.getKafkaRoleInfo();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMKafkaInfoApi.getKafkaRoleInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMKafkaInfoApi();

try {
    $result = $api_instance->getKafkaRoleInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMKafkaInfoApi->getKafkaRoleInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMKafkaInfoApi;

my $api_instance = WWW::SwaggerClient::CMKafkaInfoApi->new();

eval { 
    my $result = $api_instance->getKafkaRoleInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMKafkaInfoApi->getKafkaRoleInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMKafkaInfoApi()

try: 
    # Fetch Kafka cluster Role information from the Cloudera Manager environment
    api_response = api_instance.get_kafka_role_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMKafkaInfoApi->getKafkaRoleInfo: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


ClusterMetadataOperations

getClusterDetails

Get the kafka cluster details to which this service is connected to.


/api/v1/admin/cluster

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/cluster"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClusterMetadataOperationsApi;

import java.io.File;
import java.util.*;

public class ClusterMetadataOperationsApiExample {

    public static void main(String[] args) {
        
        ClusterMetadataOperationsApi apiInstance = new ClusterMetadataOperationsApi();
        try {
            KafkaClusterInfo result = apiInstance.getClusterDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterMetadataOperationsApi#getClusterDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClusterMetadataOperationsApi;

public class ClusterMetadataOperationsApiExample {

    public static void main(String[] args) {
        ClusterMetadataOperationsApi apiInstance = new ClusterMetadataOperationsApi();
        try {
            KafkaClusterInfo result = apiInstance.getClusterDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterMetadataOperationsApi#getClusterDetails");
            e.printStackTrace();
        }
    }
}

ClusterMetadataOperationsApi *apiInstance = [[ClusterMetadataOperationsApi alloc] init];

// Get the kafka cluster details to which this service is connected to.
[apiInstance getClusterDetailsWithCompletionHandler: 
              ^(KafkaClusterInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ClusterMetadataOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getClusterDetails(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getClusterDetailsExample
    {
        public void main()
        {

            var apiInstance = new ClusterMetadataOperationsApi();

            try
            {
                // Get the kafka cluster details to which this service is connected to.
                KafkaClusterInfo result = apiInstance.getClusterDetails();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClusterMetadataOperationsApi.getClusterDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiClusterMetadataOperationsApi();

try {
    $result = $api_instance->getClusterDetails();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClusterMetadataOperationsApi->getClusterDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ClusterMetadataOperationsApi;

my $api_instance = WWW::SwaggerClient::ClusterMetadataOperationsApi->new();

eval { 
    my $result = $api_instance->getClusterDetails();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClusterMetadataOperationsApi->getClusterDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ClusterMetadataOperationsApi()

try: 
    # Get the kafka cluster details to which this service is connected to.
    api_response = api_instance.get_cluster_details()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClusterMetadataOperationsApi->getClusterDetails: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


ConsumerGroupRelatedDetails_

getAllConsumerInfo

Get consumer group details for all clients.


/api/v1/admin/consumers/clients

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/consumers/clients"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

import java.io.File;
import java.util.*;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        try {
            array[ConsumerInfo] result = apiInstance.getAllConsumerInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getAllConsumerInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        try {
            array[ConsumerInfo] result = apiInstance.getAllConsumerInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getAllConsumerInfo");
            e.printStackTrace();
        }
    }
}

ConsumerGroupRelatedDetails_Api *apiInstance = [[ConsumerGroupRelatedDetails_Api alloc] init];

// Get consumer group details for all clients.
[apiInstance getAllConsumerInfoWithCompletionHandler: 
              ^(array[ConsumerInfo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ConsumerGroupRelatedDetails_Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllConsumerInfo(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllConsumerInfoExample
    {
        public void main()
        {

            var apiInstance = new ConsumerGroupRelatedDetails_Api();

            try
            {
                // Get consumer group details for all clients.
                array[ConsumerInfo] result = apiInstance.getAllConsumerInfo();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsumerGroupRelatedDetails_Api.getAllConsumerInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConsumerGroupRelatedDetails_Api();

try {
    $result = $api_instance->getAllConsumerInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConsumerGroupRelatedDetails_Api->getAllConsumerInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api;

my $api_instance = WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api->new();

eval { 
    my $result = $api_instance->getAllConsumerInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConsumerGroupRelatedDetails_Api->getAllConsumerInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConsumerGroupRelatedDetails_Api()

try: 
    # Get consumer group details for all clients.
    api_response = api_instance.get_all_consumer_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConsumerGroupRelatedDetails_Api->getAllConsumerInfo: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


getConsumerGroupInfo

Get consumer group details for the given groupName `groupName`.


/api/v1/admin/consumers/groups/{groupName}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/consumers/groups/{groupName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

import java.io.File;
import java.util.*;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        String groupName = groupName_example; // String | Name of the consumer group
        try {
            ConsumerGroupInfo result = apiInstance.getConsumerGroupInfo(groupName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getConsumerGroupInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        String groupName = groupName_example; // String | Name of the consumer group
        try {
            ConsumerGroupInfo result = apiInstance.getConsumerGroupInfo(groupName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getConsumerGroupInfo");
            e.printStackTrace();
        }
    }
}
String *groupName = groupName_example; // Name of the consumer group

ConsumerGroupRelatedDetails_Api *apiInstance = [[ConsumerGroupRelatedDetails_Api alloc] init];

// Get consumer group details for the given groupName `groupName`.
[apiInstance getConsumerGroupInfoWith:groupName
              completionHandler: ^(ConsumerGroupInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ConsumerGroupRelatedDetails_Api()
var groupName = groupName_example; // {{String}} Name of the consumer group

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerGroupInfo(groupName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerGroupInfoExample
    {
        public void main()
        {

            var apiInstance = new ConsumerGroupRelatedDetails_Api();
            var groupName = groupName_example;  // String | Name of the consumer group

            try
            {
                // Get consumer group details for the given groupName `groupName`.
                ConsumerGroupInfo result = apiInstance.getConsumerGroupInfo(groupName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsumerGroupRelatedDetails_Api.getConsumerGroupInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConsumerGroupRelatedDetails_Api();
$groupName = groupName_example; // String | Name of the consumer group

try {
    $result = $api_instance->getConsumerGroupInfo($groupName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerGroupInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api;

my $api_instance = WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api->new();
my $groupName = groupName_example; # String | Name of the consumer group

eval { 
    my $result = $api_instance->getConsumerGroupInfo(groupName => $groupName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerGroupInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConsumerGroupRelatedDetails_Api()
groupName = groupName_example # String | Name of the consumer group

try: 
    # Get consumer group details for the given groupName `groupName`.
    api_response = api_instance.get_consumer_group_info(groupName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerGroupInfo: %s\n" % e)

Parameters

Path parameters
Name Description
groupName*
String
Name of the consumer group
Required

Responses

Status: 200 - successful operation


getConsumerGroupNames

Get all consumer group names.


/api/v1/admin/consumers/groupNames

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/consumers/groupNames"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

import java.io.File;
import java.util.*;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        try {
            array['String'] result = apiInstance.getConsumerGroupNames();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getConsumerGroupNames");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        try {
            array['String'] result = apiInstance.getConsumerGroupNames();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getConsumerGroupNames");
            e.printStackTrace();
        }
    }
}

ConsumerGroupRelatedDetails_Api *apiInstance = [[ConsumerGroupRelatedDetails_Api alloc] init];

// Get all consumer group names.
[apiInstance getConsumerGroupNamesWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ConsumerGroupRelatedDetails_Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerGroupNames(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerGroupNamesExample
    {
        public void main()
        {

            var apiInstance = new ConsumerGroupRelatedDetails_Api();

            try
            {
                // Get all consumer group names.
                array['String'] result = apiInstance.getConsumerGroupNames();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsumerGroupRelatedDetails_Api.getConsumerGroupNames: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConsumerGroupRelatedDetails_Api();

try {
    $result = $api_instance->getConsumerGroupNames();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerGroupNames: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api;

my $api_instance = WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api->new();

eval { 
    my $result = $api_instance->getConsumerGroupNames();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerGroupNames: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConsumerGroupRelatedDetails_Api()

try: 
    # Get all consumer group names.
    api_response = api_instance.get_consumer_group_names()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerGroupNames: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


getConsumerGroups

Get all consumer group details.


/api/v1/admin/consumers/groups

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/consumers/groups?state="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

import java.io.File;
import java.util.*;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        String state = state_example; // String | State of the Consumer Group
        try {
            array[ConsumerGroupInfo] result = apiInstance.getConsumerGroups(state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getConsumerGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        String state = state_example; // String | State of the Consumer Group
        try {
            array[ConsumerGroupInfo] result = apiInstance.getConsumerGroups(state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getConsumerGroups");
            e.printStackTrace();
        }
    }
}
String *state = state_example; // State of the Consumer Group (optional)

ConsumerGroupRelatedDetails_Api *apiInstance = [[ConsumerGroupRelatedDetails_Api alloc] init];

// Get all consumer group details.
[apiInstance getConsumerGroupsWith:state
              completionHandler: ^(array[ConsumerGroupInfo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ConsumerGroupRelatedDetails_Api()
var opts = { 
  'state': state_example // {{String}} State of the Consumer Group
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerGroups(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerGroupsExample
    {
        public void main()
        {

            var apiInstance = new ConsumerGroupRelatedDetails_Api();
            var state = state_example;  // String | State of the Consumer Group (optional) 

            try
            {
                // Get all consumer group details.
                array[ConsumerGroupInfo] result = apiInstance.getConsumerGroups(state);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsumerGroupRelatedDetails_Api.getConsumerGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConsumerGroupRelatedDetails_Api();
$state = state_example; // String | State of the Consumer Group

try {
    $result = $api_instance->getConsumerGroups($state);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerGroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api;

my $api_instance = WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api->new();
my $state = state_example; # String | State of the Consumer Group

eval { 
    my $result = $api_instance->getConsumerGroups(state => $state);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerGroups: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConsumerGroupRelatedDetails_Api()
state = state_example # String | State of the Consumer Group (optional)

try: 
    # Get all consumer group details.
    api_response = api_instance.get_consumer_groups(state=state)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerGroups: %s\n" % e)

Parameters

Query parameters
Name Description
state
String
State of the Consumer Group

Responses

Status: 200 - successful operation


getConsumerInfo

Get consumer group details for a given clientId.


/api/v1/admin/consumers/clients/{clientId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/consumers/clients/{clientId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

import java.io.File;
import java.util.*;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        String clientId = clientId_example; // String | Consumer client identifier
        try {
            ConsumerInfo result = apiInstance.getConsumerInfo(clientId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getConsumerInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        String clientId = clientId_example; // String | Consumer client identifier
        try {
            ConsumerInfo result = apiInstance.getConsumerInfo(clientId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getConsumerInfo");
            e.printStackTrace();
        }
    }
}
String *clientId = clientId_example; // Consumer client identifier

ConsumerGroupRelatedDetails_Api *apiInstance = [[ConsumerGroupRelatedDetails_Api alloc] init];

// Get consumer group details for a given clientId.
[apiInstance getConsumerInfoWith:clientId
              completionHandler: ^(ConsumerInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ConsumerGroupRelatedDetails_Api()
var clientId = clientId_example; // {{String}} Consumer client identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerInfo(clientId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerInfoExample
    {
        public void main()
        {

            var apiInstance = new ConsumerGroupRelatedDetails_Api();
            var clientId = clientId_example;  // String | Consumer client identifier

            try
            {
                // Get consumer group details for a given clientId.
                ConsumerInfo result = apiInstance.getConsumerInfo(clientId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsumerGroupRelatedDetails_Api.getConsumerInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConsumerGroupRelatedDetails_Api();
$clientId = clientId_example; // String | Consumer client identifier

try {
    $result = $api_instance->getConsumerInfo($clientId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api;

my $api_instance = WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api->new();
my $clientId = clientId_example; # String | Consumer client identifier

eval { 
    my $result = $api_instance->getConsumerInfo(clientId => $clientId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConsumerGroupRelatedDetails_Api()
clientId = clientId_example # String | Consumer client identifier

try: 
    # Get consumer group details for a given clientId.
    api_response = api_instance.get_consumer_info(clientId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerInfo: %s\n" % e)

Parameters

Path parameters
Name Description
clientId*
String
Consumer client identifier
Required

Responses

Status: 200 - successful operation


resetOffset

Reset consumer offsets


/api/v1/admin/consumers/groups/{groupName}/resetOffsets

Usage and SDK Samples

curl -X POST\
-H "Content-Type: */*"\
"//api/v1/admin/consumers/groups/{groupName}/resetOffsets"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

import java.io.File;
import java.util.*;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        String groupName = groupName_example; // String | Name of the consumer group
        ConsumerOffsetResetParams body = ; // ConsumerOffsetResetParams | 
        try {
            apiInstance.resetOffset(groupName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#resetOffset");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        String groupName = groupName_example; // String | Name of the consumer group
        ConsumerOffsetResetParams body = ; // ConsumerOffsetResetParams | 
        try {
            apiInstance.resetOffset(groupName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#resetOffset");
            e.printStackTrace();
        }
    }
}
String *groupName = groupName_example; // Name of the consumer group
ConsumerOffsetResetParams *body = ; //  (optional)

ConsumerGroupRelatedDetails_Api *apiInstance = [[ConsumerGroupRelatedDetails_Api alloc] init];

// Reset consumer offsets
[apiInstance resetOffsetWith:groupName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ConsumerGroupRelatedDetails_Api()
var groupName = groupName_example; // {{String}} Name of the consumer group
var opts = { 
  'body':  // {{ConsumerOffsetResetParams}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.resetOffset(groupName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class resetOffsetExample
    {
        public void main()
        {

            var apiInstance = new ConsumerGroupRelatedDetails_Api();
            var groupName = groupName_example;  // String | Name of the consumer group
            var body = new ConsumerOffsetResetParams(); // ConsumerOffsetResetParams |  (optional) 

            try
            {
                // Reset consumer offsets
                apiInstance.resetOffset(groupName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsumerGroupRelatedDetails_Api.resetOffset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConsumerGroupRelatedDetails_Api();
$groupName = groupName_example; // String | Name of the consumer group
$body = ; // ConsumerOffsetResetParams | 

try {
    $api_instance->resetOffset($groupName, $body);
} catch (Exception $e) {
    echo 'Exception when calling ConsumerGroupRelatedDetails_Api->resetOffset: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api;

my $api_instance = WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api->new();
my $groupName = groupName_example; # String | Name of the consumer group
my $body = WWW::SwaggerClient::Object::ConsumerOffsetResetParams->new(); # ConsumerOffsetResetParams | 

eval { 
    $api_instance->resetOffset(groupName => $groupName, body => $body);
};
if ($@) {
    warn "Exception when calling ConsumerGroupRelatedDetails_Api->resetOffset: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConsumerGroupRelatedDetails_Api()
groupName = groupName_example # String | Name of the consumer group
body =  # ConsumerOffsetResetParams |  (optional)

try: 
    # Reset consumer offsets
    api_instance.reset_offset(groupName, body=body)
except ApiException as e:
    print("Exception when calling ConsumerGroupRelatedDetails_Api->resetOffset: %s\n" % e)

Parameters

Path parameters
Name Description
groupName*
String
Name of the consumer group
Required
Body parameters
Name Description
body

Responses

Status: default - successful operation


ConsumerMetricOperations

getConsumerGroupMetrics1

Get timeline metrics for a consumer group. This will return per partition metrics for a consumer group.


/api/v2/admin/metrics/consumers/group/{groupId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/metrics/consumers/group/{groupId}?duration=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsumerMetricOperationsApi;

import java.io.File;
import java.util.*;

public class ConsumerMetricOperationsApiExample {

    public static void main(String[] args) {
        
        ConsumerMetricOperationsApi apiInstance = new ConsumerMetricOperationsApi();
        String groupId = groupId_example; // String | Consumer group identifier
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            ConsumerGroupMetrics result = apiInstance.getConsumerGroupMetrics1(groupId, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerMetricOperationsApi#getConsumerGroupMetrics1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsumerMetricOperationsApi;

public class ConsumerMetricOperationsApiExample {

    public static void main(String[] args) {
        ConsumerMetricOperationsApi apiInstance = new ConsumerMetricOperationsApi();
        String groupId = groupId_example; // String | Consumer group identifier
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            ConsumerGroupMetrics result = apiInstance.getConsumerGroupMetrics1(groupId, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerMetricOperationsApi#getConsumerGroupMetrics1");
            e.printStackTrace();
        }
    }
}
String *groupId = groupId_example; // Consumer group identifier
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)

ConsumerMetricOperationsApi *apiInstance = [[ConsumerMetricOperationsApi alloc] init];

// Get timeline metrics for a consumer group. This will return per partition metrics for a consumer group.
[apiInstance getConsumerGroupMetrics1With:groupId
    duration:duration
    from:from
    to:to
              completionHandler: ^(ConsumerGroupMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ConsumerMetricOperationsApi()
var groupId = groupId_example; // {{String}} Consumer group identifier
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789 // {{Long}} End of the time period. Provide '-1' to fetch the latest value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerGroupMetrics1(groupId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerGroupMetrics1Example
    {
        public void main()
        {

            var apiInstance = new ConsumerMetricOperationsApi();
            var groupId = groupId_example;  // String | Consumer group identifier
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 

            try
            {
                // Get timeline metrics for a consumer group. This will return per partition metrics for a consumer group.
                ConsumerGroupMetrics result = apiInstance.getConsumerGroupMetrics1(groupId, duration, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsumerMetricOperationsApi.getConsumerGroupMetrics1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConsumerMetricOperationsApi();
$groupId = groupId_example; // String | Consumer group identifier
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value

try {
    $result = $api_instance->getConsumerGroupMetrics1($groupId, $duration, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConsumerMetricOperationsApi->getConsumerGroupMetrics1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConsumerMetricOperationsApi;

my $api_instance = WWW::SwaggerClient::ConsumerMetricOperationsApi->new();
my $groupId = groupId_example; # String | Consumer group identifier
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value

eval { 
    my $result = $api_instance->getConsumerGroupMetrics1(groupId => $groupId, duration => $duration, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConsumerMetricOperationsApi->getConsumerGroupMetrics1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConsumerMetricOperationsApi()
groupId = groupId_example # String | Consumer group identifier
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)

try: 
    # Get timeline metrics for a consumer group. This will return per partition metrics for a consumer group.
    api_response = api_instance.get_consumer_group_metrics1(groupId, duration=duration, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConsumerMetricOperationsApi->getConsumerGroupMetrics1: %s\n" % e)

Parameters

Path parameters
Name Description
groupId*
String
Consumer group identifier
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value

Responses

Status: 200 - successful operation


EndToEndLatencyMetrics

getConsumerMetrics

Get the end to end latency metrics for the given topic across all intercepted consumer groups.


/api/v1/admin/etelatency/{topicName}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/etelatency/{topicName}?duration=&from=&to=&granularity="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EndToEndLatencyMetricsApi;

import java.io.File;
import java.util.*;

public class EndToEndLatencyMetricsApiExample {

    public static void main(String[] args) {
        
        EndToEndLatencyMetricsApi apiInstance = new EndToEndLatencyMetricsApi();
        String topicName = topicName_example; // String | Topic to query about
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String granularity = granularity_example; // String | Granularity to aggregate the metrics with
        try {
            ETELatencyMetrics result = apiInstance.getConsumerMetrics(topicName, duration, from, to, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndToEndLatencyMetricsApi#getConsumerMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EndToEndLatencyMetricsApi;

public class EndToEndLatencyMetricsApiExample {

    public static void main(String[] args) {
        EndToEndLatencyMetricsApi apiInstance = new EndToEndLatencyMetricsApi();
        String topicName = topicName_example; // String | Topic to query about
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String granularity = granularity_example; // String | Granularity to aggregate the metrics with
        try {
            ETELatencyMetrics result = apiInstance.getConsumerMetrics(topicName, duration, from, to, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndToEndLatencyMetricsApi#getConsumerMetrics");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // Topic to query about
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *granularity = granularity_example; // Granularity to aggregate the metrics with (optional) (default to THIRTY_SECS)

EndToEndLatencyMetricsApi *apiInstance = [[EndToEndLatencyMetricsApi alloc] init];

// Get the end to end latency metrics for the given topic across all intercepted consumer groups.
[apiInstance getConsumerMetricsWith:topicName
    duration:duration
    from:from
    to:to
    granularity:granularity
              completionHandler: ^(ETELatencyMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.EndToEndLatencyMetricsApi()
var topicName = topicName_example; // {{String}} Topic to query about
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'granularity': granularity_example // {{String}} Granularity to aggregate the metrics with
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerMetrics(topicName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerMetricsExample
    {
        public void main()
        {

            var apiInstance = new EndToEndLatencyMetricsApi();
            var topicName = topicName_example;  // String | Topic to query about
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var granularity = granularity_example;  // String | Granularity to aggregate the metrics with (optional)  (default to THIRTY_SECS)

            try
            {
                // Get the end to end latency metrics for the given topic across all intercepted consumer groups.
                ETELatencyMetrics result = apiInstance.getConsumerMetrics(topicName, duration, from, to, granularity);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EndToEndLatencyMetricsApi.getConsumerMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiEndToEndLatencyMetricsApi();
$topicName = topicName_example; // String | Topic to query about
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$granularity = granularity_example; // String | Granularity to aggregate the metrics with

try {
    $result = $api_instance->getConsumerMetrics($topicName, $duration, $from, $to, $granularity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndToEndLatencyMetricsApi->getConsumerMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EndToEndLatencyMetricsApi;

my $api_instance = WWW::SwaggerClient::EndToEndLatencyMetricsApi->new();
my $topicName = topicName_example; # String | Topic to query about
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $granularity = granularity_example; # String | Granularity to aggregate the metrics with

eval { 
    my $result = $api_instance->getConsumerMetrics(topicName => $topicName, duration => $duration, from => $from, to => $to, granularity => $granularity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndToEndLatencyMetricsApi->getConsumerMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.EndToEndLatencyMetricsApi()
topicName = topicName_example # String | Topic to query about
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
granularity = granularity_example # String | Granularity to aggregate the metrics with (optional) (default to THIRTY_SECS)

try: 
    # Get the end to end latency metrics for the given topic across all intercepted consumer groups.
    api_response = api_instance.get_consumer_metrics(topicName, duration=duration, from=from, to=to, granularity=granularity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndToEndLatencyMetricsApi->getConsumerMetrics: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Topic to query about
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
granularity
String
Granularity to aggregate the metrics with

Responses

Status: 200 - successful operation


getConsumerMetricsByClientId

Get the end to end latency metrics under a given consumer group for the given clientId and topic.


/api/v1/admin/etelatency/{topicName}/groups/{groupId}/clients/{clientId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/etelatency/{topicName}/groups/{groupId}/clients/{clientId}?duration=&from=&to=&granularity="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EndToEndLatencyMetricsApi;

import java.io.File;
import java.util.*;

public class EndToEndLatencyMetricsApiExample {

    public static void main(String[] args) {
        
        EndToEndLatencyMetricsApi apiInstance = new EndToEndLatencyMetricsApi();
        String topicName = topicName_example; // String | Topic to query about
        String groupId = groupId_example; // String | Consumer Group Id queried for
        String clientId = clientId_example; // String | Client Id queried for
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String granularity = granularity_example; // String | Granularity to aggregate the metrics with
        try {
            ETELatencyMetrics result = apiInstance.getConsumerMetricsByClientId(topicName, groupId, clientId, duration, from, to, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndToEndLatencyMetricsApi#getConsumerMetricsByClientId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EndToEndLatencyMetricsApi;

public class EndToEndLatencyMetricsApiExample {

    public static void main(String[] args) {
        EndToEndLatencyMetricsApi apiInstance = new EndToEndLatencyMetricsApi();
        String topicName = topicName_example; // String | Topic to query about
        String groupId = groupId_example; // String | Consumer Group Id queried for
        String clientId = clientId_example; // String | Client Id queried for
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String granularity = granularity_example; // String | Granularity to aggregate the metrics with
        try {
            ETELatencyMetrics result = apiInstance.getConsumerMetricsByClientId(topicName, groupId, clientId, duration, from, to, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndToEndLatencyMetricsApi#getConsumerMetricsByClientId");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // Topic to query about
String *groupId = groupId_example; // Consumer Group Id queried for
String *clientId = clientId_example; // Client Id queried for
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *granularity = granularity_example; // Granularity to aggregate the metrics with (optional) (default to THIRTY_SECS)

EndToEndLatencyMetricsApi *apiInstance = [[EndToEndLatencyMetricsApi alloc] init];

// Get the end to end latency metrics under a given consumer group for the given clientId and topic.
[apiInstance getConsumerMetricsByClientIdWith:topicName
    groupId:groupId
    clientId:clientId
    duration:duration
    from:from
    to:to
    granularity:granularity
              completionHandler: ^(ETELatencyMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.EndToEndLatencyMetricsApi()
var topicName = topicName_example; // {{String}} Topic to query about
var groupId = groupId_example; // {{String}} Consumer Group Id queried for
var clientId = clientId_example; // {{String}} Client Id queried for
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'granularity': granularity_example // {{String}} Granularity to aggregate the metrics with
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerMetricsByClientId(topicName, groupId, clientId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerMetricsByClientIdExample
    {
        public void main()
        {

            var apiInstance = new EndToEndLatencyMetricsApi();
            var topicName = topicName_example;  // String | Topic to query about
            var groupId = groupId_example;  // String | Consumer Group Id queried for
            var clientId = clientId_example;  // String | Client Id queried for
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var granularity = granularity_example;  // String | Granularity to aggregate the metrics with (optional)  (default to THIRTY_SECS)

            try
            {
                // Get the end to end latency metrics under a given consumer group for the given clientId and topic.
                ETELatencyMetrics result = apiInstance.getConsumerMetricsByClientId(topicName, groupId, clientId, duration, from, to, granularity);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EndToEndLatencyMetricsApi.getConsumerMetricsByClientId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiEndToEndLatencyMetricsApi();
$topicName = topicName_example; // String | Topic to query about
$groupId = groupId_example; // String | Consumer Group Id queried for
$clientId = clientId_example; // String | Client Id queried for
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$granularity = granularity_example; // String | Granularity to aggregate the metrics with

try {
    $result = $api_instance->getConsumerMetricsByClientId($topicName, $groupId, $clientId, $duration, $from, $to, $granularity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndToEndLatencyMetricsApi->getConsumerMetricsByClientId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EndToEndLatencyMetricsApi;

my $api_instance = WWW::SwaggerClient::EndToEndLatencyMetricsApi->new();
my $topicName = topicName_example; # String | Topic to query about
my $groupId = groupId_example; # String | Consumer Group Id queried for
my $clientId = clientId_example; # String | Client Id queried for
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $granularity = granularity_example; # String | Granularity to aggregate the metrics with

eval { 
    my $result = $api_instance->getConsumerMetricsByClientId(topicName => $topicName, groupId => $groupId, clientId => $clientId, duration => $duration, from => $from, to => $to, granularity => $granularity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndToEndLatencyMetricsApi->getConsumerMetricsByClientId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.EndToEndLatencyMetricsApi()
topicName = topicName_example # String | Topic to query about
groupId = groupId_example # String | Consumer Group Id queried for
clientId = clientId_example # String | Client Id queried for
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
granularity = granularity_example # String | Granularity to aggregate the metrics with (optional) (default to THIRTY_SECS)

try: 
    # Get the end to end latency metrics under a given consumer group for the given clientId and topic.
    api_response = api_instance.get_consumer_metrics_by_client_id(topicName, groupId, clientId, duration=duration, from=from, to=to, granularity=granularity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndToEndLatencyMetricsApi->getConsumerMetricsByClientId: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Topic to query about
Required
groupId*
String
Consumer Group Id queried for
Required
clientId*
String
Client Id queried for
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
granularity
String
Granularity to aggregate the metrics with

Responses

Status: 200 - successful operation


getConsumerMetricsByClientPartition

Get the end to end latency metrics of a client under a given consumer group for the given partition and topic.


/api/v1/admin/etelatency/{topicName}/partitions/{partitionNum}/groups/{groupId}/clients/{clientId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/etelatency/{topicName}/partitions/{partitionNum}/groups/{groupId}/clients/{clientId}?duration=&from=&to=&granularity="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EndToEndLatencyMetricsApi;

import java.io.File;
import java.util.*;

public class EndToEndLatencyMetricsApiExample {

    public static void main(String[] args) {
        
        EndToEndLatencyMetricsApi apiInstance = new EndToEndLatencyMetricsApi();
        String topicName = topicName_example; // String | Topic to query about
        Integer partitionNum = 56; // Integer | Partition to query about
        String groupId = groupId_example; // String | Consumer Group Id queried for
        String clientId = clientId_example; // String | Client Id queried for
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String granularity = granularity_example; // String | Granularity to aggregate the metrics with
        try {
            ETELatencyMetrics result = apiInstance.getConsumerMetricsByClientPartition(topicName, partitionNum, groupId, clientId, duration, from, to, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndToEndLatencyMetricsApi#getConsumerMetricsByClientPartition");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EndToEndLatencyMetricsApi;

public class EndToEndLatencyMetricsApiExample {

    public static void main(String[] args) {
        EndToEndLatencyMetricsApi apiInstance = new EndToEndLatencyMetricsApi();
        String topicName = topicName_example; // String | Topic to query about
        Integer partitionNum = 56; // Integer | Partition to query about
        String groupId = groupId_example; // String | Consumer Group Id queried for
        String clientId = clientId_example; // String | Client Id queried for
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String granularity = granularity_example; // String | Granularity to aggregate the metrics with
        try {
            ETELatencyMetrics result = apiInstance.getConsumerMetricsByClientPartition(topicName, partitionNum, groupId, clientId, duration, from, to, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndToEndLatencyMetricsApi#getConsumerMetricsByClientPartition");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // Topic to query about
Integer *partitionNum = 56; // Partition to query about
String *groupId = groupId_example; // Consumer Group Id queried for
String *clientId = clientId_example; // Client Id queried for
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *granularity = granularity_example; // Granularity to aggregate the metrics with (optional) (default to THIRTY_SECS)

EndToEndLatencyMetricsApi *apiInstance = [[EndToEndLatencyMetricsApi alloc] init];

// Get the end to end latency metrics of a client under a given consumer group for the given partition and topic.
[apiInstance getConsumerMetricsByClientPartitionWith:topicName
    partitionNum:partitionNum
    groupId:groupId
    clientId:clientId
    duration:duration
    from:from
    to:to
    granularity:granularity
              completionHandler: ^(ETELatencyMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.EndToEndLatencyMetricsApi()
var topicName = topicName_example; // {{String}} Topic to query about
var partitionNum = 56; // {{Integer}} Partition to query about
var groupId = groupId_example; // {{String}} Consumer Group Id queried for
var clientId = clientId_example; // {{String}} Client Id queried for
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'granularity': granularity_example // {{String}} Granularity to aggregate the metrics with
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerMetricsByClientPartition(topicName, partitionNum, groupId, clientId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerMetricsByClientPartitionExample
    {
        public void main()
        {

            var apiInstance = new EndToEndLatencyMetricsApi();
            var topicName = topicName_example;  // String | Topic to query about
            var partitionNum = 56;  // Integer | Partition to query about
            var groupId = groupId_example;  // String | Consumer Group Id queried for
            var clientId = clientId_example;  // String | Client Id queried for
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var granularity = granularity_example;  // String | Granularity to aggregate the metrics with (optional)  (default to THIRTY_SECS)

            try
            {
                // Get the end to end latency metrics of a client under a given consumer group for the given partition and topic.
                ETELatencyMetrics result = apiInstance.getConsumerMetricsByClientPartition(topicName, partitionNum, groupId, clientId, duration, from, to, granularity);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EndToEndLatencyMetricsApi.getConsumerMetricsByClientPartition: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiEndToEndLatencyMetricsApi();
$topicName = topicName_example; // String | Topic to query about
$partitionNum = 56; // Integer | Partition to query about
$groupId = groupId_example; // String | Consumer Group Id queried for
$clientId = clientId_example; // String | Client Id queried for
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$granularity = granularity_example; // String | Granularity to aggregate the metrics with

try {
    $result = $api_instance->getConsumerMetricsByClientPartition($topicName, $partitionNum, $groupId, $clientId, $duration, $from, $to, $granularity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndToEndLatencyMetricsApi->getConsumerMetricsByClientPartition: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EndToEndLatencyMetricsApi;

my $api_instance = WWW::SwaggerClient::EndToEndLatencyMetricsApi->new();
my $topicName = topicName_example; # String | Topic to query about
my $partitionNum = 56; # Integer | Partition to query about
my $groupId = groupId_example; # String | Consumer Group Id queried for
my $clientId = clientId_example; # String | Client Id queried for
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $granularity = granularity_example; # String | Granularity to aggregate the metrics with

eval { 
    my $result = $api_instance->getConsumerMetricsByClientPartition(topicName => $topicName, partitionNum => $partitionNum, groupId => $groupId, clientId => $clientId, duration => $duration, from => $from, to => $to, granularity => $granularity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndToEndLatencyMetricsApi->getConsumerMetricsByClientPartition: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.EndToEndLatencyMetricsApi()
topicName = topicName_example # String | Topic to query about
partitionNum = 56 # Integer | Partition to query about
groupId = groupId_example # String | Consumer Group Id queried for
clientId = clientId_example # String | Client Id queried for
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
granularity = granularity_example # String | Granularity to aggregate the metrics with (optional) (default to THIRTY_SECS)

try: 
    # Get the end to end latency metrics of a client under a given consumer group for the given partition and topic.
    api_response = api_instance.get_consumer_metrics_by_client_partition(topicName, partitionNum, groupId, clientId, duration=duration, from=from, to=to, granularity=granularity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndToEndLatencyMetricsApi->getConsumerMetricsByClientPartition: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Topic to query about
Required
partitionNum*
Integer (int32)
Partition to query about
Required
groupId*
String
Consumer Group Id queried for
Required
clientId*
String
Client Id queried for
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
granularity
String
Granularity to aggregate the metrics with

Responses

Status: 200 - successful operation


getConsumerMetricsByGroup

Get the end to end latency metrics under the given consumer group Id for the given topic.


/api/v1/admin/etelatency/{topicName}/groups/{groupId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/etelatency/{topicName}/groups/{groupId}?duration=&from=&to=&granularity="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EndToEndLatencyMetricsApi;

import java.io.File;
import java.util.*;

public class EndToEndLatencyMetricsApiExample {

    public static void main(String[] args) {
        
        EndToEndLatencyMetricsApi apiInstance = new EndToEndLatencyMetricsApi();
        String topicName = topicName_example; // String | Topic to query about
        String groupId = groupId_example; // String | Consumer Group Id queried for
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String granularity = granularity_example; // String | Granularity to aggregate the metrics with
        try {
            ETELatencyMetrics result = apiInstance.getConsumerMetricsByGroup(topicName, groupId, duration, from, to, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndToEndLatencyMetricsApi#getConsumerMetricsByGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EndToEndLatencyMetricsApi;

public class EndToEndLatencyMetricsApiExample {

    public static void main(String[] args) {
        EndToEndLatencyMetricsApi apiInstance = new EndToEndLatencyMetricsApi();
        String topicName = topicName_example; // String | Topic to query about
        String groupId = groupId_example; // String | Consumer Group Id queried for
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String granularity = granularity_example; // String | Granularity to aggregate the metrics with
        try {
            ETELatencyMetrics result = apiInstance.getConsumerMetricsByGroup(topicName, groupId, duration, from, to, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndToEndLatencyMetricsApi#getConsumerMetricsByGroup");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // Topic to query about
String *groupId = groupId_example; // Consumer Group Id queried for
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *granularity = granularity_example; // Granularity to aggregate the metrics with (optional) (default to THIRTY_SECS)

EndToEndLatencyMetricsApi *apiInstance = [[EndToEndLatencyMetricsApi alloc] init];

// Get the end to end latency metrics under the given consumer group Id for the given topic.
[apiInstance getConsumerMetricsByGroupWith:topicName
    groupId:groupId
    duration:duration
    from:from
    to:to
    granularity:granularity
              completionHandler: ^(ETELatencyMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.EndToEndLatencyMetricsApi()
var topicName = topicName_example; // {{String}} Topic to query about
var groupId = groupId_example; // {{String}} Consumer Group Id queried for
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of