clusterInfo
Get cluster info for the specified Kafka cluster ID.
The default time range for this operation is 2 hours.
/v2/cluster-info/{kafkaClusterId}
Usage and SDK Samples
curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"//v2/cluster-info/{kafkaClusterId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Class1SRMServiceAPIV2Api;
import java.io.File;
import java.util.*;
public class Class1SRMServiceAPIV2ApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
Class1SRMServiceAPIV2Api apiInstance = new Class1SRMServiceAPIV2Api();
String kafkaClusterId = kafkaClusterId_example; // String | Cluster ID of the Kafka cluster.
try {
ClusterInfo result = apiInstance.clusterInfo(kafkaClusterId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling Class1SRMServiceAPIV2Api#clusterInfo");
e.printStackTrace();
}
}
}
import io.swagger.client.api.Class1SRMServiceAPIV2Api;
public class Class1SRMServiceAPIV2ApiExample {
public static void main(String[] args) {
Class1SRMServiceAPIV2Api apiInstance = new Class1SRMServiceAPIV2Api();
String kafkaClusterId = kafkaClusterId_example; // String | Cluster ID of the Kafka cluster.
try {
ClusterInfo result = apiInstance.clusterInfo(kafkaClusterId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling Class1SRMServiceAPIV2Api#clusterInfo");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *kafkaClusterId = kafkaClusterId_example; // Cluster ID of the Kafka cluster.
Class1SRMServiceAPIV2Api *apiInstance = [[Class1SRMServiceAPIV2Api alloc] init];
// Get cluster info for the specified Kafka cluster ID.
[apiInstance clusterInfoWith:kafkaClusterId
completionHandler: ^(ClusterInfo output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var SwaggerJsClient = require('swagger-js-client');
var defaultClient = SwaggerJsClient.ApiClient.instance;
// Configure API key authorization: Authorization
var Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix['Authorization'] = "Token"
var api = new SwaggerJsClient.Class1SRMServiceAPIV2Api()
var kafkaClusterId = kafkaClusterId_example; // {{String}} Cluster ID of the Kafka cluster.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.clusterInfo(kafkaClusterId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class clusterInfoExample
{
public void main()
{
// Configure API key authorization: Authorization
Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
var apiInstance = new Class1SRMServiceAPIV2Api();
var kafkaClusterId = kafkaClusterId_example; // String | Cluster ID of the Kafka cluster.
try
{
// Get cluster info for the specified Kafka cluster ID.
ClusterInfo result = apiInstance.clusterInfo(kafkaClusterId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling Class1SRMServiceAPIV2Api.clusterInfo: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Authorization
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
$api_instance = new Swagger\Client\ApiClass1SRMServiceAPIV2Api();
$kafkaClusterId = kafkaClusterId_example; // String | Cluster ID of the Kafka cluster.
try {
$result = $api_instance->clusterInfo($kafkaClusterId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling Class1SRMServiceAPIV2Api->clusterInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Class1SRMServiceAPIV2Api;
# Configure API key authorization: Authorization
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
my $api_instance = WWW::SwaggerClient::Class1SRMServiceAPIV2Api->new();
my $kafkaClusterId = kafkaClusterId_example; # String | Cluster ID of the Kafka cluster.
eval {
my $result = $api_instance->clusterInfo(kafkaClusterId => $kafkaClusterId);
print Dumper($result);
};
if ($@) {
warn "Exception when calling Class1SRMServiceAPIV2Api->clusterInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: Authorization
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = swagger_client.Class1SRMServiceAPIV2Api()
kafkaClusterId = kafkaClusterId_example # String | Cluster ID of the Kafka cluster.
try:
# Get cluster info for the specified Kafka cluster ID.
api_response = api_instance.cluster_info(kafkaClusterId)
pprint(api_response)
except ApiException as e:
print("Exception when calling Class1SRMServiceAPIV2Api->clusterInfo: %s\n" % e)
Parameters
Name | Description |
---|---|
kafkaClusterId* |
String
Cluster ID of the Kafka cluster.
Required
|