Swagger spec for Ambari REST API

Actions

actionServiceCreateActionDefinition

Creates an action definition - Currently Not Supported


/actions/{actionName}

Usage and SDK Samples

curl -X post "https://localhost/api/v1/actions/{actionName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActionsApi;

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

public class ActionsApiExample {

    public static void main(String[] args) {
        
        ActionsApi apiInstance = new ActionsApi();
        String actionName = actionName_example; // String | 
        ActionRequestSwagger body = ; // ActionRequestSwagger | 
        try {
            apiInstance.actionServiceCreateActionDefinition(actionName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#actionServiceCreateActionDefinition");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActionsApi;

public class ActionsApiExample {

    public static void main(String[] args) {
        ActionsApi apiInstance = new ActionsApi();
        String actionName = actionName_example; // String | 
        ActionRequestSwagger body = ; // ActionRequestSwagger | 
        try {
            apiInstance.actionServiceCreateActionDefinition(actionName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#actionServiceCreateActionDefinition");
            e.printStackTrace();
        }
    }
}
String *actionName = actionName_example; // 
ActionRequestSwagger *body = ; //  (optional)

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

// Creates an action definition - Currently Not Supported
[apiInstance actionServiceCreateActionDefinitionWith:actionName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ActionsApi()

var actionName = actionName_example; // {String} 

var opts = { 
  'body':  // {ActionRequestSwagger} 
};

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

namespace Example
{
    public class actionServiceCreateActionDefinitionExample
    {
        public void main()
        {
            
            var apiInstance = new ActionsApi();
            var actionName = actionName_example;  // String | 
            var body = new ActionRequestSwagger(); // ActionRequestSwagger |  (optional) 

            try
            {
                // Creates an action definition - Currently Not Supported
                apiInstance.actionServiceCreateActionDefinition(actionName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActionsApi.actionServiceCreateActionDefinition: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ActionsApi();
$actionName = actionName_example; // String | 
$body = ; // ActionRequestSwagger | 

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

my $api_instance = WWW::SwaggerClient::ActionsApi->new();
my $actionName = actionName_example; # String | 
my $body = WWW::SwaggerClient::Object::ActionRequestSwagger->new(); # ActionRequestSwagger | 

eval { 
    $api_instance->actionServiceCreateActionDefinition(actionName => $actionName, body => $body);
};
if ($@) {
    warn "Exception when calling ActionsApi->actionServiceCreateActionDefinition: $@\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.ActionsApi()
actionName = actionName_example # String | 
body =  # ActionRequestSwagger |  (optional)

try: 
    # Creates an action definition - Currently Not Supported
    api_instance.actionServiceCreateActionDefinition(actionName, body=body)
except ApiException as e:
    print("Exception when calling ActionsApi->actionServiceCreateActionDefinition: %s\n" % e)

Parameters

Path parameters
Name Description
actionName*
Body parameters
Name Description
body

Responses

Status: 400 - Invalid request

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 500 - Internal server error


actionServiceDeleteActionDefinition

Deletes an action definition - Currently Not Supported


/actions/{actionName}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/actions/{actionName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActionsApi;

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

public class ActionsApiExample {

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

public class ActionsApiExample {

    public static void main(String[] args) {
        ActionsApi apiInstance = new ActionsApi();
        String actionName = actionName_example; // String | 
        try {
            apiInstance.actionServiceDeleteActionDefinition(actionName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#actionServiceDeleteActionDefinition");
            e.printStackTrace();
        }
    }
}
String *actionName = actionName_example; // 

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

// Deletes an action definition - Currently Not Supported
[apiInstance actionServiceDeleteActionDefinitionWith:actionName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ActionsApi()

var actionName = actionName_example; // {String} 


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

namespace Example
{
    public class actionServiceDeleteActionDefinitionExample
    {
        public void main()
        {
            
            var apiInstance = new ActionsApi();
            var actionName = actionName_example;  // String | 

            try
            {
                // Deletes an action definition - Currently Not Supported
                apiInstance.actionServiceDeleteActionDefinition(actionName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActionsApi.actionServiceDeleteActionDefinition: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ActionsApi();
$actionName = actionName_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ActionsApi->new();
my $actionName = actionName_example; # String | 

eval { 
    $api_instance->actionServiceDeleteActionDefinition(actionName => $actionName);
};
if ($@) {
    warn "Exception when calling ActionsApi->actionServiceDeleteActionDefinition: $@\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.ActionsApi()
actionName = actionName_example # String | 

try: 
    # Deletes an action definition - Currently Not Supported
    api_instance.actionServiceDeleteActionDefinition(actionName)
except ApiException as e:
    print("Exception when calling ActionsApi->actionServiceDeleteActionDefinition: %s\n" % e)

Parameters

Path parameters
Name Description
actionName*

Responses

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


actionServiceGetActionDefinition

Get the details of an action definition


/actions/{actionName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/actions/{actionName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActionsApi;

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

public class ActionsApiExample {

    public static void main(String[] args) {
        
        ActionsApi apiInstance = new ActionsApi();
        String actionName = actionName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            ActionResponseSwagger result = apiInstance.actionServiceGetActionDefinition(actionName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#actionServiceGetActionDefinition");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActionsApi;

public class ActionsApiExample {

    public static void main(String[] args) {
        ActionsApi apiInstance = new ActionsApi();
        String actionName = actionName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            ActionResponseSwagger result = apiInstance.actionServiceGetActionDefinition(actionName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#actionServiceGetActionDefinition");
            e.printStackTrace();
        }
    }
}
String *actionName = actionName_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Actions/*)

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

// Get the details of an action definition
[apiInstance actionServiceGetActionDefinitionWith:actionName
    fields:fields
              completionHandler: ^(ActionResponseSwagger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ActionsApi()

var actionName = actionName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class actionServiceGetActionDefinitionExample
    {
        public void main()
        {
            
            var apiInstance = new ActionsApi();
            var actionName = actionName_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Actions/*)

            try
            {
                // Get the details of an action definition
                ActionResponseSwagger result = apiInstance.actionServiceGetActionDefinition(actionName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActionsApi.actionServiceGetActionDefinition: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ActionsApi();
$actionName = actionName_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::ActionsApi->new();
my $actionName = actionName_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->actionServiceGetActionDefinition(actionName => $actionName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActionsApi->actionServiceGetActionDefinition: $@\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.ActionsApi()
actionName = actionName_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Actions/*)

try: 
    # Get the details of an action definition
    api_response = api_instance.actionServiceGetActionDefinition(actionName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActionsApi->actionServiceGetActionDefinition: %s\n" % e)

Parameters

Path parameters
Name Description
actionName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


actionServiceGetActionDefinitions

Get all action definitions


/actions

Usage and SDK Samples

curl -X get "https://localhost/api/v1/actions?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActionsApi;

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

public class ActionsApiExample {

    public static void main(String[] args) {
        
        ActionsApi apiInstance = new ActionsApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ActionResponseSwagger] result = apiInstance.actionServiceGetActionDefinitions(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#actionServiceGetActionDefinitions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActionsApi;

public class ActionsApiExample {

    public static void main(String[] args) {
        ActionsApi apiInstance = new ActionsApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ActionResponseSwagger] result = apiInstance.actionServiceGetActionDefinitions(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#actionServiceGetActionDefinitions");
            e.printStackTrace();
        }
    }
}
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Actions/action_name)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional) (default to Actions/action_name.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all action definitions
[apiInstance actionServiceGetActionDefinitionsWith:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[ActionResponseSwagger] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ActionsApi()

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive).  "start" is also accepted.
  'to': to_example // {String} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class actionServiceGetActionDefinitionsExample
    {
        public void main()
        {
            
            var apiInstance = new ActionsApi();
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Actions/action_name)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional)  (default to Actions/action_name.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all action definitions
                array[ActionResponseSwagger] result = apiInstance.actionServiceGetActionDefinitions(fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActionsApi.actionServiceGetActionDefinitions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ActionsApi();
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
$to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.

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

my $api_instance = WWW::SwaggerClient::ActionsApi->new();
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive).  "start" is also accepted.
my $to = to_example; # String | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->actionServiceGetActionDefinitions(fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActionsApi->actionServiceGetActionDefinitions: $@\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.ActionsApi()
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Actions/action_name)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional) (default to Actions/action_name.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all action definitions
    api_response = api_instance.actionServiceGetActionDefinitions(fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActionsApi->actionServiceGetActionDefinitions: %s\n" % e)

Parameters

Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 500 - Internal server error


actionServiceUpdateActionDefinition

Updates an action definition - Currently Not Supported


/actions/{actionName}

Usage and SDK Samples

curl -X put "https://localhost/api/v1/actions/{actionName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActionsApi;

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

public class ActionsApiExample {

    public static void main(String[] args) {
        
        ActionsApi apiInstance = new ActionsApi();
        String actionName = actionName_example; // String | 
        ActionRequestSwagger body = ; // ActionRequestSwagger | 
        try {
            apiInstance.actionServiceUpdateActionDefinition(actionName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#actionServiceUpdateActionDefinition");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActionsApi;

public class ActionsApiExample {

    public static void main(String[] args) {
        ActionsApi apiInstance = new ActionsApi();
        String actionName = actionName_example; // String | 
        ActionRequestSwagger body = ; // ActionRequestSwagger | 
        try {
            apiInstance.actionServiceUpdateActionDefinition(actionName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionsApi#actionServiceUpdateActionDefinition");
            e.printStackTrace();
        }
    }
}
String *actionName = actionName_example; // 
ActionRequestSwagger *body = ; //  (optional)

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

// Updates an action definition - Currently Not Supported
[apiInstance actionServiceUpdateActionDefinitionWith:actionName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ActionsApi()

var actionName = actionName_example; // {String} 

var opts = { 
  'body':  // {ActionRequestSwagger} 
};

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

namespace Example
{
    public class actionServiceUpdateActionDefinitionExample
    {
        public void main()
        {
            
            var apiInstance = new ActionsApi();
            var actionName = actionName_example;  // String | 
            var body = new ActionRequestSwagger(); // ActionRequestSwagger |  (optional) 

            try
            {
                // Updates an action definition - Currently Not Supported
                apiInstance.actionServiceUpdateActionDefinition(actionName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActionsApi.actionServiceUpdateActionDefinition: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ActionsApi();
$actionName = actionName_example; // String | 
$body = ; // ActionRequestSwagger | 

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

my $api_instance = WWW::SwaggerClient::ActionsApi->new();
my $actionName = actionName_example; # String | 
my $body = WWW::SwaggerClient::Object::ActionRequestSwagger->new(); # ActionRequestSwagger | 

eval { 
    $api_instance->actionServiceUpdateActionDefinition(actionName => $actionName, body => $body);
};
if ($@) {
    warn "Exception when calling ActionsApi->actionServiceUpdateActionDefinition: $@\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.ActionsApi()
actionName = actionName_example # String | 
body =  # ActionRequestSwagger |  (optional)

try: 
    # Updates an action definition - Currently Not Supported
    api_instance.actionServiceUpdateActionDefinition(actionName, body=body)
except ApiException as e:
    print("Exception when calling ActionsApi->actionServiceUpdateActionDefinition: %s\n" % e)

Parameters

Path parameters
Name Description
actionName*
Body parameters
Name Description
body

Responses

Status: 400 - Invalid request

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 500 - Internal server error


Alerts

createTarget

Creates an alert target


/alert_targets

Usage and SDK Samples

curl -X post "https://localhost/api/v1/alert_targets?validateConfig=&overwriteExisting="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertsApi;

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

public class AlertsApiExample {

    public static void main(String[] args) {
        
        AlertsApi apiInstance = new AlertsApi();
        AlertTargetSwagger body = ; // AlertTargetSwagger | 
        String validateConfig = validateConfig_example; // String | 
        String overwriteExisting = overwriteExisting_example; // String | 
        try {
            apiInstance.createTarget(body, validateConfig, overwriteExisting);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#createTarget");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertsApi;

public class AlertsApiExample {

    public static void main(String[] args) {
        AlertsApi apiInstance = new AlertsApi();
        AlertTargetSwagger body = ; // AlertTargetSwagger | 
        String validateConfig = validateConfig_example; // String | 
        String overwriteExisting = overwriteExisting_example; // String | 
        try {
            apiInstance.createTarget(body, validateConfig, overwriteExisting);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#createTarget");
            e.printStackTrace();
        }
    }
}
AlertTargetSwagger *body = ; //  (optional)
String *validateConfig = validateConfig_example; //  (optional)
String *overwriteExisting = overwriteExisting_example; //  (optional)

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

// Creates an alert target
[apiInstance createTargetWith:body
    validateConfig:validateConfig
    overwriteExisting:overwriteExisting
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.AlertsApi()

var opts = { 
  'body': , // {AlertTargetSwagger} 
  'validateConfig': validateConfig_example, // {String} 
  'overwriteExisting': overwriteExisting_example // {String} 
};

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

namespace Example
{
    public class createTargetExample
    {
        public void main()
        {
            
            var apiInstance = new AlertsApi();
            var body = new AlertTargetSwagger(); // AlertTargetSwagger |  (optional) 
            var validateConfig = validateConfig_example;  // String |  (optional) 
            var overwriteExisting = overwriteExisting_example;  // String |  (optional) 

            try
            {
                // Creates an alert target
                apiInstance.createTarget(body, validateConfig, overwriteExisting);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertsApi.createTarget: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AlertsApi();
$body = ; // AlertTargetSwagger | 
$validateConfig = validateConfig_example; // String | 
$overwriteExisting = overwriteExisting_example; // String | 

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

my $api_instance = WWW::SwaggerClient::AlertsApi->new();
my $body = WWW::SwaggerClient::Object::AlertTargetSwagger->new(); # AlertTargetSwagger | 
my $validateConfig = validateConfig_example; # String | 
my $overwriteExisting = overwriteExisting_example; # String | 

eval { 
    $api_instance->createTarget(body => $body, validateConfig => $validateConfig, overwriteExisting => $overwriteExisting);
};
if ($@) {
    warn "Exception when calling AlertsApi->createTarget: $@\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.AlertsApi()
body =  # AlertTargetSwagger |  (optional)
validateConfig = validateConfig_example # String |  (optional)
overwriteExisting = overwriteExisting_example # String |  (optional)

try: 
    # Creates an alert target
    api_instance.createTarget(body=body, validateConfig=validateConfig, overwriteExisting=overwriteExisting)
except ApiException as e:
    print("Exception when calling AlertsApi->createTarget: %s\n" % e)

Parameters

Body parameters
Name Description
body
Query parameters
Name Description
validate_config
overwrite_existing

Responses

Status: 201 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 500 - Internal server error


deleteTarget

Deletes an alert target


/alert_targets/{targetId}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/alert_targets/{targetId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertsApi;

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

public class AlertsApiExample {

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

public class AlertsApiExample {

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

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

// Deletes an alert target
[apiInstance deleteTargetWith:targetId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.AlertsApi()

var targetId = 789; // {Long} 


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

namespace Example
{
    public class deleteTargetExample
    {
        public void main()
        {
            
            var apiInstance = new AlertsApi();
            var targetId = 789;  // Long | 

            try
            {
                // Deletes an alert target
                apiInstance.deleteTarget(targetId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertsApi.deleteTarget: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AlertsApi();
$targetId = 789; // Long | 

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

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

eval { 
    $api_instance->deleteTarget(targetId => $targetId);
};
if ($@) {
    warn "Exception when calling AlertsApi->deleteTarget: $@\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.AlertsApi()
targetId = 789 # Long | 

try: 
    # Deletes an alert target
    api_instance.deleteTarget(targetId)
except ApiException as e:
    print("Exception when calling AlertsApi->deleteTarget: %s\n" % e)

Parameters

Path parameters
Name Description
targetId*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 500 - Internal server error


getTarget

Returns a single alert target


/alert_targets/{targetId}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/alert_targets/{targetId}?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertsApi;

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

public class AlertsApiExample {

    public static void main(String[] args) {
        
        AlertsApi apiInstance = new AlertsApi();
        Long targetId = 789; // Long | alert target id
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            AlertTargetSwagger result = apiInstance.getTarget(targetId, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#getTarget");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertsApi;

public class AlertsApiExample {

    public static void main(String[] args) {
        AlertsApi apiInstance = new AlertsApi();
        Long targetId = 789; // Long | alert target id
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            AlertTargetSwagger result = apiInstance.getTarget(targetId, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#getTarget");
            e.printStackTrace();
        }
    }
}
Long *targetId = 789; // alert target id
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to AlertTarget/*)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
Integer *from = 56; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
Integer *to = 56; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Returns a single alert target
[apiInstance getTargetWith:targetId
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(AlertTargetSwagger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.AlertsApi()

var targetId = 789; // {Long} alert target id

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': 56, // {Integer} The starting page resource (inclusive).  "start" is also accepted.
  'to': 56 // {Integer} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class getTargetExample
    {
        public void main()
        {
            
            var apiInstance = new AlertsApi();
            var targetId = 789;  // Long | alert target id
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to AlertTarget/*)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional) 
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = 56;  // Integer | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = 56;  // Integer | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Returns a single alert target
                AlertTargetSwagger result = apiInstance.getTarget(targetId, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertsApi.getTarget: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AlertsApi();
$targetId = 789; // Long | alert target id
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
$to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->getTarget($targetId, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->getTarget: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertsApi;

my $api_instance = WWW::SwaggerClient::AlertsApi->new();
my $targetId = 789; # Long | alert target id
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = 56; # Integer | The starting page resource (inclusive).  "start" is also accepted.
my $to = 56; # Integer | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->getTarget(targetId => $targetId, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertsApi->getTarget: $@\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.AlertsApi()
targetId = 789 # Long | alert target id
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to AlertTarget/*)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = 56 # Integer | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = 56 # Integer | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Returns a single alert target
    api_response = api_instance.getTarget(targetId, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertsApi->getTarget: %s\n" % e)

Parameters

Path parameters
Name Description
targetId*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


getTargets

Returns all alert targets


/alert_targets

Usage and SDK Samples

curl -X get "https://localhost/api/v1/alert_targets?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertsApi;

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

public class AlertsApiExample {

    public static void main(String[] args) {
        
        AlertsApi apiInstance = new AlertsApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[AlertTargetSwagger] result = apiInstance.getTargets(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#getTargets");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertsApi;

public class AlertsApiExample {

    public static void main(String[] args) {
        AlertsApi apiInstance = new AlertsApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[AlertTargetSwagger] result = apiInstance.getTargets(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#getTargets");
            e.printStackTrace();
        }
    }
}
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to AlertTarget/*)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
Integer *from = 56; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
Integer *to = 56; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Returns all alert targets
[apiInstance getTargetsWith:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[AlertTargetSwagger] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.AlertsApi()

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': 56, // {Integer} The starting page resource (inclusive).  "start" is also accepted.
  'to': 56 // {Integer} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class getTargetsExample
    {
        public void main()
        {
            
            var apiInstance = new AlertsApi();
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to AlertTarget/*)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional) 
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = 56;  // Integer | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = 56;  // Integer | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Returns all alert targets
                array[AlertTargetSwagger] result = apiInstance.getTargets(fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertsApi.getTargets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AlertsApi();
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
$to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.

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

my $api_instance = WWW::SwaggerClient::AlertsApi->new();
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = 56; # Integer | The starting page resource (inclusive).  "start" is also accepted.
my $to = 56; # Integer | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->getTargets(fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertsApi->getTargets: $@\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.AlertsApi()
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to AlertTarget/*)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = 56 # Integer | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = 56 # Integer | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Returns all alert targets
    api_response = api_instance.getTargets(fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertsApi->getTargets: %s\n" % e)

Parameters

Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


updateTarget

Updates an alert target


/alert_targets/{targetId}

Usage and SDK Samples

curl -X put "https://localhost/api/v1/alert_targets/{targetId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertsApi;

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

public class AlertsApiExample {

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

public class AlertsApiExample {

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

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

// Updates an alert target
[apiInstance updateTargetWith:targetId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.AlertsApi()

var targetId = 789; // {Long} 

var opts = { 
  'body':  // {AlertTargetSwagger} 
};

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

namespace Example
{
    public class updateTargetExample
    {
        public void main()
        {
            
            var apiInstance = new AlertsApi();
            var targetId = 789;  // Long | 
            var body = new AlertTargetSwagger(); // AlertTargetSwagger |  (optional) 

            try
            {
                // Updates an alert target
                apiInstance.updateTarget(targetId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertsApi.updateTarget: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AlertsApi();
$targetId = 789; // Long | 
$body = ; // AlertTargetSwagger | 

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

my $api_instance = WWW::SwaggerClient::AlertsApi->new();
my $targetId = 789; # Long | 
my $body = WWW::SwaggerClient::Object::AlertTargetSwagger->new(); # AlertTargetSwagger | 

eval { 
    $api_instance->updateTarget(targetId => $targetId, body => $body);
};
if ($@) {
    warn "Exception when calling AlertsApi->updateTarget: $@\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.AlertsApi()
targetId = 789 # Long | 
body =  # AlertTargetSwagger |  (optional)

try: 
    # Updates an alert target
    api_instance.updateTarget(targetId, body=body)
except ApiException as e:
    print("Exception when calling AlertsApi->updateTarget: %s\n" % e)

Parameters

Path parameters
Name Description
targetId*
Body parameters
Name Description
body

Responses

Status: 200 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 500 - Internal server error


Blueprints

blueprintServiceCreateBlueprint

Creates a blueprint


/blueprints/{blueprintName}

Usage and SDK Samples

curl -X post "https://localhost/api/v1/blueprints/{blueprintName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlueprintsApi;

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

public class BlueprintsApiExample {

    public static void main(String[] args) {
        
        BlueprintsApi apiInstance = new BlueprintsApi();
        String blueprintName = blueprintName_example; // String | 
        BlueprintSwagger body = ; // BlueprintSwagger | 
        try {
            apiInstance.blueprintServiceCreateBlueprint(blueprintName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintsApi#blueprintServiceCreateBlueprint");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlueprintsApi;

public class BlueprintsApiExample {

    public static void main(String[] args) {
        BlueprintsApi apiInstance = new BlueprintsApi();
        String blueprintName = blueprintName_example; // String | 
        BlueprintSwagger body = ; // BlueprintSwagger | 
        try {
            apiInstance.blueprintServiceCreateBlueprint(blueprintName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintsApi#blueprintServiceCreateBlueprint");
            e.printStackTrace();
        }
    }
}
String *blueprintName = blueprintName_example; // 
BlueprintSwagger *body = ; //  (optional)

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

// Creates a blueprint
[apiInstance blueprintServiceCreateBlueprintWith:blueprintName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.BlueprintsApi()

var blueprintName = blueprintName_example; // {String} 

var opts = { 
  'body':  // {BlueprintSwagger} 
};

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

namespace Example
{
    public class blueprintServiceCreateBlueprintExample
    {
        public void main()
        {
            
            var apiInstance = new BlueprintsApi();
            var blueprintName = blueprintName_example;  // String | 
            var body = new BlueprintSwagger(); // BlueprintSwagger |  (optional) 

            try
            {
                // Creates a blueprint
                apiInstance.blueprintServiceCreateBlueprint(blueprintName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlueprintsApi.blueprintServiceCreateBlueprint: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BlueprintsApi();
$blueprintName = blueprintName_example; // String | 
$body = ; // BlueprintSwagger | 

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

my $api_instance = WWW::SwaggerClient::BlueprintsApi->new();
my $blueprintName = blueprintName_example; # String | 
my $body = WWW::SwaggerClient::Object::BlueprintSwagger->new(); # BlueprintSwagger | 

eval { 
    $api_instance->blueprintServiceCreateBlueprint(blueprintName => $blueprintName, body => $body);
};
if ($@) {
    warn "Exception when calling BlueprintsApi->blueprintServiceCreateBlueprint: $@\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.BlueprintsApi()
blueprintName = blueprintName_example # String | 
body =  # BlueprintSwagger |  (optional)

try: 
    # Creates a blueprint
    api_instance.blueprintServiceCreateBlueprint(blueprintName, body=body)
except ApiException as e:
    print("Exception when calling BlueprintsApi->blueprintServiceCreateBlueprint: %s\n" % e)

Parameters

Path parameters
Name Description
blueprintName*
Body parameters
Name Description
body

Responses

Status: 201 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - The requested resource doesn't exist.

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 409 - The requested resource already exists.

Status: 500 - Internal server error


blueprintServiceDeleteBlueprint

Deletes a blueprint


/blueprints/{blueprintName}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/blueprints/{blueprintName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlueprintsApi;

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

public class BlueprintsApiExample {

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

public class BlueprintsApiExample {

    public static void main(String[] args) {
        BlueprintsApi apiInstance = new BlueprintsApi();
        String blueprintName = blueprintName_example; // String | 
        try {
            apiInstance.blueprintServiceDeleteBlueprint(blueprintName);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintsApi#blueprintServiceDeleteBlueprint");
            e.printStackTrace();
        }
    }
}
String *blueprintName = blueprintName_example; // 

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

// Deletes a blueprint
[apiInstance blueprintServiceDeleteBlueprintWith:blueprintName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.BlueprintsApi()

var blueprintName = blueprintName_example; // {String} 


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

namespace Example
{
    public class blueprintServiceDeleteBlueprintExample
    {
        public void main()
        {
            
            var apiInstance = new BlueprintsApi();
            var blueprintName = blueprintName_example;  // String | 

            try
            {
                // Deletes a blueprint
                apiInstance.blueprintServiceDeleteBlueprint(blueprintName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlueprintsApi.blueprintServiceDeleteBlueprint: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BlueprintsApi();
$blueprintName = blueprintName_example; // String | 

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

my $api_instance = WWW::SwaggerClient::BlueprintsApi->new();
my $blueprintName = blueprintName_example; # String | 

eval { 
    $api_instance->blueprintServiceDeleteBlueprint(blueprintName => $blueprintName);
};
if ($@) {
    warn "Exception when calling BlueprintsApi->blueprintServiceDeleteBlueprint: $@\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.BlueprintsApi()
blueprintName = blueprintName_example # String | 

try: 
    # Deletes a blueprint
    api_instance.blueprintServiceDeleteBlueprint(blueprintName)
except ApiException as e:
    print("Exception when calling BlueprintsApi->blueprintServiceDeleteBlueprint: %s\n" % e)

Parameters

Path parameters
Name Description
blueprintName*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


blueprintServiceDeleteBlueprints

Deletes multiple blueprints that match the predicate. Omitting the predicate will delete all blueprints.


/blueprints

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/blueprints"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlueprintsApi;

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

public class BlueprintsApiExample {

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

public class BlueprintsApiExample {

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

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

// Deletes multiple blueprints that match the predicate. Omitting the predicate will delete all blueprints.
[apiInstance blueprintServiceDeleteBlueprintsWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.BlueprintsApi()

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

namespace Example
{
    public class blueprintServiceDeleteBlueprintsExample
    {
        public void main()
        {
            
            var apiInstance = new BlueprintsApi();

            try
            {
                // Deletes multiple blueprints that match the predicate. Omitting the predicate will delete all blueprints.
                apiInstance.blueprintServiceDeleteBlueprints();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlueprintsApi.blueprintServiceDeleteBlueprints: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BlueprintsApi();

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

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

eval { 
    $api_instance->blueprintServiceDeleteBlueprints();
};
if ($@) {
    warn "Exception when calling BlueprintsApi->blueprintServiceDeleteBlueprints: $@\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.BlueprintsApi()

try: 
    # Deletes multiple blueprints that match the predicate. Omitting the predicate will delete all blueprints.
    api_instance.blueprintServiceDeleteBlueprints()
except ApiException as e:
    print("Exception when calling BlueprintsApi->blueprintServiceDeleteBlueprints: %s\n" % e)

Parameters

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


blueprintServiceGetBlueprint

Get the details of a blueprint


/blueprints/{blueprintName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/blueprints/{blueprintName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlueprintsApi;

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

public class BlueprintsApiExample {

    public static void main(String[] args) {
        
        BlueprintsApi apiInstance = new BlueprintsApi();
        String blueprintName = blueprintName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            array[BlueprintSwagger] result = apiInstance.blueprintServiceGetBlueprint(blueprintName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintsApi#blueprintServiceGetBlueprint");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlueprintsApi;

public class BlueprintsApiExample {

    public static void main(String[] args) {
        BlueprintsApi apiInstance = new BlueprintsApi();
        String blueprintName = blueprintName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            array[BlueprintSwagger] result = apiInstance.blueprintServiceGetBlueprint(blueprintName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintsApi#blueprintServiceGetBlueprint");
            e.printStackTrace();
        }
    }
}
String *blueprintName = blueprintName_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Blueprints/*)

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

// Get the details of a blueprint
[apiInstance blueprintServiceGetBlueprintWith:blueprintName
    fields:fields
              completionHandler: ^(array[BlueprintSwagger] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.BlueprintsApi()

var blueprintName = blueprintName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class blueprintServiceGetBlueprintExample
    {
        public void main()
        {
            
            var apiInstance = new BlueprintsApi();
            var blueprintName = blueprintName_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Blueprints/*)

            try
            {
                // Get the details of a blueprint
                array[BlueprintSwagger] result = apiInstance.blueprintServiceGetBlueprint(blueprintName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlueprintsApi.blueprintServiceGetBlueprint: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BlueprintsApi();
$blueprintName = blueprintName_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::BlueprintsApi->new();
my $blueprintName = blueprintName_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->blueprintServiceGetBlueprint(blueprintName => $blueprintName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BlueprintsApi->blueprintServiceGetBlueprint: $@\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.BlueprintsApi()
blueprintName = blueprintName_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Blueprints/*)

try: 
    # Get the details of a blueprint
    api_response = api_instance.blueprintServiceGetBlueprint(blueprintName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlueprintsApi->blueprintServiceGetBlueprint: %s\n" % e)

Parameters

Path parameters
Name Description
blueprintName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


blueprintServiceGetBlueprints

Get all blueprints


/blueprints

Usage and SDK Samples

curl -X get "https://localhost/api/v1/blueprints?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlueprintsApi;

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

public class BlueprintsApiExample {

    public static void main(String[] args) {
        
        BlueprintsApi apiInstance = new BlueprintsApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[BlueprintSwagger] result = apiInstance.blueprintServiceGetBlueprints(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintsApi#blueprintServiceGetBlueprints");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlueprintsApi;

public class BlueprintsApiExample {

    public static void main(String[] args) {
        BlueprintsApi apiInstance = new BlueprintsApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[BlueprintSwagger] result = apiInstance.blueprintServiceGetBlueprints(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlueprintsApi#blueprintServiceGetBlueprints");
            e.printStackTrace();
        }
    }
}
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Blueprints/blueprint_name)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional) (default to Blueprints/blueprint_name.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all blueprints
[apiInstance blueprintServiceGetBlueprintsWith:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[BlueprintSwagger] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.BlueprintsApi()

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive).  "start" is also accepted.
  'to': to_example // {String} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class blueprintServiceGetBlueprintsExample
    {
        public void main()
        {
            
            var apiInstance = new BlueprintsApi();
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Blueprints/blueprint_name)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional)  (default to Blueprints/blueprint_name.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all blueprints
                array[BlueprintSwagger] result = apiInstance.blueprintServiceGetBlueprints(fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlueprintsApi.blueprintServiceGetBlueprints: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\BlueprintsApi();
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
$to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.

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

my $api_instance = WWW::SwaggerClient::BlueprintsApi->new();
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive).  "start" is also accepted.
my $to = to_example; # String | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->blueprintServiceGetBlueprints(fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BlueprintsApi->blueprintServiceGetBlueprints: $@\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.BlueprintsApi()
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Blueprints/blueprint_name)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional) (default to Blueprints/blueprint_name.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all blueprints
    api_response = api_instance.blueprintServiceGetBlueprints(fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlueprintsApi->blueprintServiceGetBlueprints: %s\n" % e)

Parameters

Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 500 - Internal server error


ClusterServices

serviceServiceCreateArtifact

Creates a service artifact


/clusters/{clusterName}/services/{serviceName}/artifacts/{artifactName}

Usage and SDK Samples

curl -X post "https://localhost/api/v1/clusters/{clusterName}/services/{serviceName}/artifacts/{artifactName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClusterServicesApi;

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

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String artifactName = artifactName_example; // String | 
        String clusterName = clusterName_example; // String | 
        ClusterServiceArtifactRequest body = ; // ClusterServiceArtifactRequest | 
        try {
            apiInstance.serviceServiceCreateArtifact(serviceName, artifactName, clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceCreateArtifact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClusterServicesApi;

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String artifactName = artifactName_example; // String | 
        String clusterName = clusterName_example; // String | 
        ClusterServiceArtifactRequest body = ; // ClusterServiceArtifactRequest | 
        try {
            apiInstance.serviceServiceCreateArtifact(serviceName, artifactName, clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceCreateArtifact");
            e.printStackTrace();
        }
    }
}
String *serviceName = serviceName_example; // 
String *artifactName = artifactName_example; // 
String *clusterName = clusterName_example; // 
ClusterServiceArtifactRequest *body = ; //  (optional)

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

// Creates a service artifact
[apiInstance serviceServiceCreateArtifactWith:serviceName
    artifactName:artifactName
    clusterName:clusterName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClusterServicesApi()

var serviceName = serviceName_example; // {String} 

var artifactName = artifactName_example; // {String} 

var clusterName = clusterName_example; // {String} 

var opts = { 
  'body':  // {ClusterServiceArtifactRequest} 
};

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

namespace Example
{
    public class serviceServiceCreateArtifactExample
    {
        public void main()
        {
            
            var apiInstance = new ClusterServicesApi();
            var serviceName = serviceName_example;  // String | 
            var artifactName = artifactName_example;  // String | 
            var clusterName = clusterName_example;  // String | 
            var body = new ClusterServiceArtifactRequest(); // ClusterServiceArtifactRequest |  (optional) 

            try
            {
                // Creates a service artifact
                apiInstance.serviceServiceCreateArtifact(serviceName, artifactName, clusterName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClusterServicesApi.serviceServiceCreateArtifact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClusterServicesApi();
$serviceName = serviceName_example; // String | 
$artifactName = artifactName_example; // String | 
$clusterName = clusterName_example; // String | 
$body = ; // ClusterServiceArtifactRequest | 

try {
    $api_instance->serviceServiceCreateArtifact($serviceName, $artifactName, $clusterName, $body);
} catch (Exception $e) {
    echo 'Exception when calling ClusterServicesApi->serviceServiceCreateArtifact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ClusterServicesApi;

my $api_instance = WWW::SwaggerClient::ClusterServicesApi->new();
my $serviceName = serviceName_example; # String | 
my $artifactName = artifactName_example; # String | 
my $clusterName = clusterName_example; # String | 
my $body = WWW::SwaggerClient::Object::ClusterServiceArtifactRequest->new(); # ClusterServiceArtifactRequest | 

eval { 
    $api_instance->serviceServiceCreateArtifact(serviceName => $serviceName, artifactName => $artifactName, clusterName => $clusterName, body => $body);
};
if ($@) {
    warn "Exception when calling ClusterServicesApi->serviceServiceCreateArtifact: $@\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.ClusterServicesApi()
serviceName = serviceName_example # String | 
artifactName = artifactName_example # String | 
clusterName = clusterName_example # String | 
body =  # ClusterServiceArtifactRequest |  (optional)

try: 
    # Creates a service artifact
    api_instance.serviceServiceCreateArtifact(serviceName, artifactName, clusterName, body=body)
except ApiException as e:
    print("Exception when calling ClusterServicesApi->serviceServiceCreateArtifact: %s\n" % e)

Parameters

Path parameters
Name Description
serviceName*
artifactName*
clusterName*
Body parameters
Name Description
body

Responses

Status: 201 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 409 - The requested resource already exists.

Status: 500 - Internal server error


serviceServiceCreateServices

Creates a service


/clusters/{clusterName}/services/{serviceName}

Usage and SDK Samples

curl -X post "https://localhost/api/v1/clusters/{clusterName}/services/{serviceName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClusterServicesApi;

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

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String clusterName = clusterName_example; // String | 
        ServiceRequestSwagger body = ; // ServiceRequestSwagger | 
        try {
            apiInstance.serviceServiceCreateServices(serviceName, clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceCreateServices");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClusterServicesApi;

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String clusterName = clusterName_example; // String | 
        ServiceRequestSwagger body = ; // ServiceRequestSwagger | 
        try {
            apiInstance.serviceServiceCreateServices(serviceName, clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceCreateServices");
            e.printStackTrace();
        }
    }
}
String *serviceName = serviceName_example; // 
String *clusterName = clusterName_example; // 
ServiceRequestSwagger *body = ; //  (optional)

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

// Creates a service
[apiInstance serviceServiceCreateServicesWith:serviceName
    clusterName:clusterName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClusterServicesApi()

var serviceName = serviceName_example; // {String} 

var clusterName = clusterName_example; // {String} 

var opts = { 
  'body':  // {ServiceRequestSwagger} 
};

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

namespace Example
{
    public class serviceServiceCreateServicesExample
    {
        public void main()
        {
            
            var apiInstance = new ClusterServicesApi();
            var serviceName = serviceName_example;  // String | 
            var clusterName = clusterName_example;  // String | 
            var body = new ServiceRequestSwagger(); // ServiceRequestSwagger |  (optional) 

            try
            {
                // Creates a service
                apiInstance.serviceServiceCreateServices(serviceName, clusterName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClusterServicesApi.serviceServiceCreateServices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClusterServicesApi();
$serviceName = serviceName_example; // String | 
$clusterName = clusterName_example; // String | 
$body = ; // ServiceRequestSwagger | 

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

my $api_instance = WWW::SwaggerClient::ClusterServicesApi->new();
my $serviceName = serviceName_example; # String | 
my $clusterName = clusterName_example; # String | 
my $body = WWW::SwaggerClient::Object::ServiceRequestSwagger->new(); # ServiceRequestSwagger | 

eval { 
    $api_instance->serviceServiceCreateServices(serviceName => $serviceName, clusterName => $clusterName, body => $body);
};
if ($@) {
    warn "Exception when calling ClusterServicesApi->serviceServiceCreateServices: $@\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.ClusterServicesApi()
serviceName = serviceName_example # String | 
clusterName = clusterName_example # String | 
body =  # ServiceRequestSwagger |  (optional)

try: 
    # Creates a service
    api_instance.serviceServiceCreateServices(serviceName, clusterName, body=body)
except ApiException as e:
    print("Exception when calling ClusterServicesApi->serviceServiceCreateServices: %s\n" % e)

Parameters

Path parameters
Name Description
serviceName*
clusterName*
Body parameters
Name Description
body

Responses

Status: 201 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 409 - The requested resource already exists.

Status: 500 - Internal server error


serviceServiceDeleteArtifact

Deletes a single service artifact


/clusters/{clusterName}/services/{serviceName}/artifacts/{artifactName}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/clusters/{clusterName}/services/{serviceName}/artifacts/{artifactName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClusterServicesApi;

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

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String artifactName = artifactName_example; // String | 
        String clusterName = clusterName_example; // String | 
        try {
            apiInstance.serviceServiceDeleteArtifact(serviceName, artifactName, clusterName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceDeleteArtifact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClusterServicesApi;

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String artifactName = artifactName_example; // String | 
        String clusterName = clusterName_example; // String | 
        try {
            apiInstance.serviceServiceDeleteArtifact(serviceName, artifactName, clusterName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceDeleteArtifact");
            e.printStackTrace();
        }
    }
}
String *serviceName = serviceName_example; // 
String *artifactName = artifactName_example; // 
String *clusterName = clusterName_example; // 

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

// Deletes a single service artifact
[apiInstance serviceServiceDeleteArtifactWith:serviceName
    artifactName:artifactName
    clusterName:clusterName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClusterServicesApi()

var serviceName = serviceName_example; // {String} 

var artifactName = artifactName_example; // {String} 

var clusterName = clusterName_example; // {String} 


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

namespace Example
{
    public class serviceServiceDeleteArtifactExample
    {
        public void main()
        {
            
            var apiInstance = new ClusterServicesApi();
            var serviceName = serviceName_example;  // String | 
            var artifactName = artifactName_example;  // String | 
            var clusterName = clusterName_example;  // String | 

            try
            {
                // Deletes a single service artifact
                apiInstance.serviceServiceDeleteArtifact(serviceName, artifactName, clusterName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClusterServicesApi.serviceServiceDeleteArtifact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClusterServicesApi();
$serviceName = serviceName_example; // String | 
$artifactName = artifactName_example; // String | 
$clusterName = clusterName_example; // String | 

try {
    $api_instance->serviceServiceDeleteArtifact($serviceName, $artifactName, $clusterName);
} catch (Exception $e) {
    echo 'Exception when calling ClusterServicesApi->serviceServiceDeleteArtifact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ClusterServicesApi;

my $api_instance = WWW::SwaggerClient::ClusterServicesApi->new();
my $serviceName = serviceName_example; # String | 
my $artifactName = artifactName_example; # String | 
my $clusterName = clusterName_example; # String | 

eval { 
    $api_instance->serviceServiceDeleteArtifact(serviceName => $serviceName, artifactName => $artifactName, clusterName => $clusterName);
};
if ($@) {
    warn "Exception when calling ClusterServicesApi->serviceServiceDeleteArtifact: $@\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.ClusterServicesApi()
serviceName = serviceName_example # String | 
artifactName = artifactName_example # String | 
clusterName = clusterName_example # String | 

try: 
    # Deletes a single service artifact
    api_instance.serviceServiceDeleteArtifact(serviceName, artifactName, clusterName)
except ApiException as e:
    print("Exception when calling ClusterServicesApi->serviceServiceDeleteArtifact: %s\n" % e)

Parameters

Path parameters
Name Description
serviceName*
artifactName*
clusterName*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


serviceServiceDeleteArtifacts

Deletes all artifacts of a service that match the provided predicate


/clusters/{clusterName}/services/{serviceName}/artifacts

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/clusters/{clusterName}/services/{serviceName}/artifacts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClusterServicesApi;

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

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String clusterName = clusterName_example; // String | 
        try {
            apiInstance.serviceServiceDeleteArtifacts(serviceName, clusterName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceDeleteArtifacts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClusterServicesApi;

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String clusterName = clusterName_example; // String | 
        try {
            apiInstance.serviceServiceDeleteArtifacts(serviceName, clusterName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceDeleteArtifacts");
            e.printStackTrace();
        }
    }
}
String *serviceName = serviceName_example; // 
String *clusterName = clusterName_example; // 

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

// Deletes all artifacts of a service that match the provided predicate
[apiInstance serviceServiceDeleteArtifactsWith:serviceName
    clusterName:clusterName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClusterServicesApi()

var serviceName = serviceName_example; // {String} 

var clusterName = clusterName_example; // {String} 


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

namespace Example
{
    public class serviceServiceDeleteArtifactsExample
    {
        public void main()
        {
            
            var apiInstance = new ClusterServicesApi();
            var serviceName = serviceName_example;  // String | 
            var clusterName = clusterName_example;  // String | 

            try
            {
                // Deletes all artifacts of a service that match the provided predicate
                apiInstance.serviceServiceDeleteArtifacts(serviceName, clusterName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClusterServicesApi.serviceServiceDeleteArtifacts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClusterServicesApi();
$serviceName = serviceName_example; // String | 
$clusterName = clusterName_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ClusterServicesApi->new();
my $serviceName = serviceName_example; # String | 
my $clusterName = clusterName_example; # String | 

eval { 
    $api_instance->serviceServiceDeleteArtifacts(serviceName => $serviceName, clusterName => $clusterName);
};
if ($@) {
    warn "Exception when calling ClusterServicesApi->serviceServiceDeleteArtifacts: $@\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.ClusterServicesApi()
serviceName = serviceName_example # String | 
clusterName = clusterName_example # String | 

try: 
    # Deletes all artifacts of a service that match the provided predicate
    api_instance.serviceServiceDeleteArtifacts(serviceName, clusterName)
except ApiException as e:
    print("Exception when calling ClusterServicesApi->serviceServiceDeleteArtifacts: %s\n" % e)

Parameters

Path parameters
Name Description
serviceName*
clusterName*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


serviceServiceDeleteService

Deletes a service


/clusters/{clusterName}/services/{serviceName}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/clusters/{clusterName}/services/{serviceName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClusterServicesApi;

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

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String clusterName = clusterName_example; // String | 
        try {
            apiInstance.serviceServiceDeleteService(serviceName, clusterName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceDeleteService");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClusterServicesApi;

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String clusterName = clusterName_example; // String | 
        try {
            apiInstance.serviceServiceDeleteService(serviceName, clusterName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceDeleteService");
            e.printStackTrace();
        }
    }
}
String *serviceName = serviceName_example; // 
String *clusterName = clusterName_example; // 

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

// Deletes a service
[apiInstance serviceServiceDeleteServiceWith:serviceName
    clusterName:clusterName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClusterServicesApi()

var serviceName = serviceName_example; // {String} 

var clusterName = clusterName_example; // {String} 


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

namespace Example
{
    public class serviceServiceDeleteServiceExample
    {
        public void main()
        {
            
            var apiInstance = new ClusterServicesApi();
            var serviceName = serviceName_example;  // String | 
            var clusterName = clusterName_example;  // String | 

            try
            {
                // Deletes a service
                apiInstance.serviceServiceDeleteService(serviceName, clusterName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClusterServicesApi.serviceServiceDeleteService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClusterServicesApi();
$serviceName = serviceName_example; // String | 
$clusterName = clusterName_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ClusterServicesApi->new();
my $serviceName = serviceName_example; # String | 
my $clusterName = clusterName_example; # String | 

eval { 
    $api_instance->serviceServiceDeleteService(serviceName => $serviceName, clusterName => $clusterName);
};
if ($@) {
    warn "Exception when calling ClusterServicesApi->serviceServiceDeleteService: $@\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.ClusterServicesApi()
serviceName = serviceName_example # String | 
clusterName = clusterName_example # String | 

try: 
    # Deletes a service
    api_instance.serviceServiceDeleteService(serviceName, clusterName)
except ApiException as e:
    print("Exception when calling ClusterServicesApi->serviceServiceDeleteService: %s\n" % e)

Parameters

Path parameters
Name Description
serviceName*
clusterName*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


serviceServiceGetArtifact

Get the details of a service artifact


/clusters/{clusterName}/services/{serviceName}/artifacts/{artifactName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/clusters/{clusterName}/services/{serviceName}/artifacts/{artifactName}?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClusterServicesApi;

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

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String artifactName = artifactName_example; // String | 
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ClusterServiceArtifactResponse] result = apiInstance.serviceServiceGetArtifact(serviceName, artifactName, clusterName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceGetArtifact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClusterServicesApi;

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String artifactName = artifactName_example; // String | 
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ClusterServiceArtifactResponse] result = apiInstance.serviceServiceGetArtifact(serviceName, artifactName, clusterName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceGetArtifact");
            e.printStackTrace();
        }
    }
}
String *serviceName = serviceName_example; // 
String *artifactName = artifactName_example; // 
String *clusterName = clusterName_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Artifacts/artifact_name)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional) (default to Artifacts/artifact_name)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get the details of a service artifact
[apiInstance serviceServiceGetArtifactWith:serviceName
    artifactName:artifactName
    clusterName:clusterName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[ClusterServiceArtifactResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClusterServicesApi()

var serviceName = serviceName_example; // {String} 

var artifactName = artifactName_example; // {String} 

var clusterName = clusterName_example; // {String} 

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive).  "start" is also accepted.
  'to': to_example // {String} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class serviceServiceGetArtifactExample
    {
        public void main()
        {
            
            var apiInstance = new ClusterServicesApi();
            var serviceName = serviceName_example;  // String | 
            var artifactName = artifactName_example;  // String | 
            var clusterName = clusterName_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Artifacts/artifact_name)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional)  (default to Artifacts/artifact_name)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get the details of a service artifact
                array[ClusterServiceArtifactResponse] result = apiInstance.serviceServiceGetArtifact(serviceName, artifactName, clusterName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClusterServicesApi.serviceServiceGetArtifact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClusterServicesApi();
$serviceName = serviceName_example; // String | 
$artifactName = artifactName_example; // String | 
$clusterName = clusterName_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
$to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->serviceServiceGetArtifact($serviceName, $artifactName, $clusterName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClusterServicesApi->serviceServiceGetArtifact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ClusterServicesApi;

my $api_instance = WWW::SwaggerClient::ClusterServicesApi->new();
my $serviceName = serviceName_example; # String | 
my $artifactName = artifactName_example; # String | 
my $clusterName = clusterName_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive).  "start" is also accepted.
my $to = to_example; # String | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->serviceServiceGetArtifact(serviceName => $serviceName, artifactName => $artifactName, clusterName => $clusterName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClusterServicesApi->serviceServiceGetArtifact: $@\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.ClusterServicesApi()
serviceName = serviceName_example # String | 
artifactName = artifactName_example # String | 
clusterName = clusterName_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Artifacts/artifact_name)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional) (default to Artifacts/artifact_name)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get the details of a service artifact
    api_response = api_instance.serviceServiceGetArtifact(serviceName, artifactName, clusterName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClusterServicesApi->serviceServiceGetArtifact: %s\n" % e)

Parameters

Path parameters
Name Description
serviceName*
artifactName*
clusterName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


serviceServiceGetArtifacts

Get all service artifacts


/clusters/{clusterName}/services/{serviceName}/artifacts

Usage and SDK Samples

curl -X get "https://localhost/api/v1/clusters/{clusterName}/services/{serviceName}/artifacts?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClusterServicesApi;

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

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ClusterServiceArtifactResponse] result = apiInstance.serviceServiceGetArtifacts(serviceName, clusterName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceGetArtifacts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClusterServicesApi;

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ClusterServiceArtifactResponse] result = apiInstance.serviceServiceGetArtifacts(serviceName, clusterName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceGetArtifacts");
            e.printStackTrace();
        }
    }
}
String *serviceName = serviceName_example; // 
String *clusterName = clusterName_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Artifacts/artifact_name)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional) (default to Artifacts/artifact_name)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all service artifacts
[apiInstance serviceServiceGetArtifactsWith:serviceName
    clusterName:clusterName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[ClusterServiceArtifactResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClusterServicesApi()

var serviceName = serviceName_example; // {String} 

var clusterName = clusterName_example; // {String} 

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive).  "start" is also accepted.
  'to': to_example // {String} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class serviceServiceGetArtifactsExample
    {
        public void main()
        {
            
            var apiInstance = new ClusterServicesApi();
            var serviceName = serviceName_example;  // String | 
            var clusterName = clusterName_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Artifacts/artifact_name)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional)  (default to Artifacts/artifact_name)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all service artifacts
                array[ClusterServiceArtifactResponse] result = apiInstance.serviceServiceGetArtifacts(serviceName, clusterName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClusterServicesApi.serviceServiceGetArtifacts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClusterServicesApi();
$serviceName = serviceName_example; // String | 
$clusterName = clusterName_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
$to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->serviceServiceGetArtifacts($serviceName, $clusterName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClusterServicesApi->serviceServiceGetArtifacts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ClusterServicesApi;

my $api_instance = WWW::SwaggerClient::ClusterServicesApi->new();
my $serviceName = serviceName_example; # String | 
my $clusterName = clusterName_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive).  "start" is also accepted.
my $to = to_example; # String | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->serviceServiceGetArtifacts(serviceName => $serviceName, clusterName => $clusterName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClusterServicesApi->serviceServiceGetArtifacts: $@\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.ClusterServicesApi()
serviceName = serviceName_example # String | 
clusterName = clusterName_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Artifacts/artifact_name)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional) (default to Artifacts/artifact_name)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all service artifacts
    api_response = api_instance.serviceServiceGetArtifacts(serviceName, clusterName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClusterServicesApi->serviceServiceGetArtifacts: %s\n" % e)

Parameters

Path parameters
Name Description
serviceName*
clusterName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


serviceServiceGetService

Get the details of a service

Returns the details of a service.


/clusters/{clusterName}/services/{serviceName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/clusters/{clusterName}/services/{serviceName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClusterServicesApi;

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

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            array[ServiceResponseSwagger] result = apiInstance.serviceServiceGetService(serviceName, clusterName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceGetService");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClusterServicesApi;

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            array[ServiceResponseSwagger] result = apiInstance.serviceServiceGetService(serviceName, clusterName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceGetService");
            e.printStackTrace();
        }
    }
}
String *serviceName = serviceName_example; // 
String *clusterName = clusterName_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to ServiceInfo/*)

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

// Get the details of a service
[apiInstance serviceServiceGetServiceWith:serviceName
    clusterName:clusterName
    fields:fields
              completionHandler: ^(array[ServiceResponseSwagger] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClusterServicesApi()

var serviceName = serviceName_example; // {String} 

var clusterName = clusterName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class serviceServiceGetServiceExample
    {
        public void main()
        {
            
            var apiInstance = new ClusterServicesApi();
            var serviceName = serviceName_example;  // String | 
            var clusterName = clusterName_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to ServiceInfo/*)

            try
            {
                // Get the details of a service
                array[ServiceResponseSwagger] result = apiInstance.serviceServiceGetService(serviceName, clusterName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClusterServicesApi.serviceServiceGetService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClusterServicesApi();
$serviceName = serviceName_example; // String | 
$clusterName = clusterName_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::ClusterServicesApi->new();
my $serviceName = serviceName_example; # String | 
my $clusterName = clusterName_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->serviceServiceGetService(serviceName => $serviceName, clusterName => $clusterName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClusterServicesApi->serviceServiceGetService: $@\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.ClusterServicesApi()
serviceName = serviceName_example # String | 
clusterName = clusterName_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to ServiceInfo/*)

try: 
    # Get the details of a service
    api_response = api_instance.serviceServiceGetService(serviceName, clusterName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClusterServicesApi->serviceServiceGetService: %s\n" % e)

Parameters

Path parameters
Name Description
serviceName*
clusterName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


serviceServiceGetServices

Get all services

Returns all services.


/clusters/{clusterName}/services

Usage and SDK Samples

curl -X get "https://localhost/api/v1/clusters/{clusterName}/services?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClusterServicesApi;

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

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ServiceResponseSwagger] result = apiInstance.serviceServiceGetServices(clusterName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceGetServices");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClusterServicesApi;

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ServiceResponseSwagger] result = apiInstance.serviceServiceGetServices(clusterName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceGetServices");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to ServiceInfo/service_name,ServiceInfo/cluster_name)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional) (default to ServiceInfo/service_name.asc,ServiceInfo/cluster_name.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all services
[apiInstance serviceServiceGetServicesWith:clusterName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[ServiceResponseSwagger] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClusterServicesApi()

var clusterName = clusterName_example; // {String} 

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive).  "start" is also accepted.
  'to': to_example // {String} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class serviceServiceGetServicesExample
    {
        public void main()
        {
            
            var apiInstance = new ClusterServicesApi();
            var clusterName = clusterName_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to ServiceInfo/service_name,ServiceInfo/cluster_name)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional)  (default to ServiceInfo/service_name.asc,ServiceInfo/cluster_name.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all services
                array[ServiceResponseSwagger] result = apiInstance.serviceServiceGetServices(clusterName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClusterServicesApi.serviceServiceGetServices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClusterServicesApi();
$clusterName = clusterName_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
$to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->serviceServiceGetServices($clusterName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClusterServicesApi->serviceServiceGetServices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ClusterServicesApi;

my $api_instance = WWW::SwaggerClient::ClusterServicesApi->new();
my $clusterName = clusterName_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive).  "start" is also accepted.
my $to = to_example; # String | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->serviceServiceGetServices(clusterName => $clusterName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClusterServicesApi->serviceServiceGetServices: $@\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.ClusterServicesApi()
clusterName = clusterName_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to ServiceInfo/service_name,ServiceInfo/cluster_name)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional) (default to ServiceInfo/service_name.asc,ServiceInfo/cluster_name.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all services
    api_response = api_instance.serviceServiceGetServices(clusterName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClusterServicesApi->serviceServiceGetServices: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 500 - Internal server error


serviceServiceUpdateArtifact

Updates a single artifact


/clusters/{clusterName}/services/{serviceName}/artifacts/{artifactName}

Usage and SDK Samples

curl -X put "https://localhost/api/v1/clusters/{clusterName}/services/{serviceName}/artifacts/{artifactName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClusterServicesApi;

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

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String artifactName = artifactName_example; // String | 
        String clusterName = clusterName_example; // String | 
        ClusterServiceArtifactRequest body = ; // ClusterServiceArtifactRequest | 
        try {
            apiInstance.serviceServiceUpdateArtifact(serviceName, artifactName, clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceUpdateArtifact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClusterServicesApi;

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String artifactName = artifactName_example; // String | 
        String clusterName = clusterName_example; // String | 
        ClusterServiceArtifactRequest body = ; // ClusterServiceArtifactRequest | 
        try {
            apiInstance.serviceServiceUpdateArtifact(serviceName, artifactName, clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceUpdateArtifact");
            e.printStackTrace();
        }
    }
}
String *serviceName = serviceName_example; // 
String *artifactName = artifactName_example; // 
String *clusterName = clusterName_example; // 
ClusterServiceArtifactRequest *body = ; //  (optional)

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

// Updates a single artifact
[apiInstance serviceServiceUpdateArtifactWith:serviceName
    artifactName:artifactName
    clusterName:clusterName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClusterServicesApi()

var serviceName = serviceName_example; // {String} 

var artifactName = artifactName_example; // {String} 

var clusterName = clusterName_example; // {String} 

var opts = { 
  'body':  // {ClusterServiceArtifactRequest} 
};

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

namespace Example
{
    public class serviceServiceUpdateArtifactExample
    {
        public void main()
        {
            
            var apiInstance = new ClusterServicesApi();
            var serviceName = serviceName_example;  // String | 
            var artifactName = artifactName_example;  // String | 
            var clusterName = clusterName_example;  // String | 
            var body = new ClusterServiceArtifactRequest(); // ClusterServiceArtifactRequest |  (optional) 

            try
            {
                // Updates a single artifact
                apiInstance.serviceServiceUpdateArtifact(serviceName, artifactName, clusterName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClusterServicesApi.serviceServiceUpdateArtifact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClusterServicesApi();
$serviceName = serviceName_example; // String | 
$artifactName = artifactName_example; // String | 
$clusterName = clusterName_example; // String | 
$body = ; // ClusterServiceArtifactRequest | 

try {
    $api_instance->serviceServiceUpdateArtifact($serviceName, $artifactName, $clusterName, $body);
} catch (Exception $e) {
    echo 'Exception when calling ClusterServicesApi->serviceServiceUpdateArtifact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ClusterServicesApi;

my $api_instance = WWW::SwaggerClient::ClusterServicesApi->new();
my $serviceName = serviceName_example; # String | 
my $artifactName = artifactName_example; # String | 
my $clusterName = clusterName_example; # String | 
my $body = WWW::SwaggerClient::Object::ClusterServiceArtifactRequest->new(); # ClusterServiceArtifactRequest | 

eval { 
    $api_instance->serviceServiceUpdateArtifact(serviceName => $serviceName, artifactName => $artifactName, clusterName => $clusterName, body => $body);
};
if ($@) {
    warn "Exception when calling ClusterServicesApi->serviceServiceUpdateArtifact: $@\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.ClusterServicesApi()
serviceName = serviceName_example # String | 
artifactName = artifactName_example # String | 
clusterName = clusterName_example # String | 
body =  # ClusterServiceArtifactRequest |  (optional)

try: 
    # Updates a single artifact
    api_instance.serviceServiceUpdateArtifact(serviceName, artifactName, clusterName, body=body)
except ApiException as e:
    print("Exception when calling ClusterServicesApi->serviceServiceUpdateArtifact: %s\n" % e)

Parameters

Path parameters
Name Description
serviceName*
artifactName*
clusterName*
Body parameters
Name Description
body

Responses

Status: 200 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


serviceServiceUpdateArtifacts

Updates multiple artifacts


/clusters/{clusterName}/services/{serviceName}/artifacts

Usage and SDK Samples

curl -X put "https://localhost/api/v1/clusters/{clusterName}/services/{serviceName}/artifacts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClusterServicesApi;

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

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String clusterName = clusterName_example; // String | 
        ClusterServiceArtifactRequest body = ; // ClusterServiceArtifactRequest | 
        try {
            apiInstance.serviceServiceUpdateArtifacts(serviceName, clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceUpdateArtifacts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClusterServicesApi;

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String clusterName = clusterName_example; // String | 
        ClusterServiceArtifactRequest body = ; // ClusterServiceArtifactRequest | 
        try {
            apiInstance.serviceServiceUpdateArtifacts(serviceName, clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceUpdateArtifacts");
            e.printStackTrace();
        }
    }
}
String *serviceName = serviceName_example; // 
String *clusterName = clusterName_example; // 
ClusterServiceArtifactRequest *body = ; //  (optional)

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

// Updates multiple artifacts
[apiInstance serviceServiceUpdateArtifactsWith:serviceName
    clusterName:clusterName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClusterServicesApi()

var serviceName = serviceName_example; // {String} 

var clusterName = clusterName_example; // {String} 

var opts = { 
  'body':  // {ClusterServiceArtifactRequest} 
};

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

namespace Example
{
    public class serviceServiceUpdateArtifactsExample
    {
        public void main()
        {
            
            var apiInstance = new ClusterServicesApi();
            var serviceName = serviceName_example;  // String | 
            var clusterName = clusterName_example;  // String | 
            var body = new ClusterServiceArtifactRequest(); // ClusterServiceArtifactRequest |  (optional) 

            try
            {
                // Updates multiple artifacts
                apiInstance.serviceServiceUpdateArtifacts(serviceName, clusterName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClusterServicesApi.serviceServiceUpdateArtifacts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClusterServicesApi();
$serviceName = serviceName_example; // String | 
$clusterName = clusterName_example; // String | 
$body = ; // ClusterServiceArtifactRequest | 

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

my $api_instance = WWW::SwaggerClient::ClusterServicesApi->new();
my $serviceName = serviceName_example; # String | 
my $clusterName = clusterName_example; # String | 
my $body = WWW::SwaggerClient::Object::ClusterServiceArtifactRequest->new(); # ClusterServiceArtifactRequest | 

eval { 
    $api_instance->serviceServiceUpdateArtifacts(serviceName => $serviceName, clusterName => $clusterName, body => $body);
};
if ($@) {
    warn "Exception when calling ClusterServicesApi->serviceServiceUpdateArtifacts: $@\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.ClusterServicesApi()
serviceName = serviceName_example # String | 
clusterName = clusterName_example # String | 
body =  # ClusterServiceArtifactRequest |  (optional)

try: 
    # Updates multiple artifacts
    api_instance.serviceServiceUpdateArtifacts(serviceName, clusterName, body=body)
except ApiException as e:
    print("Exception when calling ClusterServicesApi->serviceServiceUpdateArtifacts: %s\n" % e)

Parameters

Path parameters
Name Description
serviceName*
clusterName*
Body parameters
Name Description
body

Responses

Status: 200 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


serviceServiceUpdateService

Updates a service


/clusters/{clusterName}/services/{serviceName}

Usage and SDK Samples

curl -X put "https://localhost/api/v1/clusters/{clusterName}/services/{serviceName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClusterServicesApi;

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

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String clusterName = clusterName_example; // String | 
        ServiceRequestSwagger body = ; // ServiceRequestSwagger | 
        try {
            apiInstance.serviceServiceUpdateService(serviceName, clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceUpdateService");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClusterServicesApi;

public class ClusterServicesApiExample {

    public static void main(String[] args) {
        ClusterServicesApi apiInstance = new ClusterServicesApi();
        String serviceName = serviceName_example; // String | 
        String clusterName = clusterName_example; // String | 
        ServiceRequestSwagger body = ; // ServiceRequestSwagger | 
        try {
            apiInstance.serviceServiceUpdateService(serviceName, clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterServicesApi#serviceServiceUpdateService");
            e.printStackTrace();
        }
    }
}
String *serviceName = serviceName_example; // 
String *clusterName = clusterName_example; // 
ServiceRequestSwagger *body = ; //  (optional)

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

// Updates a service
[apiInstance serviceServiceUpdateServiceWith:serviceName
    clusterName:clusterName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClusterServicesApi()

var serviceName = serviceName_example; // {String} 

var clusterName = clusterName_example; // {String} 

var opts = { 
  'body':  // {ServiceRequestSwagger} 
};

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

namespace Example
{
    public class serviceServiceUpdateServiceExample
    {
        public void main()
        {
            
            var apiInstance = new ClusterServicesApi();
            var serviceName = serviceName_example;  // String | 
            var clusterName = clusterName_example;  // String | 
            var body = new ServiceRequestSwagger(); // ServiceRequestSwagger |  (optional) 

            try
            {
                // Updates a service
                apiInstance.serviceServiceUpdateService(serviceName, clusterName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClusterServicesApi.serviceServiceUpdateService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClusterServicesApi();
$serviceName = serviceName_example; // String | 
$clusterName = clusterName_example; // String | 
$body = ; // ServiceRequestSwagger | 

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

my $api_instance = WWW::SwaggerClient::ClusterServicesApi->new();
my $serviceName = serviceName_example; # String | 
my $clusterName = clusterName_example; # String | 
my $body = WWW::SwaggerClient::Object::ServiceRequestSwagger->new(); # ServiceRequestSwagger | 

eval { 
    $api_instance->serviceServiceUpdateService(serviceName => $serviceName, clusterName => $clusterName, body => $body);
};
if ($@) {
    warn "Exception when calling ClusterServicesApi->serviceServiceUpdateService: $@\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.ClusterServicesApi()
serviceName = serviceName_example # String | 
clusterName = clusterName_example # String | 
body =  # ServiceRequestSwagger |  (optional)

try: 
    # Updates a service
    api_instance.serviceServiceUpdateService(serviceName, clusterName, body=body)
except ApiException as e:
    print("Exception when calling ClusterServicesApi->serviceServiceUpdateService: %s\n" % e)

Parameters

Path parameters
Name Description
serviceName*
clusterName*
Body parameters
Name Description
body

Responses

Status: 200 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


Clusters

createCluster

Creates a cluster


/clusters/{clusterName}

Usage and SDK Samples

curl -X post "https://localhost/api/v1/clusters/{clusterName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClustersApi;

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

public class ClustersApiExample {

    public static void main(String[] args) {
        
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        ClusterRequestSwagger body = ; // ClusterRequestSwagger | 
        try {
            apiInstance.createCluster(clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#createCluster");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClustersApi;

public class ClustersApiExample {

    public static void main(String[] args) {
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        ClusterRequestSwagger body = ; // ClusterRequestSwagger | 
        try {
            apiInstance.createCluster(clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#createCluster");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 
ClusterRequestSwagger *body = ; //  (optional)

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

// Creates a cluster
[apiInstance createClusterWith:clusterName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClustersApi()

var clusterName = clusterName_example; // {String} 

var opts = { 
  'body':  // {ClusterRequestSwagger} 
};

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

namespace Example
{
    public class createClusterExample
    {
        public void main()
        {
            
            var apiInstance = new ClustersApi();
            var clusterName = clusterName_example;  // String | 
            var body = new ClusterRequestSwagger(); // ClusterRequestSwagger |  (optional) 

            try
            {
                // Creates a cluster
                apiInstance.createCluster(clusterName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClustersApi.createCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClustersApi();
$clusterName = clusterName_example; // String | 
$body = ; // ClusterRequestSwagger | 

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

my $api_instance = WWW::SwaggerClient::ClustersApi->new();
my $clusterName = clusterName_example; # String | 
my $body = WWW::SwaggerClient::Object::ClusterRequestSwagger->new(); # ClusterRequestSwagger | 

eval { 
    $api_instance->createCluster(clusterName => $clusterName, body => $body);
};
if ($@) {
    warn "Exception when calling ClustersApi->createCluster: $@\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.ClustersApi()
clusterName = clusterName_example # String | 
body =  # ClusterRequestSwagger |  (optional)

try: 
    # Creates a cluster
    api_instance.createCluster(clusterName, body=body)
except ApiException as e:
    print("Exception when calling ClustersApi->createCluster: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*
Body parameters
Name Description
body

Responses

Status: 201 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 409 - The requested resource already exists.

Status: 500 - Internal server error


createClusterArtifact

Creates a cluster artifact


/clusters/{clusterName}/artifacts/{artifactName}

Usage and SDK Samples

curl -X post "https://localhost/api/v1/clusters/{clusterName}/artifacts/{artifactName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClustersApi;

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

public class ClustersApiExample {

    public static void main(String[] args) {
        
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        String artifactName = artifactName_example; // String | 
        ClusterArtifactRequest body = ; // ClusterArtifactRequest | 
        try {
            apiInstance.createClusterArtifact(clusterName, artifactName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#createClusterArtifact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClustersApi;

public class ClustersApiExample {

    public static void main(String[] args) {
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        String artifactName = artifactName_example; // String | 
        ClusterArtifactRequest body = ; // ClusterArtifactRequest | 
        try {
            apiInstance.createClusterArtifact(clusterName, artifactName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#createClusterArtifact");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 
String *artifactName = artifactName_example; // 
ClusterArtifactRequest *body = ; //  (optional)

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

// Creates a cluster artifact
[apiInstance createClusterArtifactWith:clusterName
    artifactName:artifactName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClustersApi()

var clusterName = clusterName_example; // {String} 

var artifactName = artifactName_example; // {String} 

var opts = { 
  'body':  // {ClusterArtifactRequest} 
};

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

namespace Example
{
    public class createClusterArtifactExample
    {
        public void main()
        {
            
            var apiInstance = new ClustersApi();
            var clusterName = clusterName_example;  // String | 
            var artifactName = artifactName_example;  // String | 
            var body = new ClusterArtifactRequest(); // ClusterArtifactRequest |  (optional) 

            try
            {
                // Creates a cluster artifact
                apiInstance.createClusterArtifact(clusterName, artifactName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClustersApi.createClusterArtifact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClustersApi();
$clusterName = clusterName_example; // String | 
$artifactName = artifactName_example; // String | 
$body = ; // ClusterArtifactRequest | 

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

my $api_instance = WWW::SwaggerClient::ClustersApi->new();
my $clusterName = clusterName_example; # String | 
my $artifactName = artifactName_example; # String | 
my $body = WWW::SwaggerClient::Object::ClusterArtifactRequest->new(); # ClusterArtifactRequest | 

eval { 
    $api_instance->createClusterArtifact(clusterName => $clusterName, artifactName => $artifactName, body => $body);
};
if ($@) {
    warn "Exception when calling ClustersApi->createClusterArtifact: $@\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.ClustersApi()
clusterName = clusterName_example # String | 
artifactName = artifactName_example # String | 
body =  # ClusterArtifactRequest |  (optional)

try: 
    # Creates a cluster artifact
    api_instance.createClusterArtifact(clusterName, artifactName, body=body)
except ApiException as e:
    print("Exception when calling ClustersApi->createClusterArtifact: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*
artifactName*
Body parameters
Name Description
body

Responses

Status: 201 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 409 - The requested resource already exists.

Status: 500 - Internal server error


deleteCluster

Deletes a cluster


/clusters/{clusterName}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/clusters/{clusterName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClustersApi;

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

public class ClustersApiExample {

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

public class ClustersApiExample {

    public static void main(String[] args) {
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        try {
            apiInstance.deleteCluster(clusterName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#deleteCluster");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 

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

// Deletes a cluster
[apiInstance deleteClusterWith:clusterName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClustersApi()

var clusterName = clusterName_example; // {String} 


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

namespace Example
{
    public class deleteClusterExample
    {
        public void main()
        {
            
            var apiInstance = new ClustersApi();
            var clusterName = clusterName_example;  // String | 

            try
            {
                // Deletes a cluster
                apiInstance.deleteCluster(clusterName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClustersApi.deleteCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClustersApi();
$clusterName = clusterName_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ClustersApi->new();
my $clusterName = clusterName_example; # String | 

eval { 
    $api_instance->deleteCluster(clusterName => $clusterName);
};
if ($@) {
    warn "Exception when calling ClustersApi->deleteCluster: $@\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.ClustersApi()
clusterName = clusterName_example # String | 

try: 
    # Deletes a cluster
    api_instance.deleteCluster(clusterName)
except ApiException as e:
    print("Exception when calling ClustersApi->deleteCluster: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


deleteClusterArtifact

Deletes a single artifact


/clusters/{clusterName}/artifacts/{artifactName}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/clusters/{clusterName}/artifacts/{artifactName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClustersApi;

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

public class ClustersApiExample {

    public static void main(String[] args) {
        
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        String artifactName = artifactName_example; // String | 
        try {
            apiInstance.deleteClusterArtifact(clusterName, artifactName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#deleteClusterArtifact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClustersApi;

public class ClustersApiExample {

    public static void main(String[] args) {
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        String artifactName = artifactName_example; // String | 
        try {
            apiInstance.deleteClusterArtifact(clusterName, artifactName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#deleteClusterArtifact");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 
String *artifactName = artifactName_example; // 

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

// Deletes a single artifact
[apiInstance deleteClusterArtifactWith:clusterName
    artifactName:artifactName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClustersApi()

var clusterName = clusterName_example; // {String} 

var artifactName = artifactName_example; // {String} 


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

namespace Example
{
    public class deleteClusterArtifactExample
    {
        public void main()
        {
            
            var apiInstance = new ClustersApi();
            var clusterName = clusterName_example;  // String | 
            var artifactName = artifactName_example;  // String | 

            try
            {
                // Deletes a single artifact
                apiInstance.deleteClusterArtifact(clusterName, artifactName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClustersApi.deleteClusterArtifact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClustersApi();
$clusterName = clusterName_example; // String | 
$artifactName = artifactName_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ClustersApi->new();
my $clusterName = clusterName_example; # String | 
my $artifactName = artifactName_example; # String | 

eval { 
    $api_instance->deleteClusterArtifact(clusterName => $clusterName, artifactName => $artifactName);
};
if ($@) {
    warn "Exception when calling ClustersApi->deleteClusterArtifact: $@\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.ClustersApi()
clusterName = clusterName_example # String | 
artifactName = artifactName_example # String | 

try: 
    # Deletes a single artifact
    api_instance.deleteClusterArtifact(clusterName, artifactName)
except ApiException as e:
    print("Exception when calling ClustersApi->deleteClusterArtifact: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*
artifactName*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


deleteClusterArtifacts

Deletes all artifacts of a cluster that match the provided predicate


/clusters/{clusterName}/artifacts

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/clusters/{clusterName}/artifacts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClustersApi;

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

public class ClustersApiExample {

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

public class ClustersApiExample {

    public static void main(String[] args) {
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        try {
            apiInstance.deleteClusterArtifacts(clusterName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#deleteClusterArtifacts");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 

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

// Deletes all artifacts of a cluster that match the provided predicate
[apiInstance deleteClusterArtifactsWith:clusterName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClustersApi()

var clusterName = clusterName_example; // {String} 


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

namespace Example
{
    public class deleteClusterArtifactsExample
    {
        public void main()
        {
            
            var apiInstance = new ClustersApi();
            var clusterName = clusterName_example;  // String | 

            try
            {
                // Deletes all artifacts of a cluster that match the provided predicate
                apiInstance.deleteClusterArtifacts(clusterName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClustersApi.deleteClusterArtifacts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClustersApi();
$clusterName = clusterName_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ClustersApi->new();
my $clusterName = clusterName_example; # String | 

eval { 
    $api_instance->deleteClusterArtifacts(clusterName => $clusterName);
};
if ($@) {
    warn "Exception when calling ClustersApi->deleteClusterArtifacts: $@\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.ClustersApi()
clusterName = clusterName_example # String | 

try: 
    # Deletes all artifacts of a cluster that match the provided predicate
    api_instance.deleteClusterArtifacts(clusterName)
except ApiException as e:
    print("Exception when calling ClustersApi->deleteClusterArtifacts: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


getCluster

Returns information about a specific cluster


/clusters/{clusterName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/clusters/{clusterName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClustersApi;

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

public class ClustersApiExample {

    public static void main(String[] args) {
        
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            ClusterResponseWrapper result = apiInstance.getCluster(clusterName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#getCluster");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClustersApi;

public class ClustersApiExample {

    public static void main(String[] args) {
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            ClusterResponseWrapper result = apiInstance.getCluster(clusterName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#getCluster");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Clusters/*)

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

// Returns information about a specific cluster
[apiInstance getClusterWith:clusterName
    fields:fields
              completionHandler: ^(ClusterResponseWrapper output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClustersApi()

var clusterName = clusterName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getClusterExample
    {
        public void main()
        {
            
            var apiInstance = new ClustersApi();
            var clusterName = clusterName_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Clusters/*)

            try
            {
                // Returns information about a specific cluster
                ClusterResponseWrapper result = apiInstance.getCluster(clusterName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClustersApi.getCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClustersApi();
$clusterName = clusterName_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::ClustersApi->new();
my $clusterName = clusterName_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getCluster(clusterName => $clusterName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClustersApi->getCluster: $@\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.ClustersApi()
clusterName = clusterName_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Clusters/*)

try: 
    # Returns information about a specific cluster
    api_response = api_instance.getCluster(clusterName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClustersApi->getCluster: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


getClusterArtifact

Get the details of a cluster artifact


/clusters/{clusterName}/artifacts/{artifactName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/clusters/{clusterName}/artifacts/{artifactName}?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClustersApi;

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

public class ClustersApiExample {

    public static void main(String[] args) {
        
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        String artifactName = artifactName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            ClusterArtifactResponse result = apiInstance.getClusterArtifact(clusterName, artifactName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#getClusterArtifact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClustersApi;

public class ClustersApiExample {

    public static void main(String[] args) {
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        String artifactName = artifactName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            ClusterArtifactResponse result = apiInstance.getClusterArtifact(clusterName, artifactName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#getClusterArtifact");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 
String *artifactName = artifactName_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get the details of a cluster artifact
[apiInstance getClusterArtifactWith:clusterName
    artifactName:artifactName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(ClusterArtifactResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClustersApi()

var clusterName = clusterName_example; // {String} 

var artifactName = artifactName_example; // {String} 

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive).  "start" is also accepted.
  'to': to_example // {String} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class getClusterArtifactExample
    {
        public void main()
        {
            
            var apiInstance = new ClustersApi();
            var clusterName = clusterName_example;  // String | 
            var artifactName = artifactName_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional) 
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional) 
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get the details of a cluster artifact
                ClusterArtifactResponse result = apiInstance.getClusterArtifact(clusterName, artifactName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClustersApi.getClusterArtifact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClustersApi();
$clusterName = clusterName_example; // String | 
$artifactName = artifactName_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
$to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->getClusterArtifact($clusterName, $artifactName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClustersApi->getClusterArtifact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ClustersApi;

my $api_instance = WWW::SwaggerClient::ClustersApi->new();
my $clusterName = clusterName_example; # String | 
my $artifactName = artifactName_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive).  "start" is also accepted.
my $to = to_example; # String | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->getClusterArtifact(clusterName => $clusterName, artifactName => $artifactName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClustersApi->getClusterArtifact: $@\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.ClustersApi()
clusterName = clusterName_example # String | 
artifactName = artifactName_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get the details of a cluster artifact
    api_response = api_instance.getClusterArtifact(clusterName, artifactName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClustersApi->getClusterArtifact: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*
artifactName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


getClusterArtifacts

Returns all artifacts associated with the cluster


/clusters/{clusterName}/artifacts

Usage and SDK Samples

curl -X get "https://localhost/api/v1/clusters/{clusterName}/artifacts?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClustersApi;

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

public class ClustersApiExample {

    public static void main(String[] args) {
        
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ClusterArtifactResponse] result = apiInstance.getClusterArtifacts(clusterName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#getClusterArtifacts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClustersApi;

public class ClustersApiExample {

    public static void main(String[] args) {
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ClusterArtifactResponse] result = apiInstance.getClusterArtifacts(clusterName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#getClusterArtifacts");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
Integer *from = 56; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
Integer *to = 56; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Returns all artifacts associated with the cluster
[apiInstance getClusterArtifactsWith:clusterName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[ClusterArtifactResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClustersApi()

var clusterName = clusterName_example; // {String} 

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': 56, // {Integer} The starting page resource (inclusive).  "start" is also accepted.
  'to': 56 // {Integer} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class getClusterArtifactsExample
    {
        public void main()
        {
            
            var apiInstance = new ClustersApi();
            var clusterName = clusterName_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional) 
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional) 
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = 56;  // Integer | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = 56;  // Integer | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Returns all artifacts associated with the cluster
                array[ClusterArtifactResponse] result = apiInstance.getClusterArtifacts(clusterName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClustersApi.getClusterArtifacts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClustersApi();
$clusterName = clusterName_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
$to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->getClusterArtifacts($clusterName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClustersApi->getClusterArtifacts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ClustersApi;

my $api_instance = WWW::SwaggerClient::ClustersApi->new();
my $clusterName = clusterName_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = 56; # Integer | The starting page resource (inclusive).  "start" is also accepted.
my $to = 56; # Integer | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->getClusterArtifacts(clusterName => $clusterName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClustersApi->getClusterArtifacts: $@\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.ClustersApi()
clusterName = clusterName_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = 56 # Integer | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = 56 # Integer | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Returns all artifacts associated with the cluster
    api_response = api_instance.getClusterArtifacts(clusterName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClustersApi->getClusterArtifacts: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


getClusters

Returns all clusters


/clusters

Usage and SDK Samples

curl -X get "https://localhost/api/v1/clusters?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClustersApi;

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

public class ClustersApiExample {

    public static void main(String[] args) {
        
        ClustersApi apiInstance = new ClustersApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ClusterResponseWrapper] result = apiInstance.getClusters(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#getClusters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClustersApi;

public class ClustersApiExample {

    public static void main(String[] args) {
        ClustersApi apiInstance = new ClustersApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ClusterResponseWrapper] result = apiInstance.getClusters(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#getClusters");
            e.printStackTrace();
        }
    }
}
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
Integer *from = 56; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
Integer *to = 56; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Returns all clusters
[apiInstance getClustersWith:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[ClusterResponseWrapper] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClustersApi()

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': 56, // {Integer} The starting page resource (inclusive).  "start" is also accepted.
  'to': 56 // {Integer} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class getClustersExample
    {
        public void main()
        {
            
            var apiInstance = new ClustersApi();
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional) 
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional) 
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = 56;  // Integer | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = 56;  // Integer | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Returns all clusters
                array[ClusterResponseWrapper] result = apiInstance.getClusters(fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClustersApi.getClusters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClustersApi();
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
$to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.

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

my $api_instance = WWW::SwaggerClient::ClustersApi->new();
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = 56; # Integer | The starting page resource (inclusive).  "start" is also accepted.
my $to = 56; # Integer | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->getClusters(fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClustersApi->getClusters: $@\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.ClustersApi()
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = 56 # Integer | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = 56 # Integer | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Returns all clusters
    api_response = api_instance.getClusters(fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClustersApi->getClusters: %s\n" % e)

Parameters

Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


updateCluster

Updates a cluster


/clusters/{clusterName}

Usage and SDK Samples

curl -X put "https://localhost/api/v1/clusters/{clusterName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClustersApi;

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

public class ClustersApiExample {

    public static void main(String[] args) {
        
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        ClusterRequestSwagger body = ; // ClusterRequestSwagger | 
        try {
            apiInstance.updateCluster(clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#updateCluster");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClustersApi;

public class ClustersApiExample {

    public static void main(String[] args) {
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        ClusterRequestSwagger body = ; // ClusterRequestSwagger | 
        try {
            apiInstance.updateCluster(clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#updateCluster");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 
ClusterRequestSwagger *body = ; //  (optional)

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

// Updates a cluster
[apiInstance updateClusterWith:clusterName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClustersApi()

var clusterName = clusterName_example; // {String} 

var opts = { 
  'body':  // {ClusterRequestSwagger} 
};

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

namespace Example
{
    public class updateClusterExample
    {
        public void main()
        {
            
            var apiInstance = new ClustersApi();
            var clusterName = clusterName_example;  // String | 
            var body = new ClusterRequestSwagger(); // ClusterRequestSwagger |  (optional) 

            try
            {
                // Updates a cluster
                apiInstance.updateCluster(clusterName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClustersApi.updateCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClustersApi();
$clusterName = clusterName_example; // String | 
$body = ; // ClusterRequestSwagger | 

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

my $api_instance = WWW::SwaggerClient::ClustersApi->new();
my $clusterName = clusterName_example; # String | 
my $body = WWW::SwaggerClient::Object::ClusterRequestSwagger->new(); # ClusterRequestSwagger | 

eval { 
    $api_instance->updateCluster(clusterName => $clusterName, body => $body);
};
if ($@) {
    warn "Exception when calling ClustersApi->updateCluster: $@\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.ClustersApi()
clusterName = clusterName_example # String | 
body =  # ClusterRequestSwagger |  (optional)

try: 
    # Updates a cluster
    api_instance.updateCluster(clusterName, body=body)
except ApiException as e:
    print("Exception when calling ClustersApi->updateCluster: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*
Body parameters
Name Description
body

Responses

Status: 200 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


updateClusterArtifact

Updates a single artifact


/clusters/{clusterName}/artifacts/{artifactName}

Usage and SDK Samples

curl -X put "https://localhost/api/v1/clusters/{clusterName}/artifacts/{artifactName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClustersApi;

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

public class ClustersApiExample {

    public static void main(String[] args) {
        
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        String artifactName = artifactName_example; // String | 
        ClusterArtifactRequest body = ; // ClusterArtifactRequest | 
        try {
            apiInstance.updateClusterArtifact(clusterName, artifactName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#updateClusterArtifact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClustersApi;

public class ClustersApiExample {

    public static void main(String[] args) {
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        String artifactName = artifactName_example; // String | 
        ClusterArtifactRequest body = ; // ClusterArtifactRequest | 
        try {
            apiInstance.updateClusterArtifact(clusterName, artifactName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#updateClusterArtifact");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 
String *artifactName = artifactName_example; // 
ClusterArtifactRequest *body = ; //  (optional)

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

// Updates a single artifact
[apiInstance updateClusterArtifactWith:clusterName
    artifactName:artifactName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClustersApi()

var clusterName = clusterName_example; // {String} 

var artifactName = artifactName_example; // {String} 

var opts = { 
  'body':  // {ClusterArtifactRequest} 
};

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

namespace Example
{
    public class updateClusterArtifactExample
    {
        public void main()
        {
            
            var apiInstance = new ClustersApi();
            var clusterName = clusterName_example;  // String | 
            var artifactName = artifactName_example;  // String | 
            var body = new ClusterArtifactRequest(); // ClusterArtifactRequest |  (optional) 

            try
            {
                // Updates a single artifact
                apiInstance.updateClusterArtifact(clusterName, artifactName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClustersApi.updateClusterArtifact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClustersApi();
$clusterName = clusterName_example; // String | 
$artifactName = artifactName_example; // String | 
$body = ; // ClusterArtifactRequest | 

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

my $api_instance = WWW::SwaggerClient::ClustersApi->new();
my $clusterName = clusterName_example; # String | 
my $artifactName = artifactName_example; # String | 
my $body = WWW::SwaggerClient::Object::ClusterArtifactRequest->new(); # ClusterArtifactRequest | 

eval { 
    $api_instance->updateClusterArtifact(clusterName => $clusterName, artifactName => $artifactName, body => $body);
};
if ($@) {
    warn "Exception when calling ClustersApi->updateClusterArtifact: $@\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.ClustersApi()
clusterName = clusterName_example # String | 
artifactName = artifactName_example # String | 
body =  # ClusterArtifactRequest |  (optional)

try: 
    # Updates a single artifact
    api_instance.updateClusterArtifact(clusterName, artifactName, body=body)
except ApiException as e:
    print("Exception when calling ClustersApi->updateClusterArtifact: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*
artifactName*
Body parameters
Name Description
body

Responses

Status: 200 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


updateClusterArtifacts

Updates multiple artifacts


/clusters/{clusterName}/artifacts

Usage and SDK Samples

curl -X put "https://localhost/api/v1/clusters/{clusterName}/artifacts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClustersApi;

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

public class ClustersApiExample {

    public static void main(String[] args) {
        
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        ClusterArtifactRequest body = ; // ClusterArtifactRequest | 
        try {
            apiInstance.updateClusterArtifacts(clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#updateClusterArtifacts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClustersApi;

public class ClustersApiExample {

    public static void main(String[] args) {
        ClustersApi apiInstance = new ClustersApi();
        String clusterName = clusterName_example; // String | 
        ClusterArtifactRequest body = ; // ClusterArtifactRequest | 
        try {
            apiInstance.updateClusterArtifacts(clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClustersApi#updateClusterArtifacts");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 
ClusterArtifactRequest *body = ; //  (optional)

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

// Updates multiple artifacts
[apiInstance updateClusterArtifactsWith:clusterName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ClustersApi()

var clusterName = clusterName_example; // {String} 

var opts = { 
  'body':  // {ClusterArtifactRequest} 
};

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

namespace Example
{
    public class updateClusterArtifactsExample
    {
        public void main()
        {
            
            var apiInstance = new ClustersApi();
            var clusterName = clusterName_example;  // String | 
            var body = new ClusterArtifactRequest(); // ClusterArtifactRequest |  (optional) 

            try
            {
                // Updates multiple artifacts
                apiInstance.updateClusterArtifacts(clusterName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClustersApi.updateClusterArtifacts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ClustersApi();
$clusterName = clusterName_example; // String | 
$body = ; // ClusterArtifactRequest | 

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

my $api_instance = WWW::SwaggerClient::ClustersApi->new();
my $clusterName = clusterName_example; # String | 
my $body = WWW::SwaggerClient::Object::ClusterArtifactRequest->new(); # ClusterArtifactRequest | 

eval { 
    $api_instance->updateClusterArtifacts(clusterName => $clusterName, body => $body);
};
if ($@) {
    warn "Exception when calling ClustersApi->updateClusterArtifacts: $@\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.ClustersApi()
clusterName = clusterName_example # String | 
body =  # ClusterArtifactRequest |  (optional)

try: 
    # Updates multiple artifacts
    api_instance.updateClusterArtifacts(clusterName, body=body)
except ApiException as e:
    print("Exception when calling ClustersApi->updateClusterArtifacts: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*
Body parameters
Name Description
body

Responses

Status: 200 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


ConfigGroups

createConfigGroup

Creates a config group


/clusters/{clusterName}/config_groups

Usage and SDK Samples

curl -X post "https://localhost/api/v1/clusters/{clusterName}/config_groups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigGroupsApi;

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

public class ConfigGroupsApiExample {

    public static void main(String[] args) {
        
        ConfigGroupsApi apiInstance = new ConfigGroupsApi();
        String clusterName = clusterName_example; // String | 
        ConfigGroupRequest body = ; // ConfigGroupRequest | 
        try {
            apiInstance.createConfigGroup(clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigGroupsApi#createConfigGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigGroupsApi;

public class ConfigGroupsApiExample {

    public static void main(String[] args) {
        ConfigGroupsApi apiInstance = new ConfigGroupsApi();
        String clusterName = clusterName_example; // String | 
        ConfigGroupRequest body = ; // ConfigGroupRequest | 
        try {
            apiInstance.createConfigGroup(clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigGroupsApi#createConfigGroup");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 
ConfigGroupRequest *body = ; //  (optional)

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

// Creates a config group
[apiInstance createConfigGroupWith:clusterName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ConfigGroupsApi()

var clusterName = clusterName_example; // {String} 

var opts = { 
  'body':  // {ConfigGroupRequest} 
};

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

namespace Example
{
    public class createConfigGroupExample
    {
        public void main()
        {
            
            var apiInstance = new ConfigGroupsApi();
            var clusterName = clusterName_example;  // String | 
            var body = new ConfigGroupRequest(); // ConfigGroupRequest |  (optional) 

            try
            {
                // Creates a config group
                apiInstance.createConfigGroup(clusterName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigGroupsApi.createConfigGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ConfigGroupsApi();
$clusterName = clusterName_example; // String | 
$body = ; // ConfigGroupRequest | 

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

my $api_instance = WWW::SwaggerClient::ConfigGroupsApi->new();
my $clusterName = clusterName_example; # String | 
my $body = WWW::SwaggerClient::Object::ConfigGroupRequest->new(); # ConfigGroupRequest | 

eval { 
    $api_instance->createConfigGroup(clusterName => $clusterName, body => $body);
};
if ($@) {
    warn "Exception when calling ConfigGroupsApi->createConfigGroup: $@\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.ConfigGroupsApi()
clusterName = clusterName_example # String | 
body =  # ConfigGroupRequest |  (optional)

try: 
    # Creates a config group
    api_instance.createConfigGroup(clusterName, body=body)
except ApiException as e:
    print("Exception when calling ConfigGroupsApi->createConfigGroup: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*
Body parameters
Name Description
body

Responses

Status: 201 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 500 - Internal server error


deleteConfigGroup

Deletes a config group


/clusters/{clusterName}/config_groups/{groupId}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/clusters/{clusterName}/config_groups/{groupId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigGroupsApi;

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

public class ConfigGroupsApiExample {

    public static void main(String[] args) {
        
        ConfigGroupsApi apiInstance = new ConfigGroupsApi();
        String groupId = groupId_example; // String | 
        String clusterName = clusterName_example; // String | 
        try {
            apiInstance.deleteConfigGroup(groupId, clusterName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigGroupsApi#deleteConfigGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigGroupsApi;

public class ConfigGroupsApiExample {

    public static void main(String[] args) {
        ConfigGroupsApi apiInstance = new ConfigGroupsApi();
        String groupId = groupId_example; // String | 
        String clusterName = clusterName_example; // String | 
        try {
            apiInstance.deleteConfigGroup(groupId, clusterName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigGroupsApi#deleteConfigGroup");
            e.printStackTrace();
        }
    }
}
String *groupId = groupId_example; // 
String *clusterName = clusterName_example; // 

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

// Deletes a config group
[apiInstance deleteConfigGroupWith:groupId
    clusterName:clusterName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ConfigGroupsApi()

var groupId = groupId_example; // {String} 

var clusterName = clusterName_example; // {String} 


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

namespace Example
{
    public class deleteConfigGroupExample
    {
        public void main()
        {
            
            var apiInstance = new ConfigGroupsApi();
            var groupId = groupId_example;  // String | 
            var clusterName = clusterName_example;  // String | 

            try
            {
                // Deletes a config group
                apiInstance.deleteConfigGroup(groupId, clusterName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigGroupsApi.deleteConfigGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ConfigGroupsApi();
$groupId = groupId_example; // String | 
$clusterName = clusterName_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ConfigGroupsApi->new();
my $groupId = groupId_example; # String | 
my $clusterName = clusterName_example; # String | 

eval { 
    $api_instance->deleteConfigGroup(groupId => $groupId, clusterName => $clusterName);
};
if ($@) {
    warn "Exception when calling ConfigGroupsApi->deleteConfigGroup: $@\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.ConfigGroupsApi()
groupId = groupId_example # String | 
clusterName = clusterName_example # String | 

try: 
    # Deletes a config group
    api_instance.deleteConfigGroup(groupId, clusterName)
except ApiException as e:
    print("Exception when calling ConfigGroupsApi->deleteConfigGroup: %s\n" % e)

Parameters

Path parameters
Name Description
groupId*
clusterName*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 500 - Internal server error


getConfigGroup

Returns a single config group


/clusters/{clusterName}/config_groups/{groupId}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/clusters/{clusterName}/config_groups/{groupId}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigGroupsApi;

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

public class ConfigGroupsApiExample {

    public static void main(String[] args) {
        
        ConfigGroupsApi apiInstance = new ConfigGroupsApi();
        String groupId = groupId_example; // String | 
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            ConfigGroupWrapper result = apiInstance.getConfigGroup(groupId, clusterName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigGroupsApi#getConfigGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigGroupsApi;

public class ConfigGroupsApiExample {

    public static void main(String[] args) {
        ConfigGroupsApi apiInstance = new ConfigGroupsApi();
        String groupId = groupId_example; // String | 
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            ConfigGroupWrapper result = apiInstance.getConfigGroup(groupId, clusterName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigGroupsApi#getConfigGroup");
            e.printStackTrace();
        }
    }
}
String *groupId = groupId_example; // 
String *clusterName = clusterName_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to ConfigGroup/*)

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

// Returns a single config group
[apiInstance getConfigGroupWith:groupId
    clusterName:clusterName
    fields:fields
              completionHandler: ^(ConfigGroupWrapper output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ConfigGroupsApi()

var groupId = groupId_example; // {String} 

var clusterName = clusterName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getConfigGroupExample
    {
        public void main()
        {
            
            var apiInstance = new ConfigGroupsApi();
            var groupId = groupId_example;  // String | 
            var clusterName = clusterName_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to ConfigGroup/*)

            try
            {
                // Returns a single config group
                ConfigGroupWrapper result = apiInstance.getConfigGroup(groupId, clusterName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigGroupsApi.getConfigGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ConfigGroupsApi();
$groupId = groupId_example; // String | 
$clusterName = clusterName_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::ConfigGroupsApi->new();
my $groupId = groupId_example; # String | 
my $clusterName = clusterName_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getConfigGroup(groupId => $groupId, clusterName => $clusterName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigGroupsApi->getConfigGroup: $@\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.ConfigGroupsApi()
groupId = groupId_example # String | 
clusterName = clusterName_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to ConfigGroup/*)

try: 
    # Returns a single config group
    api_response = api_instance.getConfigGroup(groupId, clusterName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigGroupsApi->getConfigGroup: %s\n" % e)

Parameters

Path parameters
Name Description
groupId*
clusterName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


getConfigGroups

Returns all config groups


/clusters/{clusterName}/config_groups

Usage and SDK Samples

curl -X get "https://localhost/api/v1/clusters/{clusterName}/config_groups?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigGroupsApi;

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

public class ConfigGroupsApiExample {

    public static void main(String[] args) {
        
        ConfigGroupsApi apiInstance = new ConfigGroupsApi();
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ConfigGroupWrapper] result = apiInstance.getConfigGroups(clusterName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigGroupsApi#getConfigGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigGroupsApi;

public class ConfigGroupsApiExample {

    public static void main(String[] args) {
        ConfigGroupsApi apiInstance = new ConfigGroupsApi();
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ConfigGroupWrapper] result = apiInstance.getConfigGroups(clusterName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigGroupsApi#getConfigGroups");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to ConfigGroup/*)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
Integer *from = 56; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
Integer *to = 56; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Returns all config groups
[apiInstance getConfigGroupsWith:clusterName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[ConfigGroupWrapper] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ConfigGroupsApi()

var clusterName = clusterName_example; // {String} 

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': 56, // {Integer} The starting page resource (inclusive).  "start" is also accepted.
  'to': 56 // {Integer} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class getConfigGroupsExample
    {
        public void main()
        {
            
            var apiInstance = new ConfigGroupsApi();
            var clusterName = clusterName_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to ConfigGroup/*)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional) 
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = 56;  // Integer | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = 56;  // Integer | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Returns all config groups
                array[ConfigGroupWrapper] result = apiInstance.getConfigGroups(clusterName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigGroupsApi.getConfigGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ConfigGroupsApi();
$clusterName = clusterName_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
$to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->getConfigGroups($clusterName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigGroupsApi->getConfigGroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigGroupsApi;

my $api_instance = WWW::SwaggerClient::ConfigGroupsApi->new();
my $clusterName = clusterName_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = 56; # Integer | The starting page resource (inclusive).  "start" is also accepted.
my $to = 56; # Integer | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->getConfigGroups(clusterName => $clusterName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigGroupsApi->getConfigGroups: $@\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.ConfigGroupsApi()
clusterName = clusterName_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to ConfigGroup/*)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = 56 # Integer | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = 56 # Integer | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Returns all config groups
    api_response = api_instance.getConfigGroups(clusterName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigGroupsApi->getConfigGroups: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


updateConfigGroup

Updates a config group


/clusters/{clusterName}/config_groups/{groupId}

Usage and SDK Samples

curl -X put "https://localhost/api/v1/clusters/{clusterName}/config_groups/{groupId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigGroupsApi;

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

public class ConfigGroupsApiExample {

    public static void main(String[] args) {
        
        ConfigGroupsApi apiInstance = new ConfigGroupsApi();
        String groupId = groupId_example; // String | 
        String clusterName = clusterName_example; // String | 
        ConfigGroupRequest body = ; // ConfigGroupRequest | 
        try {
            apiInstance.updateConfigGroup(groupId, clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigGroupsApi#updateConfigGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigGroupsApi;

public class ConfigGroupsApiExample {

    public static void main(String[] args) {
        ConfigGroupsApi apiInstance = new ConfigGroupsApi();
        String groupId = groupId_example; // String | 
        String clusterName = clusterName_example; // String | 
        ConfigGroupRequest body = ; // ConfigGroupRequest | 
        try {
            apiInstance.updateConfigGroup(groupId, clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigGroupsApi#updateConfigGroup");
            e.printStackTrace();
        }
    }
}
String *groupId = groupId_example; // 
String *clusterName = clusterName_example; // 
ConfigGroupRequest *body = ; //  (optional)

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

// Updates a config group
[apiInstance updateConfigGroupWith:groupId
    clusterName:clusterName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ConfigGroupsApi()

var groupId = groupId_example; // {String} 

var clusterName = clusterName_example; // {String} 

var opts = { 
  'body':  // {ConfigGroupRequest} 
};

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

namespace Example
{
    public class updateConfigGroupExample
    {
        public void main()
        {
            
            var apiInstance = new ConfigGroupsApi();
            var groupId = groupId_example;  // String | 
            var clusterName = clusterName_example;  // String | 
            var body = new ConfigGroupRequest(); // ConfigGroupRequest |  (optional) 

            try
            {
                // Updates a config group
                apiInstance.updateConfigGroup(groupId, clusterName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigGroupsApi.updateConfigGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ConfigGroupsApi();
$groupId = groupId_example; // String | 
$clusterName = clusterName_example; // String | 
$body = ; // ConfigGroupRequest | 

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

my $api_instance = WWW::SwaggerClient::ConfigGroupsApi->new();
my $groupId = groupId_example; # String | 
my $clusterName = clusterName_example; # String | 
my $body = WWW::SwaggerClient::Object::ConfigGroupRequest->new(); # ConfigGroupRequest | 

eval { 
    $api_instance->updateConfigGroup(groupId => $groupId, clusterName => $clusterName, body => $body);
};
if ($@) {
    warn "Exception when calling ConfigGroupsApi->updateConfigGroup: $@\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.ConfigGroupsApi()
groupId = groupId_example # String | 
clusterName = clusterName_example # String | 
body =  # ConfigGroupRequest |  (optional)

try: 
    # Updates a config group
    api_instance.updateConfigGroup(groupId, clusterName, body=body)
except ApiException as e:
    print("Exception when calling ConfigGroupsApi->updateConfigGroup: %s\n" % e)

Parameters

Path parameters
Name Description
groupId*
clusterName*
Body parameters
Name Description
body

Responses

Status: 200 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 500 - Internal server error


Configurations

createConfigurations

Create new configurations


/clusters/{clusterName}/configurations

Usage and SDK Samples

curl -X post "https://localhost/api/v1/clusters/{clusterName}/configurations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigurationsApi;

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

public class ConfigurationsApiExample {

    public static void main(String[] args) {
        
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        String clusterName = clusterName_example; // String | 
        ConfigurationRequest body = ; // ConfigurationRequest | 
        try {
            apiInstance.createConfigurations(clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#createConfigurations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigurationsApi;

public class ConfigurationsApiExample {

    public static void main(String[] args) {
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        String clusterName = clusterName_example; // String | 
        ConfigurationRequest body = ; // ConfigurationRequest | 
        try {
            apiInstance.createConfigurations(clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#createConfigurations");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 
ConfigurationRequest *body = ; //  (optional)

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

// Create new configurations
[apiInstance createConfigurationsWith:clusterName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ConfigurationsApi()

var clusterName = clusterName_example; // {String} 

var opts = { 
  'body':  // {ConfigurationRequest} 
};

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

namespace Example
{
    public class createConfigurationsExample
    {
        public void main()
        {
            
            var apiInstance = new ConfigurationsApi();
            var clusterName = clusterName_example;  // String | 
            var body = new ConfigurationRequest(); // ConfigurationRequest |  (optional) 

            try
            {
                // Create new configurations
                apiInstance.createConfigurations(clusterName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigurationsApi.createConfigurations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ConfigurationsApi();
$clusterName = clusterName_example; // String | 
$body = ; // ConfigurationRequest | 

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

my $api_instance = WWW::SwaggerClient::ConfigurationsApi->new();
my $clusterName = clusterName_example; # String | 
my $body = WWW::SwaggerClient::Object::ConfigurationRequest->new(); # ConfigurationRequest | 

eval { 
    $api_instance->createConfigurations(clusterName => $clusterName, body => $body);
};
if ($@) {
    warn "Exception when calling ConfigurationsApi->createConfigurations: $@\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.ConfigurationsApi()
clusterName = clusterName_example # String | 
body =  # ConfigurationRequest |  (optional)

try: 
    # Create new configurations
    api_instance.createConfigurations(clusterName, body=body)
except ApiException as e:
    print("Exception when calling ConfigurationsApi->createConfigurations: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*
Body parameters
Name Description
body

Responses

Status: 201 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


getConfigurations

Get all configurations


/clusters/{clusterName}/configurations

Usage and SDK Samples

curl -X get "https://localhost/api/v1/clusters/{clusterName}/configurations?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigurationsApi;

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

public class ConfigurationsApiExample {

    public static void main(String[] args) {
        
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ConfigurationResponse] result = apiInstance.getConfigurations(clusterName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#getConfigurations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigurationsApi;

public class ConfigurationsApiExample {

    public static void main(String[] args) {
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ConfigurationResponse] result = apiInstance.getConfigurations(clusterName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#getConfigurations");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
Integer *from = 56; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
Integer *to = 56; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all configurations
[apiInstance getConfigurationsWith:clusterName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[ConfigurationResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ConfigurationsApi()

var clusterName = clusterName_example; // {String} 

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': 56, // {Integer} The starting page resource (inclusive).  "start" is also accepted.
  'to': 56 // {Integer} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class getConfigurationsExample
    {
        public void main()
        {
            
            var apiInstance = new ConfigurationsApi();
            var clusterName = clusterName_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional) 
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional) 
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = 56;  // Integer | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = 56;  // Integer | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all configurations
                array[ConfigurationResponse] result = apiInstance.getConfigurations(clusterName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigurationsApi.getConfigurations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ConfigurationsApi();
$clusterName = clusterName_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
$to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->getConfigurations($clusterName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationsApi->getConfigurations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigurationsApi;

my $api_instance = WWW::SwaggerClient::ConfigurationsApi->new();
my $clusterName = clusterName_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = 56; # Integer | The starting page resource (inclusive).  "start" is also accepted.
my $to = 56; # Integer | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->getConfigurations(clusterName => $clusterName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationsApi->getConfigurations: $@\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.ConfigurationsApi()
clusterName = clusterName_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = 56 # Integer | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = 56 # Integer | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all configurations
    api_response = api_instance.getConfigurations(clusterName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationsApi->getConfigurations: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


getServiceConfigVersions

Get all service config versions


/clusters/{clusterName}/configurations/service_config_versions

Usage and SDK Samples

curl -X get "https://localhost/api/v1/clusters/{clusterName}/configurations/service_config_versions?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigurationsApi;

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

public class ConfigurationsApiExample {

    public static void main(String[] args) {
        
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ServiceConfigVersionResponse] result = apiInstance.getServiceConfigVersions(clusterName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#getServiceConfigVersions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigurationsApi;

public class ConfigurationsApiExample {

    public static void main(String[] args) {
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ServiceConfigVersionResponse] result = apiInstance.getServiceConfigVersions(clusterName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#getServiceConfigVersions");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
Integer *from = 56; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
Integer *to = 56; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all service config versions
[apiInstance getServiceConfigVersionsWith:clusterName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[ServiceConfigVersionResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ConfigurationsApi()

var clusterName = clusterName_example; // {String} 

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': 56, // {Integer} The starting page resource (inclusive).  "start" is also accepted.
  'to': 56 // {Integer} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class getServiceConfigVersionsExample
    {
        public void main()
        {
            
            var apiInstance = new ConfigurationsApi();
            var clusterName = clusterName_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional) 
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional) 
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = 56;  // Integer | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = 56;  // Integer | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all service config versions
                array[ServiceConfigVersionResponse] result = apiInstance.getServiceConfigVersions(clusterName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigurationsApi.getServiceConfigVersions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ConfigurationsApi();
$clusterName = clusterName_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
$to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->getServiceConfigVersions($clusterName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationsApi->getServiceConfigVersions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigurationsApi;

my $api_instance = WWW::SwaggerClient::ConfigurationsApi->new();
my $clusterName = clusterName_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = 56; # Integer | The starting page resource (inclusive).  "start" is also accepted.
my $to = 56; # Integer | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->getServiceConfigVersions(clusterName => $clusterName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationsApi->getServiceConfigVersions: $@\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.ConfigurationsApi()
clusterName = clusterName_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = 56 # Integer | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = 56 # Integer | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all service config versions
    api_response = api_instance.getServiceConfigVersions(clusterName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationsApi->getServiceConfigVersions: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


Groups

groupPrivilegeServiceGetPrivilege

Get group privilege

Returns group privilege details.


/groups/{groupName}/privileges/{privilegeId}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/groups/{groupName}/privileges/{privilegeId}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupsApi;

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

public class GroupsApiExample {

    public static void main(String[] args) {
        
        GroupsApi apiInstance = new GroupsApi();
        String groupName = groupName_example; // String | group name
        String privilegeId = privilegeId_example; // String | privilege id
        String fields = fields_example; // String | Filter group privilege details
        try {
            PrivilegeResponse result = apiInstance.groupPrivilegeServiceGetPrivilege(groupName, privilegeId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupPrivilegeServiceGetPrivilege");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupsApi;

public class GroupsApiExample {

    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        String groupName = groupName_example; // String | group name
        String privilegeId = privilegeId_example; // String | privilege id
        String fields = fields_example; // String | Filter group privilege details
        try {
            PrivilegeResponse result = apiInstance.groupPrivilegeServiceGetPrivilege(groupName, privilegeId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupPrivilegeServiceGetPrivilege");
            e.printStackTrace();
        }
    }
}
String *groupName = groupName_example; // group name
String *privilegeId = privilegeId_example; // privilege id
String *fields = fields_example; // Filter group privilege details (optional) (default to PrivilegeInfo/*)

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

// Get group privilege
[apiInstance groupPrivilegeServiceGetPrivilegeWith:groupName
    privilegeId:privilegeId
    fields:fields
              completionHandler: ^(PrivilegeResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.GroupsApi()

var groupName = groupName_example; // {String} group name

var privilegeId = privilegeId_example; // {String} privilege id

var opts = { 
  'fields': fields_example // {String} Filter group privilege details
};

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

namespace Example
{
    public class groupPrivilegeServiceGetPrivilegeExample
    {
        public void main()
        {
            
            var apiInstance = new GroupsApi();
            var groupName = groupName_example;  // String | group name
            var privilegeId = privilegeId_example;  // String | privilege id
            var fields = fields_example;  // String | Filter group privilege details (optional)  (default to PrivilegeInfo/*)

            try
            {
                // Get group privilege
                PrivilegeResponse result = apiInstance.groupPrivilegeServiceGetPrivilege(groupName, privilegeId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupsApi.groupPrivilegeServiceGetPrivilege: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\GroupsApi();
$groupName = groupName_example; // String | group name
$privilegeId = privilegeId_example; // String | privilege id
$fields = fields_example; // String | Filter group privilege details

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

my $api_instance = WWW::SwaggerClient::GroupsApi->new();
my $groupName = groupName_example; # String | group name
my $privilegeId = privilegeId_example; # String | privilege id
my $fields = fields_example; # String | Filter group privilege details

eval { 
    my $result = $api_instance->groupPrivilegeServiceGetPrivilege(groupName => $groupName, privilegeId => $privilegeId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->groupPrivilegeServiceGetPrivilege: $@\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.GroupsApi()
groupName = groupName_example # String | group name
privilegeId = privilegeId_example # String | privilege id
fields = fields_example # String | Filter group privilege details (optional) (default to PrivilegeInfo/*)

try: 
    # Get group privilege
    api_response = api_instance.groupPrivilegeServiceGetPrivilege(groupName, privilegeId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->groupPrivilegeServiceGetPrivilege: %s\n" % e)

Parameters

Path parameters
Name Description
groupName*
privilegeId*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation


groupPrivilegeServiceGetPrivileges

Get all privileges

Returns all privileges for group.


/groups/{groupName}/privileges

Usage and SDK Samples

curl -X get "https://localhost/api/v1/groups/{groupName}/privileges?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupsApi;

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

public class GroupsApiExample {

    public static void main(String[] args) {
        
        GroupsApi apiInstance = new GroupsApi();
        String groupName = groupName_example; // String | group name
        String fields = fields_example; // String | Filter user privileges
        String sortBy = sortBy_example; // String | Sort user privileges (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive). Valid values are :offset | "start"
        String to = to_example; // String | The ending page resource (inclusive). Valid values are :offset | "end"
        try {
            array[GroupPrivilegeResponse] result = apiInstance.groupPrivilegeServiceGetPrivileges(groupName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupPrivilegeServiceGetPrivileges");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupsApi;

public class GroupsApiExample {

    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        String groupName = groupName_example; // String | group name
        String fields = fields_example; // String | Filter user privileges
        String sortBy = sortBy_example; // String | Sort user privileges (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive). Valid values are :offset | "start"
        String to = to_example; // String | The ending page resource (inclusive). Valid values are :offset | "end"
        try {
            array[GroupPrivilegeResponse] result = apiInstance.groupPrivilegeServiceGetPrivileges(groupName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupPrivilegeServiceGetPrivileges");
            e.printStackTrace();
        }
    }
}
String *groupName = groupName_example; // group name
String *fields = fields_example; // Filter user privileges (optional) (default to PrivilegeInfo/*)
String *sortBy = sortBy_example; // Sort user privileges (asc | desc) (optional) (default to PrivilegeInfo/user_name.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive). Valid values are :offset | "start" (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive). Valid values are :offset | "end" (optional)

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

// Get all privileges
[apiInstance groupPrivilegeServiceGetPrivilegesWith:groupName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[GroupPrivilegeResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.GroupsApi()

var groupName = groupName_example; // {String} group name

var opts = { 
  'fields': fields_example, // {String} Filter user privileges
  'sortBy': sortBy_example, // {String} Sort user privileges (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive). Valid values are :offset | "start"
  'to': to_example // {String} The ending page resource (inclusive). Valid values are :offset | "end"
};

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

namespace Example
{
    public class groupPrivilegeServiceGetPrivilegesExample
    {
        public void main()
        {
            
            var apiInstance = new GroupsApi();
            var groupName = groupName_example;  // String | group name
            var fields = fields_example;  // String | Filter user privileges (optional)  (default to PrivilegeInfo/*)
            var sortBy = sortBy_example;  // String | Sort user privileges (asc | desc) (optional)  (default to PrivilegeInfo/user_name.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive). Valid values are :offset | "start" (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive). Valid values are :offset | "end" (optional) 

            try
            {
                // Get all privileges
                array[GroupPrivilegeResponse] result = apiInstance.groupPrivilegeServiceGetPrivileges(groupName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupsApi.groupPrivilegeServiceGetPrivileges: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\GroupsApi();
$groupName = groupName_example; // String | group name
$fields = fields_example; // String | Filter user privileges
$sortBy = sortBy_example; // String | Sort user privileges (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive). Valid values are :offset | "start"
$to = to_example; // String | The ending page resource (inclusive). Valid values are :offset | "end"

try {
    $result = $api_instance->groupPrivilegeServiceGetPrivileges($groupName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->groupPrivilegeServiceGetPrivileges: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupsApi;

my $api_instance = WWW::SwaggerClient::GroupsApi->new();
my $groupName = groupName_example; # String | group name
my $fields = fields_example; # String | Filter user privileges
my $sortBy = sortBy_example; # String | Sort user privileges (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive). Valid values are :offset | "start"
my $to = to_example; # String | The ending page resource (inclusive). Valid values are :offset | "end"

eval { 
    my $result = $api_instance->groupPrivilegeServiceGetPrivileges(groupName => $groupName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->groupPrivilegeServiceGetPrivileges: $@\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.GroupsApi()
groupName = groupName_example # String | group name
fields = fields_example # String | Filter user privileges (optional) (default to PrivilegeInfo/*)
sortBy = sortBy_example # String | Sort user privileges (asc | desc) (optional) (default to PrivilegeInfo/user_name.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive). Valid values are :offset | "start" (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive). Valid values are :offset | "end" (optional)

try: 
    # Get all privileges
    api_response = api_instance.groupPrivilegeServiceGetPrivileges(groupName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->groupPrivilegeServiceGetPrivileges: %s\n" % e)

Parameters

Path parameters
Name Description
groupName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - successful operation


groupServiceCreateGroup

Create new group

Creates group resource.


/groups

Usage and SDK Samples

curl -X post "https://localhost/api/v1/groups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupsApi;

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

public class GroupsApiExample {

    public static void main(String[] args) {
        
        GroupsApi apiInstance = new GroupsApi();
        GroupRequest body = ; // GroupRequest | input parameters in json form
        try {
            apiInstance.groupServiceCreateGroup(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupServiceCreateGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupsApi;

public class GroupsApiExample {

    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        GroupRequest body = ; // GroupRequest | input parameters in json form
        try {
            apiInstance.groupServiceCreateGroup(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupServiceCreateGroup");
            e.printStackTrace();
        }
    }
}
GroupRequest *body = ; // input parameters in json form

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

// Create new group
[apiInstance groupServiceCreateGroupWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.GroupsApi()

var body = ; // {GroupRequest} input parameters in json form


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

namespace Example
{
    public class groupServiceCreateGroupExample
    {
        public void main()
        {
            
            var apiInstance = new GroupsApi();
            var body = new GroupRequest(); // GroupRequest | input parameters in json form

            try
            {
                // Create new group
                apiInstance.groupServiceCreateGroup(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupsApi.groupServiceCreateGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\GroupsApi();
$body = ; // GroupRequest | input parameters in json form

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

my $api_instance = WWW::SwaggerClient::GroupsApi->new();
my $body = WWW::SwaggerClient::Object::GroupRequest->new(); # GroupRequest | input parameters in json form

eval { 
    $api_instance->groupServiceCreateGroup(body => $body);
};
if ($@) {
    warn "Exception when calling GroupsApi->groupServiceCreateGroup: $@\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.GroupsApi()
body =  # GroupRequest | input parameters in json form

try: 
    # Create new group
    api_instance.groupServiceCreateGroup(body)
except ApiException as e:
    print("Exception when calling GroupsApi->groupServiceCreateGroup: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: 500 - Server Error


groupServiceDeleteGroup

Delete group

Delete group resource.


/groups/{groupName}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/groups/{groupName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupsApi;

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

public class GroupsApiExample {

    public static void main(String[] args) {
        
        GroupsApi apiInstance = new GroupsApi();
        String groupName = groupName_example; // String | group name
        try {
            apiInstance.groupServiceDeleteGroup(groupName);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupServiceDeleteGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupsApi;

public class GroupsApiExample {

    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        String groupName = groupName_example; // String | group name
        try {
            apiInstance.groupServiceDeleteGroup(groupName);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupServiceDeleteGroup");
            e.printStackTrace();
        }
    }
}
String *groupName = groupName_example; // group name

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

// Delete group
[apiInstance groupServiceDeleteGroupWith:groupName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.GroupsApi()

var groupName = groupName_example; // {String} group name


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

namespace Example
{
    public class groupServiceDeleteGroupExample
    {
        public void main()
        {
            
            var apiInstance = new GroupsApi();
            var groupName = groupName_example;  // String | group name

            try
            {
                // Delete group
                apiInstance.groupServiceDeleteGroup(groupName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupsApi.groupServiceDeleteGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\GroupsApi();
$groupName = groupName_example; // String | group name

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

my $api_instance = WWW::SwaggerClient::GroupsApi->new();
my $groupName = groupName_example; # String | group name

eval { 
    $api_instance->groupServiceDeleteGroup(groupName => $groupName);
};
if ($@) {
    warn "Exception when calling GroupsApi->groupServiceDeleteGroup: $@\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.GroupsApi()
groupName = groupName_example # String | group name

try: 
    # Delete group
    api_instance.groupServiceDeleteGroup(groupName)
except ApiException as e:
    print("Exception when calling GroupsApi->groupServiceDeleteGroup: %s\n" % e)

Parameters

Path parameters
Name Description
groupName*

Responses

Status: 200 - Successful operation

Status: 500 - Server Error


groupServiceGetGroup

Get group

Returns group details.


/groups/{groupName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/groups/{groupName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupsApi;

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

public class GroupsApiExample {

    public static void main(String[] args) {
        
        GroupsApi apiInstance = new GroupsApi();
        String groupName = groupName_example; // String | group name
        String fields = fields_example; // String | Filter group details
        try {
            GroupResponse result = apiInstance.groupServiceGetGroup(groupName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupServiceGetGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupsApi;

public class GroupsApiExample {

    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        String groupName = groupName_example; // String | group name
        String fields = fields_example; // String | Filter group details
        try {
            GroupResponse result = apiInstance.groupServiceGetGroup(groupName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupServiceGetGroup");
            e.printStackTrace();
        }
    }
}
String *groupName = groupName_example; // group name
String *fields = fields_example; // Filter group details (optional) (default to Groups)

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

// Get group
[apiInstance groupServiceGetGroupWith:groupName
    fields:fields
              completionHandler: ^(GroupResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.GroupsApi()

var groupName = groupName_example; // {String} group name

var opts = { 
  'fields': fields_example // {String} Filter group details
};

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

namespace Example
{
    public class groupServiceGetGroupExample
    {
        public void main()
        {
            
            var apiInstance = new GroupsApi();
            var groupName = groupName_example;  // String | group name
            var fields = fields_example;  // String | Filter group details (optional)  (default to Groups)

            try
            {
                // Get group
                GroupResponse result = apiInstance.groupServiceGetGroup(groupName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupsApi.groupServiceGetGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\GroupsApi();
$groupName = groupName_example; // String | group name
$fields = fields_example; // String | Filter group details

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

my $api_instance = WWW::SwaggerClient::GroupsApi->new();
my $groupName = groupName_example; # String | group name
my $fields = fields_example; # String | Filter group details

eval { 
    my $result = $api_instance->groupServiceGetGroup(groupName => $groupName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->groupServiceGetGroup: $@\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.GroupsApi()
groupName = groupName_example # String | group name
fields = fields_example # String | Filter group details (optional) (default to Groups)

try: 
    # Get group
    api_response = api_instance.groupServiceGetGroup(groupName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->groupServiceGetGroup: %s\n" % e)

Parameters

Path parameters
Name Description
groupName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful retrieval of group resource


groupServiceGetGroups

Get all groups

Returns details of all groups.


/groups

Usage and SDK Samples

curl -X get "https://localhost/api/v1/groups?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupsApi;

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

public class GroupsApiExample {

    public static void main(String[] args) {
        
        GroupsApi apiInstance = new GroupsApi();
        String fields = fields_example; // String | Filter group details
        String sortBy = sortBy_example; // String | Sort groups (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive). Valid values are :offset | "start"
        String to = to_example; // String | The ending page resource (inclusive). Valid values are :offset | "end"
        try {
            array[GroupResponse] result = apiInstance.groupServiceGetGroups(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupServiceGetGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupsApi;

public class GroupsApiExample {

    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        String fields = fields_example; // String | Filter group details
        String sortBy = sortBy_example; // String | Sort groups (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive). Valid values are :offset | "start"
        String to = to_example; // String | The ending page resource (inclusive). Valid values are :offset | "end"
        try {
            array[GroupResponse] result = apiInstance.groupServiceGetGroups(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#groupServiceGetGroups");
            e.printStackTrace();
        }
    }
}
String *fields = fields_example; // Filter group details (optional) (default to Groups/*)
String *sortBy = sortBy_example; // Sort groups (asc | desc) (optional) (default to Groups/group_name.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive). Valid values are :offset | "start" (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive). Valid values are :offset | "end" (optional)

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

// Get all groups
[apiInstance groupServiceGetGroupsWith:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[GroupResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.GroupsApi()

var opts = { 
  'fields': fields_example, // {String} Filter group details
  'sortBy': sortBy_example, // {String} Sort groups (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive). Valid values are :offset | "start"
  'to': to_example // {String} The ending page resource (inclusive). Valid values are :offset | "end"
};

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

namespace Example
{
    public class groupServiceGetGroupsExample
    {
        public void main()
        {
            
            var apiInstance = new GroupsApi();
            var fields = fields_example;  // String | Filter group details (optional)  (default to Groups/*)
            var sortBy = sortBy_example;  // String | Sort groups (asc | desc) (optional)  (default to Groups/group_name.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive). Valid values are :offset | "start" (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive). Valid values are :offset | "end" (optional) 

            try
            {
                // Get all groups
                array[GroupResponse] result = apiInstance.groupServiceGetGroups(fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupsApi.groupServiceGetGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\GroupsApi();
$fields = fields_example; // String | Filter group details
$sortBy = sortBy_example; // String | Sort groups (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive). Valid values are :offset | "start"
$to = to_example; // String | The ending page resource (inclusive). Valid values are :offset | "end"

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

my $api_instance = WWW::SwaggerClient::GroupsApi->new();
my $fields = fields_example; # String | Filter group details
my $sortBy = sortBy_example; # String | Sort groups (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive). Valid values are :offset | "start"
my $to = to_example; # String | The ending page resource (inclusive). Valid values are :offset | "end"

eval { 
    my $result = $api_instance->groupServiceGetGroups(fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->groupServiceGetGroups: $@\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.GroupsApi()
fields = fields_example # String | Filter group details (optional) (default to Groups/*)
sortBy = sortBy_example # String | Sort groups (asc | desc) (optional) (default to Groups/group_name.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive). Valid values are :offset | "start" (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive). Valid values are :offset | "end" (optional)

try: 
    # Get all groups
    api_response = api_instance.groupServiceGetGroups(fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->groupServiceGetGroups: %s\n" % e)

Parameters

Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful retrieval of all group entries


memberServiceDeleteMember

Delete group member

Delete member resource.


/groups/{groupName}/members/{userName}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/groups/{groupName}/members/{userName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupsApi;

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

public class GroupsApiExample {

    public static void main(String[] args) {
        
        GroupsApi apiInstance = new GroupsApi();
        String groupName = groupName_example; // String | group name
        String userName = userName_example; // String | user name
        try {
            apiInstance.memberServiceDeleteMember(groupName, userName);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#memberServiceDeleteMember");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupsApi;

public class GroupsApiExample {

    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        String groupName = groupName_example; // String | group name
        String userName = userName_example; // String | user name
        try {
            apiInstance.memberServiceDeleteMember(groupName, userName);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#memberServiceDeleteMember");
            e.printStackTrace();
        }
    }
}
String *groupName = groupName_example; // group name
String *userName = userName_example; // user name

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

// Delete group member
[apiInstance memberServiceDeleteMemberWith:groupName
    userName:userName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.GroupsApi()

var groupName = groupName_example; // {String} group name

var userName = userName_example; // {String} user name


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

namespace Example
{
    public class memberServiceDeleteMemberExample
    {
        public void main()
        {
            
            var apiInstance = new GroupsApi();
            var groupName = groupName_example;  // String | group name
            var userName = userName_example;  // String | user name

            try
            {
                // Delete group member
                apiInstance.memberServiceDeleteMember(groupName, userName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupsApi.memberServiceDeleteMember: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\GroupsApi();
$groupName = groupName_example; // String | group name
$userName = userName_example; // String | user name

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

my $api_instance = WWW::SwaggerClient::GroupsApi->new();
my $groupName = groupName_example; # String | group name
my $userName = userName_example; # String | user name

eval { 
    $api_instance->memberServiceDeleteMember(groupName => $groupName, userName => $userName);
};
if ($@) {
    warn "Exception when calling GroupsApi->memberServiceDeleteMember: $@\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.GroupsApi()
groupName = groupName_example # String | group name
userName = userName_example # String | user name

try: 
    # Delete group member
    api_instance.memberServiceDeleteMember(groupName, userName)
except ApiException as e:
    print("Exception when calling GroupsApi->memberServiceDeleteMember: %s\n" % e)

Parameters

Path parameters
Name Description
groupName*
userName*

Responses

Status: 200 - Successful operation

Status: 500 - Server Error


memberServiceGetMember

Get group member

Returns member details.


/groups/{groupName}/members/{userName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/groups/{groupName}/members/{userName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupsApi;

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

public class GroupsApiExample {

    public static void main(String[] args) {
        
        GroupsApi apiInstance = new GroupsApi();
        String groupName = groupName_example; // String | group name
        String userName = userName_example; // String | user name
        String fields = fields_example; // String | Filter member details
        try {
            MemberResponse result = apiInstance.memberServiceGetMember(groupName, userName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#memberServiceGetMember");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupsApi;

public class GroupsApiExample {

    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        String groupName = groupName_example; // String | group name
        String userName = userName_example; // String | user name
        String fields = fields_example; // String | Filter member details
        try {
            MemberResponse result = apiInstance.memberServiceGetMember(groupName, userName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#memberServiceGetMember");
            e.printStackTrace();
        }
    }
}
String *groupName = groupName_example; // group name
String *userName = userName_example; // user name
String *fields = fields_example; // Filter member details (optional) (default to MemberInfo)

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

// Get group member
[apiInstance memberServiceGetMemberWith:groupName
    userName:userName
    fields:fields
              completionHandler: ^(MemberResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.GroupsApi()

var groupName = groupName_example; // {String} group name

var userName = userName_example; // {String} user name

var opts = { 
  'fields': fields_example // {String} Filter member details
};

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

namespace Example
{
    public class memberServiceGetMemberExample
    {
        public void main()
        {
            
            var apiInstance = new GroupsApi();
            var groupName = groupName_example;  // String | group name
            var userName = userName_example;  // String | user name
            var fields = fields_example;  // String | Filter member details (optional)  (default to MemberInfo)

            try
            {
                // Get group member
                MemberResponse result = apiInstance.memberServiceGetMember(groupName, userName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupsApi.memberServiceGetMember: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\GroupsApi();
$groupName = groupName_example; // String | group name
$userName = userName_example; // String | user name
$fields = fields_example; // String | Filter member details

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

my $api_instance = WWW::SwaggerClient::GroupsApi->new();
my $groupName = groupName_example; # String | group name
my $userName = userName_example; # String | user name
my $fields = fields_example; # String | Filter member details

eval { 
    my $result = $api_instance->memberServiceGetMember(groupName => $groupName, userName => $userName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->memberServiceGetMember: $@\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.GroupsApi()
groupName = groupName_example # String | group name
userName = userName_example # String | user name
fields = fields_example # String | Filter member details (optional) (default to MemberInfo)

try: 
    # Get group member
    api_response = api_instance.memberServiceGetMember(groupName, userName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->memberServiceGetMember: %s\n" % e)

Parameters

Path parameters
Name Description
groupName*
userName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation


memberServiceGetMembers

Get all group members

Returns details of all members.


/groups/{groupName}/members

Usage and SDK Samples

curl -X get "https://localhost/api/v1/groups/{groupName}/members?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupsApi;

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

public class GroupsApiExample {

    public static void main(String[] args) {
        
        GroupsApi apiInstance = new GroupsApi();
        String groupName = groupName_example; // String | group name
        String fields = fields_example; // String | Filter member details
        String sortBy = sortBy_example; // String | Sort members (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive). Valid values are :offset | "start"
        String to = to_example; // String | The ending page resource (inclusive). Valid values are :offset | "end"
        try {
            array[MemberResponse] result = apiInstance.memberServiceGetMembers(groupName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#memberServiceGetMembers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupsApi;

public class GroupsApiExample {

    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        String groupName = groupName_example; // String | group name
        String fields = fields_example; // String | Filter member details
        String sortBy = sortBy_example; // String | Sort members (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive). Valid values are :offset | "start"
        String to = to_example; // String | The ending page resource (inclusive). Valid values are :offset | "end"
        try {
            array[MemberResponse] result = apiInstance.memberServiceGetMembers(groupName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#memberServiceGetMembers");
            e.printStackTrace();
        }
    }
}
String *groupName = groupName_example; // group name
String *fields = fields_example; // Filter member details (optional) (default to MemberInfo/*)
String *sortBy = sortBy_example; // Sort members (asc | desc) (optional) (default to MemberInfo/user_name.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive). Valid values are :offset | "start" (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive). Valid values are :offset | "end" (optional)

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

// Get all group members
[apiInstance memberServiceGetMembersWith:groupName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[MemberResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.GroupsApi()

var groupName = groupName_example; // {String} group name

var opts = { 
  'fields': fields_example, // {String} Filter member details
  'sortBy': sortBy_example, // {String} Sort members (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive). Valid values are :offset | "start"
  'to': to_example // {String} The ending page resource (inclusive). Valid values are :offset | "end"
};

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

namespace Example
{
    public class memberServiceGetMembersExample
    {
        public void main()
        {
            
            var apiInstance = new GroupsApi();
            var groupName = groupName_example;  // String | group name
            var fields = fields_example;  // String | Filter member details (optional)  (default to MemberInfo/*)
            var sortBy = sortBy_example;  // String | Sort members (asc | desc) (optional)  (default to MemberInfo/user_name.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive). Valid values are :offset | "start" (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive). Valid values are :offset | "end" (optional) 

            try
            {
                // Get all group members
                array[MemberResponse] result = apiInstance.memberServiceGetMembers(groupName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupsApi.memberServiceGetMembers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\GroupsApi();
$groupName = groupName_example; // String | group name
$fields = fields_example; // String | Filter member details
$sortBy = sortBy_example; // String | Sort members (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive). Valid values are :offset | "start"
$to = to_example; // String | The ending page resource (inclusive). Valid values are :offset | "end"

try {
    $result = $api_instance->memberServiceGetMembers($groupName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->memberServiceGetMembers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GroupsApi;

my $api_instance = WWW::SwaggerClient::GroupsApi->new();
my $groupName = groupName_example; # String | group name
my $fields = fields_example; # String | Filter member details
my $sortBy = sortBy_example; # String | Sort members (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive). Valid values are :offset | "start"
my $to = to_example; # String | The ending page resource (inclusive). Valid values are :offset | "end"

eval { 
    my $result = $api_instance->memberServiceGetMembers(groupName => $groupName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->memberServiceGetMembers: $@\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.GroupsApi()
groupName = groupName_example # String | group name
fields = fields_example # String | Filter member details (optional) (default to MemberInfo/*)
sortBy = sortBy_example # String | Sort members (asc | desc) (optional) (default to MemberInfo/user_name.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive). Valid values are :offset | "start" (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive). Valid values are :offset | "end" (optional)

try: 
    # Get all group members
    api_response = api_instance.memberServiceGetMembers(groupName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->memberServiceGetMembers: %s\n" % e)

Parameters

Path parameters
Name Description
groupName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation


memberServiceUpdateMembers

Update group members

Updates group member resources.


/groups/{groupName}/members

Usage and SDK Samples

curl -X put "https://localhost/api/v1/groups/{groupName}/members"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupsApi;

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

public class GroupsApiExample {

    public static void main(String[] args) {
        
        GroupsApi apiInstance = new GroupsApi();
        String groupName = groupName_example; // String | group name
        MemberRequest body = ; // MemberRequest | input parameters in json form
        try {
            apiInstance.memberServiceUpdateMembers(groupName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#memberServiceUpdateMembers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.GroupsApi;

public class GroupsApiExample {

    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        String groupName = groupName_example; // String | group name
        MemberRequest body = ; // MemberRequest | input parameters in json form
        try {
            apiInstance.memberServiceUpdateMembers(groupName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#memberServiceUpdateMembers");
            e.printStackTrace();
        }
    }
}
String *groupName = groupName_example; // group name
MemberRequest *body = ; // input parameters in json form

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

// Update group members
[apiInstance memberServiceUpdateMembersWith:groupName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.GroupsApi()

var groupName = groupName_example; // {String} group name

var body = ; // {MemberRequest} input parameters in json form


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

namespace Example
{
    public class memberServiceUpdateMembersExample
    {
        public void main()
        {
            
            var apiInstance = new GroupsApi();
            var groupName = groupName_example;  // String | group name
            var body = new MemberRequest(); // MemberRequest | input parameters in json form

            try
            {
                // Update group members
                apiInstance.memberServiceUpdateMembers(groupName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling GroupsApi.memberServiceUpdateMembers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\GroupsApi();
$groupName = groupName_example; // String | group name
$body = ; // MemberRequest | input parameters in json form

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

my $api_instance = WWW::SwaggerClient::GroupsApi->new();
my $groupName = groupName_example; # String | group name
my $body = WWW::SwaggerClient::Object::MemberRequest->new(); # MemberRequest | input parameters in json form

eval { 
    $api_instance->memberServiceUpdateMembers(groupName => $groupName, body => $body);
};
if ($@) {
    warn "Exception when calling GroupsApi->memberServiceUpdateMembers: $@\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.GroupsApi()
groupName = groupName_example # String | group name
body =  # MemberRequest | input parameters in json form

try: 
    # Update group members
    api_instance.memberServiceUpdateMembers(groupName, body)
except ApiException as e:
    print("Exception when calling GroupsApi->memberServiceUpdateMembers: %s\n" % e)

Parameters

Path parameters
Name Description
groupName*
Body parameters
Name Description
body *

Responses

Status: 200 - Successful operation

Status: 500 - Server Error


HostComponents

createHostComponent

Create new host component


/clusters/{clusterName}/host_components/{hostComponentName}

Usage and SDK Samples

curl -X post "https://localhost/api/v1/clusters/{clusterName}/host_components/{hostComponentName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostComponentsApi;

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

public class HostComponentsApiExample {

    public static void main(String[] args) {
        
        HostComponentsApi apiInstance = new HostComponentsApi();
        String hostComponentName = hostComponentName_example; // String | 
        String clusterName = clusterName_example; // String | 
        ServiceComponentHostResponse body = ; // ServiceComponentHostResponse | 
        try {
            apiInstance.createHostComponent(hostComponentName, clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostComponentsApi#createHostComponent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HostComponentsApi;

public class HostComponentsApiExample {

    public static void main(String[] args) {
        HostComponentsApi apiInstance = new HostComponentsApi();
        String hostComponentName = hostComponentName_example; // String | 
        String clusterName = clusterName_example; // String | 
        ServiceComponentHostResponse body = ; // ServiceComponentHostResponse | 
        try {
            apiInstance.createHostComponent(hostComponentName, clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostComponentsApi#createHostComponent");
            e.printStackTrace();
        }
    }
}
String *hostComponentName = hostComponentName_example; // 
String *clusterName = clusterName_example; // 
ServiceComponentHostResponse *body = ; //  (optional)

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

// Create new host component
[apiInstance createHostComponentWith:hostComponentName
    clusterName:clusterName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.HostComponentsApi()

var hostComponentName = hostComponentName_example; // {String} 

var clusterName = clusterName_example; // {String} 

var opts = { 
  'body':  // {ServiceComponentHostResponse} 
};

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

namespace Example
{
    public class createHostComponentExample
    {
        public void main()
        {
            
            var apiInstance = new HostComponentsApi();
            var hostComponentName = hostComponentName_example;  // String | 
            var clusterName = clusterName_example;  // String | 
            var body = new ServiceComponentHostResponse(); // ServiceComponentHostResponse |  (optional) 

            try
            {
                // Create new host component
                apiInstance.createHostComponent(hostComponentName, clusterName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostComponentsApi.createHostComponent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\HostComponentsApi();
$hostComponentName = hostComponentName_example; // String | 
$clusterName = clusterName_example; // String | 
$body = ; // ServiceComponentHostResponse | 

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

my $api_instance = WWW::SwaggerClient::HostComponentsApi->new();
my $hostComponentName = hostComponentName_example; # String | 
my $clusterName = clusterName_example; # String | 
my $body = WWW::SwaggerClient::Object::ServiceComponentHostResponse->new(); # ServiceComponentHostResponse | 

eval { 
    $api_instance->createHostComponent(hostComponentName => $hostComponentName, clusterName => $clusterName, body => $body);
};
if ($@) {
    warn "Exception when calling HostComponentsApi->createHostComponent: $@\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.HostComponentsApi()
hostComponentName = hostComponentName_example # String | 
clusterName = clusterName_example # String | 
body =  # ServiceComponentHostResponse |  (optional)

try: 
    # Create new host component
    api_instance.createHostComponent(hostComponentName, clusterName, body=body)
except ApiException as e:
    print("Exception when calling HostComponentsApi->createHostComponent: %s\n" % e)

Parameters

Path parameters
Name Description
hostComponentName*
clusterName*
Body parameters
Name Description
body

Responses

Status: 201 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


deleteHostComponent

Delete host component


/clusters/{clusterName}/host_components/{hostComponentName}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/clusters/{clusterName}/host_components/{hostComponentName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostComponentsApi;

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

public class HostComponentsApiExample {

    public static void main(String[] args) {
        
        HostComponentsApi apiInstance = new HostComponentsApi();
        String hostComponentName = hostComponentName_example; // String | 
        String clusterName = clusterName_example; // String | 
        try {
            apiInstance.deleteHostComponent(hostComponentName, clusterName);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostComponentsApi#deleteHostComponent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HostComponentsApi;

public class HostComponentsApiExample {

    public static void main(String[] args) {
        HostComponentsApi apiInstance = new HostComponentsApi();
        String hostComponentName = hostComponentName_example; // String | 
        String clusterName = clusterName_example; // String | 
        try {
            apiInstance.deleteHostComponent(hostComponentName, clusterName);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostComponentsApi#deleteHostComponent");
            e.printStackTrace();
        }
    }
}
String *hostComponentName = hostComponentName_example; // 
String *clusterName = clusterName_example; // 

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

// Delete host component
[apiInstance deleteHostComponentWith:hostComponentName
    clusterName:clusterName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.HostComponentsApi()

var hostComponentName = hostComponentName_example; // {String} 

var clusterName = clusterName_example; // {String} 


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

namespace Example
{
    public class deleteHostComponentExample
    {
        public void main()
        {
            
            var apiInstance = new HostComponentsApi();
            var hostComponentName = hostComponentName_example;  // String | 
            var clusterName = clusterName_example;  // String | 

            try
            {
                // Delete host component
                apiInstance.deleteHostComponent(hostComponentName, clusterName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostComponentsApi.deleteHostComponent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\HostComponentsApi();
$hostComponentName = hostComponentName_example; // String | 
$clusterName = clusterName_example; // String | 

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

my $api_instance = WWW::SwaggerClient::HostComponentsApi->new();
my $hostComponentName = hostComponentName_example; # String | 
my $clusterName = clusterName_example; # String | 

eval { 
    $api_instance->deleteHostComponent(hostComponentName => $hostComponentName, clusterName => $clusterName);
};
if ($@) {
    warn "Exception when calling HostComponentsApi->deleteHostComponent: $@\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.HostComponentsApi()
hostComponentName = hostComponentName_example # String | 
clusterName = clusterName_example # String | 

try: 
    # Delete host component
    api_instance.deleteHostComponent(hostComponentName, clusterName)
except ApiException as e:
    print("Exception when calling HostComponentsApi->deleteHostComponent: %s\n" % e)

Parameters

Path parameters
Name Description
hostComponentName*
clusterName*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


deleteHostComponents

Delete host components


/clusters/{clusterName}/host_components

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/clusters/{clusterName}/host_components"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostComponentsApi;

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

public class HostComponentsApiExample {

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

public class HostComponentsApiExample {

    public static void main(String[] args) {
        HostComponentsApi apiInstance = new HostComponentsApi();
        String clusterName = clusterName_example; // String | 
        try {
            apiInstance.deleteHostComponents(clusterName);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostComponentsApi#deleteHostComponents");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 

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

// Delete host components
[apiInstance deleteHostComponentsWith:clusterName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.HostComponentsApi()

var clusterName = clusterName_example; // {String} 


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

namespace Example
{
    public class deleteHostComponentsExample
    {
        public void main()
        {
            
            var apiInstance = new HostComponentsApi();
            var clusterName = clusterName_example;  // String | 

            try
            {
                // Delete host components
                apiInstance.deleteHostComponents(clusterName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostComponentsApi.deleteHostComponents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\HostComponentsApi();
$clusterName = clusterName_example; // String | 

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

my $api_instance = WWW::SwaggerClient::HostComponentsApi->new();
my $clusterName = clusterName_example; # String | 

eval { 
    $api_instance->deleteHostComponents(clusterName => $clusterName);
};
if ($@) {
    warn "Exception when calling HostComponentsApi->deleteHostComponents: $@\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.HostComponentsApi()
clusterName = clusterName_example # String | 

try: 
    # Delete host components
    api_instance.deleteHostComponents(clusterName)
except ApiException as e:
    print("Exception when calling HostComponentsApi->deleteHostComponents: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


getHostComponent

Get single host component for a host


/clusters/{clusterName}/host_components/{hostComponentName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/clusters/{clusterName}/host_components/{hostComponentName}?format=&fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostComponentsApi;

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

public class HostComponentsApiExample {

    public static void main(String[] args) {
        
        HostComponentsApi apiInstance = new HostComponentsApi();
        String hostComponentName = hostComponentName_example; // String | 
        String clusterName = clusterName_example; // String | 
        String format = format_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            HostComponentSwagger result = apiInstance.getHostComponent(hostComponentName, clusterName, format, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostComponentsApi#getHostComponent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HostComponentsApi;

public class HostComponentsApiExample {

    public static void main(String[] args) {
        HostComponentsApi apiInstance = new HostComponentsApi();
        String hostComponentName = hostComponentName_example; // String | 
        String clusterName = clusterName_example; // String | 
        String format = format_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            HostComponentSwagger result = apiInstance.getHostComponent(hostComponentName, clusterName, format, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostComponentsApi#getHostComponent");
            e.printStackTrace();
        }
    }
}
String *hostComponentName = hostComponentName_example; // 
String *clusterName = clusterName_example; // 
String *format = format_example; //  (optional)
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional)

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

// Get single host component for a host
[apiInstance getHostComponentWith:hostComponentName
    clusterName:clusterName
    format:format
    fields:fields
              completionHandler: ^(HostComponentSwagger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.HostComponentsApi()

var hostComponentName = hostComponentName_example; // {String} 

var clusterName = clusterName_example; // {String} 

var opts = { 
  'format': format_example, // {String} 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getHostComponentExample
    {
        public void main()
        {
            
            var apiInstance = new HostComponentsApi();
            var hostComponentName = hostComponentName_example;  // String | 
            var clusterName = clusterName_example;  // String | 
            var format = format_example;  // String |  (optional) 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional) 

            try
            {
                // Get single host component for a host
                HostComponentSwagger result = apiInstance.getHostComponent(hostComponentName, clusterName, format, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostComponentsApi.getHostComponent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\HostComponentsApi();
$hostComponentName = hostComponentName_example; // String | 
$clusterName = clusterName_example; // String | 
$format = format_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

try {
    $result = $api_instance->getHostComponent($hostComponentName, $clusterName, $format, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HostComponentsApi->getHostComponent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HostComponentsApi;

my $api_instance = WWW::SwaggerClient::HostComponentsApi->new();
my $hostComponentName = hostComponentName_example; # String | 
my $clusterName = clusterName_example; # String | 
my $format = format_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getHostComponent(hostComponentName => $hostComponentName, clusterName => $clusterName, format => $format, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HostComponentsApi->getHostComponent: $@\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.HostComponentsApi()
hostComponentName = hostComponentName_example # String | 
clusterName = clusterName_example # String | 
format = format_example # String |  (optional)
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional)

try: 
    # Get single host component for a host
    api_response = api_instance.getHostComponent(hostComponentName, clusterName, format=format, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HostComponentsApi->getHostComponent: %s\n" % e)

Parameters

Path parameters
Name Description
hostComponentName*
clusterName*
Query parameters
Name Description
format
fields

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


getHostComponents

Get all host components for a host


/clusters/{clusterName}/host_components

Usage and SDK Samples

curl -X get "https://localhost/api/v1/clusters/{clusterName}/host_components?format=&fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostComponentsApi;

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

public class HostComponentsApiExample {

    public static void main(String[] args) {
        
        HostComponentsApi apiInstance = new HostComponentsApi();
        String clusterName = clusterName_example; // String | 
        String format = format_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            array[HostComponentSwagger] result = apiInstance.getHostComponents(clusterName, format, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostComponentsApi#getHostComponents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HostComponentsApi;

public class HostComponentsApiExample {

    public static void main(String[] args) {
        HostComponentsApi apiInstance = new HostComponentsApi();
        String clusterName = clusterName_example; // String | 
        String format = format_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            array[HostComponentSwagger] result = apiInstance.getHostComponents(clusterName, format, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostComponentsApi#getHostComponents");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 
String *format = format_example; //  (optional)
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional)

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

// Get all host components for a host
[apiInstance getHostComponentsWith:clusterName
    format:format
    fields:fields
              completionHandler: ^(array[HostComponentSwagger] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.HostComponentsApi()

var clusterName = clusterName_example; // {String} 

var opts = { 
  'format': format_example, // {String} 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getHostComponentsExample
    {
        public void main()
        {
            
            var apiInstance = new HostComponentsApi();
            var clusterName = clusterName_example;  // String | 
            var format = format_example;  // String |  (optional) 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional) 

            try
            {
                // Get all host components for a host
                array[HostComponentSwagger] result = apiInstance.getHostComponents(clusterName, format, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostComponentsApi.getHostComponents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\HostComponentsApi();
$clusterName = clusterName_example; // String | 
$format = format_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::HostComponentsApi->new();
my $clusterName = clusterName_example; # String | 
my $format = format_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getHostComponents(clusterName => $clusterName, format => $format, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HostComponentsApi->getHostComponents: $@\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.HostComponentsApi()
clusterName = clusterName_example # String | 
format = format_example # String |  (optional)
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional)

try: 
    # Get all host components for a host
    api_response = api_instance.getHostComponents(clusterName, format=format, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HostComponentsApi->getHostComponents: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*
Query parameters
Name Description
format
fields

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


getProcesses

Get processes of a specific host component


/clusters/{clusterName}/host_components/{hostComponentName}/processes

Usage and SDK Samples

curl -X get "https://localhost/api/v1/clusters/{clusterName}/host_components/{hostComponentName}/processes?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostComponentsApi;

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

public class HostComponentsApiExample {

    public static void main(String[] args) {
        
        HostComponentsApi apiInstance = new HostComponentsApi();
        String hostComponentName = hostComponentName_example; // String | 
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            HostComponentProcessResponse result = apiInstance.getProcesses(hostComponentName, clusterName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostComponentsApi#getProcesses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HostComponentsApi;

public class HostComponentsApiExample {

    public static void main(String[] args) {
        HostComponentsApi apiInstance = new HostComponentsApi();
        String hostComponentName = hostComponentName_example; // String | 
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            HostComponentProcessResponse result = apiInstance.getProcesses(hostComponentName, clusterName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostComponentsApi#getProcesses");
            e.printStackTrace();
        }
    }
}
String *hostComponentName = hostComponentName_example; // 
String *clusterName = clusterName_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional)

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

// Get processes of a specific host component
[apiInstance getProcessesWith:hostComponentName
    clusterName:clusterName
    fields:fields
              completionHandler: ^(HostComponentProcessResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.HostComponentsApi()

var hostComponentName = hostComponentName_example; // {String} 

var clusterName = clusterName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getProcessesExample
    {
        public void main()
        {
            
            var apiInstance = new HostComponentsApi();
            var hostComponentName = hostComponentName_example;  // String | 
            var clusterName = clusterName_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional) 

            try
            {
                // Get processes of a specific host component
                HostComponentProcessResponse result = apiInstance.getProcesses(hostComponentName, clusterName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostComponentsApi.getProcesses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\HostComponentsApi();
$hostComponentName = hostComponentName_example; // String | 
$clusterName = clusterName_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::HostComponentsApi->new();
my $hostComponentName = hostComponentName_example; # String | 
my $clusterName = clusterName_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getProcesses(hostComponentName => $hostComponentName, clusterName => $clusterName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HostComponentsApi->getProcesses: $@\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.HostComponentsApi()
hostComponentName = hostComponentName_example # String | 
clusterName = clusterName_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional)

try: 
    # Get processes of a specific host component
    api_response = api_instance.getProcesses(hostComponentName, clusterName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HostComponentsApi->getProcesses: %s\n" % e)

Parameters

Path parameters
Name Description
hostComponentName*
clusterName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


updateHostComponent

Update host component detail


/clusters/{clusterName}/host_components/{hostComponentName}

Usage and SDK Samples

curl -X put "https://localhost/api/v1/clusters/{clusterName}/host_components/{hostComponentName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostComponentsApi;

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

public class HostComponentsApiExample {

    public static void main(String[] args) {
        
        HostComponentsApi apiInstance = new HostComponentsApi();
        String hostComponentName = hostComponentName_example; // String | 
        String clusterName = clusterName_example; // String | 
        ServiceComponentHostResponse body = ; // ServiceComponentHostResponse | 
        try {
            apiInstance.updateHostComponent(hostComponentName, clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostComponentsApi#updateHostComponent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HostComponentsApi;

public class HostComponentsApiExample {

    public static void main(String[] args) {
        HostComponentsApi apiInstance = new HostComponentsApi();
        String hostComponentName = hostComponentName_example; // String | 
        String clusterName = clusterName_example; // String | 
        ServiceComponentHostResponse body = ; // ServiceComponentHostResponse | 
        try {
            apiInstance.updateHostComponent(hostComponentName, clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostComponentsApi#updateHostComponent");
            e.printStackTrace();
        }
    }
}
String *hostComponentName = hostComponentName_example; // 
String *clusterName = clusterName_example; // 
ServiceComponentHostResponse *body = ; //  (optional)

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

// Update host component detail
[apiInstance updateHostComponentWith:hostComponentName
    clusterName:clusterName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.HostComponentsApi()

var hostComponentName = hostComponentName_example; // {String} 

var clusterName = clusterName_example; // {String} 

var opts = { 
  'body':  // {ServiceComponentHostResponse} 
};

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

namespace Example
{
    public class updateHostComponentExample
    {
        public void main()
        {
            
            var apiInstance = new HostComponentsApi();
            var hostComponentName = hostComponentName_example;  // String | 
            var clusterName = clusterName_example;  // String | 
            var body = new ServiceComponentHostResponse(); // ServiceComponentHostResponse |  (optional) 

            try
            {
                // Update host component detail
                apiInstance.updateHostComponent(hostComponentName, clusterName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostComponentsApi.updateHostComponent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\HostComponentsApi();
$hostComponentName = hostComponentName_example; // String | 
$clusterName = clusterName_example; // String | 
$body = ; // ServiceComponentHostResponse | 

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

my $api_instance = WWW::SwaggerClient::HostComponentsApi->new();
my $hostComponentName = hostComponentName_example; # String | 
my $clusterName = clusterName_example; # String | 
my $body = WWW::SwaggerClient::Object::ServiceComponentHostResponse->new(); # ServiceComponentHostResponse | 

eval { 
    $api_instance->updateHostComponent(hostComponentName => $hostComponentName, clusterName => $clusterName, body => $body);
};
if ($@) {
    warn "Exception when calling HostComponentsApi->updateHostComponent: $@\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.HostComponentsApi()
hostComponentName = hostComponentName_example # String | 
clusterName = clusterName_example # String | 
body =  # ServiceComponentHostResponse |  (optional)

try: 
    # Update host component detail
    api_instance.updateHostComponent(hostComponentName, clusterName, body=body)
except ApiException as e:
    print("Exception when calling HostComponentsApi->updateHostComponent: %s\n" % e)

Parameters

Path parameters
Name Description
hostComponentName*
clusterName*
Body parameters
Name Description
body

Responses

Status: 200 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


Hosts

createHost

Creates a host


/hosts/{hostName}

Usage and SDK Samples

curl -X post "https://localhost/api/v1/hosts/{hostName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostsApi;

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

public class HostsApiExample {

    public static void main(String[] args) {
        
        HostsApi apiInstance = new HostsApi();
        String hostName = hostName_example; // String | host name
        HostRequest body = ; // HostRequest | 
        try {
            apiInstance.createHost(hostName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostsApi#createHost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HostsApi;

public class HostsApiExample {

    public static void main(String[] args) {
        HostsApi apiInstance = new HostsApi();
        String hostName = hostName_example; // String | host name
        HostRequest body = ; // HostRequest | 
        try {
            apiInstance.createHost(hostName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostsApi#createHost");
            e.printStackTrace();
        }
    }
}
String *hostName = hostName_example; // host name
HostRequest *body = ; //  (optional)

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

// Creates a host
[apiInstance createHostWith:hostName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.HostsApi()

var hostName = hostName_example; // {String} host name

var opts = { 
  'body':  // {HostRequest} 
};

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

namespace Example
{
    public class createHostExample
    {
        public void main()
        {
            
            var apiInstance = new HostsApi();
            var hostName = hostName_example;  // String | host name
            var body = new HostRequest(); // HostRequest |  (optional) 

            try
            {
                // Creates a host
                apiInstance.createHost(hostName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostsApi.createHost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\HostsApi();
$hostName = hostName_example; // String | host name
$body = ; // HostRequest | 

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

my $api_instance = WWW::SwaggerClient::HostsApi->new();
my $hostName = hostName_example; # String | host name
my $body = WWW::SwaggerClient::Object::HostRequest->new(); # HostRequest | 

eval { 
    $api_instance->createHost(hostName => $hostName, body => $body);
};
if ($@) {
    warn "Exception when calling HostsApi->createHost: $@\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.HostsApi()
hostName = hostName_example # String | host name
body =  # HostRequest |  (optional)

try: 
    # Creates a host
    api_instance.createHost(hostName, body=body)
except ApiException as e:
    print("Exception when calling HostsApi->createHost: %s\n" % e)

Parameters

Path parameters
Name Description
hostName*
Body parameters
Name Description
body

Responses

Status: 201 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 409 - Attempt to create a host which already exists

Status: 500 - Internal server error


createHosts

Creates multiple hosts in a single request


/hosts

Usage and SDK Samples

curl -X post "https://localhost/api/v1/hosts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostsApi;

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

public class HostsApiExample {

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

public class HostsApiExample {

    public static void main(String[] args) {
        HostsApi apiInstance = new HostsApi();
        HostRequest body = ; // HostRequest | 
        try {
            apiInstance.createHosts(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostsApi#createHosts");
            e.printStackTrace();
        }
    }
}
HostRequest *body = ; //  (optional)

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

// Creates multiple hosts in a single request
[apiInstance createHostsWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.HostsApi()

var opts = { 
  'body':  // {HostRequest} 
};

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

namespace Example
{
    public class createHostsExample
    {
        public void main()
        {
            
            var apiInstance = new HostsApi();
            var body = new HostRequest(); // HostRequest |  (optional) 

            try
            {
                // Creates multiple hosts in a single request
                apiInstance.createHosts(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostsApi.createHosts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\HostsApi();
$body = ; // HostRequest | 

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

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

eval { 
    $api_instance->createHosts(body => $body);
};
if ($@) {
    warn "Exception when calling HostsApi->createHosts: $@\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.HostsApi()
body =  # HostRequest |  (optional)

try: 
    # Creates multiple hosts in a single request
    api_instance.createHosts(body=body)
except ApiException as e:
    print("Exception when calling HostsApi->createHosts: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Attempt to add hosts that have not been registered

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 409 - Attempt to create a host which already exists

Status: 500 - Internal server error


deleteHost

Deletes a host


/hosts/{hostName}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/hosts/{hostName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostsApi;

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

public class HostsApiExample {

    public static void main(String[] args) {
        
        HostsApi apiInstance = new HostsApi();
        String hostName = hostName_example; // String | host name
        try {
            apiInstance.deleteHost(hostName);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostsApi#deleteHost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HostsApi;

public class HostsApiExample {

    public static void main(String[] args) {
        HostsApi apiInstance = new HostsApi();
        String hostName = hostName_example; // String | host name
        try {
            apiInstance.deleteHost(hostName);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostsApi#deleteHost");
            e.printStackTrace();
        }
    }
}
String *hostName = hostName_example; // host name

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

// Deletes a host
[apiInstance deleteHostWith:hostName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.HostsApi()

var hostName = hostName_example; // {String} host name


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

namespace Example
{
    public class deleteHostExample
    {
        public void main()
        {
            
            var apiInstance = new HostsApi();
            var hostName = hostName_example;  // String | host name

            try
            {
                // Deletes a host
                apiInstance.deleteHost(hostName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostsApi.deleteHost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\HostsApi();
$hostName = hostName_example; // String | host name

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

my $api_instance = WWW::SwaggerClient::HostsApi->new();
my $hostName = hostName_example; # String | host name

eval { 
    $api_instance->deleteHost(hostName => $hostName);
};
if ($@) {
    warn "Exception when calling HostsApi->deleteHost: $@\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.HostsApi()
hostName = hostName_example # String | host name

try: 
    # Deletes a host
    api_instance.deleteHost(hostName)
except ApiException as e:
    print("Exception when calling HostsApi->deleteHost: %s\n" % e)

Parameters

Path parameters
Name Description
hostName*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


deleteHosts

Deletes multiple hosts in a single request


/hosts

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/hosts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostsApi;

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

public class HostsApiExample {

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

public class HostsApiExample {

    public static void main(String[] args) {
        HostsApi apiInstance = new HostsApi();
        HostRequest body = ; // HostRequest | 
        try {
            apiInstance.deleteHosts(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostsApi#deleteHosts");
            e.printStackTrace();
        }
    }
}
HostRequest *body = ; //  (optional)

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

// Deletes multiple hosts in a single request
[apiInstance deleteHostsWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.HostsApi()

var opts = { 
  'body':  // {HostRequest} 
};

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

namespace Example
{
    public class deleteHostsExample
    {
        public void main()
        {
            
            var apiInstance = new HostsApi();
            var body = new HostRequest(); // HostRequest |  (optional) 

            try
            {
                // Deletes multiple hosts in a single request
                apiInstance.deleteHosts(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostsApi.deleteHosts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\HostsApi();
$body = ; // HostRequest | 

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

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

eval { 
    $api_instance->deleteHosts(body => $body);
};
if ($@) {
    warn "Exception when calling HostsApi->deleteHosts: $@\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.HostsApi()
body =  # HostRequest |  (optional)

try: 
    # Deletes multiple hosts in a single request
    api_instance.deleteHosts(body=body)
except ApiException as e:
    print("Exception when calling HostsApi->deleteHosts: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


getHost

Returns information about a single host


/hosts/{hostName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/hosts/{hostName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostsApi;

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

public class HostsApiExample {

    public static void main(String[] args) {
        
        HostsApi apiInstance = new HostsApi();
        String hostName = hostName_example; // String | host name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            HostResponseWrapper result = apiInstance.getHost(hostName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostsApi#getHost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HostsApi;

public class HostsApiExample {

    public static void main(String[] args) {
        HostsApi apiInstance = new HostsApi();
        String hostName = hostName_example; // String | host name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            HostResponseWrapper result = apiInstance.getHost(hostName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostsApi#getHost");
            e.printStackTrace();
        }
    }
}
String *hostName = hostName_example; // host name
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional)

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

// Returns information about a single host
[apiInstance getHostWith:hostName
    fields:fields
              completionHandler: ^(HostResponseWrapper output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.HostsApi()

var hostName = hostName_example; // {String} host name

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getHostExample
    {
        public void main()
        {
            
            var apiInstance = new HostsApi();
            var hostName = hostName_example;  // String | host name
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional) 

            try
            {
                // Returns information about a single host
                HostResponseWrapper result = apiInstance.getHost(hostName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostsApi.getHost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\HostsApi();
$hostName = hostName_example; // String | host name
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::HostsApi->new();
my $hostName = hostName_example; # String | host name
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getHost(hostName => $hostName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HostsApi->getHost: $@\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.HostsApi()
hostName = hostName_example # String | host name
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional)

try: 
    # Returns information about a single host
    api_response = api_instance.getHost(hostName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HostsApi->getHost: %s\n" % e)

Parameters

Path parameters
Name Description
hostName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


getHosts

Returns a collection of all hosts


/hosts

Usage and SDK Samples

curl -X get "https://localhost/api/v1/hosts?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostsApi;

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

public class HostsApiExample {

    public static void main(String[] args) {
        
        HostsApi apiInstance = new HostsApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[HostResponseWrapper] result = apiInstance.getHosts(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostsApi#getHosts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HostsApi;

public class HostsApiExample {

    public static void main(String[] args) {
        HostsApi apiInstance = new HostsApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[HostResponseWrapper] result = apiInstance.getHosts(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostsApi#getHosts");
            e.printStackTrace();
        }
    }
}
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Hosts/*)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional) (default to Hosts/host_name.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
Integer *from = 56; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
Integer *to = 56; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Returns a collection of all hosts
[apiInstance getHostsWith:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[HostResponseWrapper] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.HostsApi()

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': 56, // {Integer} The starting page resource (inclusive).  "start" is also accepted.
  'to': 56 // {Integer} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class getHostsExample
    {
        public void main()
        {
            
            var apiInstance = new HostsApi();
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Hosts/*)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional)  (default to Hosts/host_name.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = 56;  // Integer | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = 56;  // Integer | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Returns a collection of all hosts
                array[HostResponseWrapper] result = apiInstance.getHosts(fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostsApi.getHosts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\HostsApi();
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
$to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.

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

my $api_instance = WWW::SwaggerClient::HostsApi->new();
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = 56; # Integer | The starting page resource (inclusive).  "start" is also accepted.
my $to = 56; # Integer | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->getHosts(fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HostsApi->getHosts: $@\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.HostsApi()
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Hosts/*)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional) (default to Hosts/host_name.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = 56 # Integer | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = 56 # Integer | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Returns a collection of all hosts
    api_response = api_instance.getHosts(fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HostsApi->getHosts: %s\n" % e)

Parameters

Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


updateHost

Updates a host


/hosts/{hostName}

Usage and SDK Samples

curl -X put "https://localhost/api/v1/hosts/{hostName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostsApi;

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

public class HostsApiExample {

    public static void main(String[] args) {
        
        HostsApi apiInstance = new HostsApi();
        String hostName = hostName_example; // String | host name
        HostRequest body = ; // HostRequest | 
        try {
            apiInstance.updateHost(hostName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostsApi#updateHost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HostsApi;

public class HostsApiExample {

    public static void main(String[] args) {
        HostsApi apiInstance = new HostsApi();
        String hostName = hostName_example; // String | host name
        HostRequest body = ; // HostRequest | 
        try {
            apiInstance.updateHost(hostName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostsApi#updateHost");
            e.printStackTrace();
        }
    }
}
String *hostName = hostName_example; // host name
HostRequest *body = ; //  (optional)

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

// Updates a host
[apiInstance updateHostWith:hostName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.HostsApi()

var hostName = hostName_example; // {String} host name

var opts = { 
  'body':  // {HostRequest} 
};

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

namespace Example
{
    public class updateHostExample
    {
        public void main()
        {
            
            var apiInstance = new HostsApi();
            var hostName = hostName_example;  // String | host name
            var body = new HostRequest(); // HostRequest |  (optional) 

            try
            {
                // Updates a host
                apiInstance.updateHost(hostName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostsApi.updateHost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\HostsApi();
$hostName = hostName_example; // String | host name
$body = ; // HostRequest | 

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

my $api_instance = WWW::SwaggerClient::HostsApi->new();
my $hostName = hostName_example; # String | host name
my $body = WWW::SwaggerClient::Object::HostRequest->new(); # HostRequest | 

eval { 
    $api_instance->updateHost(hostName => $hostName, body => $body);
};
if ($@) {
    warn "Exception when calling HostsApi->updateHost: $@\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.HostsApi()
hostName = hostName_example # String | host name
body =  # HostRequest |  (optional)

try: 
    # Updates a host
    api_instance.updateHost(hostName, body=body)
except ApiException as e:
    print("Exception when calling HostsApi->updateHost: %s\n" % e)

Parameters

Path parameters
Name Description
hostName*
Body parameters
Name Description
body

Responses

Status: 200 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


updateHosts

Updates multiple hosts in a single request


/hosts

Usage and SDK Samples

curl -X put "https://localhost/api/v1/hosts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HostsApi;

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

public class HostsApiExample {

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

public class HostsApiExample {

    public static void main(String[] args) {
        HostsApi apiInstance = new HostsApi();
        HostRequest body = ; // HostRequest | 
        try {
            apiInstance.updateHosts(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling HostsApi#updateHosts");
            e.printStackTrace();
        }
    }
}
HostRequest *body = ; //  (optional)

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

// Updates multiple hosts in a single request
[apiInstance updateHostsWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.HostsApi()

var opts = { 
  'body':  // {HostRequest} 
};

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

namespace Example
{
    public class updateHostsExample
    {
        public void main()
        {
            
            var apiInstance = new HostsApi();
            var body = new HostRequest(); // HostRequest |  (optional) 

            try
            {
                // Updates multiple hosts in a single request
                apiInstance.updateHosts(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HostsApi.updateHosts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\HostsApi();
$body = ; // HostRequest | 

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

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

eval { 
    $api_instance->updateHosts(body => $body);
};
if ($@) {
    warn "Exception when calling HostsApi->updateHosts: $@\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.HostsApi()
body =  # HostRequest |  (optional)

try: 
    # Updates multiple hosts in a single request
    api_instance.updateHosts(body=body)
except ApiException as e:
    print("Exception when calling HostsApi->updateHosts: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


RequestSchedules

createRequestSchedule

Create new request schedule


/clusters/{clusterName}/request_schedules

Usage and SDK Samples

curl -X post "https://localhost/api/v1/clusters/{clusterName}/request_schedules"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RequestSchedulesApi;

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

public class RequestSchedulesApiExample {

    public static void main(String[] args) {
        
        RequestSchedulesApi apiInstance = new RequestSchedulesApi();
        String clusterName = clusterName_example; // String | 
        RequestScheduleRequestSwagger body = ; // RequestScheduleRequestSwagger | 
        try {
            apiInstance.createRequestSchedule(clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling RequestSchedulesApi#createRequestSchedule");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RequestSchedulesApi;

public class RequestSchedulesApiExample {

    public static void main(String[] args) {
        RequestSchedulesApi apiInstance = new RequestSchedulesApi();
        String clusterName = clusterName_example; // String | 
        RequestScheduleRequestSwagger body = ; // RequestScheduleRequestSwagger | 
        try {
            apiInstance.createRequestSchedule(clusterName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling RequestSchedulesApi#createRequestSchedule");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 
RequestScheduleRequestSwagger *body = ; //  (optional)

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

// Create new request schedule
[apiInstance createRequestScheduleWith:clusterName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.RequestSchedulesApi()

var clusterName = clusterName_example; // {String} 

var opts = { 
  'body':  // {RequestScheduleRequestSwagger} 
};

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

namespace Example
{
    public class createRequestScheduleExample
    {
        public void main()
        {
            
            var apiInstance = new RequestSchedulesApi();
            var clusterName = clusterName_example;  // String | 
            var body = new RequestScheduleRequestSwagger(); // RequestScheduleRequestSwagger |  (optional) 

            try
            {
                // Create new request schedule
                apiInstance.createRequestSchedule(clusterName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RequestSchedulesApi.createRequestSchedule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\RequestSchedulesApi();
$clusterName = clusterName_example; // String | 
$body = ; // RequestScheduleRequestSwagger | 

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

my $api_instance = WWW::SwaggerClient::RequestSchedulesApi->new();
my $clusterName = clusterName_example; # String | 
my $body = WWW::SwaggerClient::Object::RequestScheduleRequestSwagger->new(); # RequestScheduleRequestSwagger | 

eval { 
    $api_instance->createRequestSchedule(clusterName => $clusterName, body => $body);
};
if ($@) {
    warn "Exception when calling RequestSchedulesApi->createRequestSchedule: $@\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.RequestSchedulesApi()
clusterName = clusterName_example # String | 
body =  # RequestScheduleRequestSwagger |  (optional)

try: 
    # Create new request schedule
    api_instance.createRequestSchedule(clusterName, body=body)
except ApiException as e:
    print("Exception when calling RequestSchedulesApi->createRequestSchedule: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*
Body parameters
Name Description
body

Responses

Status: 201 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


deleteRequestSchedule

Delete a request schedule

Changes status from COMPLETED to DISABLED


/clusters/{clusterName}/request_schedules/{requestScheduleId}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/clusters/{clusterName}/request_schedules/{requestScheduleId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RequestSchedulesApi;

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

public class RequestSchedulesApiExample {

    public static void main(String[] args) {
        
        RequestSchedulesApi apiInstance = new RequestSchedulesApi();
        String requestScheduleId = requestScheduleId_example; // String | 
        String clusterName = clusterName_example; // String | 
        try {
            apiInstance.deleteRequestSchedule(requestScheduleId, clusterName);
        } catch (ApiException e) {
            System.err.println("Exception when calling RequestSchedulesApi#deleteRequestSchedule");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RequestSchedulesApi;

public class RequestSchedulesApiExample {

    public static void main(String[] args) {
        RequestSchedulesApi apiInstance = new RequestSchedulesApi();
        String requestScheduleId = requestScheduleId_example; // String | 
        String clusterName = clusterName_example; // String | 
        try {
            apiInstance.deleteRequestSchedule(requestScheduleId, clusterName);
        } catch (ApiException e) {
            System.err.println("Exception when calling RequestSchedulesApi#deleteRequestSchedule");
            e.printStackTrace();
        }
    }
}
String *requestScheduleId = requestScheduleId_example; // 
String *clusterName = clusterName_example; // 

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

// Delete a request schedule
[apiInstance deleteRequestScheduleWith:requestScheduleId
    clusterName:clusterName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.RequestSchedulesApi()

var requestScheduleId = requestScheduleId_example; // {String} 

var clusterName = clusterName_example; // {String} 


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

namespace Example
{
    public class deleteRequestScheduleExample
    {
        public void main()
        {
            
            var apiInstance = new RequestSchedulesApi();
            var requestScheduleId = requestScheduleId_example;  // String | 
            var clusterName = clusterName_example;  // String | 

            try
            {
                // Delete a request schedule
                apiInstance.deleteRequestSchedule(requestScheduleId, clusterName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RequestSchedulesApi.deleteRequestSchedule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\RequestSchedulesApi();
$requestScheduleId = requestScheduleId_example; // String | 
$clusterName = clusterName_example; // String | 

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

my $api_instance = WWW::SwaggerClient::RequestSchedulesApi->new();
my $requestScheduleId = requestScheduleId_example; # String | 
my $clusterName = clusterName_example; # String | 

eval { 
    $api_instance->deleteRequestSchedule(requestScheduleId => $requestScheduleId, clusterName => $clusterName);
};
if ($@) {
    warn "Exception when calling RequestSchedulesApi->deleteRequestSchedule: $@\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.RequestSchedulesApi()
requestScheduleId = requestScheduleId_example # String | 
clusterName = clusterName_example # String | 

try: 
    # Delete a request schedule
    api_instance.deleteRequestSchedule(requestScheduleId, clusterName)
except ApiException as e:
    print("Exception when calling RequestSchedulesApi->deleteRequestSchedule: %s\n" % e)

Parameters

Path parameters
Name Description
requestScheduleId*
clusterName*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


getRequestSchedule

Get request schedule


/clusters/{clusterName}/request_schedules/{requestScheduleId}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/clusters/{clusterName}/request_schedules/{requestScheduleId}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RequestSchedulesApi;

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

public class RequestSchedulesApiExample {

    public static void main(String[] args) {
        
        RequestSchedulesApi apiInstance = new RequestSchedulesApi();
        String requestScheduleId = requestScheduleId_example; // String | 
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            RequestScheduleResponseSwagger result = apiInstance.getRequestSchedule(requestScheduleId, clusterName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RequestSchedulesApi#getRequestSchedule");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RequestSchedulesApi;

public class RequestSchedulesApiExample {

    public static void main(String[] args) {
        RequestSchedulesApi apiInstance = new RequestSchedulesApi();
        String requestScheduleId = requestScheduleId_example; // String | 
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            RequestScheduleResponseSwagger result = apiInstance.getRequestSchedule(requestScheduleId, clusterName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RequestSchedulesApi#getRequestSchedule");
            e.printStackTrace();
        }
    }
}
String *requestScheduleId = requestScheduleId_example; // 
String *clusterName = clusterName_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to RequestSchedule/*)

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

// Get request schedule
[apiInstance getRequestScheduleWith:requestScheduleId
    clusterName:clusterName
    fields:fields
              completionHandler: ^(RequestScheduleResponseSwagger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.RequestSchedulesApi()

var requestScheduleId = requestScheduleId_example; // {String} 

var clusterName = clusterName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getRequestScheduleExample
    {
        public void main()
        {
            
            var apiInstance = new RequestSchedulesApi();
            var requestScheduleId = requestScheduleId_example;  // String | 
            var clusterName = clusterName_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to RequestSchedule/*)

            try
            {
                // Get request schedule
                RequestScheduleResponseSwagger result = apiInstance.getRequestSchedule(requestScheduleId, clusterName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RequestSchedulesApi.getRequestSchedule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\RequestSchedulesApi();
$requestScheduleId = requestScheduleId_example; // String | 
$clusterName = clusterName_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::RequestSchedulesApi->new();
my $requestScheduleId = requestScheduleId_example; # String | 
my $clusterName = clusterName_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getRequestSchedule(requestScheduleId => $requestScheduleId, clusterName => $clusterName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RequestSchedulesApi->getRequestSchedule: $@\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.RequestSchedulesApi()
requestScheduleId = requestScheduleId_example # String | 
clusterName = clusterName_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to RequestSchedule/*)

try: 
    # Get request schedule
    api_response = api_instance.getRequestSchedule(requestScheduleId, clusterName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RequestSchedulesApi->getRequestSchedule: %s\n" % e)

Parameters

Path parameters
Name Description
requestScheduleId*
clusterName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


getRequestSchedules

Get all request schedules


/clusters/{clusterName}/request_schedules

Usage and SDK Samples

curl -X get "https://localhost/api/v1/clusters/{clusterName}/request_schedules?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RequestSchedulesApi;

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

public class RequestSchedulesApiExample {

    public static void main(String[] args) {
        
        RequestSchedulesApi apiInstance = new RequestSchedulesApi();
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            array[RequestScheduleResponseSwagger] result = apiInstance.getRequestSchedules(clusterName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RequestSchedulesApi#getRequestSchedules");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RequestSchedulesApi;

public class RequestSchedulesApiExample {

    public static void main(String[] args) {
        RequestSchedulesApi apiInstance = new RequestSchedulesApi();
        String clusterName = clusterName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            array[RequestScheduleResponseSwagger] result = apiInstance.getRequestSchedules(clusterName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RequestSchedulesApi#getRequestSchedules");
            e.printStackTrace();
        }
    }
}
String *clusterName = clusterName_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to RequestSchedule/*)

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

// Get all request schedules
[apiInstance getRequestSchedulesWith:clusterName
    fields:fields
              completionHandler: ^(array[RequestScheduleResponseSwagger] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.RequestSchedulesApi()

var clusterName = clusterName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getRequestSchedulesExample
    {
        public void main()
        {
            
            var apiInstance = new RequestSchedulesApi();
            var clusterName = clusterName_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to RequestSchedule/*)

            try
            {
                // Get all request schedules
                array[RequestScheduleResponseSwagger] result = apiInstance.getRequestSchedules(clusterName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RequestSchedulesApi.getRequestSchedules: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\RequestSchedulesApi();
$clusterName = clusterName_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::RequestSchedulesApi->new();
my $clusterName = clusterName_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getRequestSchedules(clusterName => $clusterName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RequestSchedulesApi->getRequestSchedules: $@\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.RequestSchedulesApi()
clusterName = clusterName_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to RequestSchedule/*)

try: 
    # Get all request schedules
    api_response = api_instance.getRequestSchedules(clusterName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RequestSchedulesApi->getRequestSchedules: %s\n" % e)

Parameters

Path parameters
Name Description
clusterName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


Requests

requestServiceCreateRequests

Creates one or more Requests


/requests

Usage and SDK Samples

curl -X post "https://localhost/api/v1/requests"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RequestsApi;

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

public class RequestsApiExample {

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

public class RequestsApiExample {

    public static void main(String[] args) {
        RequestsApi apiInstance = new RequestsApi();
        RequestPostRequest body = ; // RequestPostRequest | 
        try {
            apiInstance.requestServiceCreateRequests(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling RequestsApi#requestServiceCreateRequests");
            e.printStackTrace();
        }
    }
}
RequestPostRequest *body = ; //  (optional)

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

// Creates one or more Requests
[apiInstance requestServiceCreateRequestsWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.RequestsApi()

var opts = { 
  'body':  // {RequestPostRequest} 
};

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

namespace Example
{
    public class requestServiceCreateRequestsExample
    {
        public void main()
        {
            
            var apiInstance = new RequestsApi();
            var body = new RequestPostRequest(); // RequestPostRequest |  (optional) 

            try
            {
                // Creates one or more Requests
                apiInstance.requestServiceCreateRequests(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RequestsApi.requestServiceCreateRequests: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\RequestsApi();
$body = ; // RequestPostRequest | 

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

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

eval { 
    $api_instance->requestServiceCreateRequests(body => $body);
};
if ($@) {
    warn "Exception when calling RequestsApi->requestServiceCreateRequests: $@\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.RequestsApi()
body =  # RequestPostRequest |  (optional)

try: 
    # Creates one or more Requests
    api_instance.requestServiceCreateRequests(body=body)
except ApiException as e:
    print("Exception when calling RequestsApi->requestServiceCreateRequests: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 409 - The requested resource already exists.

Status: 500 - Internal server error


requestServiceGetRequest

Get the details of a request


/requests/{requestId}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/requests/{requestId}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RequestsApi;

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

public class RequestsApiExample {

    public static void main(String[] args) {
        
        RequestsApi apiInstance = new RequestsApi();
        String requestId = requestId_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            RequestResponse result = apiInstance.requestServiceGetRequest(requestId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RequestsApi#requestServiceGetRequest");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RequestsApi;

public class RequestsApiExample {

    public static void main(String[] args) {
        RequestsApi apiInstance = new RequestsApi();
        String requestId = requestId_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            RequestResponse result = apiInstance.requestServiceGetRequest(requestId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RequestsApi#requestServiceGetRequest");
            e.printStackTrace();
        }
    }
}
String *requestId = requestId_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Requests/*)

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

// Get the details of a request
[apiInstance requestServiceGetRequestWith:requestId
    fields:fields
              completionHandler: ^(RequestResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.RequestsApi()

var requestId = requestId_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class requestServiceGetRequestExample
    {
        public void main()
        {
            
            var apiInstance = new RequestsApi();
            var requestId = requestId_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Requests/*)

            try
            {
                // Get the details of a request
                RequestResponse result = apiInstance.requestServiceGetRequest(requestId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RequestsApi.requestServiceGetRequest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\RequestsApi();
$requestId = requestId_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::RequestsApi->new();
my $requestId = requestId_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->requestServiceGetRequest(requestId => $requestId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RequestsApi->requestServiceGetRequest: $@\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.RequestsApi()
requestId = requestId_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Requests/*)

try: 
    # Get the details of a request
    api_response = api_instance.requestServiceGetRequest(requestId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RequestsApi->requestServiceGetRequest: %s\n" % e)

Parameters

Path parameters
Name Description
requestId*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


requestServiceGetRequests

Get all requests. A predicate can be given to filter results.


/requests

Usage and SDK Samples

curl -X get "https://localhost/api/v1/requests?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RequestsApi;

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

public class RequestsApiExample {

    public static void main(String[] args) {
        
        RequestsApi apiInstance = new RequestsApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[RequestResponse] result = apiInstance.requestServiceGetRequests(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RequestsApi#requestServiceGetRequests");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RequestsApi;

public class RequestsApiExample {

    public static void main(String[] args) {
        RequestsApi apiInstance = new RequestsApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[RequestResponse] result = apiInstance.requestServiceGetRequests(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RequestsApi#requestServiceGetRequests");
            e.printStackTrace();
        }
    }
}
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Requests/id)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional) (default to Requests/id.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all requests. A predicate can be given to filter results.
[apiInstance requestServiceGetRequestsWith:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[RequestResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.RequestsApi()

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive).  "start" is also accepted.
  'to': to_example // {String} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class requestServiceGetRequestsExample
    {
        public void main()
        {
            
            var apiInstance = new RequestsApi();
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Requests/id)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional)  (default to Requests/id.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all requests. A predicate can be given to filter results.
                array[RequestResponse] result = apiInstance.requestServiceGetRequests(fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RequestsApi.requestServiceGetRequests: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\RequestsApi();
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
$to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.

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

my $api_instance = WWW::SwaggerClient::RequestsApi->new();
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive).  "start" is also accepted.
my $to = to_example; # String | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->requestServiceGetRequests(fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RequestsApi->requestServiceGetRequests: $@\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.RequestsApi()
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Requests/id)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional) (default to Requests/id.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all requests. A predicate can be given to filter results.
    api_response = api_instance.requestServiceGetRequests(fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RequestsApi->requestServiceGetRequests: %s\n" % e)

Parameters

Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 500 - Internal server error


requestServiceUpdateRequests

Updates a request, usually used to cancel running requests.

Changes the state of an existing request. Usually used to cancel running requests.


/requests/{requestId}

Usage and SDK Samples

curl -X put "https://localhost/api/v1/requests/{requestId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RequestsApi;

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

public class RequestsApiExample {

    public static void main(String[] args) {
        
        RequestsApi apiInstance = new RequestsApi();
        String requestId = requestId_example; // String | 
        RequestPutRequest body = ; // RequestPutRequest | 
        try {
            apiInstance.requestServiceUpdateRequests(requestId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling RequestsApi#requestServiceUpdateRequests");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RequestsApi;

public class RequestsApiExample {

    public static void main(String[] args) {
        RequestsApi apiInstance = new RequestsApi();
        String requestId = requestId_example; // String | 
        RequestPutRequest body = ; // RequestPutRequest | 
        try {
            apiInstance.requestServiceUpdateRequests(requestId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling RequestsApi#requestServiceUpdateRequests");
            e.printStackTrace();
        }
    }
}
String *requestId = requestId_example; // 
RequestPutRequest *body = ; //  (optional)

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

// Updates a request, usually used to cancel running requests.
[apiInstance requestServiceUpdateRequestsWith:requestId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.RequestsApi()

var requestId = requestId_example; // {String} 

var opts = { 
  'body':  // {RequestPutRequest} 
};

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

namespace Example
{
    public class requestServiceUpdateRequestsExample
    {
        public void main()
        {
            
            var apiInstance = new RequestsApi();
            var requestId = requestId_example;  // String | 
            var body = new RequestPutRequest(); // RequestPutRequest |  (optional) 

            try
            {
                // Updates a request, usually used to cancel running requests.
                apiInstance.requestServiceUpdateRequests(requestId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RequestsApi.requestServiceUpdateRequests: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\RequestsApi();
$requestId = requestId_example; // String | 
$body = ; // RequestPutRequest | 

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

my $api_instance = WWW::SwaggerClient::RequestsApi->new();
my $requestId = requestId_example; # String | 
my $body = WWW::SwaggerClient::Object::RequestPutRequest->new(); # RequestPutRequest | 

eval { 
    $api_instance->requestServiceUpdateRequests(requestId => $requestId, body => $body);
};
if ($@) {
    warn "Exception when calling RequestsApi->requestServiceUpdateRequests: $@\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.RequestsApi()
requestId = requestId_example # String | 
body =  # RequestPutRequest |  (optional)

try: 
    # Updates a request, usually used to cancel running requests.
    api_instance.requestServiceUpdateRequests(requestId, body=body)
except ApiException as e:
    print("Exception when calling RequestsApi->requestServiceUpdateRequests: %s\n" % e)

Parameters

Path parameters
Name Description
requestId*
Body parameters
Name Description
body

Responses

Status: 200 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


RootServiceConfigurations

rootServiceComponentConfigurationServiceDeleteConfiguration

Deletes a root service component configuration resource


/services/{serviceName}/components/{componentName}/configurations/{category}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/services/{serviceName}/components/{componentName}/configurations/{category}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RootServiceConfigurationsApi;

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

public class RootServiceConfigurationsApiExample {

    public static void main(String[] args) {
        
        RootServiceConfigurationsApi apiInstance = new RootServiceConfigurationsApi();
        String category = category_example; // String | 
        String serviceName = serviceName_example; // String | 
        String componentName = componentName_example; // String | 
        try {
            apiInstance.rootServiceComponentConfigurationServiceDeleteConfiguration(category, serviceName, componentName);
        } catch (ApiException e) {
            System.err.println("Exception when calling RootServiceConfigurationsApi#rootServiceComponentConfigurationServiceDeleteConfiguration");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RootServiceConfigurationsApi;

public class RootServiceConfigurationsApiExample {

    public static void main(String[] args) {
        RootServiceConfigurationsApi apiInstance = new RootServiceConfigurationsApi();
        String category = category_example; // String | 
        String serviceName = serviceName_example; // String | 
        String componentName = componentName_example; // String | 
        try {
            apiInstance.rootServiceComponentConfigurationServiceDeleteConfiguration(category, serviceName, componentName);
        } catch (ApiException e) {
            System.err.println("Exception when calling RootServiceConfigurationsApi#rootServiceComponentConfigurationServiceDeleteConfiguration");
            e.printStackTrace();
        }
    }
}
String *category = category_example; // 
String *serviceName = serviceName_example; // 
String *componentName = componentName_example; // 

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

// Deletes a root service component configuration resource
[apiInstance rootServiceComponentConfigurationServiceDeleteConfigurationWith:category
    serviceName:serviceName
    componentName:componentName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.RootServiceConfigurationsApi()

var category = category_example; // {String} 

var serviceName = serviceName_example; // {String} 

var componentName = componentName_example; // {String} 


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

namespace Example
{
    public class rootServiceComponentConfigurationServiceDeleteConfigurationExample
    {
        public void main()
        {
            
            var apiInstance = new RootServiceConfigurationsApi();
            var category = category_example;  // String | 
            var serviceName = serviceName_example;  // String | 
            var componentName = componentName_example;  // String | 

            try
            {
                // Deletes a root service component configuration resource
                apiInstance.rootServiceComponentConfigurationServiceDeleteConfiguration(category, serviceName, componentName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RootServiceConfigurationsApi.rootServiceComponentConfigurationServiceDeleteConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\RootServiceConfigurationsApi();
$category = category_example; // String | 
$serviceName = serviceName_example; // String | 
$componentName = componentName_example; // String | 

try {
    $api_instance->rootServiceComponentConfigurationServiceDeleteConfiguration($category, $serviceName, $componentName);
} catch (Exception $e) {
    echo 'Exception when calling RootServiceConfigurationsApi->rootServiceComponentConfigurationServiceDeleteConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RootServiceConfigurationsApi;

my $api_instance = WWW::SwaggerClient::RootServiceConfigurationsApi->new();
my $category = category_example; # String | 
my $serviceName = serviceName_example; # String | 
my $componentName = componentName_example; # String | 

eval { 
    $api_instance->rootServiceComponentConfigurationServiceDeleteConfiguration(category => $category, serviceName => $serviceName, componentName => $componentName);
};
if ($@) {
    warn "Exception when calling RootServiceConfigurationsApi->rootServiceComponentConfigurationServiceDeleteConfiguration: $@\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.RootServiceConfigurationsApi()
category = category_example # String | 
serviceName = serviceName_example # String | 
componentName = componentName_example # String | 

try: 
    # Deletes a root service component configuration resource
    api_instance.rootServiceComponentConfigurationServiceDeleteConfiguration(category, serviceName, componentName)
except ApiException as e:
    print("Exception when calling RootServiceConfigurationsApi->rootServiceComponentConfigurationServiceDeleteConfiguration: %s\n" % e)

Parameters

Path parameters
Name Description
category*
serviceName*
componentName*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


rootServiceComponentConfigurationServiceGetConfiguration

Retrieve the details of a root service component configuration resource


/services/{serviceName}/components/{componentName}/configurations/{category}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/services/{serviceName}/components/{componentName}/configurations/{category}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RootServiceConfigurationsApi;

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

public class RootServiceConfigurationsApiExample {

    public static void main(String[] args) {
        
        RootServiceConfigurationsApi apiInstance = new RootServiceConfigurationsApi();
        String category = category_example; // String | 
        String serviceName = serviceName_example; // String | 
        String componentName = componentName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            RootServiceComponentConfigurationResponseSwagger result = apiInstance.rootServiceComponentConfigurationServiceGetConfiguration(category, serviceName, componentName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RootServiceConfigurationsApi#rootServiceComponentConfigurationServiceGetConfiguration");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RootServiceConfigurationsApi;

public class RootServiceConfigurationsApiExample {

    public static void main(String[] args) {
        RootServiceConfigurationsApi apiInstance = new RootServiceConfigurationsApi();
        String category = category_example; // String | 
        String serviceName = serviceName_example; // String | 
        String componentName = componentName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            RootServiceComponentConfigurationResponseSwagger result = apiInstance.rootServiceComponentConfigurationServiceGetConfiguration(category, serviceName, componentName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RootServiceConfigurationsApi#rootServiceComponentConfigurationServiceGetConfiguration");
            e.printStackTrace();
        }
    }
}
String *category = category_example; // 
String *serviceName = serviceName_example; // 
String *componentName = componentName_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Configuration/*)

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

// Retrieve the details of a root service component configuration resource
[apiInstance rootServiceComponentConfigurationServiceGetConfigurationWith:category
    serviceName:serviceName
    componentName:componentName
    fields:fields
              completionHandler: ^(RootServiceComponentConfigurationResponseSwagger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.RootServiceConfigurationsApi()

var category = category_example; // {String} 

var serviceName = serviceName_example; // {String} 

var componentName = componentName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class rootServiceComponentConfigurationServiceGetConfigurationExample
    {
        public void main()
        {
            
            var apiInstance = new RootServiceConfigurationsApi();
            var category = category_example;  // String | 
            var serviceName = serviceName_example;  // String | 
            var componentName = componentName_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Configuration/*)

            try
            {
                // Retrieve the details of a root service component configuration resource
                RootServiceComponentConfigurationResponseSwagger result = apiInstance.rootServiceComponentConfigurationServiceGetConfiguration(category, serviceName, componentName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RootServiceConfigurationsApi.rootServiceComponentConfigurationServiceGetConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\RootServiceConfigurationsApi();
$category = category_example; // String | 
$serviceName = serviceName_example; // String | 
$componentName = componentName_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

try {
    $result = $api_instance->rootServiceComponentConfigurationServiceGetConfiguration($category, $serviceName, $componentName, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RootServiceConfigurationsApi->rootServiceComponentConfigurationServiceGetConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RootServiceConfigurationsApi;

my $api_instance = WWW::SwaggerClient::RootServiceConfigurationsApi->new();
my $category = category_example; # String | 
my $serviceName = serviceName_example; # String | 
my $componentName = componentName_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->rootServiceComponentConfigurationServiceGetConfiguration(category => $category, serviceName => $serviceName, componentName => $componentName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RootServiceConfigurationsApi->rootServiceComponentConfigurationServiceGetConfiguration: $@\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.RootServiceConfigurationsApi()
category = category_example # String | 
serviceName = serviceName_example # String | 
componentName = componentName_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Configuration/*)

try: 
    # Retrieve the details of a root service component configuration resource
    api_response = api_instance.rootServiceComponentConfigurationServiceGetConfiguration(category, serviceName, componentName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RootServiceConfigurationsApi->rootServiceComponentConfigurationServiceGetConfiguration: %s\n" % e)

Parameters

Path parameters
Name Description
category*
serviceName*
componentName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


rootServiceComponentConfigurationServiceUpdateConfiguration

Updates root service component configuration resources


/services/{serviceName}/components/{componentName}/configurations/{category}

Usage and SDK Samples

curl -X put "https://localhost/api/v1/services/{serviceName}/components/{componentName}/configurations/{category}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RootServiceConfigurationsApi;

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

public class RootServiceConfigurationsApiExample {

    public static void main(String[] args) {
        
        RootServiceConfigurationsApi apiInstance = new RootServiceConfigurationsApi();
        String category = category_example; // String | 
        String serviceName = serviceName_example; // String | 
        String componentName = componentName_example; // String | 
        RootServiceComponentConfigurationRequestSwagger body = ; // RootServiceComponentConfigurationRequestSwagger | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            apiInstance.rootServiceComponentConfigurationServiceUpdateConfiguration(category, serviceName, componentName, body, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling RootServiceConfigurationsApi#rootServiceComponentConfigurationServiceUpdateConfiguration");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RootServiceConfigurationsApi;

public class RootServiceConfigurationsApiExample {

    public static void main(String[] args) {
        RootServiceConfigurationsApi apiInstance = new RootServiceConfigurationsApi();
        String category = category_example; // String | 
        String serviceName = serviceName_example; // String | 
        String componentName = componentName_example; // String | 
        RootServiceComponentConfigurationRequestSwagger body = ; // RootServiceComponentConfigurationRequestSwagger | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            apiInstance.rootServiceComponentConfigurationServiceUpdateConfiguration(category, serviceName, componentName, body, fields);
        } catch (ApiException e) {
            System.err.println("Exception when calling RootServiceConfigurationsApi#rootServiceComponentConfigurationServiceUpdateConfiguration");
            e.printStackTrace();
        }
    }
}
String *category = category_example; // 
String *serviceName = serviceName_example; // 
String *componentName = componentName_example; // 
RootServiceComponentConfigurationRequestSwagger *body = ; //  (optional)
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Configuration/*)

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

// Updates root service component configuration resources 
[apiInstance rootServiceComponentConfigurationServiceUpdateConfigurationWith:category
    serviceName:serviceName
    componentName:componentName
    body:body
    fields:fields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.RootServiceConfigurationsApi()

var category = category_example; // {String} 

var serviceName = serviceName_example; // {String} 

var componentName = componentName_example; // {String} 

var opts = { 
  'body': , // {RootServiceComponentConfigurationRequestSwagger} 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class rootServiceComponentConfigurationServiceUpdateConfigurationExample
    {
        public void main()
        {
            
            var apiInstance = new RootServiceConfigurationsApi();
            var category = category_example;  // String | 
            var serviceName = serviceName_example;  // String | 
            var componentName = componentName_example;  // String | 
            var body = new RootServiceComponentConfigurationRequestSwagger(); // RootServiceComponentConfigurationRequestSwagger |  (optional) 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Configuration/*)

            try
            {
                // Updates root service component configuration resources 
                apiInstance.rootServiceComponentConfigurationServiceUpdateConfiguration(category, serviceName, componentName, body, fields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RootServiceConfigurationsApi.rootServiceComponentConfigurationServiceUpdateConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\RootServiceConfigurationsApi();
$category = category_example; // String | 
$serviceName = serviceName_example; // String | 
$componentName = componentName_example; // String | 
$body = ; // RootServiceComponentConfigurationRequestSwagger | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

try {
    $api_instance->rootServiceComponentConfigurationServiceUpdateConfiguration($category, $serviceName, $componentName, $body, $fields);
} catch (Exception $e) {
    echo 'Exception when calling RootServiceConfigurationsApi->rootServiceComponentConfigurationServiceUpdateConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RootServiceConfigurationsApi;

my $api_instance = WWW::SwaggerClient::RootServiceConfigurationsApi->new();
my $category = category_example; # String | 
my $serviceName = serviceName_example; # String | 
my $componentName = componentName_example; # String | 
my $body = WWW::SwaggerClient::Object::RootServiceComponentConfigurationRequestSwagger->new(); # RootServiceComponentConfigurationRequestSwagger | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    $api_instance->rootServiceComponentConfigurationServiceUpdateConfiguration(category => $category, serviceName => $serviceName, componentName => $componentName, body => $body, fields => $fields);
};
if ($@) {
    warn "Exception when calling RootServiceConfigurationsApi->rootServiceComponentConfigurationServiceUpdateConfiguration: $@\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.RootServiceConfigurationsApi()
category = category_example # String | 
serviceName = serviceName_example # String | 
componentName = componentName_example # String | 
body =  # RootServiceComponentConfigurationRequestSwagger |  (optional)
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Configuration/*)

try: 
    # Updates root service component configuration resources 
    api_instance.rootServiceComponentConfigurationServiceUpdateConfiguration(category, serviceName, componentName, body=body, fields=fields)
except ApiException as e:
    print("Exception when calling RootServiceConfigurationsApi->rootServiceComponentConfigurationServiceUpdateConfiguration: %s\n" % e)

Parameters

Path parameters
Name Description
category*
serviceName*
componentName*
Body parameters
Name Description
body
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


Services

getRootHost

Returns information about the given host


/services/{serviceName}/hosts/{hostName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/services/{serviceName}/hosts/{hostName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServicesApi;

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

public class ServicesApiExample {

    public static void main(String[] args) {
        
        ServicesApi apiInstance = new ServicesApi();
        String hostName = hostName_example; // String | host name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            HostResponseWrapper result = apiInstance.getRootHost(hostName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServicesApi#getRootHost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServicesApi;

public class ServicesApiExample {

    public static void main(String[] args) {
        ServicesApi apiInstance = new ServicesApi();
        String hostName = hostName_example; // String | host name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            HostResponseWrapper result = apiInstance.getRootHost(hostName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServicesApi#getRootHost");
            e.printStackTrace();
        }
    }
}
String *hostName = hostName_example; // host name
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Hosts/*)

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

// Returns information about the given host
[apiInstance getRootHostWith:hostName
    fields:fields
              completionHandler: ^(HostResponseWrapper output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ServicesApi()

var hostName = hostName_example; // {String} host name

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getRootHostExample
    {
        public void main()
        {
            
            var apiInstance = new ServicesApi();
            var hostName = hostName_example;  // String | host name
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Hosts/*)

            try
            {
                // Returns information about the given host
                HostResponseWrapper result = apiInstance.getRootHost(hostName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServicesApi.getRootHost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServicesApi();
$hostName = hostName_example; // String | host name
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::ServicesApi->new();
my $hostName = hostName_example; # String | host name
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getRootHost(hostName => $hostName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServicesApi->getRootHost: $@\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.ServicesApi()
hostName = hostName_example # String | host name
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Hosts/*)

try: 
    # Returns information about the given host
    api_response = api_instance.getRootHost(hostName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesApi->getRootHost: %s\n" % e)

Parameters

Path parameters
Name Description
hostName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


getRootHosts

Returns the list of hosts for the given root-level service


/services/{serviceName}/hosts

Usage and SDK Samples

curl -X get "https://localhost/api/v1/services/{serviceName}/hosts?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServicesApi;

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

public class ServicesApiExample {

    public static void main(String[] args) {
        
        ServicesApi apiInstance = new ServicesApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            array[HostResponseWrapper] result = apiInstance.getRootHosts(fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServicesApi#getRootHosts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServicesApi;

public class ServicesApiExample {

    public static void main(String[] args) {
        ServicesApi apiInstance = new ServicesApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            array[HostResponseWrapper] result = apiInstance.getRootHosts(fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServicesApi#getRootHosts");
            e.printStackTrace();
        }
    }
}
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Hosts/host_name)

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

// Returns the list of hosts for the given root-level service
[apiInstance getRootHostsWith:fields
              completionHandler: ^(array[HostResponseWrapper] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ServicesApi()

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getRootHostsExample
    {
        public void main()
        {
            
            var apiInstance = new ServicesApi();
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Hosts/host_name)

            try
            {
                // Returns the list of hosts for the given root-level service
                array[HostResponseWrapper] result = apiInstance.getRootHosts(fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServicesApi.getRootHosts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServicesApi();
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::ServicesApi->new();
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getRootHosts(fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServicesApi->getRootHosts: $@\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.ServicesApi()
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Hosts/host_name)

try: 
    # Returns the list of hosts for the given root-level service
    api_response = api_instance.getRootHosts(fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesApi->getRootHosts: %s\n" % e)

Parameters

Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


getRootService

Returns information about the given root-level service, including a list of its components


/services/{serviceName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/services/{serviceName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServicesApi;

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

public class ServicesApiExample {

    public static void main(String[] args) {
        
        ServicesApi apiInstance = new ServicesApi();
        String serviceName = serviceName_example; // String | service name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            RootServiceResponseWithComponentList result = apiInstance.getRootService(serviceName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServicesApi#getRootService");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServicesApi;

public class ServicesApiExample {

    public static void main(String[] args) {
        ServicesApi apiInstance = new ServicesApi();
        String serviceName = serviceName_example; // String | service name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            RootServiceResponseWithComponentList result = apiInstance.getRootService(serviceName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServicesApi#getRootService");
            e.printStackTrace();
        }
    }
}
String *serviceName = serviceName_example; // service name
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to RootService/service_name, components/RootServiceComponents/component_name, components/RootServiceComponents/service_name)

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

// Returns information about the given root-level service, including a list of its components
[apiInstance getRootServiceWith:serviceName
    fields:fields
              completionHandler: ^(RootServiceResponseWithComponentList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ServicesApi()

var serviceName = serviceName_example; // {String} service name

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getRootServiceExample
    {
        public void main()
        {
            
            var apiInstance = new ServicesApi();
            var serviceName = serviceName_example;  // String | service name
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to RootService/service_name, components/RootServiceComponents/component_name, components/RootServiceComponents/service_name)

            try
            {
                // Returns information about the given root-level service, including a list of its components
                RootServiceResponseWithComponentList result = apiInstance.getRootService(serviceName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServicesApi.getRootService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServicesApi();
$serviceName = serviceName_example; // String | service name
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::ServicesApi->new();
my $serviceName = serviceName_example; # String | service name
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getRootService(serviceName => $serviceName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServicesApi->getRootService: $@\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.ServicesApi()
serviceName = serviceName_example # String | service name
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to RootService/service_name, components/RootServiceComponents/component_name, components/RootServiceComponents/service_name)

try: 
    # Returns information about the given root-level service, including a list of its components
    api_response = api_instance.getRootService(serviceName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesApi->getRootService: %s\n" % e)

Parameters

Path parameters
Name Description
serviceName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


getRootServiceComponent

Returns information about the given component for the given root-level service


/services/{serviceName}/components/{componentName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/services/{serviceName}/components/{componentName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServicesApi;

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

public class ServicesApiExample {

    public static void main(String[] args) {
        
        ServicesApi apiInstance = new ServicesApi();
        String serviceName = serviceName_example; // String | service name
        String componentName = componentName_example; // String | component name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            RootServiceComponentWithHostComponentList result = apiInstance.getRootServiceComponent(serviceName, componentName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServicesApi#getRootServiceComponent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServicesApi;

public class ServicesApiExample {

    public static void main(String[] args) {
        ServicesApi apiInstance = new ServicesApi();
        String serviceName = serviceName_example; // String | service name
        String componentName = componentName_example; // String | component name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            RootServiceComponentWithHostComponentList result = apiInstance.getRootServiceComponent(serviceName, componentName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServicesApi#getRootServiceComponent");
            e.printStackTrace();
        }
    }
}
String *serviceName = serviceName_example; // service name
String *componentName = componentName_example; // component name
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to RootServiceComponents/*, hostComponents/RootServiceHostComponents/component_name, hostComponents/RootServiceHostComponents/host_name, hostComponents/RootServiceHostComponents/service_name)

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

// Returns information about the given component for the given root-level service
[apiInstance getRootServiceComponentWith:serviceName
    componentName:componentName
    fields:fields
              completionHandler: ^(RootServiceComponentWithHostComponentList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ServicesApi()

var serviceName = serviceName_example; // {String} service name

var componentName = componentName_example; // {String} component name

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getRootServiceComponentExample
    {
        public void main()
        {
            
            var apiInstance = new ServicesApi();
            var serviceName = serviceName_example;  // String | service name
            var componentName = componentName_example;  // String | component name
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to RootServiceComponents/*, hostComponents/RootServiceHostComponents/component_name, hostComponents/RootServiceHostComponents/host_name, hostComponents/RootServiceHostComponents/service_name)

            try
            {
                // Returns information about the given component for the given root-level service
                RootServiceComponentWithHostComponentList result = apiInstance.getRootServiceComponent(serviceName, componentName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServicesApi.getRootServiceComponent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServicesApi();
$serviceName = serviceName_example; // String | service name
$componentName = componentName_example; // String | component name
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::ServicesApi->new();
my $serviceName = serviceName_example; # String | service name
my $componentName = componentName_example; # String | component name
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getRootServiceComponent(serviceName => $serviceName, componentName => $componentName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServicesApi->getRootServiceComponent: $@\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.ServicesApi()
serviceName = serviceName_example # String | service name
componentName = componentName_example # String | component name
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to RootServiceComponents/*, hostComponents/RootServiceHostComponents/component_name, hostComponents/RootServiceHostComponents/host_name, hostComponents/RootServiceHostComponents/service_name)

try: 
    # Returns information about the given component for the given root-level service
    api_response = api_instance.getRootServiceComponent(serviceName, componentName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesApi->getRootServiceComponent: %s\n" % e)

Parameters

Path parameters
Name Description
serviceName*
componentName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


getRootServiceComponentHosts

Returns the list of hosts for the given root-level service component


/services/{serviceName}/components/{componentName}/hostComponents

Usage and SDK Samples

curl -X get "https://localhost/api/v1/services/{serviceName}/components/{componentName}/hostComponents?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServicesApi;

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

public class ServicesApiExample {

    public static void main(String[] args) {
        
        ServicesApi apiInstance = new ServicesApi();
        String serviceName = serviceName_example; // String | service name
        String componentName = componentName_example; // String | component name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            array[RootServiceHostComponentResponseWrapper] result = apiInstance.getRootServiceComponentHosts(serviceName, componentName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServicesApi#getRootServiceComponentHosts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServicesApi;

public class ServicesApiExample {

    public static void main(String[] args) {
        ServicesApi apiInstance = new ServicesApi();
        String serviceName = serviceName_example; // String | service name
        String componentName = componentName_example; // String | component name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            array[RootServiceHostComponentResponseWrapper] result = apiInstance.getRootServiceComponentHosts(serviceName, componentName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServicesApi#getRootServiceComponentHosts");
            e.printStackTrace();
        }
    }
}
String *serviceName = serviceName_example; // service name
String *componentName = componentName_example; // component name
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to RootServiceHostComponents/component_name, RootServiceHostComponents/host_name, RootServiceHostComponents/service_name)

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

// Returns the list of hosts for the given root-level service component
[apiInstance getRootServiceComponentHostsWith:serviceName
    componentName:componentName
    fields:fields
              completionHandler: ^(array[RootServiceHostComponentResponseWrapper] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ServicesApi()

var serviceName = serviceName_example; // {String} service name

var componentName = componentName_example; // {String} component name

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getRootServiceComponentHostsExample
    {
        public void main()
        {
            
            var apiInstance = new ServicesApi();
            var serviceName = serviceName_example;  // String | service name
            var componentName = componentName_example;  // String | component name
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to RootServiceHostComponents/component_name, RootServiceHostComponents/host_name, RootServiceHostComponents/service_name)

            try
            {
                // Returns the list of hosts for the given root-level service component
                array[RootServiceHostComponentResponseWrapper] result = apiInstance.getRootServiceComponentHosts(serviceName, componentName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServicesApi.getRootServiceComponentHosts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServicesApi();
$serviceName = serviceName_example; // String | service name
$componentName = componentName_example; // String | component name
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::ServicesApi->new();
my $serviceName = serviceName_example; # String | service name
my $componentName = componentName_example; # String | component name
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getRootServiceComponentHosts(serviceName => $serviceName, componentName => $componentName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServicesApi->getRootServiceComponentHosts: $@\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.ServicesApi()
serviceName = serviceName_example # String | service name
componentName = componentName_example # String | component name
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to RootServiceHostComponents/component_name, RootServiceHostComponents/host_name, RootServiceHostComponents/service_name)

try: 
    # Returns the list of hosts for the given root-level service component
    api_response = api_instance.getRootServiceComponentHosts(serviceName, componentName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesApi->getRootServiceComponentHosts: %s\n" % e)

Parameters

Path parameters
Name Description
serviceName*
componentName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


getRootServiceComponents

Returns the list of components for the given root-level service


/services/{serviceName}/components

Usage and SDK Samples

curl -X get "https://localhost/api/v1/services/{serviceName}/components?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServicesApi;

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

public class ServicesApiExample {

    public static void main(String[] args) {
        
        ServicesApi apiInstance = new ServicesApi();
        String serviceName = serviceName_example; // String | service name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            array[RootServiceComponentResponseWrapper] result = apiInstance.getRootServiceComponents(serviceName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServicesApi#getRootServiceComponents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServicesApi;

public class ServicesApiExample {

    public static void main(String[] args) {
        ServicesApi apiInstance = new ServicesApi();
        String serviceName = serviceName_example; // String | service name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            array[RootServiceComponentResponseWrapper] result = apiInstance.getRootServiceComponents(serviceName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServicesApi#getRootServiceComponents");
            e.printStackTrace();
        }
    }
}
String *serviceName = serviceName_example; // service name
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to RootServiceComponents/component_name, RootServiceComponents/service_name)

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

// Returns the list of components for the given root-level service
[apiInstance getRootServiceComponentsWith:serviceName
    fields:fields
              completionHandler: ^(array[RootServiceComponentResponseWrapper] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ServicesApi()

var serviceName = serviceName_example; // {String} service name

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getRootServiceComponentsExample
    {
        public void main()
        {
            
            var apiInstance = new ServicesApi();
            var serviceName = serviceName_example;  // String | service name
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to RootServiceComponents/component_name, RootServiceComponents/service_name)

            try
            {
                // Returns the list of components for the given root-level service
                array[RootServiceComponentResponseWrapper] result = apiInstance.getRootServiceComponents(serviceName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServicesApi.getRootServiceComponents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServicesApi();
$serviceName = serviceName_example; // String | service name
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::ServicesApi->new();
my $serviceName = serviceName_example; # String | service name
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getRootServiceComponents(serviceName => $serviceName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServicesApi->getRootServiceComponents: $@\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.ServicesApi()
serviceName = serviceName_example # String | service name
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to RootServiceComponents/component_name, RootServiceComponents/service_name)

try: 
    # Returns the list of components for the given root-level service
    api_response = api_instance.getRootServiceComponents(serviceName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesApi->getRootServiceComponents: %s\n" % e)

Parameters

Path parameters
Name Description
serviceName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


getRootServiceHostComponent

Returns information about the given component for the given root-level service on the given host


/services/{serviceName}/hosts/{hostName}/hostComponents/{hostComponent}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/services/{serviceName}/hosts/{hostName}/hostComponents/{hostComponent}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServicesApi;

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

public class ServicesApiExample {

    public static void main(String[] args) {
        
        ServicesApi apiInstance = new ServicesApi();
        String serviceName = serviceName_example; // String | service name
        String hostName = hostName_example; // String | host name
        String hostComponent = hostComponent_example; // String | component name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            RootServiceHostComponentResponseWrapper result = apiInstance.getRootServiceHostComponent(serviceName, hostName, hostComponent, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServicesApi#getRootServiceHostComponent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServicesApi;

public class ServicesApiExample {

    public static void main(String[] args) {
        ServicesApi apiInstance = new ServicesApi();
        String serviceName = serviceName_example; // String | service name
        String hostName = hostName_example; // String | host name
        String hostComponent = hostComponent_example; // String | component name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            RootServiceHostComponentResponseWrapper result = apiInstance.getRootServiceHostComponent(serviceName, hostName, hostComponent, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServicesApi#getRootServiceHostComponent");
            e.printStackTrace();
        }
    }
}
String *serviceName = serviceName_example; // service name
String *hostName = hostName_example; // host name
String *hostComponent = hostComponent_example; // component name
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to RootServiceHostComponents/component_name, RootServiceHostComponents/host_name, RootServiceHostComponents/service_name)

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

// Returns information about the given component for the given root-level service on the given host
[apiInstance getRootServiceHostComponentWith:serviceName
    hostName:hostName
    hostComponent:hostComponent
    fields:fields
              completionHandler: ^(RootServiceHostComponentResponseWrapper output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ServicesApi()

var serviceName = serviceName_example; // {String} service name

var hostName = hostName_example; // {String} host name

var hostComponent = hostComponent_example; // {String} component name

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getRootServiceHostComponentExample
    {
        public void main()
        {
            
            var apiInstance = new ServicesApi();
            var serviceName = serviceName_example;  // String | service name
            var hostName = hostName_example;  // String | host name
            var hostComponent = hostComponent_example;  // String | component name
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to RootServiceHostComponents/component_name, RootServiceHostComponents/host_name, RootServiceHostComponents/service_name)

            try
            {
                // Returns information about the given component for the given root-level service on the given host
                RootServiceHostComponentResponseWrapper result = apiInstance.getRootServiceHostComponent(serviceName, hostName, hostComponent, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServicesApi.getRootServiceHostComponent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServicesApi();
$serviceName = serviceName_example; // String | service name
$hostName = hostName_example; // String | host name
$hostComponent = hostComponent_example; // String | component name
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

try {
    $result = $api_instance->getRootServiceHostComponent($serviceName, $hostName, $hostComponent, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServicesApi->getRootServiceHostComponent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ServicesApi;

my $api_instance = WWW::SwaggerClient::ServicesApi->new();
my $serviceName = serviceName_example; # String | service name
my $hostName = hostName_example; # String | host name
my $hostComponent = hostComponent_example; # String | component name
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getRootServiceHostComponent(serviceName => $serviceName, hostName => $hostName, hostComponent => $hostComponent, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServicesApi->getRootServiceHostComponent: $@\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.ServicesApi()
serviceName = serviceName_example # String | service name
hostName = hostName_example # String | host name
hostComponent = hostComponent_example # String | component name
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to RootServiceHostComponents/component_name, RootServiceHostComponents/host_name, RootServiceHostComponents/service_name)

try: 
    # Returns information about the given component for the given root-level service on the given host
    api_response = api_instance.getRootServiceHostComponent(serviceName, hostName, hostComponent, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesApi->getRootServiceHostComponent: %s\n" % e)

Parameters

Path parameters
Name Description
serviceName*
hostName*
hostComponent*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


getRootServiceHostComponents

Returns the list of components for the given root-level service on the given host


/services/{serviceName}/hosts/{hostName}/hostComponents

Usage and SDK Samples

curl -X get "https://localhost/api/v1/services/{serviceName}/hosts/{hostName}/hostComponents?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServicesApi;

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

public class ServicesApiExample {

    public static void main(String[] args) {
        
        ServicesApi apiInstance = new ServicesApi();
        String serviceName = serviceName_example; // String | service name
        String hostName = hostName_example; // String | host name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            array[RootServiceHostComponentResponseWrapper] result = apiInstance.getRootServiceHostComponents(serviceName, hostName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServicesApi#getRootServiceHostComponents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServicesApi;

public class ServicesApiExample {

    public static void main(String[] args) {
        ServicesApi apiInstance = new ServicesApi();
        String serviceName = serviceName_example; // String | service name
        String hostName = hostName_example; // String | host name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            array[RootServiceHostComponentResponseWrapper] result = apiInstance.getRootServiceHostComponents(serviceName, hostName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServicesApi#getRootServiceHostComponents");
            e.printStackTrace();
        }
    }
}
String *serviceName = serviceName_example; // service name
String *hostName = hostName_example; // host name
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to RootServiceHostComponents/component_name, RootServiceHostComponents/host_name, RootServiceHostComponents/service_name)

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

// Returns the list of components for the given root-level service on the given host
[apiInstance getRootServiceHostComponentsWith:serviceName
    hostName:hostName
    fields:fields
              completionHandler: ^(array[RootServiceHostComponentResponseWrapper] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ServicesApi()

var serviceName = serviceName_example; // {String} service name

var hostName = hostName_example; // {String} host name

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getRootServiceHostComponentsExample
    {
        public void main()
        {
            
            var apiInstance = new ServicesApi();
            var serviceName = serviceName_example;  // String | service name
            var hostName = hostName_example;  // String | host name
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to RootServiceHostComponents/component_name, RootServiceHostComponents/host_name, RootServiceHostComponents/service_name)

            try
            {
                // Returns the list of components for the given root-level service on the given host
                array[RootServiceHostComponentResponseWrapper] result = apiInstance.getRootServiceHostComponents(serviceName, hostName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServicesApi.getRootServiceHostComponents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServicesApi();
$serviceName = serviceName_example; // String | service name
$hostName = hostName_example; // String | host name
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::ServicesApi->new();
my $serviceName = serviceName_example; # String | service name
my $hostName = hostName_example; # String | host name
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getRootServiceHostComponents(serviceName => $serviceName, hostName => $hostName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServicesApi->getRootServiceHostComponents: $@\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.ServicesApi()
serviceName = serviceName_example # String | service name
hostName = hostName_example # String | host name
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to RootServiceHostComponents/component_name, RootServiceHostComponents/host_name, RootServiceHostComponents/service_name)

try: 
    # Returns the list of components for the given root-level service on the given host
    api_response = api_instance.getRootServiceHostComponents(serviceName, hostName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesApi->getRootServiceHostComponents: %s\n" % e)

Parameters

Path parameters
Name Description
serviceName*
hostName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


getRootServices

Returns the list of root-level services


/services

Usage and SDK Samples

curl -X get "https://localhost/api/v1/services?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ServicesApi;

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

public class ServicesApiExample {

    public static void main(String[] args) {
        
        ServicesApi apiInstance = new ServicesApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            array[RootServiceResponseWrapper] result = apiInstance.getRootServices(fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServicesApi#getRootServices");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ServicesApi;

public class ServicesApiExample {

    public static void main(String[] args) {
        ServicesApi apiInstance = new ServicesApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            array[RootServiceResponseWrapper] result = apiInstance.getRootServices(fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServicesApi#getRootServices");
            e.printStackTrace();
        }
    }
}
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to RootService/service_name)

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

// Returns the list of root-level services
[apiInstance getRootServicesWith:fields
              completionHandler: ^(array[RootServiceResponseWrapper] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ServicesApi()

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getRootServicesExample
    {
        public void main()
        {
            
            var apiInstance = new ServicesApi();
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to RootService/service_name)

            try
            {
                // Returns the list of root-level services
                array[RootServiceResponseWrapper] result = apiInstance.getRootServices(fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ServicesApi.getRootServices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ServicesApi();
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::ServicesApi->new();
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getRootServices(fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServicesApi->getRootServices: $@\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.ServicesApi()
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to RootService/service_name)

try: 
    # Returns the list of root-level services
    api_response = api_instance.getRootServices(fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesApi->getRootServices: %s\n" % e)

Parameters

Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 500 - Internal server error


Settings

createSetting

Creates a setting


/settings

Usage and SDK Samples

curl -X post "https://localhost/api/v1/settings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SettingsApi;

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

public class SettingsApiExample {

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

public class SettingsApiExample {

    public static void main(String[] args) {
        SettingsApi apiInstance = new SettingsApi();
        SettingRequestSwagger body = ; // SettingRequestSwagger | 
        try {
            apiInstance.createSetting(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SettingsApi#createSetting");
            e.printStackTrace();
        }
    }
}
SettingRequestSwagger *body = ; // 

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

// Creates a setting
[apiInstance createSettingWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.SettingsApi()

var body = ; // {SettingRequestSwagger} 


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

namespace Example
{
    public class createSettingExample
    {
        public void main()
        {
            
            var apiInstance = new SettingsApi();
            var body = new SettingRequestSwagger(); // SettingRequestSwagger | 

            try
            {
                // Creates a setting
                apiInstance.createSetting(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SettingsApi.createSetting: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SettingsApi();
$body = ; // SettingRequestSwagger | 

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

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

eval { 
    $api_instance->createSetting(body => $body);
};
if ($@) {
    warn "Exception when calling SettingsApi->createSetting: $@\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.SettingsApi()
body =  # SettingRequestSwagger | 

try: 
    # Creates a setting
    api_instance.createSetting(body)
except ApiException as e:
    print("Exception when calling SettingsApi->createSetting: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 409 - The requested resource already exists.

Status: 500 - Internal server error


deleteSetting

Deletes a setting


/settings/{settingName}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/settings/{settingName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SettingsApi;

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

public class SettingsApiExample {

    public static void main(String[] args) {
        
        SettingsApi apiInstance = new SettingsApi();
        String settingName = settingName_example; // String | setting name
        try {
            apiInstance.deleteSetting(settingName);
        } catch (ApiException e) {
            System.err.println("Exception when calling SettingsApi#deleteSetting");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SettingsApi;

public class SettingsApiExample {

    public static void main(String[] args) {
        SettingsApi apiInstance = new SettingsApi();
        String settingName = settingName_example; // String | setting name
        try {
            apiInstance.deleteSetting(settingName);
        } catch (ApiException e) {
            System.err.println("Exception when calling SettingsApi#deleteSetting");
            e.printStackTrace();
        }
    }
}
String *settingName = settingName_example; // setting name

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

// Deletes a setting
[apiInstance deleteSettingWith:settingName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.SettingsApi()

var settingName = settingName_example; // {String} setting name


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

namespace Example
{
    public class deleteSettingExample
    {
        public void main()
        {
            
            var apiInstance = new SettingsApi();
            var settingName = settingName_example;  // String | setting name

            try
            {
                // Deletes a setting
                apiInstance.deleteSetting(settingName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SettingsApi.deleteSetting: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SettingsApi();
$settingName = settingName_example; // String | setting name

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

my $api_instance = WWW::SwaggerClient::SettingsApi->new();
my $settingName = settingName_example; # String | setting name

eval { 
    $api_instance->deleteSetting(settingName => $settingName);
};
if ($@) {
    warn "Exception when calling SettingsApi->deleteSetting: $@\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.SettingsApi()
settingName = settingName_example # String | setting name

try: 
    # Deletes a setting
    api_instance.deleteSetting(settingName)
except ApiException as e:
    print("Exception when calling SettingsApi->deleteSetting: %s\n" % e)

Parameters

Path parameters
Name Description
settingName*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


getSetting

Returns a specific setting


/settings/{settingName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/settings/{settingName}?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SettingsApi;

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

public class SettingsApiExample {

    public static void main(String[] args) {
        
        SettingsApi apiInstance = new SettingsApi();
        String settingName = settingName_example; // String | setting name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            SettingResponseWrapper result = apiInstance.getSetting(settingName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SettingsApi#getSetting");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SettingsApi;

public class SettingsApiExample {

    public static void main(String[] args) {
        SettingsApi apiInstance = new SettingsApi();
        String settingName = settingName_example; // String | setting name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            SettingResponseWrapper result = apiInstance.getSetting(settingName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SettingsApi#getSetting");
            e.printStackTrace();
        }
    }
}
String *settingName = settingName_example; // setting name
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Settings/*)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
Integer *from = 56; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
Integer *to = 56; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Returns a specific setting
[apiInstance getSettingWith:settingName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(SettingResponseWrapper output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.SettingsApi()

var settingName = settingName_example; // {String} setting name

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': 56, // {Integer} The starting page resource (inclusive).  "start" is also accepted.
  'to': 56 // {Integer} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class getSettingExample
    {
        public void main()
        {
            
            var apiInstance = new SettingsApi();
            var settingName = settingName_example;  // String | setting name
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Settings/*)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional) 
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = 56;  // Integer | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = 56;  // Integer | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Returns a specific setting
                SettingResponseWrapper result = apiInstance.getSetting(settingName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SettingsApi.getSetting: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SettingsApi();
$settingName = settingName_example; // String | setting name
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
$to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->getSetting($settingName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SettingsApi->getSetting: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SettingsApi;

my $api_instance = WWW::SwaggerClient::SettingsApi->new();
my $settingName = settingName_example; # String | setting name
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = 56; # Integer | The starting page resource (inclusive).  "start" is also accepted.
my $to = 56; # Integer | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->getSetting(settingName => $settingName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SettingsApi->getSetting: $@\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.SettingsApi()
settingName = settingName_example # String | setting name
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Settings/*)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = 56 # Integer | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = 56 # Integer | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Returns a specific setting
    api_response = api_instance.getSetting(settingName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SettingsApi->getSetting: %s\n" % e)

Parameters

Path parameters
Name Description
settingName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


getSettings

Returns all settings


/settings

Usage and SDK Samples

curl -X get "https://localhost/api/v1/settings?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SettingsApi;

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

public class SettingsApiExample {

    public static void main(String[] args) {
        
        SettingsApi apiInstance = new SettingsApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[SettingResponseWrapper] result = apiInstance.getSettings(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SettingsApi#getSettings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SettingsApi;

public class SettingsApiExample {

    public static void main(String[] args) {
        SettingsApi apiInstance = new SettingsApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[SettingResponseWrapper] result = apiInstance.getSettings(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SettingsApi#getSettings");
            e.printStackTrace();
        }
    }
}
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Settings/name)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
Integer *from = 56; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
Integer *to = 56; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Returns all settings
[apiInstance getSettingsWith:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[SettingResponseWrapper] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.SettingsApi()

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': 56, // {Integer} The starting page resource (inclusive).  "start" is also accepted.
  'to': 56 // {Integer} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class getSettingsExample
    {
        public void main()
        {
            
            var apiInstance = new SettingsApi();
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Settings/name)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional) 
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = 56;  // Integer | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = 56;  // Integer | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Returns all settings
                array[SettingResponseWrapper] result = apiInstance.getSettings(fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SettingsApi.getSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SettingsApi();
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
$to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.

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

my $api_instance = WWW::SwaggerClient::SettingsApi->new();
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = 56; # Integer | The starting page resource (inclusive).  "start" is also accepted.
my $to = 56; # Integer | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->getSettings(fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SettingsApi->getSettings: $@\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.SettingsApi()
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Settings/name)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = 56 # Integer | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = 56 # Integer | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Returns all settings
    api_response = api_instance.getSettings(fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SettingsApi->getSettings: %s\n" % e)

Parameters

Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 500 - Internal server error


updateSetting

Updates a setting


/settings/{settingName}

Usage and SDK Samples

curl -X put "https://localhost/api/v1/settings/{settingName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SettingsApi;

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

public class SettingsApiExample {

    public static void main(String[] args) {
        
        SettingsApi apiInstance = new SettingsApi();
        String settingName = settingName_example; // String | setting name
        SettingRequestSwagger body = ; // SettingRequestSwagger | 
        try {
            apiInstance.updateSetting(settingName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SettingsApi#updateSetting");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SettingsApi;

public class SettingsApiExample {

    public static void main(String[] args) {
        SettingsApi apiInstance = new SettingsApi();
        String settingName = settingName_example; // String | setting name
        SettingRequestSwagger body = ; // SettingRequestSwagger | 
        try {
            apiInstance.updateSetting(settingName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SettingsApi#updateSetting");
            e.printStackTrace();
        }
    }
}
String *settingName = settingName_example; // setting name
SettingRequestSwagger *body = ; // 

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

// Updates a setting
[apiInstance updateSettingWith:settingName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.SettingsApi()

var settingName = settingName_example; // {String} setting name

var body = ; // {SettingRequestSwagger} 


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

namespace Example
{
    public class updateSettingExample
    {
        public void main()
        {
            
            var apiInstance = new SettingsApi();
            var settingName = settingName_example;  // String | setting name
            var body = new SettingRequestSwagger(); // SettingRequestSwagger | 

            try
            {
                // Updates a setting
                apiInstance.updateSetting(settingName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SettingsApi.updateSetting: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SettingsApi();
$settingName = settingName_example; // String | setting name
$body = ; // SettingRequestSwagger | 

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

my $api_instance = WWW::SwaggerClient::SettingsApi->new();
my $settingName = settingName_example; # String | setting name
my $body = WWW::SwaggerClient::Object::SettingRequestSwagger->new(); # SettingRequestSwagger | 

eval { 
    $api_instance->updateSetting(settingName => $settingName, body => $body);
};
if ($@) {
    warn "Exception when calling SettingsApi->updateSetting: $@\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.SettingsApi()
settingName = settingName_example # String | setting name
body =  # SettingRequestSwagger | 

try: 
    # Updates a setting
    api_instance.updateSetting(settingName, body)
except ApiException as e:
    print("Exception when calling SettingsApi->updateSetting: %s\n" % e)

Parameters

Path parameters
Name Description
settingName*
Body parameters
Name Description
body *

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


Stacks

stacksServiceGetServiceComponent

Get details for a stack service component

Returns details for a stack service component.


/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/components/{componentName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/components/{componentName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String componentName = componentName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            StackServiceComponentResponseSwagger result = apiInstance.stacksServiceGetServiceComponent(stackName, stackVersion, serviceName, componentName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetServiceComponent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String componentName = componentName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            StackServiceComponentResponseSwagger result = apiInstance.stacksServiceGetServiceComponent(stackName, stackVersion, serviceName, componentName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetServiceComponent");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *serviceName = serviceName_example; // 
String *componentName = componentName_example; // 
String *fields = fields_example; // Filter returned attributes (optional) (default to StackServiceComponents/*)

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

// Get details for a stack service component
[apiInstance stacksServiceGetServiceComponentWith:stackName
    stackVersion:stackVersion
    serviceName:serviceName
    componentName:componentName
    fields:fields
              completionHandler: ^(StackServiceComponentResponseSwagger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var serviceName = serviceName_example; // {String} 

var componentName = componentName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter returned attributes
};

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

namespace Example
{
    public class stacksServiceGetServiceComponentExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var serviceName = serviceName_example;  // String | 
            var componentName = componentName_example;  // String | 
            var fields = fields_example;  // String | Filter returned attributes (optional)  (default to StackServiceComponents/*)

            try
            {
                // Get details for a stack service component
                StackServiceComponentResponseSwagger result = apiInstance.stacksServiceGetServiceComponent(stackName, stackVersion, serviceName, componentName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetServiceComponent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$serviceName = serviceName_example; // String | 
$componentName = componentName_example; // String | 
$fields = fields_example; // String | Filter returned attributes

try {
    $result = $api_instance->stacksServiceGetServiceComponent($stackName, $stackVersion, $serviceName, $componentName, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StacksApi->stacksServiceGetServiceComponent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StacksApi;

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $serviceName = serviceName_example; # String | 
my $componentName = componentName_example; # String | 
my $fields = fields_example; # String | Filter returned attributes

eval { 
    my $result = $api_instance->stacksServiceGetServiceComponent(stackName => $stackName, stackVersion => $stackVersion, serviceName => $serviceName, componentName => $componentName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetServiceComponent: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
serviceName = serviceName_example # String | 
componentName = componentName_example # String | 
fields = fields_example # String | Filter returned attributes (optional) (default to StackServiceComponents/*)

try: 
    # Get details for a stack service component
    api_response = api_instance.stacksServiceGetServiceComponent(stackName, stackVersion, serviceName, componentName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetServiceComponent: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
serviceName*
componentName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetServiceComponentDependencies

Get all dependencies for a stack service component

Returns all dependencies for a stack service component.


/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/components/{componentName}/dependencies

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/components/{componentName}/dependencies?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String componentName = componentName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        String sortBy = sortBy_example; // String | Sort component dependencies (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ComponentDependencyResponse] result = apiInstance.stacksServiceGetServiceComponentDependencies(stackName, stackVersion, serviceName, componentName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetServiceComponentDependencies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String componentName = componentName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        String sortBy = sortBy_example; // String | Sort component dependencies (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ComponentDependencyResponse] result = apiInstance.stacksServiceGetServiceComponentDependencies(stackName, stackVersion, serviceName, componentName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetServiceComponentDependencies");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *serviceName = serviceName_example; // 
String *componentName = componentName_example; // 
String *fields = fields_example; // Filter returned attributes (optional) (default to Dependencies/stack_name,Dependencies/stack_version,Dependencies/dependent_service_name,Dependencies/dependent_component_name,Dependencies/component_name)
String *sortBy = sortBy_example; // Sort component dependencies (asc | desc) (optional) (default to Dependencies/stack_name.asc,Dependencies/stack_version.asc,Dependencies/dependent_service_name.asc,Dependencies/dependent_component_name.asc,Dependencies/component_name.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all dependencies for a stack service component
[apiInstance stacksServiceGetServiceComponentDependenciesWith:stackName
    stackVersion:stackVersion
    serviceName:serviceName
    componentName:componentName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[ComponentDependencyResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var serviceName = serviceName_example; // {String} 

var componentName = componentName_example; // {String} 

var opts = { 
  'fields': fields_example, // {String} Filter returned attributes
  'sortBy': sortBy_example, // {String} Sort component dependencies (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive).  "start" is also accepted.
  'to': to_example // {String} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class stacksServiceGetServiceComponentDependenciesExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var serviceName = serviceName_example;  // String | 
            var componentName = componentName_example;  // String | 
            var fields = fields_example;  // String | Filter returned attributes (optional)  (default to Dependencies/stack_name,Dependencies/stack_version,Dependencies/dependent_service_name,Dependencies/dependent_component_name,Dependencies/component_name)
            var sortBy = sortBy_example;  // String | Sort component dependencies (asc | desc) (optional)  (default to Dependencies/stack_name.asc,Dependencies/stack_version.asc,Dependencies/dependent_service_name.asc,Dependencies/dependent_component_name.asc,Dependencies/component_name.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all dependencies for a stack service component
                array[ComponentDependencyResponse] result = apiInstance.stacksServiceGetServiceComponentDependencies(stackName, stackVersion, serviceName, componentName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetServiceComponentDependencies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$serviceName = serviceName_example; // String | 
$componentName = componentName_example; // String | 
$fields = fields_example; // String | Filter returned attributes
$sortBy = sortBy_example; // String | Sort component dependencies (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
$to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->stacksServiceGetServiceComponentDependencies($stackName, $stackVersion, $serviceName, $componentName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StacksApi->stacksServiceGetServiceComponentDependencies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StacksApi;

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $serviceName = serviceName_example; # String | 
my $componentName = componentName_example; # String | 
my $fields = fields_example; # String | Filter returned attributes
my $sortBy = sortBy_example; # String | Sort component dependencies (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive).  "start" is also accepted.
my $to = to_example; # String | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->stacksServiceGetServiceComponentDependencies(stackName => $stackName, stackVersion => $stackVersion, serviceName => $serviceName, componentName => $componentName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetServiceComponentDependencies: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
serviceName = serviceName_example # String | 
componentName = componentName_example # String | 
fields = fields_example # String | Filter returned attributes (optional) (default to Dependencies/stack_name,Dependencies/stack_version,Dependencies/dependent_service_name,Dependencies/dependent_component_name,Dependencies/component_name)
sortBy = sortBy_example # String | Sort component dependencies (asc | desc) (optional) (default to Dependencies/stack_name.asc,Dependencies/stack_version.asc,Dependencies/dependent_service_name.asc,Dependencies/dependent_component_name.asc,Dependencies/component_name.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all dependencies for a stack service component
    api_response = api_instance.stacksServiceGetServiceComponentDependencies(stackName, stackVersion, serviceName, componentName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetServiceComponentDependencies: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
serviceName*
componentName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetServiceComponentDependency

Get a stack service component dependency

Returns a stack service component dependency.


/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/components/{componentName}/dependencies/{dependencyName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/components/{componentName}/dependencies/{dependencyName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String componentName = componentName_example; // String | 
        String dependencyName = dependencyName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            ComponentDependencyResponse result = apiInstance.stacksServiceGetServiceComponentDependency(stackName, stackVersion, serviceName, componentName, dependencyName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetServiceComponentDependency");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String componentName = componentName_example; // String | 
        String dependencyName = dependencyName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            ComponentDependencyResponse result = apiInstance.stacksServiceGetServiceComponentDependency(stackName, stackVersion, serviceName, componentName, dependencyName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetServiceComponentDependency");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *serviceName = serviceName_example; // 
String *componentName = componentName_example; // 
String *dependencyName = dependencyName_example; // 
String *fields = fields_example; // Filter returned attributes (optional) (default to Dependencies/*)

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

// Get a stack service component dependency
[apiInstance stacksServiceGetServiceComponentDependencyWith:stackName
    stackVersion:stackVersion
    serviceName:serviceName
    componentName:componentName
    dependencyName:dependencyName
    fields:fields
              completionHandler: ^(ComponentDependencyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var serviceName = serviceName_example; // {String} 

var componentName = componentName_example; // {String} 

var dependencyName = dependencyName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter returned attributes
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.stacksServiceGetServiceComponentDependency(stackName, stackVersion, serviceName, componentName, dependencyName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class stacksServiceGetServiceComponentDependencyExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var serviceName = serviceName_example;  // String | 
            var componentName = componentName_example;  // String | 
            var dependencyName = dependencyName_example;  // String | 
            var fields = fields_example;  // String | Filter returned attributes (optional)  (default to Dependencies/*)

            try
            {
                // Get a stack service component dependency
                ComponentDependencyResponse result = apiInstance.stacksServiceGetServiceComponentDependency(stackName, stackVersion, serviceName, componentName, dependencyName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetServiceComponentDependency: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$serviceName = serviceName_example; // String | 
$componentName = componentName_example; // String | 
$dependencyName = dependencyName_example; // String | 
$fields = fields_example; // String | Filter returned attributes

try {
    $result = $api_instance->stacksServiceGetServiceComponentDependency($stackName, $stackVersion, $serviceName, $componentName, $dependencyName, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StacksApi->stacksServiceGetServiceComponentDependency: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StacksApi;

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $serviceName = serviceName_example; # String | 
my $componentName = componentName_example; # String | 
my $dependencyName = dependencyName_example; # String | 
my $fields = fields_example; # String | Filter returned attributes

eval { 
    my $result = $api_instance->stacksServiceGetServiceComponentDependency(stackName => $stackName, stackVersion => $stackVersion, serviceName => $serviceName, componentName => $componentName, dependencyName => $dependencyName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetServiceComponentDependency: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
serviceName = serviceName_example # String | 
componentName = componentName_example # String | 
dependencyName = dependencyName_example # String | 
fields = fields_example # String | Filter returned attributes (optional) (default to Dependencies/*)

try: 
    # Get a stack service component dependency
    api_response = api_instance.stacksServiceGetServiceComponentDependency(stackName, stackVersion, serviceName, componentName, dependencyName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetServiceComponentDependency: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
serviceName*
componentName*
dependencyName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetServiceComponents

Get all components for a stack service

Returns all components for a stack service.


/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/components

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/components?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        String sortBy = sortBy_example; // String | Sort service components (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[StackServiceComponentResponseSwagger] result = apiInstance.stacksServiceGetServiceComponents(stackName, stackVersion, serviceName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetServiceComponents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        String sortBy = sortBy_example; // String | Sort service components (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[StackServiceComponentResponseSwagger] result = apiInstance.stacksServiceGetServiceComponents(stackName, stackVersion, serviceName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetServiceComponents");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *serviceName = serviceName_example; // 
String *fields = fields_example; // Filter returned attributes (optional) (default to StackServiceComponents/component_name,StackServiceComponents/service_name,StackServiceComponents/stack_name,StackServiceComponents/stack_version)
String *sortBy = sortBy_example; // Sort service components (asc | desc) (optional) (default to StackServiceComponents/component_name.asc,StackServiceComponents/service_name.asc,StackServiceComponents/stack_name.asc,StackServiceComponents/stack_version.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all components for a stack service
[apiInstance stacksServiceGetServiceComponentsWith:stackName
    stackVersion:stackVersion
    serviceName:serviceName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[StackServiceComponentResponseSwagger] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var serviceName = serviceName_example; // {String} 

var opts = { 
  'fields': fields_example, // {String} Filter returned attributes
  'sortBy': sortBy_example, // {String} Sort service components (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive).  "start" is also accepted.
  'to': to_example // {String} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class stacksServiceGetServiceComponentsExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var serviceName = serviceName_example;  // String | 
            var fields = fields_example;  // String | Filter returned attributes (optional)  (default to StackServiceComponents/component_name,StackServiceComponents/service_name,StackServiceComponents/stack_name,StackServiceComponents/stack_version)
            var sortBy = sortBy_example;  // String | Sort service components (asc | desc) (optional)  (default to StackServiceComponents/component_name.asc,StackServiceComponents/service_name.asc,StackServiceComponents/stack_name.asc,StackServiceComponents/stack_version.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all components for a stack service
                array[StackServiceComponentResponseSwagger] result = apiInstance.stacksServiceGetServiceComponents(stackName, stackVersion, serviceName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetServiceComponents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$serviceName = serviceName_example; // String | 
$fields = fields_example; // String | Filter returned attributes
$sortBy = sortBy_example; // String | Sort service components (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
$to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->stacksServiceGetServiceComponents($stackName, $stackVersion, $serviceName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StacksApi->stacksServiceGetServiceComponents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StacksApi;

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $serviceName = serviceName_example; # String | 
my $fields = fields_example; # String | Filter returned attributes
my $sortBy = sortBy_example; # String | Sort service components (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive).  "start" is also accepted.
my $to = to_example; # String | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->stacksServiceGetServiceComponents(stackName => $stackName, stackVersion => $stackVersion, serviceName => $serviceName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetServiceComponents: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
serviceName = serviceName_example # String | 
fields = fields_example # String | Filter returned attributes (optional) (default to StackServiceComponents/component_name,StackServiceComponents/service_name,StackServiceComponents/stack_name,StackServiceComponents/stack_version)
sortBy = sortBy_example # String | Sort service components (asc | desc) (optional) (default to StackServiceComponents/component_name.asc,StackServiceComponents/service_name.asc,StackServiceComponents/stack_name.asc,StackServiceComponents/stack_version.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all components for a stack service
    api_response = api_instance.stacksServiceGetServiceComponents(stackName, stackVersion, serviceName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetServiceComponents: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
serviceName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetStack

Get a stack

Returns stack details.


/stacks/{stackName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String fields = fields_example; // String | Filter stack details
        try {
            array[StackResponseSwagger] result = apiInstance.stacksServiceGetStack(stackName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStack");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String fields = fields_example; // String | Filter stack details
        try {
            array[StackResponseSwagger] result = apiInstance.stacksServiceGetStack(stackName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStack");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *fields = fields_example; // Filter stack details (optional) (default to Stacks/*)

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

// Get a stack
[apiInstance stacksServiceGetStackWith:stackName
    fields:fields
              completionHandler: ^(array[StackResponseSwagger] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter stack details
};

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

namespace Example
{
    public class stacksServiceGetStackExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var fields = fields_example;  // String | Filter stack details (optional)  (default to Stacks/*)

            try
            {
                // Get a stack
                array[StackResponseSwagger] result = apiInstance.stacksServiceGetStack(stackName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetStack: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$fields = fields_example; // String | Filter stack details

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

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $fields = fields_example; # String | Filter stack details

eval { 
    my $result = $api_instance->stacksServiceGetStack(stackName => $stackName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetStack: $@\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.StacksApi()
stackName = stackName_example # String | 
fields = fields_example # String | Filter stack details (optional) (default to Stacks/*)

try: 
    # Get a stack
    api_response = api_instance.stacksServiceGetStack(stackName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetStack: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetStackArtifact

Get stack artifact details

Returns the details of a stack artifact


/stacks/{stackName}/versions/{stackVersion}/artifacts/{artifactName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}/artifacts/{artifactName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String artifactName = artifactName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            StackArtifactResponse result = apiInstance.stacksServiceGetStackArtifact(stackName, stackVersion, artifactName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackArtifact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String artifactName = artifactName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            StackArtifactResponse result = apiInstance.stacksServiceGetStackArtifact(stackName, stackVersion, artifactName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackArtifact");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *artifactName = artifactName_example; // 
String *fields = fields_example; // Filter returned attributes (optional) (default to Artifacts/*)

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

// Get stack artifact details
[apiInstance stacksServiceGetStackArtifactWith:stackName
    stackVersion:stackVersion
    artifactName:artifactName
    fields:fields
              completionHandler: ^(StackArtifactResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var artifactName = artifactName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter returned attributes
};

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

namespace Example
{
    public class stacksServiceGetStackArtifactExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var artifactName = artifactName_example;  // String | 
            var fields = fields_example;  // String | Filter returned attributes (optional)  (default to Artifacts/*)

            try
            {
                // Get stack artifact details
                StackArtifactResponse result = apiInstance.stacksServiceGetStackArtifact(stackName, stackVersion, artifactName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetStackArtifact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$artifactName = artifactName_example; // String | 
$fields = fields_example; // String | Filter returned attributes

try {
    $result = $api_instance->stacksServiceGetStackArtifact($stackName, $stackVersion, $artifactName, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StacksApi->stacksServiceGetStackArtifact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StacksApi;

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $artifactName = artifactName_example; # String | 
my $fields = fields_example; # String | Filter returned attributes

eval { 
    my $result = $api_instance->stacksServiceGetStackArtifact(stackName => $stackName, stackVersion => $stackVersion, artifactName => $artifactName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetStackArtifact: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
artifactName = artifactName_example # String | 
fields = fields_example # String | Filter returned attributes (optional) (default to Artifacts/*)

try: 
    # Get stack artifact details
    api_response = api_instance.stacksServiceGetStackArtifact(stackName, stackVersion, artifactName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetStackArtifact: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
artifactName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetStackArtifacts

Get all stack artifacts

Returns all stack artifacts (e.g: kerberos descriptor, metrics descriptor)


/stacks/{stackName}/versions/{stackVersion}/artifacts

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}/artifacts?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            array[StackArtifactResponse] result = apiInstance.stacksServiceGetStackArtifacts(stackName, stackVersion, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackArtifacts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            array[StackArtifactResponse] result = apiInstance.stacksServiceGetStackArtifacts(stackName, stackVersion, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackArtifacts");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *fields = fields_example; // Filter returned attributes (optional) (default to Artifacts/artifact_name,Artifacts/stack_name,Artifacts/stack_version)

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

// Get all stack artifacts
[apiInstance stacksServiceGetStackArtifactsWith:stackName
    stackVersion:stackVersion
    fields:fields
              completionHandler: ^(array[StackArtifactResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter returned attributes
};

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

namespace Example
{
    public class stacksServiceGetStackArtifactsExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var fields = fields_example;  // String | Filter returned attributes (optional)  (default to Artifacts/artifact_name,Artifacts/stack_name,Artifacts/stack_version)

            try
            {
                // Get all stack artifacts
                array[StackArtifactResponse] result = apiInstance.stacksServiceGetStackArtifacts(stackName, stackVersion, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetStackArtifacts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$fields = fields_example; // String | Filter returned attributes

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

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $fields = fields_example; # String | Filter returned attributes

eval { 
    my $result = $api_instance->stacksServiceGetStackArtifacts(stackName => $stackName, stackVersion => $stackVersion, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetStackArtifacts: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
fields = fields_example # String | Filter returned attributes (optional) (default to Artifacts/artifact_name,Artifacts/stack_name,Artifacts/stack_version)

try: 
    # Get all stack artifacts
    api_response = api_instance.stacksServiceGetStackArtifacts(stackName, stackVersion, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetStackArtifacts: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetStackConfiguration

Get stack service configuration details

Returns the details of a stack service configuration.


/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/configurations/{propertyName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/configurations/{propertyName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String propertyName = propertyName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            StackConfigurationResponseSwagger result = apiInstance.stacksServiceGetStackConfiguration(stackName, stackVersion, serviceName, propertyName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackConfiguration");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String propertyName = propertyName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            StackConfigurationResponseSwagger result = apiInstance.stacksServiceGetStackConfiguration(stackName, stackVersion, serviceName, propertyName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackConfiguration");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *serviceName = serviceName_example; // 
String *propertyName = propertyName_example; // 
String *fields = fields_example; // Filter returned attributes (optional) (default to StackConfigurations/*)

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

// Get stack service configuration details
[apiInstance stacksServiceGetStackConfigurationWith:stackName
    stackVersion:stackVersion
    serviceName:serviceName
    propertyName:propertyName
    fields:fields
              completionHandler: ^(StackConfigurationResponseSwagger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var serviceName = serviceName_example; // {String} 

var propertyName = propertyName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter returned attributes
};

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

namespace Example
{
    public class stacksServiceGetStackConfigurationExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var serviceName = serviceName_example;  // String | 
            var propertyName = propertyName_example;  // String | 
            var fields = fields_example;  // String | Filter returned attributes (optional)  (default to StackConfigurations/*)

            try
            {
                // Get stack service configuration details
                StackConfigurationResponseSwagger result = apiInstance.stacksServiceGetStackConfiguration(stackName, stackVersion, serviceName, propertyName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetStackConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$serviceName = serviceName_example; // String | 
$propertyName = propertyName_example; // String | 
$fields = fields_example; // String | Filter returned attributes

try {
    $result = $api_instance->stacksServiceGetStackConfiguration($stackName, $stackVersion, $serviceName, $propertyName, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StacksApi->stacksServiceGetStackConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StacksApi;

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $serviceName = serviceName_example; # String | 
my $propertyName = propertyName_example; # String | 
my $fields = fields_example; # String | Filter returned attributes

eval { 
    my $result = $api_instance->stacksServiceGetStackConfiguration(stackName => $stackName, stackVersion => $stackVersion, serviceName => $serviceName, propertyName => $propertyName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetStackConfiguration: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
serviceName = serviceName_example # String | 
propertyName = propertyName_example # String | 
fields = fields_example # String | Filter returned attributes (optional) (default to StackConfigurations/*)

try: 
    # Get stack service configuration details
    api_response = api_instance.stacksServiceGetStackConfiguration(stackName, stackVersion, serviceName, propertyName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetStackConfiguration: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
serviceName*
propertyName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetStackConfigurationDependencies

Get all dependencies for a stack service configuration

Returns all dependencies for a stack service configuration.


/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/configurations/{propertyName}/dependencies

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/configurations/{propertyName}/dependencies?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String propertyName = propertyName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        String sortBy = sortBy_example; // String | Sort configuration dependencies (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[StackConfigurationDependencyResponseSwagger] result = apiInstance.stacksServiceGetStackConfigurationDependencies(stackName, stackVersion, serviceName, propertyName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackConfigurationDependencies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String propertyName = propertyName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        String sortBy = sortBy_example; // String | Sort configuration dependencies (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[StackConfigurationDependencyResponseSwagger] result = apiInstance.stacksServiceGetStackConfigurationDependencies(stackName, stackVersion, serviceName, propertyName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackConfigurationDependencies");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *serviceName = serviceName_example; // 
String *propertyName = propertyName_example; // 
String *fields = fields_example; // Filter returned attributes (optional) (default to StackConfigurationDependency/stack_name,StackConfigurationDependency/stack_version,StackConfigurationDependency/service_name,StackConfigurationDependency/property_name,StackConfigurationDependency/dependency_name)
String *sortBy = sortBy_example; // Sort configuration dependencies (asc | desc) (optional) (default to StackConfigurationDependency/stack_name.asc,StackConfigurationDependency/stack_version.asc,StackConfigurationDependency/service_name.asc,StackConfigurationDependency/property_name.asc,StackConfigurationDependency/dependency_name.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all dependencies for a stack service configuration
[apiInstance stacksServiceGetStackConfigurationDependenciesWith:stackName
    stackVersion:stackVersion
    serviceName:serviceName
    propertyName:propertyName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[StackConfigurationDependencyResponseSwagger] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var serviceName = serviceName_example; // {String} 

var propertyName = propertyName_example; // {String} 

var opts = { 
  'fields': fields_example, // {String} Filter returned attributes
  'sortBy': sortBy_example, // {String} Sort configuration dependencies (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive).  "start" is also accepted.
  'to': to_example // {String} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class stacksServiceGetStackConfigurationDependenciesExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var serviceName = serviceName_example;  // String | 
            var propertyName = propertyName_example;  // String | 
            var fields = fields_example;  // String | Filter returned attributes (optional)  (default to StackConfigurationDependency/stack_name,StackConfigurationDependency/stack_version,StackConfigurationDependency/service_name,StackConfigurationDependency/property_name,StackConfigurationDependency/dependency_name)
            var sortBy = sortBy_example;  // String | Sort configuration dependencies (asc | desc) (optional)  (default to StackConfigurationDependency/stack_name.asc,StackConfigurationDependency/stack_version.asc,StackConfigurationDependency/service_name.asc,StackConfigurationDependency/property_name.asc,StackConfigurationDependency/dependency_name.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all dependencies for a stack service configuration
                array[StackConfigurationDependencyResponseSwagger] result = apiInstance.stacksServiceGetStackConfigurationDependencies(stackName, stackVersion, serviceName, propertyName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetStackConfigurationDependencies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$serviceName = serviceName_example; // String | 
$propertyName = propertyName_example; // String | 
$fields = fields_example; // String | Filter returned attributes
$sortBy = sortBy_example; // String | Sort configuration dependencies (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
$to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->stacksServiceGetStackConfigurationDependencies($stackName, $stackVersion, $serviceName, $propertyName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StacksApi->stacksServiceGetStackConfigurationDependencies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StacksApi;

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $serviceName = serviceName_example; # String | 
my $propertyName = propertyName_example; # String | 
my $fields = fields_example; # String | Filter returned attributes
my $sortBy = sortBy_example; # String | Sort configuration dependencies (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive).  "start" is also accepted.
my $to = to_example; # String | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->stacksServiceGetStackConfigurationDependencies(stackName => $stackName, stackVersion => $stackVersion, serviceName => $serviceName, propertyName => $propertyName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetStackConfigurationDependencies: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
serviceName = serviceName_example # String | 
propertyName = propertyName_example # String | 
fields = fields_example # String | Filter returned attributes (optional) (default to StackConfigurationDependency/stack_name,StackConfigurationDependency/stack_version,StackConfigurationDependency/service_name,StackConfigurationDependency/property_name,StackConfigurationDependency/dependency_name)
sortBy = sortBy_example # String | Sort configuration dependencies (asc | desc) (optional) (default to StackConfigurationDependency/stack_name.asc,StackConfigurationDependency/stack_version.asc,StackConfigurationDependency/service_name.asc,StackConfigurationDependency/property_name.asc,StackConfigurationDependency/dependency_name.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all dependencies for a stack service configuration
    api_response = api_instance.stacksServiceGetStackConfigurationDependencies(stackName, stackVersion, serviceName, propertyName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetStackConfigurationDependencies: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
serviceName*
propertyName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetStackConfigurations

Get all configurations for a stack service

Returns all configurations for a stack service.


/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/configurations

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/configurations?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        String sortBy = sortBy_example; // String | Sort service configurations (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[StackConfigurationResponseSwagger] result = apiInstance.stacksServiceGetStackConfigurations(stackName, stackVersion, serviceName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackConfigurations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        String sortBy = sortBy_example; // String | Sort service configurations (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[StackConfigurationResponseSwagger] result = apiInstance.stacksServiceGetStackConfigurations(stackName, stackVersion, serviceName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackConfigurations");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *serviceName = serviceName_example; // 
String *fields = fields_example; // Filter returned attributes (optional) (default to StackConfigurations/property_name,StackConfigurations/service_name,StackConfigurations/stack_nameStackConfigurations/stack_version)
String *sortBy = sortBy_example; // Sort service configurations (asc | desc) (optional) (default to StackConfigurations/property_name.asc,StackConfigurations/service_name.asc,StackConfigurations/stack_name.ascStackConfigurations/stack_version.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all configurations for a stack service
[apiInstance stacksServiceGetStackConfigurationsWith:stackName
    stackVersion:stackVersion
    serviceName:serviceName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[StackConfigurationResponseSwagger] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var serviceName = serviceName_example; // {String} 

var opts = { 
  'fields': fields_example, // {String} Filter returned attributes
  'sortBy': sortBy_example, // {String} Sort service configurations (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive).  "start" is also accepted.
  'to': to_example // {String} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class stacksServiceGetStackConfigurationsExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var serviceName = serviceName_example;  // String | 
            var fields = fields_example;  // String | Filter returned attributes (optional)  (default to StackConfigurations/property_name,StackConfigurations/service_name,StackConfigurations/stack_nameStackConfigurations/stack_version)
            var sortBy = sortBy_example;  // String | Sort service configurations (asc | desc) (optional)  (default to StackConfigurations/property_name.asc,StackConfigurations/service_name.asc,StackConfigurations/stack_name.ascStackConfigurations/stack_version.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all configurations for a stack service
                array[StackConfigurationResponseSwagger] result = apiInstance.stacksServiceGetStackConfigurations(stackName, stackVersion, serviceName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetStackConfigurations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$serviceName = serviceName_example; // String | 
$fields = fields_example; // String | Filter returned attributes
$sortBy = sortBy_example; // String | Sort service configurations (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
$to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->stacksServiceGetStackConfigurations($stackName, $stackVersion, $serviceName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StacksApi->stacksServiceGetStackConfigurations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StacksApi;

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $serviceName = serviceName_example; # String | 
my $fields = fields_example; # String | Filter returned attributes
my $sortBy = sortBy_example; # String | Sort service configurations (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive).  "start" is also accepted.
my $to = to_example; # String | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->stacksServiceGetStackConfigurations(stackName => $stackName, stackVersion => $stackVersion, serviceName => $serviceName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetStackConfigurations: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
serviceName = serviceName_example # String | 
fields = fields_example # String | Filter returned attributes (optional) (default to StackConfigurations/property_name,StackConfigurations/service_name,StackConfigurations/stack_nameStackConfigurations/stack_version)
sortBy = sortBy_example # String | Sort service configurations (asc | desc) (optional) (default to StackConfigurations/property_name.asc,StackConfigurations/service_name.asc,StackConfigurations/stack_name.ascStackConfigurations/stack_version.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all configurations for a stack service
    api_response = api_instance.stacksServiceGetStackConfigurations(stackName, stackVersion, serviceName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetStackConfigurations: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
serviceName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetStackLevelConfiguration

Get configuration details for a given property

Returns the configuration details for a given property.


/stacks/{stackName}/versions/{stackVersion}/configurations/{propertyName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}/configurations/{propertyName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String propertyName = propertyName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            StackConfigurationResponseSwagger result = apiInstance.stacksServiceGetStackLevelConfiguration(stackName, stackVersion, serviceName, propertyName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackLevelConfiguration");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String propertyName = propertyName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            StackConfigurationResponseSwagger result = apiInstance.stacksServiceGetStackLevelConfiguration(stackName, stackVersion, serviceName, propertyName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackLevelConfiguration");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *serviceName = serviceName_example; // 
String *propertyName = propertyName_example; // 
String *fields = fields_example; // Filter returned attributes (optional) (default to StackLevelConfigurations/*)

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

// Get configuration details for a given property
[apiInstance stacksServiceGetStackLevelConfigurationWith:stackName
    stackVersion:stackVersion
    serviceName:serviceName
    propertyName:propertyName
    fields:fields
              completionHandler: ^(StackConfigurationResponseSwagger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var serviceName = serviceName_example; // {String} 

var propertyName = propertyName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter returned attributes
};

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

namespace Example
{
    public class stacksServiceGetStackLevelConfigurationExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var serviceName = serviceName_example;  // String | 
            var propertyName = propertyName_example;  // String | 
            var fields = fields_example;  // String | Filter returned attributes (optional)  (default to StackLevelConfigurations/*)

            try
            {
                // Get configuration details for a given property
                StackConfigurationResponseSwagger result = apiInstance.stacksServiceGetStackLevelConfiguration(stackName, stackVersion, serviceName, propertyName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetStackLevelConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$serviceName = serviceName_example; // String | 
$propertyName = propertyName_example; // String | 
$fields = fields_example; // String | Filter returned attributes

try {
    $result = $api_instance->stacksServiceGetStackLevelConfiguration($stackName, $stackVersion, $serviceName, $propertyName, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StacksApi->stacksServiceGetStackLevelConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StacksApi;

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $serviceName = serviceName_example; # String | 
my $propertyName = propertyName_example; # String | 
my $fields = fields_example; # String | Filter returned attributes

eval { 
    my $result = $api_instance->stacksServiceGetStackLevelConfiguration(stackName => $stackName, stackVersion => $stackVersion, serviceName => $serviceName, propertyName => $propertyName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetStackLevelConfiguration: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
serviceName = serviceName_example # String | 
propertyName = propertyName_example # String | 
fields = fields_example # String | Filter returned attributes (optional) (default to StackLevelConfigurations/*)

try: 
    # Get configuration details for a given property
    api_response = api_instance.stacksServiceGetStackLevelConfiguration(stackName, stackVersion, serviceName, propertyName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetStackLevelConfiguration: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
serviceName*
propertyName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetStackLevelConfigurations

Get all configurations for a stack version

Returns all configurations for a stack version.


/stacks/{stackName}/versions/{stackVersion}/configurations

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}/configurations?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        String sortBy = sortBy_example; // String | Sort configuration (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[StackConfigurationResponseSwagger] result = apiInstance.stacksServiceGetStackLevelConfigurations(stackName, stackVersion, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackLevelConfigurations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        String sortBy = sortBy_example; // String | Sort configuration (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[StackConfigurationResponseSwagger] result = apiInstance.stacksServiceGetStackLevelConfigurations(stackName, stackVersion, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackLevelConfigurations");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *fields = fields_example; // Filter returned attributes (optional) (default to StackLevelConfigurations/stack_name,StackLevelConfigurations/stack_version,StackLevelConfigurations/property_name)
String *sortBy = sortBy_example; // Sort configuration (asc | desc) (optional) (default to StackLevelConfigurations/stack_name.asc,StackLevelConfigurations/stack_version.asc,StackLevelConfigurations/property_name.asc )
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all configurations for a stack version
[apiInstance stacksServiceGetStackLevelConfigurationsWith:stackName
    stackVersion:stackVersion
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[StackConfigurationResponseSwagger] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var opts = { 
  'fields': fields_example, // {String} Filter returned attributes
  'sortBy': sortBy_example, // {String} Sort configuration (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive).  "start" is also accepted.
  'to': to_example // {String} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class stacksServiceGetStackLevelConfigurationsExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var fields = fields_example;  // String | Filter returned attributes (optional)  (default to StackLevelConfigurations/stack_name,StackLevelConfigurations/stack_version,StackLevelConfigurations/property_name)
            var sortBy = sortBy_example;  // String | Sort configuration (asc | desc) (optional)  (default to StackLevelConfigurations/stack_name.asc,StackLevelConfigurations/stack_version.asc,StackLevelConfigurations/property_name.asc )
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all configurations for a stack version
                array[StackConfigurationResponseSwagger] result = apiInstance.stacksServiceGetStackLevelConfigurations(stackName, stackVersion, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetStackLevelConfigurations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$fields = fields_example; // String | Filter returned attributes
$sortBy = sortBy_example; // String | Sort configuration (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
$to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->stacksServiceGetStackLevelConfigurations($stackName, $stackVersion, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StacksApi->stacksServiceGetStackLevelConfigurations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StacksApi;

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $fields = fields_example; # String | Filter returned attributes
my $sortBy = sortBy_example; # String | Sort configuration (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive).  "start" is also accepted.
my $to = to_example; # String | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->stacksServiceGetStackLevelConfigurations(stackName => $stackName, stackVersion => $stackVersion, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetStackLevelConfigurations: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
fields = fields_example # String | Filter returned attributes (optional) (default to StackLevelConfigurations/stack_name,StackLevelConfigurations/stack_version,StackLevelConfigurations/property_name)
sortBy = sortBy_example # String | Sort configuration (asc | desc) (optional) (default to StackLevelConfigurations/stack_name.asc,StackLevelConfigurations/stack_version.asc,StackLevelConfigurations/property_name.asc )
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all configurations for a stack version
    api_response = api_instance.stacksServiceGetStackLevelConfigurations(stackName, stackVersion, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetStackLevelConfigurations: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetStackService

Get stack service details

Returns the details of a stack service.


/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            StackServiceResponseSwagger result = apiInstance.stacksServiceGetStackService(stackName, stackVersion, serviceName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackService");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            StackServiceResponseSwagger result = apiInstance.stacksServiceGetStackService(stackName, stackVersion, serviceName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackService");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *serviceName = serviceName_example; // 
String *fields = fields_example; // Filter returned attributes (optional) (default to StackServices/*)

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

// Get stack service details
[apiInstance stacksServiceGetStackServiceWith:stackName
    stackVersion:stackVersion
    serviceName:serviceName
    fields:fields
              completionHandler: ^(StackServiceResponseSwagger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var serviceName = serviceName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter returned attributes
};

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

namespace Example
{
    public class stacksServiceGetStackServiceExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var serviceName = serviceName_example;  // String | 
            var fields = fields_example;  // String | Filter returned attributes (optional)  (default to StackServices/*)

            try
            {
                // Get stack service details
                StackServiceResponseSwagger result = apiInstance.stacksServiceGetStackService(stackName, stackVersion, serviceName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetStackService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$serviceName = serviceName_example; // String | 
$fields = fields_example; // String | Filter returned attributes

try {
    $result = $api_instance->stacksServiceGetStackService($stackName, $stackVersion, $serviceName, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StacksApi->stacksServiceGetStackService: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StacksApi;

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $serviceName = serviceName_example; # String | 
my $fields = fields_example; # String | Filter returned attributes

eval { 
    my $result = $api_instance->stacksServiceGetStackService(stackName => $stackName, stackVersion => $stackVersion, serviceName => $serviceName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetStackService: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
serviceName = serviceName_example # String | 
fields = fields_example # String | Filter returned attributes (optional) (default to StackServices/*)

try: 
    # Get stack service details
    api_response = api_instance.stacksServiceGetStackService(stackName, stackVersion, serviceName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetStackService: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
serviceName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetStackServiceArtifact

Get stack service artifact details

Returns the details of a stack service artifact.


/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/artifacts/{artifactName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/artifacts/{artifactName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String artifactName = artifactName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            StackArtifactResponse result = apiInstance.stacksServiceGetStackServiceArtifact(stackName, stackVersion, serviceName, artifactName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackServiceArtifact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String artifactName = artifactName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            StackArtifactResponse result = apiInstance.stacksServiceGetStackServiceArtifact(stackName, stackVersion, serviceName, artifactName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackServiceArtifact");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *serviceName = serviceName_example; // 
String *artifactName = artifactName_example; // 
String *fields = fields_example; // Filter returned attributes (optional) (default to Artifacts/*)

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

// Get stack service artifact details
[apiInstance stacksServiceGetStackServiceArtifactWith:stackName
    stackVersion:stackVersion
    serviceName:serviceName
    artifactName:artifactName
    fields:fields
              completionHandler: ^(StackArtifactResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var serviceName = serviceName_example; // {String} 

var artifactName = artifactName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter returned attributes
};

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

namespace Example
{
    public class stacksServiceGetStackServiceArtifactExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var serviceName = serviceName_example;  // String | 
            var artifactName = artifactName_example;  // String | 
            var fields = fields_example;  // String | Filter returned attributes (optional)  (default to Artifacts/*)

            try
            {
                // Get stack service artifact details
                StackArtifactResponse result = apiInstance.stacksServiceGetStackServiceArtifact(stackName, stackVersion, serviceName, artifactName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetStackServiceArtifact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$serviceName = serviceName_example; // String | 
$artifactName = artifactName_example; // String | 
$fields = fields_example; // String | Filter returned attributes

try {
    $result = $api_instance->stacksServiceGetStackServiceArtifact($stackName, $stackVersion, $serviceName, $artifactName, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StacksApi->stacksServiceGetStackServiceArtifact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StacksApi;

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $serviceName = serviceName_example; # String | 
my $artifactName = artifactName_example; # String | 
my $fields = fields_example; # String | Filter returned attributes

eval { 
    my $result = $api_instance->stacksServiceGetStackServiceArtifact(stackName => $stackName, stackVersion => $stackVersion, serviceName => $serviceName, artifactName => $artifactName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetStackServiceArtifact: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
serviceName = serviceName_example # String | 
artifactName = artifactName_example # String | 
fields = fields_example # String | Filter returned attributes (optional) (default to Artifacts/*)

try: 
    # Get stack service artifact details
    api_response = api_instance.stacksServiceGetStackServiceArtifact(stackName, stackVersion, serviceName, artifactName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetStackServiceArtifact: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
serviceName*
artifactName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetStackServiceArtifacts

Get all artifacts for a stack service

Returns all stack service artifacts


/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/artifacts

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/artifacts?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        String sortBy = sortBy_example; // String | Sort service artifacts (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[StackServiceArtifactResponse] result = apiInstance.stacksServiceGetStackServiceArtifacts(stackName, stackVersion, serviceName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackServiceArtifacts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        String sortBy = sortBy_example; // String | Sort service artifacts (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[StackServiceArtifactResponse] result = apiInstance.stacksServiceGetStackServiceArtifacts(stackName, stackVersion, serviceName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackServiceArtifacts");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *serviceName = serviceName_example; // 
String *fields = fields_example; // Filter returned attributes (optional) (default to Artifacts/artifact_name,Artifacts/stack_name,Artifacts/stack_version)
String *sortBy = sortBy_example; // Sort service artifacts (asc | desc) (optional) (default to Artifacts/artifact_name.asc,Artifacts/stack_name.asc,Artifacts/stack_version.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all artifacts for a stack service
[apiInstance stacksServiceGetStackServiceArtifactsWith:stackName
    stackVersion:stackVersion
    serviceName:serviceName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[StackServiceArtifactResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var serviceName = serviceName_example; // {String} 

var opts = { 
  'fields': fields_example, // {String} Filter returned attributes
  'sortBy': sortBy_example, // {String} Sort service artifacts (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive).  "start" is also accepted.
  'to': to_example // {String} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class stacksServiceGetStackServiceArtifactsExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var serviceName = serviceName_example;  // String | 
            var fields = fields_example;  // String | Filter returned attributes (optional)  (default to Artifacts/artifact_name,Artifacts/stack_name,Artifacts/stack_version)
            var sortBy = sortBy_example;  // String | Sort service artifacts (asc | desc) (optional)  (default to Artifacts/artifact_name.asc,Artifacts/stack_name.asc,Artifacts/stack_version.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all artifacts for a stack service
                array[StackServiceArtifactResponse] result = apiInstance.stacksServiceGetStackServiceArtifacts(stackName, stackVersion, serviceName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetStackServiceArtifacts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$serviceName = serviceName_example; // String | 
$fields = fields_example; // String | Filter returned attributes
$sortBy = sortBy_example; // String | Sort service artifacts (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
$to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->stacksServiceGetStackServiceArtifacts($stackName, $stackVersion, $serviceName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StacksApi->stacksServiceGetStackServiceArtifacts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StacksApi;

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $serviceName = serviceName_example; # String | 
my $fields = fields_example; # String | Filter returned attributes
my $sortBy = sortBy_example; # String | Sort service artifacts (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive).  "start" is also accepted.
my $to = to_example; # String | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->stacksServiceGetStackServiceArtifacts(stackName => $stackName, stackVersion => $stackVersion, serviceName => $serviceName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetStackServiceArtifacts: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
serviceName = serviceName_example # String | 
fields = fields_example # String | Filter returned attributes (optional) (default to Artifacts/artifact_name,Artifacts/stack_name,Artifacts/stack_version)
sortBy = sortBy_example # String | Sort service artifacts (asc | desc) (optional) (default to Artifacts/artifact_name.asc,Artifacts/stack_name.asc,Artifacts/stack_version.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all artifacts for a stack service
    api_response = api_instance.stacksServiceGetStackServiceArtifacts(stackName, stackVersion, serviceName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetStackServiceArtifacts: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
serviceName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetStackServiceQuickLinksConfiguration

Get quicklinks configuration details

Returns the details of a quicklinks configuration.


/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/quicklinks/{quickLinksConfigurationName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/quicklinks/{quickLinksConfigurationName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String quickLinksConfigurationName = quickLinksConfigurationName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            array[QuickLinksResponse] result = apiInstance.stacksServiceGetStackServiceQuickLinksConfiguration(stackName, stackVersion, serviceName, quickLinksConfigurationName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackServiceQuickLinksConfiguration");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String quickLinksConfigurationName = quickLinksConfigurationName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            array[QuickLinksResponse] result = apiInstance.stacksServiceGetStackServiceQuickLinksConfiguration(stackName, stackVersion, serviceName, quickLinksConfigurationName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackServiceQuickLinksConfiguration");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *serviceName = serviceName_example; // 
String *quickLinksConfigurationName = quickLinksConfigurationName_example; // 
String *fields = fields_example; // Filter returned attributes (optional) (default to QuickLinkInfo/*)

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

// Get quicklinks configuration details
[apiInstance stacksServiceGetStackServiceQuickLinksConfigurationWith:stackName
    stackVersion:stackVersion
    serviceName:serviceName
    quickLinksConfigurationName:quickLinksConfigurationName
    fields:fields
              completionHandler: ^(array[QuickLinksResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var serviceName = serviceName_example; // {String} 

var quickLinksConfigurationName = quickLinksConfigurationName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter returned attributes
};

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

namespace Example
{
    public class stacksServiceGetStackServiceQuickLinksConfigurationExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var serviceName = serviceName_example;  // String | 
            var quickLinksConfigurationName = quickLinksConfigurationName_example;  // String | 
            var fields = fields_example;  // String | Filter returned attributes (optional)  (default to QuickLinkInfo/*)

            try
            {
                // Get quicklinks configuration details
                array[QuickLinksResponse] result = apiInstance.stacksServiceGetStackServiceQuickLinksConfiguration(stackName, stackVersion, serviceName, quickLinksConfigurationName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetStackServiceQuickLinksConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$serviceName = serviceName_example; // String | 
$quickLinksConfigurationName = quickLinksConfigurationName_example; // String | 
$fields = fields_example; // String | Filter returned attributes

try {
    $result = $api_instance->stacksServiceGetStackServiceQuickLinksConfiguration($stackName, $stackVersion, $serviceName, $quickLinksConfigurationName, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StacksApi->stacksServiceGetStackServiceQuickLinksConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StacksApi;

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $serviceName = serviceName_example; # String | 
my $quickLinksConfigurationName = quickLinksConfigurationName_example; # String | 
my $fields = fields_example; # String | Filter returned attributes

eval { 
    my $result = $api_instance->stacksServiceGetStackServiceQuickLinksConfiguration(stackName => $stackName, stackVersion => $stackVersion, serviceName => $serviceName, quickLinksConfigurationName => $quickLinksConfigurationName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetStackServiceQuickLinksConfiguration: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
serviceName = serviceName_example # String | 
quickLinksConfigurationName = quickLinksConfigurationName_example # String | 
fields = fields_example # String | Filter returned attributes (optional) (default to QuickLinkInfo/*)

try: 
    # Get quicklinks configuration details
    api_response = api_instance.stacksServiceGetStackServiceQuickLinksConfiguration(stackName, stackVersion, serviceName, quickLinksConfigurationName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetStackServiceQuickLinksConfiguration: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
serviceName*
quickLinksConfigurationName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetStackServiceQuickLinksConfigurations

Get all quicklinks configurations for a stack service

Returns all quicklinks configurations for a stack service.


/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/quicklinks

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/quicklinks?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        String sortBy = sortBy_example; // String | Sort quick links (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[QuickLinksResponse] result = apiInstance.stacksServiceGetStackServiceQuickLinksConfigurations(stackName, stackVersion, serviceName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackServiceQuickLinksConfigurations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        String sortBy = sortBy_example; // String | Sort quick links (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[QuickLinksResponse] result = apiInstance.stacksServiceGetStackServiceQuickLinksConfigurations(stackName, stackVersion, serviceName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackServiceQuickLinksConfigurations");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *serviceName = serviceName_example; // 
String *fields = fields_example; // Filter returned attributes (optional) (default to QuickLinkInfo/file_name,QuickLinkInfo/service_name,QuickLinkInfo/stack_name,QuickLinkInfo/stack_version)
String *sortBy = sortBy_example; // Sort quick links (asc | desc) (optional) (default to QuickLinkInfo/file_name.asc,QuickLinkInfo/service_name.asc,QuickLinkInfo/stack_name.asc,QuickLinkInfo/stack_version.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all quicklinks configurations for a stack service
[apiInstance stacksServiceGetStackServiceQuickLinksConfigurationsWith:stackName
    stackVersion:stackVersion
    serviceName:serviceName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[QuickLinksResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var serviceName = serviceName_example; // {String} 

var opts = { 
  'fields': fields_example, // {String} Filter returned attributes
  'sortBy': sortBy_example, // {String} Sort quick links (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive).  "start" is also accepted.
  'to': to_example // {String} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class stacksServiceGetStackServiceQuickLinksConfigurationsExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var serviceName = serviceName_example;  // String | 
            var fields = fields_example;  // String | Filter returned attributes (optional)  (default to QuickLinkInfo/file_name,QuickLinkInfo/service_name,QuickLinkInfo/stack_name,QuickLinkInfo/stack_version)
            var sortBy = sortBy_example;  // String | Sort quick links (asc | desc) (optional)  (default to QuickLinkInfo/file_name.asc,QuickLinkInfo/service_name.asc,QuickLinkInfo/stack_name.asc,QuickLinkInfo/stack_version.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all quicklinks configurations for a stack service
                array[QuickLinksResponse] result = apiInstance.stacksServiceGetStackServiceQuickLinksConfigurations(stackName, stackVersion, serviceName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetStackServiceQuickLinksConfigurations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$serviceName = serviceName_example; // String | 
$fields = fields_example; // String | Filter returned attributes
$sortBy = sortBy_example; // String | Sort quick links (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
$to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->stacksServiceGetStackServiceQuickLinksConfigurations($stackName, $stackVersion, $serviceName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StacksApi->stacksServiceGetStackServiceQuickLinksConfigurations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StacksApi;

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $serviceName = serviceName_example; # String | 
my $fields = fields_example; # String | Filter returned attributes
my $sortBy = sortBy_example; # String | Sort quick links (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive).  "start" is also accepted.
my $to = to_example; # String | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->stacksServiceGetStackServiceQuickLinksConfigurations(stackName => $stackName, stackVersion => $stackVersion, serviceName => $serviceName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetStackServiceQuickLinksConfigurations: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
serviceName = serviceName_example # String | 
fields = fields_example # String | Filter returned attributes (optional) (default to QuickLinkInfo/file_name,QuickLinkInfo/service_name,QuickLinkInfo/stack_name,QuickLinkInfo/stack_version)
sortBy = sortBy_example # String | Sort quick links (asc | desc) (optional) (default to QuickLinkInfo/file_name.asc,QuickLinkInfo/service_name.asc,QuickLinkInfo/stack_name.asc,QuickLinkInfo/stack_version.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all quicklinks configurations for a stack service
    api_response = api_instance.stacksServiceGetStackServiceQuickLinksConfigurations(stackName, stackVersion, serviceName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetStackServiceQuickLinksConfigurations: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
serviceName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetStackServiceTheme

Get theme details for a stack service

Returns stack service theme details.


/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/themes/{themeName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/themes/{themeName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String themeName = themeName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            ThemeResponse result = apiInstance.stacksServiceGetStackServiceTheme(stackName, stackVersion, serviceName, themeName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackServiceTheme");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String themeName = themeName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        try {
            ThemeResponse result = apiInstance.stacksServiceGetStackServiceTheme(stackName, stackVersion, serviceName, themeName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackServiceTheme");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *serviceName = serviceName_example; // 
String *themeName = themeName_example; // 
String *fields = fields_example; // Filter returned attributes (optional) (default to ThemeInfo/*)

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

// Get theme details for a stack service
[apiInstance stacksServiceGetStackServiceThemeWith:stackName
    stackVersion:stackVersion
    serviceName:serviceName
    themeName:themeName
    fields:fields
              completionHandler: ^(ThemeResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var serviceName = serviceName_example; // {String} 

var themeName = themeName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter returned attributes
};

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

namespace Example
{
    public class stacksServiceGetStackServiceThemeExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var serviceName = serviceName_example;  // String | 
            var themeName = themeName_example;  // String | 
            var fields = fields_example;  // String | Filter returned attributes (optional)  (default to ThemeInfo/*)

            try
            {
                // Get theme details for a stack service
                ThemeResponse result = apiInstance.stacksServiceGetStackServiceTheme(stackName, stackVersion, serviceName, themeName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetStackServiceTheme: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$serviceName = serviceName_example; // String | 
$themeName = themeName_example; // String | 
$fields = fields_example; // String | Filter returned attributes

try {
    $result = $api_instance->stacksServiceGetStackServiceTheme($stackName, $stackVersion, $serviceName, $themeName, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StacksApi->stacksServiceGetStackServiceTheme: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StacksApi;

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $serviceName = serviceName_example; # String | 
my $themeName = themeName_example; # String | 
my $fields = fields_example; # String | Filter returned attributes

eval { 
    my $result = $api_instance->stacksServiceGetStackServiceTheme(stackName => $stackName, stackVersion => $stackVersion, serviceName => $serviceName, themeName => $themeName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetStackServiceTheme: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
serviceName = serviceName_example # String | 
themeName = themeName_example # String | 
fields = fields_example # String | Filter returned attributes (optional) (default to ThemeInfo/*)

try: 
    # Get theme details for a stack service
    api_response = api_instance.stacksServiceGetStackServiceTheme(stackName, stackVersion, serviceName, themeName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetStackServiceTheme: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
serviceName*
themeName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetStackServiceThemes

Get all themes for a stack service

Returns all stack themes


/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/themes

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}/services/{serviceName}/themes?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        String sortBy = sortBy_example; // String | Sort service artifacts (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ThemeResponse] result = apiInstance.stacksServiceGetStackServiceThemes(stackName, stackVersion, serviceName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackServiceThemes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String serviceName = serviceName_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        String sortBy = sortBy_example; // String | Sort service artifacts (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ThemeResponse] result = apiInstance.stacksServiceGetStackServiceThemes(stackName, stackVersion, serviceName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackServiceThemes");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *serviceName = serviceName_example; // 
String *fields = fields_example; // Filter returned attributes (optional) (default to ThemeInfo/file_name,ThemeInfo/service_name,ThemeInfo/stack_name,ThemeInfo/stack_version)
String *sortBy = sortBy_example; // Sort service artifacts (asc | desc) (optional) (default to ThemeInfo/file_name.asc,ThemeInfo/service_name.asc,ThemeInfo/stack_name.asc,ThemeInfo/stack_version.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all themes for a stack service
[apiInstance stacksServiceGetStackServiceThemesWith:stackName
    stackVersion:stackVersion
    serviceName:serviceName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[ThemeResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var serviceName = serviceName_example; // {String} 

var opts = { 
  'fields': fields_example, // {String} Filter returned attributes
  'sortBy': sortBy_example, // {String} Sort service artifacts (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive).  "start" is also accepted.
  'to': to_example // {String} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class stacksServiceGetStackServiceThemesExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var serviceName = serviceName_example;  // String | 
            var fields = fields_example;  // String | Filter returned attributes (optional)  (default to ThemeInfo/file_name,ThemeInfo/service_name,ThemeInfo/stack_name,ThemeInfo/stack_version)
            var sortBy = sortBy_example;  // String | Sort service artifacts (asc | desc) (optional)  (default to ThemeInfo/file_name.asc,ThemeInfo/service_name.asc,ThemeInfo/stack_name.asc,ThemeInfo/stack_version.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all themes for a stack service
                array[ThemeResponse] result = apiInstance.stacksServiceGetStackServiceThemes(stackName, stackVersion, serviceName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetStackServiceThemes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$serviceName = serviceName_example; // String | 
$fields = fields_example; // String | Filter returned attributes
$sortBy = sortBy_example; // String | Sort service artifacts (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
$to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->stacksServiceGetStackServiceThemes($stackName, $stackVersion, $serviceName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StacksApi->stacksServiceGetStackServiceThemes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StacksApi;

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $serviceName = serviceName_example; # String | 
my $fields = fields_example; # String | Filter returned attributes
my $sortBy = sortBy_example; # String | Sort service artifacts (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive).  "start" is also accepted.
my $to = to_example; # String | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->stacksServiceGetStackServiceThemes(stackName => $stackName, stackVersion => $stackVersion, serviceName => $serviceName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetStackServiceThemes: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
serviceName = serviceName_example # String | 
fields = fields_example # String | Filter returned attributes (optional) (default to ThemeInfo/file_name,ThemeInfo/service_name,ThemeInfo/stack_name,ThemeInfo/stack_version)
sortBy = sortBy_example # String | Sort service artifacts (asc | desc) (optional) (default to ThemeInfo/file_name.asc,ThemeInfo/service_name.asc,ThemeInfo/stack_name.asc,ThemeInfo/stack_version.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all themes for a stack service
    api_response = api_instance.stacksServiceGetStackServiceThemes(stackName, stackVersion, serviceName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetStackServiceThemes: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
serviceName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetStackServices

Get all services for a stack version

Returns all services for a stack version.


/stacks/{stackName}/versions/{stackVersion}/services

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}/services?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        String sortBy = sortBy_example; // String | Sort stack services (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[StackServiceResponseSwagger] result = apiInstance.stacksServiceGetStackServices(stackName, stackVersion, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackServices");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String fields = fields_example; // String | Filter returned attributes
        String sortBy = sortBy_example; // String | Sort stack services (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[StackServiceResponseSwagger] result = apiInstance.stacksServiceGetStackServices(stackName, stackVersion, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackServices");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *fields = fields_example; // Filter returned attributes (optional) (default to StackServices/stack_name,StackServices/stack_version,StackServices/service_name)
String *sortBy = sortBy_example; // Sort stack services (asc | desc) (optional) (default to StackServices/stack_name.asc,StackServices/stack_version.asc,StackServices/service_name.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all services for a stack version
[apiInstance stacksServiceGetStackServicesWith:stackName
    stackVersion:stackVersion
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[StackServiceResponseSwagger] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var opts = { 
  'fields': fields_example, // {String} Filter returned attributes
  'sortBy': sortBy_example, // {String} Sort stack services (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive).  "start" is also accepted.
  'to': to_example // {String} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class stacksServiceGetStackServicesExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var fields = fields_example;  // String | Filter returned attributes (optional)  (default to StackServices/stack_name,StackServices/stack_version,StackServices/service_name)
            var sortBy = sortBy_example;  // String | Sort stack services (asc | desc) (optional)  (default to StackServices/stack_name.asc,StackServices/stack_version.asc,StackServices/service_name.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all services for a stack version
                array[StackServiceResponseSwagger] result = apiInstance.stacksServiceGetStackServices(stackName, stackVersion, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetStackServices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$fields = fields_example; // String | Filter returned attributes
$sortBy = sortBy_example; // String | Sort stack services (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
$to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->stacksServiceGetStackServices($stackName, $stackVersion, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StacksApi->stacksServiceGetStackServices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StacksApi;

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $fields = fields_example; # String | Filter returned attributes
my $sortBy = sortBy_example; # String | Sort stack services (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive).  "start" is also accepted.
my $to = to_example; # String | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->stacksServiceGetStackServices(stackName => $stackName, stackVersion => $stackVersion, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetStackServices: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
fields = fields_example # String | Filter returned attributes (optional) (default to StackServices/stack_name,StackServices/stack_version,StackServices/service_name)
sortBy = sortBy_example # String | Sort stack services (asc | desc) (optional) (default to StackServices/stack_name.asc,StackServices/stack_version.asc,StackServices/service_name.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all services for a stack version
    api_response = api_instance.stacksServiceGetStackServices(stackName, stackVersion, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetStackServices: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetStackVersion

Get details for a stack version

Returns the details for a stack version.


/stacks/{stackName}/versions/{stackVersion}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions/{stackVersion}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String fields = fields_example; // String | Filter stack version details
        try {
            StackVersionResponseSwagger result = apiInstance.stacksServiceGetStackVersion(stackName, stackVersion, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String stackVersion = stackVersion_example; // String | 
        String fields = fields_example; // String | Filter stack version details
        try {
            StackVersionResponseSwagger result = apiInstance.stacksServiceGetStackVersion(stackName, stackVersion, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackVersion");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *stackVersion = stackVersion_example; // 
String *fields = fields_example; // Filter stack version details (optional) (default to Versions/*)

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

// Get details for a stack version
[apiInstance stacksServiceGetStackVersionWith:stackName
    stackVersion:stackVersion
    fields:fields
              completionHandler: ^(StackVersionResponseSwagger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var stackVersion = stackVersion_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter stack version details
};

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

namespace Example
{
    public class stacksServiceGetStackVersionExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var stackVersion = stackVersion_example;  // String | 
            var fields = fields_example;  // String | Filter stack version details (optional)  (default to Versions/*)

            try
            {
                // Get details for a stack version
                StackVersionResponseSwagger result = apiInstance.stacksServiceGetStackVersion(stackName, stackVersion, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetStackVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$stackVersion = stackVersion_example; // String | 
$fields = fields_example; // String | Filter stack version details

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

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $stackVersion = stackVersion_example; # String | 
my $fields = fields_example; # String | Filter stack version details

eval { 
    my $result = $api_instance->stacksServiceGetStackVersion(stackName => $stackName, stackVersion => $stackVersion, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetStackVersion: $@\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.StacksApi()
stackName = stackName_example # String | 
stackVersion = stackVersion_example # String | 
fields = fields_example # String | Filter stack version details (optional) (default to Versions/*)

try: 
    # Get details for a stack version
    api_response = api_instance.stacksServiceGetStackVersion(stackName, stackVersion, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetStackVersion: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
stackVersion*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error



stacksServiceGetStackVersions

Get all versions for a stacks

Returns all versions for a stack.


/stacks/{stackName}/versions

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks/{stackName}/versions?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String fields = fields_example; // String | Filter stack version details
        String sortBy = sortBy_example; // String | Sort stack privileges (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[StackVersionResponseSwagger] result = apiInstance.stacksServiceGetStackVersions(stackName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackVersions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String stackName = stackName_example; // String | 
        String fields = fields_example; // String | Filter stack version details
        String sortBy = sortBy_example; // String | Sort stack privileges (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[StackVersionResponseSwagger] result = apiInstance.stacksServiceGetStackVersions(stackName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStackVersions");
            e.printStackTrace();
        }
    }
}
String *stackName = stackName_example; // 
String *fields = fields_example; // Filter stack version details (optional) (default to Versions/stack_name,Versions/stack_version)
String *sortBy = sortBy_example; // Sort stack privileges (asc | desc) (optional) (default to Versions/stack_name.asc,Versions/stack_version.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all versions for a stacks
[apiInstance stacksServiceGetStackVersionsWith:stackName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[StackVersionResponseSwagger] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var stackName = stackName_example; // {String} 

var opts = { 
  'fields': fields_example, // {String} Filter stack version details
  'sortBy': sortBy_example, // {String} Sort stack privileges (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive).  "start" is also accepted.
  'to': to_example // {String} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class stacksServiceGetStackVersionsExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var stackName = stackName_example;  // String | 
            var fields = fields_example;  // String | Filter stack version details (optional)  (default to Versions/stack_name,Versions/stack_version)
            var sortBy = sortBy_example;  // String | Sort stack privileges (asc | desc) (optional)  (default to Versions/stack_name.asc,Versions/stack_version.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all versions for a stacks
                array[StackVersionResponseSwagger] result = apiInstance.stacksServiceGetStackVersions(stackName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetStackVersions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$stackName = stackName_example; // String | 
$fields = fields_example; // String | Filter stack version details
$sortBy = sortBy_example; // String | Sort stack privileges (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
$to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->stacksServiceGetStackVersions($stackName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StacksApi->stacksServiceGetStackVersions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StacksApi;

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $stackName = stackName_example; # String | 
my $fields = fields_example; # String | Filter stack version details
my $sortBy = sortBy_example; # String | Sort stack privileges (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive).  "start" is also accepted.
my $to = to_example; # String | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->stacksServiceGetStackVersions(stackName => $stackName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetStackVersions: $@\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.StacksApi()
stackName = stackName_example # String | 
fields = fields_example # String | Filter stack version details (optional) (default to Versions/stack_name,Versions/stack_version)
sortBy = sortBy_example # String | Sort stack privileges (asc | desc) (optional) (default to Versions/stack_name.asc,Versions/stack_version.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all versions for a stacks
    api_response = api_instance.stacksServiceGetStackVersions(stackName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetStackVersions: %s\n" % e)

Parameters

Path parameters
Name Description
stackName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


stacksServiceGetStacks

Get all stacks

Returns all stacks.


/stacks

Usage and SDK Samples

curl -X get "https://localhost/api/v1/stacks?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StacksApi;

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

public class StacksApiExample {

    public static void main(String[] args) {
        
        StacksApi apiInstance = new StacksApi();
        String fields = fields_example; // String | Filter stack details
        String sortBy = sortBy_example; // String | Sort stack privileges (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[StackResponseSwagger] result = apiInstance.stacksServiceGetStacks(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStacks");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StacksApi;

public class StacksApiExample {

    public static void main(String[] args) {
        StacksApi apiInstance = new StacksApi();
        String fields = fields_example; // String | Filter stack details
        String sortBy = sortBy_example; // String | Sort stack privileges (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
        String to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[StackResponseSwagger] result = apiInstance.stacksServiceGetStacks(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StacksApi#stacksServiceGetStacks");
            e.printStackTrace();
        }
    }
}
String *fields = fields_example; // Filter stack details (optional) (default to Stacks/stack_name)
String *sortBy = sortBy_example; // Sort stack privileges (asc | desc) (optional) (default to Stacks/stack_name.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all stacks
[apiInstance stacksServiceGetStacksWith:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[StackResponseSwagger] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.StacksApi()

var opts = { 
  'fields': fields_example, // {String} Filter stack details
  'sortBy': sortBy_example, // {String} Sort stack privileges (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive).  "start" is also accepted.
  'to': to_example // {String} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class stacksServiceGetStacksExample
    {
        public void main()
        {
            
            var apiInstance = new StacksApi();
            var fields = fields_example;  // String | Filter stack details (optional)  (default to Stacks/stack_name)
            var sortBy = sortBy_example;  // String | Sort stack privileges (asc | desc) (optional)  (default to Stacks/stack_name.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all stacks
                array[StackResponseSwagger] result = apiInstance.stacksServiceGetStacks(fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StacksApi.stacksServiceGetStacks: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\StacksApi();
$fields = fields_example; // String | Filter stack details
$sortBy = sortBy_example; // String | Sort stack privileges (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive).  "start" is also accepted.
$to = to_example; // String | The ending page resource (inclusive).  "end" is also accepted.

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

my $api_instance = WWW::SwaggerClient::StacksApi->new();
my $fields = fields_example; # String | Filter stack details
my $sortBy = sortBy_example; # String | Sort stack privileges (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive).  "start" is also accepted.
my $to = to_example; # String | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->stacksServiceGetStacks(fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StacksApi->stacksServiceGetStacks: $@\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.StacksApi()
fields = fields_example # String | Filter stack details (optional) (default to Stacks/stack_name)
sortBy = sortBy_example # String | Sort stack privileges (asc | desc) (optional) (default to Stacks/stack_name.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all stacks
    api_response = api_instance.stacksServiceGetStacks(fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stacksServiceGetStacks: %s\n" % e)

Parameters

Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 500 - Internal server error


UserAuthenticationSources

createAuthenticationSources

Create one or more new authentication sources for a user


/users/{userName}/sources

Usage and SDK Samples

curl -X post "https://localhost/api/v1/users/{userName}/sources"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserAuthenticationSourcesApi;

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

public class UserAuthenticationSourcesApiExample {

    public static void main(String[] args) {
        
        UserAuthenticationSourcesApi apiInstance = new UserAuthenticationSourcesApi();
        String userName = userName_example; // String | user name
        UserAuthenticationSourceRequestCreateSwagger body = ; // UserAuthenticationSourceRequestCreateSwagger | 
        try {
            apiInstance.createAuthenticationSources(userName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAuthenticationSourcesApi#createAuthenticationSources");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserAuthenticationSourcesApi;

public class UserAuthenticationSourcesApiExample {

    public static void main(String[] args) {
        UserAuthenticationSourcesApi apiInstance = new UserAuthenticationSourcesApi();
        String userName = userName_example; // String | user name
        UserAuthenticationSourceRequestCreateSwagger body = ; // UserAuthenticationSourceRequestCreateSwagger | 
        try {
            apiInstance.createAuthenticationSources(userName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAuthenticationSourcesApi#createAuthenticationSources");
            e.printStackTrace();
        }
    }
}
String *userName = userName_example; // user name
UserAuthenticationSourceRequestCreateSwagger *body = ; //  (optional)

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

// Create one or more new authentication sources for a user
[apiInstance createAuthenticationSourcesWith:userName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.UserAuthenticationSourcesApi()

var userName = userName_example; // {String} user name

var opts = { 
  'body':  // {UserAuthenticationSourceRequestCreateSwagger} 
};

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

namespace Example
{
    public class createAuthenticationSourcesExample
    {
        public void main()
        {
            
            var apiInstance = new UserAuthenticationSourcesApi();
            var userName = userName_example;  // String | user name
            var body = new UserAuthenticationSourceRequestCreateSwagger(); // UserAuthenticationSourceRequestCreateSwagger |  (optional) 

            try
            {
                // Create one or more new authentication sources for a user
                apiInstance.createAuthenticationSources(userName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserAuthenticationSourcesApi.createAuthenticationSources: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UserAuthenticationSourcesApi();
$userName = userName_example; // String | user name
$body = ; // UserAuthenticationSourceRequestCreateSwagger | 

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

my $api_instance = WWW::SwaggerClient::UserAuthenticationSourcesApi->new();
my $userName = userName_example; # String | user name
my $body = WWW::SwaggerClient::Object::UserAuthenticationSourceRequestCreateSwagger->new(); # UserAuthenticationSourceRequestCreateSwagger | 

eval { 
    $api_instance->createAuthenticationSources(userName => $userName, body => $body);
};
if ($@) {
    warn "Exception when calling UserAuthenticationSourcesApi->createAuthenticationSources: $@\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.UserAuthenticationSourcesApi()
userName = userName_example # String | user name
body =  # UserAuthenticationSourceRequestCreateSwagger |  (optional)

try: 
    # Create one or more new authentication sources for a user
    api_instance.createAuthenticationSources(userName, body=body)
except ApiException as e:
    print("Exception when calling UserAuthenticationSourcesApi->createAuthenticationSources: %s\n" % e)

Parameters

Path parameters
Name Description
userName*
Body parameters
Name Description
body

Responses

Status: 201 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 409 - The requested resource already exists.

Status: 500 - Internal server error


deleteAuthenticationSource

Deletes an existing authentication source


/users/{userName}/sources/{sourceId}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/users/{userName}/sources/{sourceId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserAuthenticationSourcesApi;

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

public class UserAuthenticationSourcesApiExample {

    public static void main(String[] args) {
        
        UserAuthenticationSourcesApi apiInstance = new UserAuthenticationSourcesApi();
        String userName = userName_example; // String | user name
        String sourceId = sourceId_example; // String | source id
        try {
            apiInstance.deleteAuthenticationSource(userName, sourceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAuthenticationSourcesApi#deleteAuthenticationSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserAuthenticationSourcesApi;

public class UserAuthenticationSourcesApiExample {

    public static void main(String[] args) {
        UserAuthenticationSourcesApi apiInstance = new UserAuthenticationSourcesApi();
        String userName = userName_example; // String | user name
        String sourceId = sourceId_example; // String | source id
        try {
            apiInstance.deleteAuthenticationSource(userName, sourceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAuthenticationSourcesApi#deleteAuthenticationSource");
            e.printStackTrace();
        }
    }
}
String *userName = userName_example; // user name
String *sourceId = sourceId_example; // source id

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

// Deletes an existing authentication source
[apiInstance deleteAuthenticationSourceWith:userName
    sourceId:sourceId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.UserAuthenticationSourcesApi()

var userName = userName_example; // {String} user name

var sourceId = sourceId_example; // {String} source id


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

namespace Example
{
    public class deleteAuthenticationSourceExample
    {
        public void main()
        {
            
            var apiInstance = new UserAuthenticationSourcesApi();
            var userName = userName_example;  // String | user name
            var sourceId = sourceId_example;  // String | source id

            try
            {
                // Deletes an existing authentication source
                apiInstance.deleteAuthenticationSource(userName, sourceId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserAuthenticationSourcesApi.deleteAuthenticationSource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UserAuthenticationSourcesApi();
$userName = userName_example; // String | user name
$sourceId = sourceId_example; // String | source id

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

my $api_instance = WWW::SwaggerClient::UserAuthenticationSourcesApi->new();
my $userName = userName_example; # String | user name
my $sourceId = sourceId_example; # String | source id

eval { 
    $api_instance->deleteAuthenticationSource(userName => $userName, sourceId => $sourceId);
};
if ($@) {
    warn "Exception when calling UserAuthenticationSourcesApi->deleteAuthenticationSource: $@\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.UserAuthenticationSourcesApi()
userName = userName_example # String | user name
sourceId = sourceId_example # String | source id

try: 
    # Deletes an existing authentication source
    api_instance.deleteAuthenticationSource(userName, sourceId)
except ApiException as e:
    print("Exception when calling UserAuthenticationSourcesApi->deleteAuthenticationSource: %s\n" % e)

Parameters

Path parameters
Name Description
userName*
sourceId*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


getAuthenticationSource

Get user authentication source


/users/{userName}/sources/{sourceId}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/users/{userName}/sources/{sourceId}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserAuthenticationSourcesApi;

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

public class UserAuthenticationSourcesApiExample {

    public static void main(String[] args) {
        
        UserAuthenticationSourcesApi apiInstance = new UserAuthenticationSourcesApi();
        String userName = userName_example; // String | user name
        String sourceId = sourceId_example; // String | source id
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            UserAuthenticationSourceResponseSwagger result = apiInstance.getAuthenticationSource(userName, sourceId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAuthenticationSourcesApi#getAuthenticationSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserAuthenticationSourcesApi;

public class UserAuthenticationSourcesApiExample {

    public static void main(String[] args) {
        UserAuthenticationSourcesApi apiInstance = new UserAuthenticationSourcesApi();
        String userName = userName_example; // String | user name
        String sourceId = sourceId_example; // String | source id
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            UserAuthenticationSourceResponseSwagger result = apiInstance.getAuthenticationSource(userName, sourceId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAuthenticationSourcesApi#getAuthenticationSource");
            e.printStackTrace();
        }
    }
}
String *userName = userName_example; // user name
String *sourceId = sourceId_example; // source id
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to AuthenticationSourceInfo/*)

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

// Get user authentication source
[apiInstance getAuthenticationSourceWith:userName
    sourceId:sourceId
    fields:fields
              completionHandler: ^(UserAuthenticationSourceResponseSwagger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.UserAuthenticationSourcesApi()

var userName = userName_example; // {String} user name

var sourceId = sourceId_example; // {String} source id

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getAuthenticationSourceExample
    {
        public void main()
        {
            
            var apiInstance = new UserAuthenticationSourcesApi();
            var userName = userName_example;  // String | user name
            var sourceId = sourceId_example;  // String | source id
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to AuthenticationSourceInfo/*)

            try
            {
                // Get user authentication source
                UserAuthenticationSourceResponseSwagger result = apiInstance.getAuthenticationSource(userName, sourceId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserAuthenticationSourcesApi.getAuthenticationSource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UserAuthenticationSourcesApi();
$userName = userName_example; // String | user name
$sourceId = sourceId_example; // String | source id
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::UserAuthenticationSourcesApi->new();
my $userName = userName_example; # String | user name
my $sourceId = sourceId_example; # String | source id
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getAuthenticationSource(userName => $userName, sourceId => $sourceId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserAuthenticationSourcesApi->getAuthenticationSource: $@\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.UserAuthenticationSourcesApi()
userName = userName_example # String | user name
sourceId = sourceId_example # String | source id
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to AuthenticationSourceInfo/*)

try: 
    # Get user authentication source
    api_response = api_instance.getAuthenticationSource(userName, sourceId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserAuthenticationSourcesApi->getAuthenticationSource: %s\n" % e)

Parameters

Path parameters
Name Description
userName*
sourceId*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


getAuthenticationSources

Get all authentication sources


/users/{userName}/sources

Usage and SDK Samples

curl -X get "https://localhost/api/v1/users/{userName}/sources?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserAuthenticationSourcesApi;

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

public class UserAuthenticationSourcesApiExample {

    public static void main(String[] args) {
        
        UserAuthenticationSourcesApi apiInstance = new UserAuthenticationSourcesApi();
        String userName = userName_example; // String | user name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[UserAuthenticationSourceResponseSwagger] result = apiInstance.getAuthenticationSources(userName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAuthenticationSourcesApi#getAuthenticationSources");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserAuthenticationSourcesApi;

public class UserAuthenticationSourcesApiExample {

    public static void main(String[] args) {
        UserAuthenticationSourcesApi apiInstance = new UserAuthenticationSourcesApi();
        String userName = userName_example; // String | user name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[UserAuthenticationSourceResponseSwagger] result = apiInstance.getAuthenticationSources(userName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAuthenticationSourcesApi#getAuthenticationSources");
            e.printStackTrace();
        }
    }
}
String *userName = userName_example; // user name
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to AuthenticationSourceInfo/source_id,AuthenticationSourceInfo/user_name)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional) (default to AuthenticationSourceInfo/source_id.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
Integer *from = 56; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
Integer *to = 56; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all authentication sources
[apiInstance getAuthenticationSourcesWith:userName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[UserAuthenticationSourceResponseSwagger] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.UserAuthenticationSourcesApi()

var userName = userName_example; // {String} user name

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': 56, // {Integer} The starting page resource (inclusive).  "start" is also accepted.
  'to': 56 // {Integer} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class getAuthenticationSourcesExample
    {
        public void main()
        {
            
            var apiInstance = new UserAuthenticationSourcesApi();
            var userName = userName_example;  // String | user name
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to AuthenticationSourceInfo/source_id,AuthenticationSourceInfo/user_name)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional)  (default to AuthenticationSourceInfo/source_id.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = 56;  // Integer | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = 56;  // Integer | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all authentication sources
                array[UserAuthenticationSourceResponseSwagger] result = apiInstance.getAuthenticationSources(userName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserAuthenticationSourcesApi.getAuthenticationSources: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UserAuthenticationSourcesApi();
$userName = userName_example; // String | user name
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
$to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->getAuthenticationSources($userName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserAuthenticationSourcesApi->getAuthenticationSources: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserAuthenticationSourcesApi;

my $api_instance = WWW::SwaggerClient::UserAuthenticationSourcesApi->new();
my $userName = userName_example; # String | user name
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = 56; # Integer | The starting page resource (inclusive).  "start" is also accepted.
my $to = 56; # Integer | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->getAuthenticationSources(userName => $userName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserAuthenticationSourcesApi->getAuthenticationSources: $@\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.UserAuthenticationSourcesApi()
userName = userName_example # String | user name
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to AuthenticationSourceInfo/source_id,AuthenticationSourceInfo/user_name)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional) (default to AuthenticationSourceInfo/source_id.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = 56 # Integer | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = 56 # Integer | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all authentication sources
    api_response = api_instance.getAuthenticationSources(userName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserAuthenticationSourcesApi->getAuthenticationSources: %s\n" % e)

Parameters

Path parameters
Name Description
userName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


updateAuthenticationSource

Updates an existing authentication source


/users/{userName}/sources/{sourceId}

Usage and SDK Samples

curl -X put "https://localhost/api/v1/users/{userName}/sources/{sourceId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserAuthenticationSourcesApi;

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

public class UserAuthenticationSourcesApiExample {

    public static void main(String[] args) {
        
        UserAuthenticationSourcesApi apiInstance = new UserAuthenticationSourcesApi();
        String userName = userName_example; // String | user name
        String sourceId = sourceId_example; // String | source id
        UserAuthenticationSourceRequestUpdateSwagger body = ; // UserAuthenticationSourceRequestUpdateSwagger | 
        try {
            apiInstance.updateAuthenticationSource(userName, sourceId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAuthenticationSourcesApi#updateAuthenticationSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserAuthenticationSourcesApi;

public class UserAuthenticationSourcesApiExample {

    public static void main(String[] args) {
        UserAuthenticationSourcesApi apiInstance = new UserAuthenticationSourcesApi();
        String userName = userName_example; // String | user name
        String sourceId = sourceId_example; // String | source id
        UserAuthenticationSourceRequestUpdateSwagger body = ; // UserAuthenticationSourceRequestUpdateSwagger | 
        try {
            apiInstance.updateAuthenticationSource(userName, sourceId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAuthenticationSourcesApi#updateAuthenticationSource");
            e.printStackTrace();
        }
    }
}
String *userName = userName_example; // user name
String *sourceId = sourceId_example; // source id
UserAuthenticationSourceRequestUpdateSwagger *body = ; //  (optional)

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

// Updates an existing authentication source
[apiInstance updateAuthenticationSourceWith:userName
    sourceId:sourceId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.UserAuthenticationSourcesApi()

var userName = userName_example; // {String} user name

var sourceId = sourceId_example; // {String} source id

var opts = { 
  'body':  // {UserAuthenticationSourceRequestUpdateSwagger} 
};

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

namespace Example
{
    public class updateAuthenticationSourceExample
    {
        public void main()
        {
            
            var apiInstance = new UserAuthenticationSourcesApi();
            var userName = userName_example;  // String | user name
            var sourceId = sourceId_example;  // String | source id
            var body = new UserAuthenticationSourceRequestUpdateSwagger(); // UserAuthenticationSourceRequestUpdateSwagger |  (optional) 

            try
            {
                // Updates an existing authentication source
                apiInstance.updateAuthenticationSource(userName, sourceId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserAuthenticationSourcesApi.updateAuthenticationSource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UserAuthenticationSourcesApi();
$userName = userName_example; // String | user name
$sourceId = sourceId_example; // String | source id
$body = ; // UserAuthenticationSourceRequestUpdateSwagger | 

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

my $api_instance = WWW::SwaggerClient::UserAuthenticationSourcesApi->new();
my $userName = userName_example; # String | user name
my $sourceId = sourceId_example; # String | source id
my $body = WWW::SwaggerClient::Object::UserAuthenticationSourceRequestUpdateSwagger->new(); # UserAuthenticationSourceRequestUpdateSwagger | 

eval { 
    $api_instance->updateAuthenticationSource(userName => $userName, sourceId => $sourceId, body => $body);
};
if ($@) {
    warn "Exception when calling UserAuthenticationSourcesApi->updateAuthenticationSource: $@\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.UserAuthenticationSourcesApi()
userName = userName_example # String | user name
sourceId = sourceId_example # String | source id
body =  # UserAuthenticationSourceRequestUpdateSwagger |  (optional)

try: 
    # Updates an existing authentication source
    api_instance.updateAuthenticationSource(userName, sourceId, body=body)
except ApiException as e:
    print("Exception when calling UserAuthenticationSourcesApi->updateAuthenticationSource: %s\n" % e)

Parameters

Path parameters
Name Description
userName*
sourceId*
Body parameters
Name Description
body

Responses

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 409 - The requested resource already exists.

Status: 500 - Internal server error


Users

activeWidgetLayoutServiceGetServices

Get user widget layouts

Returns all active widget layouts for user.


/users/{userName}/activeWidgetLayouts

Usage and SDK Samples

curl -X get "https://localhost/api/v1/users/{userName}/activeWidgetLayouts?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        String fields = fields_example; // String | Filter user layout details
        String sortBy = sortBy_example; // String | Sort layouts (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive). Valid values are :offset | "start"
        String to = to_example; // String | The ending page resource (inclusive). Valid values are :offset | "end"
        try {
            array[ActiveWidgetLayoutResponse] result = apiInstance.activeWidgetLayoutServiceGetServices(userName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#activeWidgetLayoutServiceGetServices");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        String fields = fields_example; // String | Filter user layout details
        String sortBy = sortBy_example; // String | Sort layouts (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive). Valid values are :offset | "start"
        String to = to_example; // String | The ending page resource (inclusive). Valid values are :offset | "end"
        try {
            array[ActiveWidgetLayoutResponse] result = apiInstance.activeWidgetLayoutServiceGetServices(userName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#activeWidgetLayoutServiceGetServices");
            e.printStackTrace();
        }
    }
}
String *userName = userName_example; // user name
String *fields = fields_example; // Filter user layout details (optional) (default to WidgetLayoutInfo/*)
String *sortBy = sortBy_example; // Sort layouts (asc | desc) (optional) (default to WidgetLayoutInfo/user_name.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive). Valid values are :offset | "start" (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive). Valid values are :offset | "end" (optional)

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

// Get user widget layouts
[apiInstance activeWidgetLayoutServiceGetServicesWith:userName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[ActiveWidgetLayoutResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.UsersApi()

var userName = userName_example; // {String} user name

var opts = { 
  'fields': fields_example, // {String} Filter user layout details
  'sortBy': sortBy_example, // {String} Sort layouts (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive). Valid values are :offset | "start"
  'to': to_example // {String} The ending page resource (inclusive). Valid values are :offset | "end"
};

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

namespace Example
{
    public class activeWidgetLayoutServiceGetServicesExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userName = userName_example;  // String | user name
            var fields = fields_example;  // String | Filter user layout details (optional)  (default to WidgetLayoutInfo/*)
            var sortBy = sortBy_example;  // String | Sort layouts (asc | desc) (optional)  (default to WidgetLayoutInfo/user_name.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive). Valid values are :offset | "start" (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive). Valid values are :offset | "end" (optional) 

            try
            {
                // Get user widget layouts
                array[ActiveWidgetLayoutResponse] result = apiInstance.activeWidgetLayoutServiceGetServices(userName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.activeWidgetLayoutServiceGetServices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userName = userName_example; // String | user name
$fields = fields_example; // String | Filter user layout details
$sortBy = sortBy_example; // String | Sort layouts (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive). Valid values are :offset | "start"
$to = to_example; // String | The ending page resource (inclusive). Valid values are :offset | "end"

try {
    $result = $api_instance->activeWidgetLayoutServiceGetServices($userName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->activeWidgetLayoutServiceGetServices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userName = userName_example; # String | user name
my $fields = fields_example; # String | Filter user layout details
my $sortBy = sortBy_example; # String | Sort layouts (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive). Valid values are :offset | "start"
my $to = to_example; # String | The ending page resource (inclusive). Valid values are :offset | "end"

eval { 
    my $result = $api_instance->activeWidgetLayoutServiceGetServices(userName => $userName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->activeWidgetLayoutServiceGetServices: $@\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.UsersApi()
userName = userName_example # String | user name
fields = fields_example # String | Filter user layout details (optional) (default to WidgetLayoutInfo/*)
sortBy = sortBy_example # String | Sort layouts (asc | desc) (optional) (default to WidgetLayoutInfo/user_name.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive). Valid values are :offset | "start" (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive). Valid values are :offset | "end" (optional)

try: 
    # Get user widget layouts
    api_response = api_instance.activeWidgetLayoutServiceGetServices(userName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->activeWidgetLayoutServiceGetServices: %s\n" % e)

Parameters

Path parameters
Name Description
userName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - successful operation


activeWidgetLayoutServiceUpdateServices

Update user widget layouts

Updates user widget layout.


/users/{userName}/activeWidgetLayouts

Usage and SDK Samples

curl -X put "https://localhost/api/v1/users/{userName}/activeWidgetLayouts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        ActiveWidgetLayoutRequest body = ; // ActiveWidgetLayoutRequest | input parameters in json form
        try {
            apiInstance.activeWidgetLayoutServiceUpdateServices(userName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#activeWidgetLayoutServiceUpdateServices");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        ActiveWidgetLayoutRequest body = ; // ActiveWidgetLayoutRequest | input parameters in json form
        try {
            apiInstance.activeWidgetLayoutServiceUpdateServices(userName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#activeWidgetLayoutServiceUpdateServices");
            e.printStackTrace();
        }
    }
}
String *userName = userName_example; // user name
ActiveWidgetLayoutRequest *body = ; // input parameters in json form

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

// Update user widget layouts
[apiInstance activeWidgetLayoutServiceUpdateServicesWith:userName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.UsersApi()

var userName = userName_example; // {String} user name

var body = ; // {ActiveWidgetLayoutRequest} input parameters in json form


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

namespace Example
{
    public class activeWidgetLayoutServiceUpdateServicesExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userName = userName_example;  // String | user name
            var body = new ActiveWidgetLayoutRequest(); // ActiveWidgetLayoutRequest | input parameters in json form

            try
            {
                // Update user widget layouts
                apiInstance.activeWidgetLayoutServiceUpdateServices(userName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.activeWidgetLayoutServiceUpdateServices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userName = userName_example; // String | user name
$body = ; // ActiveWidgetLayoutRequest | input parameters in json form

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userName = userName_example; # String | user name
my $body = WWW::SwaggerClient::Object::ActiveWidgetLayoutRequest->new(); # ActiveWidgetLayoutRequest | input parameters in json form

eval { 
    $api_instance->activeWidgetLayoutServiceUpdateServices(userName => $userName, body => $body);
};
if ($@) {
    warn "Exception when calling UsersApi->activeWidgetLayoutServiceUpdateServices: $@\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.UsersApi()
userName = userName_example # String | user name
body =  # ActiveWidgetLayoutRequest | input parameters in json form

try: 
    # Update user widget layouts
    api_instance.activeWidgetLayoutServiceUpdateServices(userName, body)
except ApiException as e:
    print("Exception when calling UsersApi->activeWidgetLayoutServiceUpdateServices: %s\n" % e)

Parameters

Path parameters
Name Description
userName*
Body parameters
Name Description
body *

Responses

Status: 200 - Successful operation

Status: 500 - Server Error


createUser

Create new user


/users/{userName}

Usage and SDK Samples

curl -X post "https://localhost/api/v1/users/{userName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        UserRequestCreateUserSwagger body = ; // UserRequestCreateUserSwagger | 
        try {
            apiInstance.createUser(userName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#createUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        UserRequestCreateUserSwagger body = ; // UserRequestCreateUserSwagger | 
        try {
            apiInstance.createUser(userName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#createUser");
            e.printStackTrace();
        }
    }
}
String *userName = userName_example; // user name
UserRequestCreateUserSwagger *body = ; //  (optional)

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

// Create new user
[apiInstance createUserWith:userName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.UsersApi()

var userName = userName_example; // {String} user name

var opts = { 
  'body':  // {UserRequestCreateUserSwagger} 
};

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

namespace Example
{
    public class createUserExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userName = userName_example;  // String | user name
            var body = new UserRequestCreateUserSwagger(); // UserRequestCreateUserSwagger |  (optional) 

            try
            {
                // Create new user
                apiInstance.createUser(userName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.createUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userName = userName_example; // String | user name
$body = ; // UserRequestCreateUserSwagger | 

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userName = userName_example; # String | user name
my $body = WWW::SwaggerClient::Object::UserRequestCreateUserSwagger->new(); # UserRequestCreateUserSwagger | 

eval { 
    $api_instance->createUser(userName => $userName, body => $body);
};
if ($@) {
    warn "Exception when calling UsersApi->createUser: $@\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.UsersApi()
userName = userName_example # String | user name
body =  # UserRequestCreateUserSwagger |  (optional)

try: 
    # Create new user
    api_instance.createUser(userName, body=body)
except ApiException as e:
    print("Exception when calling UsersApi->createUser: %s\n" % e)

Parameters

Path parameters
Name Description
userName*
Body parameters
Name Description
body

Responses

Status: 201 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 409 - The requested resource already exists.

Status: 500 - Internal server error


createUsers

Creates one or more users in a single request


/users

Usage and SDK Samples

curl -X post "https://localhost/api/v1/users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

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

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        UserRequestCreateUsersSwagger body = ; // UserRequestCreateUsersSwagger | 
        try {
            apiInstance.createUsers(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#createUsers");
            e.printStackTrace();
        }
    }
}
UserRequestCreateUsersSwagger *body = ; //  (optional)

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

// Creates one or more users in a single request
[apiInstance createUsersWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.UsersApi()

var opts = { 
  'body':  // {UserRequestCreateUsersSwagger} 
};

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

namespace Example
{
    public class createUsersExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var body = new UserRequestCreateUsersSwagger(); // UserRequestCreateUsersSwagger |  (optional) 

            try
            {
                // Creates one or more users in a single request
                apiInstance.createUsers(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.createUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$body = ; // UserRequestCreateUsersSwagger | 

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

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

eval { 
    $api_instance->createUsers(body => $body);
};
if ($@) {
    warn "Exception when calling UsersApi->createUsers: $@\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.UsersApi()
body =  # UserRequestCreateUsersSwagger |  (optional)

try: 
    # Creates one or more users in a single request
    api_instance.createUsers(body=body)
except ApiException as e:
    print("Exception when calling UsersApi->createUsers: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 409 - The requested resource already exists.

Status: 500 - Internal server error


deleteUser

Delete single user


/users/{userName}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/users/{userName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        try {
            apiInstance.deleteUser(userName);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#deleteUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        try {
            apiInstance.deleteUser(userName);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#deleteUser");
            e.printStackTrace();
        }
    }
}
String *userName = userName_example; // user name

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

// Delete single user
[apiInstance deleteUserWith:userName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.UsersApi()

var userName = userName_example; // {String} user name


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

namespace Example
{
    public class deleteUserExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userName = userName_example;  // String | user name

            try
            {
                // Delete single user
                apiInstance.deleteUser(userName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.deleteUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userName = userName_example; // String | user name

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userName = userName_example; # String | user name

eval { 
    $api_instance->deleteUser(userName => $userName);
};
if ($@) {
    warn "Exception when calling UsersApi->deleteUser: $@\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.UsersApi()
userName = userName_example # String | user name

try: 
    # Delete single user
    api_instance.deleteUser(userName)
except ApiException as e:
    print("Exception when calling UsersApi->deleteUser: %s\n" % e)

Parameters

Path parameters
Name Description
userName*

Responses

Status: 200 - Successful operation

Status: 500 - Server Error


getUser

Get single user


/users/{userName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/users/{userName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            UserResponseSwagger result = apiInstance.getUser(userName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            UserResponseSwagger result = apiInstance.getUser(userName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUser");
            e.printStackTrace();
        }
    }
}
String *userName = userName_example; // user name
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Users/*)

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

// Get single user
[apiInstance getUserWith:userName
    fields:fields
              completionHandler: ^(UserResponseSwagger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.UsersApi()

var userName = userName_example; // {String} user name

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getUserExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userName = userName_example;  // String | user name
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Users/*)

            try
            {
                // Get single user
                UserResponseSwagger result = apiInstance.getUser(userName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.getUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userName = userName_example; // String | user name
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userName = userName_example; # String | user name
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getUser(userName => $userName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->getUser: $@\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.UsersApi()
userName = userName_example # String | user name
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Users/*)

try: 
    # Get single user
    api_response = api_instance.getUser(userName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getUser: %s\n" % e)

Parameters

Path parameters
Name Description
userName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


getUsers

Get all users


/users

Usage and SDK Samples

curl -X get "https://localhost/api/v1/users?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[UserResponseSwagger] result = apiInstance.getUsers(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[UserResponseSwagger] result = apiInstance.getUsers(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUsers");
            e.printStackTrace();
        }
    }
}
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Users/user_name)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional) (default to Users/user_name.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
Integer *from = 56; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
Integer *to = 56; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all users
[apiInstance getUsersWith:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[UserResponseSwagger] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.UsersApi()

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': 56, // {Integer} The starting page resource (inclusive).  "start" is also accepted.
  'to': 56 // {Integer} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class getUsersExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Users/user_name)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional)  (default to Users/user_name.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = 56;  // Integer | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = 56;  // Integer | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all users
                array[UserResponseSwagger] result = apiInstance.getUsers(fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.getUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
$to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = 56; # Integer | The starting page resource (inclusive).  "start" is also accepted.
my $to = 56; # Integer | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->getUsers(fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->getUsers: $@\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.UsersApi()
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Users/user_name)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional) (default to Users/user_name.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = 56 # Integer | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = 56 # Integer | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all users
    api_response = api_instance.getUsers(fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getUsers: %s\n" % e)

Parameters

Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 500 - Internal server error


updateUser

Update user details


/users/{userName}

Usage and SDK Samples

curl -X put "https://localhost/api/v1/users/{userName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        UserRequestUpdateUserSwagger body = ; // UserRequestUpdateUserSwagger | 
        try {
            apiInstance.updateUser(userName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        UserRequestUpdateUserSwagger body = ; // UserRequestUpdateUserSwagger | 
        try {
            apiInstance.updateUser(userName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateUser");
            e.printStackTrace();
        }
    }
}
String *userName = userName_example; // user name
UserRequestUpdateUserSwagger *body = ; //  (optional)

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

// Update user details
[apiInstance updateUserWith:userName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.UsersApi()

var userName = userName_example; // {String} user name

var opts = { 
  'body':  // {UserRequestUpdateUserSwagger} 
};

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

namespace Example
{
    public class updateUserExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userName = userName_example;  // String | user name
            var body = new UserRequestUpdateUserSwagger(); // UserRequestUpdateUserSwagger |  (optional) 

            try
            {
                // Update user details
                apiInstance.updateUser(userName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.updateUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userName = userName_example; // String | user name
$body = ; // UserRequestUpdateUserSwagger | 

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userName = userName_example; # String | user name
my $body = WWW::SwaggerClient::Object::UserRequestUpdateUserSwagger->new(); # UserRequestUpdateUserSwagger | 

eval { 
    $api_instance->updateUser(userName => $userName, body => $body);
};
if ($@) {
    warn "Exception when calling UsersApi->updateUser: $@\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.UsersApi()
userName = userName_example # String | user name
body =  # UserRequestUpdateUserSwagger |  (optional)

try: 
    # Update user details
    api_instance.updateUser(userName, body=body)
except ApiException as e:
    print("Exception when calling UsersApi->updateUser: %s\n" % e)

Parameters

Path parameters
Name Description
userName*
Body parameters
Name Description
body

Responses

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - The requested resource doesn't exist.

Status: 409 - The requested resource already exists.

Status: 500 - Internal server error


userAuthorizationServiceGetAuthorization

Get user authorization

Returns user authorization details.


/users/{userName}/authorizations/{authorization_id}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/users/{userName}/authorizations/{authorization_id}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        String authorizationId = authorizationId_example; // String | Authorization Id
        String fields = fields_example; // String | Filter user authorization details
        try {
            UserAuthorizationResponse result = apiInstance.userAuthorizationServiceGetAuthorization(userName, authorizationId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#userAuthorizationServiceGetAuthorization");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        String authorizationId = authorizationId_example; // String | Authorization Id
        String fields = fields_example; // String | Filter user authorization details
        try {
            UserAuthorizationResponse result = apiInstance.userAuthorizationServiceGetAuthorization(userName, authorizationId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#userAuthorizationServiceGetAuthorization");
            e.printStackTrace();
        }
    }
}
String *userName = userName_example; // user name
String *authorizationId = authorizationId_example; // Authorization Id
String *fields = fields_example; // Filter user authorization details (optional) (default to AuthorizationInfo/*)

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

// Get user authorization
[apiInstance userAuthorizationServiceGetAuthorizationWith:userName
    authorizationId:authorizationId
    fields:fields
              completionHandler: ^(UserAuthorizationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.UsersApi()

var userName = userName_example; // {String} user name

var authorizationId = authorizationId_example; // {String} Authorization Id

var opts = { 
  'fields': fields_example // {String} Filter user authorization details
};

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

namespace Example
{
    public class userAuthorizationServiceGetAuthorizationExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userName = userName_example;  // String | user name
            var authorizationId = authorizationId_example;  // String | Authorization Id
            var fields = fields_example;  // String | Filter user authorization details (optional)  (default to AuthorizationInfo/*)

            try
            {
                // Get user authorization
                UserAuthorizationResponse result = apiInstance.userAuthorizationServiceGetAuthorization(userName, authorizationId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.userAuthorizationServiceGetAuthorization: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userName = userName_example; // String | user name
$authorizationId = authorizationId_example; // String | Authorization Id
$fields = fields_example; // String | Filter user authorization details

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userName = userName_example; # String | user name
my $authorizationId = authorizationId_example; # String | Authorization Id
my $fields = fields_example; # String | Filter user authorization details

eval { 
    my $result = $api_instance->userAuthorizationServiceGetAuthorization(userName => $userName, authorizationId => $authorizationId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->userAuthorizationServiceGetAuthorization: $@\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.UsersApi()
userName = userName_example # String | user name
authorizationId = authorizationId_example # String | Authorization Id
fields = fields_example # String | Filter user authorization details (optional) (default to AuthorizationInfo/*)

try: 
    # Get user authorization
    api_response = api_instance.userAuthorizationServiceGetAuthorization(userName, authorizationId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->userAuthorizationServiceGetAuthorization: %s\n" % e)

Parameters

Path parameters
Name Description
userName*
authorization_id*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation


userAuthorizationServiceGetAuthorizations

Get all authorizations

Returns all authorization for user.


/users/{userName}/authorizations

Usage and SDK Samples

curl -X get "https://localhost/api/v1/users/{userName}/authorizations?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        String fields = fields_example; // String | Filter user authorization details
        String sortBy = sortBy_example; // String | Sort user authorizations (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive). Valid values are :offset | "start"
        String to = to_example; // String | The ending page resource (inclusive). Valid values are :offset | "end"
        try {
            array[UserAuthorizationResponse] result = apiInstance.userAuthorizationServiceGetAuthorizations(userName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#userAuthorizationServiceGetAuthorizations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        String fields = fields_example; // String | Filter user authorization details
        String sortBy = sortBy_example; // String | Sort user authorizations (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive). Valid values are :offset | "start"
        String to = to_example; // String | The ending page resource (inclusive). Valid values are :offset | "end"
        try {
            array[UserAuthorizationResponse] result = apiInstance.userAuthorizationServiceGetAuthorizations(userName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#userAuthorizationServiceGetAuthorizations");
            e.printStackTrace();
        }
    }
}
String *userName = userName_example; // user name
String *fields = fields_example; // Filter user authorization details (optional) (default to AuthorizationInfo/*)
String *sortBy = sortBy_example; // Sort user authorizations (asc | desc) (optional) (default to AuthorizationInfo/user_name.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive). Valid values are :offset | "start" (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive). Valid values are :offset | "end" (optional)

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

// Get all authorizations
[apiInstance userAuthorizationServiceGetAuthorizationsWith:userName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[UserAuthorizationResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.UsersApi()

var userName = userName_example; // {String} user name

var opts = { 
  'fields': fields_example, // {String} Filter user authorization details
  'sortBy': sortBy_example, // {String} Sort user authorizations (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive). Valid values are :offset | "start"
  'to': to_example // {String} The ending page resource (inclusive). Valid values are :offset | "end"
};

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

namespace Example
{
    public class userAuthorizationServiceGetAuthorizationsExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userName = userName_example;  // String | user name
            var fields = fields_example;  // String | Filter user authorization details (optional)  (default to AuthorizationInfo/*)
            var sortBy = sortBy_example;  // String | Sort user authorizations (asc | desc) (optional)  (default to AuthorizationInfo/user_name.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive). Valid values are :offset | "start" (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive). Valid values are :offset | "end" (optional) 

            try
            {
                // Get all authorizations
                array[UserAuthorizationResponse] result = apiInstance.userAuthorizationServiceGetAuthorizations(userName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.userAuthorizationServiceGetAuthorizations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userName = userName_example; // String | user name
$fields = fields_example; // String | Filter user authorization details
$sortBy = sortBy_example; // String | Sort user authorizations (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive). Valid values are :offset | "start"
$to = to_example; // String | The ending page resource (inclusive). Valid values are :offset | "end"

try {
    $result = $api_instance->userAuthorizationServiceGetAuthorizations($userName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->userAuthorizationServiceGetAuthorizations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userName = userName_example; # String | user name
my $fields = fields_example; # String | Filter user authorization details
my $sortBy = sortBy_example; # String | Sort user authorizations (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive). Valid values are :offset | "start"
my $to = to_example; # String | The ending page resource (inclusive). Valid values are :offset | "end"

eval { 
    my $result = $api_instance->userAuthorizationServiceGetAuthorizations(userName => $userName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->userAuthorizationServiceGetAuthorizations: $@\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.UsersApi()
userName = userName_example # String | user name
fields = fields_example # String | Filter user authorization details (optional) (default to AuthorizationInfo/*)
sortBy = sortBy_example # String | Sort user authorizations (asc | desc) (optional) (default to AuthorizationInfo/user_name.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive). Valid values are :offset | "start" (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive). Valid values are :offset | "end" (optional)

try: 
    # Get all authorizations
    api_response = api_instance.userAuthorizationServiceGetAuthorizations(userName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->userAuthorizationServiceGetAuthorizations: %s\n" % e)

Parameters

Path parameters
Name Description
userName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - successful operation


userPrivilegeServiceGetPrivilege

Get user privilege

Returns user privilege details.


/users/{userName}/privileges/{privilegeId}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/users/{userName}/privileges/{privilegeId}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        String privilegeId = privilegeId_example; // String | privilege id
        String fields = fields_example; // String | Filter user privilege details
        try {
            UserPrivilegeResponse result = apiInstance.userPrivilegeServiceGetPrivilege(userName, privilegeId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#userPrivilegeServiceGetPrivilege");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        String privilegeId = privilegeId_example; // String | privilege id
        String fields = fields_example; // String | Filter user privilege details
        try {
            UserPrivilegeResponse result = apiInstance.userPrivilegeServiceGetPrivilege(userName, privilegeId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#userPrivilegeServiceGetPrivilege");
            e.printStackTrace();
        }
    }
}
String *userName = userName_example; // user name
String *privilegeId = privilegeId_example; // privilege id
String *fields = fields_example; // Filter user privilege details (optional) (default to PrivilegeInfo/*)

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

// Get user privilege
[apiInstance userPrivilegeServiceGetPrivilegeWith:userName
    privilegeId:privilegeId
    fields:fields
              completionHandler: ^(UserPrivilegeResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.UsersApi()

var userName = userName_example; // {String} user name

var privilegeId = privilegeId_example; // {String} privilege id

var opts = { 
  'fields': fields_example // {String} Filter user privilege details
};

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

namespace Example
{
    public class userPrivilegeServiceGetPrivilegeExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userName = userName_example;  // String | user name
            var privilegeId = privilegeId_example;  // String | privilege id
            var fields = fields_example;  // String | Filter user privilege details (optional)  (default to PrivilegeInfo/*)

            try
            {
                // Get user privilege
                UserPrivilegeResponse result = apiInstance.userPrivilegeServiceGetPrivilege(userName, privilegeId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.userPrivilegeServiceGetPrivilege: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userName = userName_example; // String | user name
$privilegeId = privilegeId_example; // String | privilege id
$fields = fields_example; // String | Filter user privilege details

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userName = userName_example; # String | user name
my $privilegeId = privilegeId_example; # String | privilege id
my $fields = fields_example; # String | Filter user privilege details

eval { 
    my $result = $api_instance->userPrivilegeServiceGetPrivilege(userName => $userName, privilegeId => $privilegeId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->userPrivilegeServiceGetPrivilege: $@\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.UsersApi()
userName = userName_example # String | user name
privilegeId = privilegeId_example # String | privilege id
fields = fields_example # String | Filter user privilege details (optional) (default to PrivilegeInfo/*)

try: 
    # Get user privilege
    api_response = api_instance.userPrivilegeServiceGetPrivilege(userName, privilegeId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->userPrivilegeServiceGetPrivilege: %s\n" % e)

Parameters

Path parameters
Name Description
userName*
privilegeId*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation


userPrivilegeServiceGetPrivileges

Get all privileges

Returns all privileges for user.


/users/{userName}/privileges

Usage and SDK Samples

curl -X get "https://localhost/api/v1/users/{userName}/privileges?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        String fields = fields_example; // String | Filter user privileges
        String sortBy = sortBy_example; // String | Sort user privileges (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive). Valid values are :offset | "start"
        String to = to_example; // String | The ending page resource (inclusive). Valid values are :offset | "end"
        try {
            array[UserPrivilegeResponse] result = apiInstance.userPrivilegeServiceGetPrivileges(userName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#userPrivilegeServiceGetPrivileges");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userName = userName_example; // String | user name
        String fields = fields_example; // String | Filter user privileges
        String sortBy = sortBy_example; // String | Sort user privileges (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        String from = from_example; // String | The starting page resource (inclusive). Valid values are :offset | "start"
        String to = to_example; // String | The ending page resource (inclusive). Valid values are :offset | "end"
        try {
            array[UserPrivilegeResponse] result = apiInstance.userPrivilegeServiceGetPrivileges(userName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#userPrivilegeServiceGetPrivileges");
            e.printStackTrace();
        }
    }
}
String *userName = userName_example; // user name
String *fields = fields_example; // Filter user privileges (optional) (default to PrivilegeInfo/*)
String *sortBy = sortBy_example; // Sort user privileges (asc | desc) (optional) (default to PrivilegeInfo/user_name.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
String *from = from_example; // The starting page resource (inclusive). Valid values are :offset | "start" (optional) (default to 0)
String *to = to_example; // The ending page resource (inclusive). Valid values are :offset | "end" (optional)

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

// Get all privileges
[apiInstance userPrivilegeServiceGetPrivilegesWith:userName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[UserPrivilegeResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.UsersApi()

var userName = userName_example; // {String} user name

var opts = { 
  'fields': fields_example, // {String} Filter user privileges
  'sortBy': sortBy_example, // {String} Sort user privileges (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': from_example, // {String} The starting page resource (inclusive). Valid values are :offset | "start"
  'to': to_example // {String} The ending page resource (inclusive). Valid values are :offset | "end"
};

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

namespace Example
{
    public class userPrivilegeServiceGetPrivilegesExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var userName = userName_example;  // String | user name
            var fields = fields_example;  // String | Filter user privileges (optional)  (default to PrivilegeInfo/*)
            var sortBy = sortBy_example;  // String | Sort user privileges (asc | desc) (optional)  (default to PrivilegeInfo/user_name.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = from_example;  // String | The starting page resource (inclusive). Valid values are :offset | "start" (optional)  (default to 0)
            var to = to_example;  // String | The ending page resource (inclusive). Valid values are :offset | "end" (optional) 

            try
            {
                // Get all privileges
                array[UserPrivilegeResponse] result = apiInstance.userPrivilegeServiceGetPrivileges(userName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.userPrivilegeServiceGetPrivileges: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UsersApi();
$userName = userName_example; // String | user name
$fields = fields_example; // String | Filter user privileges
$sortBy = sortBy_example; // String | Sort user privileges (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = from_example; // String | The starting page resource (inclusive). Valid values are :offset | "start"
$to = to_example; // String | The ending page resource (inclusive). Valid values are :offset | "end"

try {
    $result = $api_instance->userPrivilegeServiceGetPrivileges($userName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->userPrivilegeServiceGetPrivileges: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userName = userName_example; # String | user name
my $fields = fields_example; # String | Filter user privileges
my $sortBy = sortBy_example; # String | Sort user privileges (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = from_example; # String | The starting page resource (inclusive). Valid values are :offset | "start"
my $to = to_example; # String | The ending page resource (inclusive). Valid values are :offset | "end"

eval { 
    my $result = $api_instance->userPrivilegeServiceGetPrivileges(userName => $userName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->userPrivilegeServiceGetPrivileges: $@\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.UsersApi()
userName = userName_example # String | user name
fields = fields_example # String | Filter user privileges (optional) (default to PrivilegeInfo/*)
sortBy = sortBy_example # String | Sort user privileges (asc | desc) (optional) (default to PrivilegeInfo/user_name.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = from_example # String | The starting page resource (inclusive). Valid values are :offset | "start" (optional) (default to 0)
to = to_example # String | The ending page resource (inclusive). Valid values are :offset | "end" (optional)

try: 
    # Get all privileges
    api_response = api_instance.userPrivilegeServiceGetPrivileges(userName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->userPrivilegeServiceGetPrivileges: %s\n" % e)

Parameters

Path parameters
Name Description
userName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - successful operation


Views

createPrivilege

Create view instance privilege


/views/{viewName}/versions/{version}/instances/{instanceName}/privileges

Usage and SDK Samples

curl -X post "https://localhost/api/v1/views/{viewName}/versions/{version}/instances/{instanceName}/privileges"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | view version
        String instanceName = instanceName_example; // String | instance name
        ViewPrivilegeService body = ; // ViewPrivilegeService | 
        try {
            apiInstance.createPrivilege(viewName, version, instanceName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#createPrivilege");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | view version
        String instanceName = instanceName_example; // String | instance name
        ViewPrivilegeService body = ; // ViewPrivilegeService | 
        try {
            apiInstance.createPrivilege(viewName, version, instanceName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#createPrivilege");
            e.printStackTrace();
        }
    }
}
String *viewName = viewName_example; // view name
String *version = version_example; // view version
String *instanceName = instanceName_example; // instance name
ViewPrivilegeService *body = ; //  (optional)

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

// Create view instance privilege
[apiInstance createPrivilegeWith:viewName
    version:version
    instanceName:instanceName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var viewName = viewName_example; // {String} view name

var version = version_example; // {String} view version

var instanceName = instanceName_example; // {String} instance name

var opts = { 
  'body':  // {ViewPrivilegeService} 
};

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

namespace Example
{
    public class createPrivilegeExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var viewName = viewName_example;  // String | view name
            var version = version_example;  // String | view version
            var instanceName = instanceName_example;  // String | instance name
            var body = new ViewPrivilegeService(); // ViewPrivilegeService |  (optional) 

            try
            {
                // Create view instance privilege
                apiInstance.createPrivilege(viewName, version, instanceName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.createPrivilege: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$viewName = viewName_example; // String | view name
$version = version_example; // String | view version
$instanceName = instanceName_example; // String | instance name
$body = ; // ViewPrivilegeService | 

try {
    $api_instance->createPrivilege($viewName, $version, $instanceName, $body);
} catch (Exception $e) {
    echo 'Exception when calling ViewsApi->createPrivilege: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ViewsApi;

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $viewName = viewName_example; # String | view name
my $version = version_example; # String | view version
my $instanceName = instanceName_example; # String | instance name
my $body = WWW::SwaggerClient::Object::ViewPrivilegeService->new(); # ViewPrivilegeService | 

eval { 
    $api_instance->createPrivilege(viewName => $viewName, version => $version, instanceName => $instanceName, body => $body);
};
if ($@) {
    warn "Exception when calling ViewsApi->createPrivilege: $@\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.ViewsApi()
viewName = viewName_example # String | view name
version = version_example # String | view version
instanceName = instanceName_example # String | instance name
body =  # ViewPrivilegeService |  (optional)

try: 
    # Create view instance privilege
    api_instance.createPrivilege(viewName, version, instanceName, body=body)
except ApiException as e:
    print("Exception when calling ViewsApi->createPrivilege: %s\n" % e)

Parameters

Path parameters
Name Description
viewName*
version*
instanceName*
Body parameters
Name Description
body

Responses

Status: 201 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 500 - Internal server error


createService

Create view instance


/views/{viewName}/versions/{version}/instances/{instanceName}

Usage and SDK Samples

curl -X post "https://localhost/api/v1/views/{viewName}/versions/{version}/instances/{instanceName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | 
        String instanceName = instanceName_example; // String | instance name
        ViewInstanceResponse body = ; // ViewInstanceResponse | 
        try {
            apiInstance.createService(viewName, version, instanceName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#createService");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | 
        String instanceName = instanceName_example; // String | instance name
        ViewInstanceResponse body = ; // ViewInstanceResponse | 
        try {
            apiInstance.createService(viewName, version, instanceName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#createService");
            e.printStackTrace();
        }
    }
}
String *viewName = viewName_example; // view name
String *version = version_example; // 
String *instanceName = instanceName_example; // instance name
ViewInstanceResponse *body = ; //  (optional)

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

// Create view instance
[apiInstance createServiceWith:viewName
    version:version
    instanceName:instanceName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var viewName = viewName_example; // {String} view name

var version = version_example; // {String} 

var instanceName = instanceName_example; // {String} instance name

var opts = { 
  'body':  // {ViewInstanceResponse} 
};

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

namespace Example
{
    public class createServiceExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var viewName = viewName_example;  // String | view name
            var version = version_example;  // String | 
            var instanceName = instanceName_example;  // String | instance name
            var body = new ViewInstanceResponse(); // ViewInstanceResponse |  (optional) 

            try
            {
                // Create view instance
                apiInstance.createService(viewName, version, instanceName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.createService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$viewName = viewName_example; // String | view name
$version = version_example; // String | 
$instanceName = instanceName_example; // String | instance name
$body = ; // ViewInstanceResponse | 

try {
    $api_instance->createService($viewName, $version, $instanceName, $body);
} catch (Exception $e) {
    echo 'Exception when calling ViewsApi->createService: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ViewsApi;

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $viewName = viewName_example; # String | view name
my $version = version_example; # String | 
my $instanceName = instanceName_example; # String | instance name
my $body = WWW::SwaggerClient::Object::ViewInstanceResponse->new(); # ViewInstanceResponse | 

eval { 
    $api_instance->createService(viewName => $viewName, version => $version, instanceName => $instanceName, body => $body);
};
if ($@) {
    warn "Exception when calling ViewsApi->createService: $@\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.ViewsApi()
viewName = viewName_example # String | view name
version = version_example # String | 
instanceName = instanceName_example # String | instance name
body =  # ViewInstanceResponse |  (optional)

try: 
    # Create view instance
    api_instance.createService(viewName, version, instanceName, body=body)
except ApiException as e:
    print("Exception when calling ViewsApi->createService: %s\n" % e)

Parameters

Path parameters
Name Description
viewName*
version*
instanceName*
Body parameters
Name Description
body

Responses

Status: 201 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


createServices

Create view instances


/views/{viewName}/versions/{version}/instances

Usage and SDK Samples

curl -X post "https://localhost/api/v1/views/{viewName}/versions/{version}/instances"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | 
        String version = version_example; // String | 
        ViewInstanceResponse body = ; // ViewInstanceResponse | 
        try {
            apiInstance.createServices(viewName, version, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#createServices");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | 
        String version = version_example; // String | 
        ViewInstanceResponse body = ; // ViewInstanceResponse | 
        try {
            apiInstance.createServices(viewName, version, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#createServices");
            e.printStackTrace();
        }
    }
}
String *viewName = viewName_example; // 
String *version = version_example; // 
ViewInstanceResponse *body = ; //  (optional)

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

// Create view instances
[apiInstance createServicesWith:viewName
    version:version
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var viewName = viewName_example; // {String} 

var version = version_example; // {String} 

var opts = { 
  'body':  // {ViewInstanceResponse} 
};

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

namespace Example
{
    public class createServicesExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var viewName = viewName_example;  // String | 
            var version = version_example;  // String | 
            var body = new ViewInstanceResponse(); // ViewInstanceResponse |  (optional) 

            try
            {
                // Create view instances
                apiInstance.createServices(viewName, version, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.createServices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$viewName = viewName_example; // String | 
$version = version_example; // String | 
$body = ; // ViewInstanceResponse | 

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

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $viewName = viewName_example; # String | 
my $version = version_example; # String | 
my $body = WWW::SwaggerClient::Object::ViewInstanceResponse->new(); # ViewInstanceResponse | 

eval { 
    $api_instance->createServices(viewName => $viewName, version => $version, body => $body);
};
if ($@) {
    warn "Exception when calling ViewsApi->createServices: $@\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.ViewsApi()
viewName = viewName_example # String | 
version = version_example # String | 
body =  # ViewInstanceResponse |  (optional)

try: 
    # Create view instances
    api_instance.createServices(viewName, version, body=body)
except ApiException as e:
    print("Exception when calling ViewsApi->createServices: %s\n" % e)

Parameters

Path parameters
Name Description
viewName*
version*
Body parameters
Name Description
body

Responses

Status: 201 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


createUrl

Create view URL


/view/urls/{urlName}

Usage and SDK Samples

curl -X post "https://localhost/api/v1/view/urls/{urlName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String urlName = urlName_example; // String | 
        ViewUrlResponseSwagger body = ; // ViewUrlResponseSwagger | 
        try {
            apiInstance.createUrl(urlName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#createUrl");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String urlName = urlName_example; // String | 
        ViewUrlResponseSwagger body = ; // ViewUrlResponseSwagger | 
        try {
            apiInstance.createUrl(urlName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#createUrl");
            e.printStackTrace();
        }
    }
}
String *urlName = urlName_example; // 
ViewUrlResponseSwagger *body = ; //  (optional)

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

// Create view URL
[apiInstance createUrlWith:urlName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var urlName = urlName_example; // {String} 

var opts = { 
  'body':  // {ViewUrlResponseSwagger} 
};

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

namespace Example
{
    public class createUrlExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var urlName = urlName_example;  // String | 
            var body = new ViewUrlResponseSwagger(); // ViewUrlResponseSwagger |  (optional) 

            try
            {
                // Create view URL
                apiInstance.createUrl(urlName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.createUrl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$urlName = urlName_example; // String | 
$body = ; // ViewUrlResponseSwagger | 

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

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $urlName = urlName_example; # String | 
my $body = WWW::SwaggerClient::Object::ViewUrlResponseSwagger->new(); # ViewUrlResponseSwagger | 

eval { 
    $api_instance->createUrl(urlName => $urlName, body => $body);
};
if ($@) {
    warn "Exception when calling ViewsApi->createUrl: $@\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.ViewsApi()
urlName = urlName_example # String | 
body =  # ViewUrlResponseSwagger |  (optional)

try: 
    # Create view URL
    api_instance.createUrl(urlName, body=body)
except ApiException as e:
    print("Exception when calling ViewsApi->createUrl: %s\n" % e)

Parameters

Path parameters
Name Description
urlName*
Body parameters
Name Description
body

Responses

Status: 201 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 500 - Internal server error


deletePrivilege

Delete privileges


/views/{viewName}/versions/{version}/instances/{instanceName}/privileges/{privilegeId}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/views/{viewName}/versions/{version}/instances/{instanceName}/privileges/{privilegeId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | view version
        String instanceName = instanceName_example; // String | instance name
        String privilegeId = privilegeId_example; // String | privilege id
        try {
            apiInstance.deletePrivilege(viewName, version, instanceName, privilegeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#deletePrivilege");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | view version
        String instanceName = instanceName_example; // String | instance name
        String privilegeId = privilegeId_example; // String | privilege id
        try {
            apiInstance.deletePrivilege(viewName, version, instanceName, privilegeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#deletePrivilege");
            e.printStackTrace();
        }
    }
}
String *viewName = viewName_example; // view name
String *version = version_example; // view version
String *instanceName = instanceName_example; // instance name
String *privilegeId = privilegeId_example; // privilege id

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

// Delete privileges
[apiInstance deletePrivilegeWith:viewName
    version:version
    instanceName:instanceName
    privilegeId:privilegeId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var viewName = viewName_example; // {String} view name

var version = version_example; // {String} view version

var instanceName = instanceName_example; // {String} instance name

var privilegeId = privilegeId_example; // {String} privilege id


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

namespace Example
{
    public class deletePrivilegeExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var viewName = viewName_example;  // String | view name
            var version = version_example;  // String | view version
            var instanceName = instanceName_example;  // String | instance name
            var privilegeId = privilegeId_example;  // String | privilege id

            try
            {
                // Delete privileges
                apiInstance.deletePrivilege(viewName, version, instanceName, privilegeId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.deletePrivilege: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$viewName = viewName_example; // String | view name
$version = version_example; // String | view version
$instanceName = instanceName_example; // String | instance name
$privilegeId = privilegeId_example; // String | privilege id

try {
    $api_instance->deletePrivilege($viewName, $version, $instanceName, $privilegeId);
} catch (Exception $e) {
    echo 'Exception when calling ViewsApi->deletePrivilege: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ViewsApi;

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $viewName = viewName_example; # String | view name
my $version = version_example; # String | view version
my $instanceName = instanceName_example; # String | instance name
my $privilegeId = privilegeId_example; # String | privilege id

eval { 
    $api_instance->deletePrivilege(viewName => $viewName, version => $version, instanceName => $instanceName, privilegeId => $privilegeId);
};
if ($@) {
    warn "Exception when calling ViewsApi->deletePrivilege: $@\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.ViewsApi()
viewName = viewName_example # String | view name
version = version_example # String | view version
instanceName = instanceName_example # String | instance name
privilegeId = privilegeId_example # String | privilege id

try: 
    # Delete privileges
    api_instance.deletePrivilege(viewName, version, instanceName, privilegeId)
except ApiException as e:
    print("Exception when calling ViewsApi->deletePrivilege: %s\n" % e)

Parameters

Path parameters
Name Description
viewName*
version*
instanceName*
privilegeId*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


deletePrivileges

Delete view instance privileges


/views/{viewName}/versions/{version}/instances/{instanceName}/privileges

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/views/{viewName}/versions/{version}/instances/{instanceName}/privileges"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String viewVersion = viewVersion_example; // String | view version
        String instanceName = instanceName_example; // String | instance name
        try {
            apiInstance.deletePrivileges(viewName, viewVersion, instanceName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#deletePrivileges");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String viewVersion = viewVersion_example; // String | view version
        String instanceName = instanceName_example; // String | instance name
        try {
            apiInstance.deletePrivileges(viewName, viewVersion, instanceName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#deletePrivileges");
            e.printStackTrace();
        }
    }
}
String *viewName = viewName_example; // view name
String *viewVersion = viewVersion_example; // view version
String *instanceName = instanceName_example; // instance name

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

// Delete view instance privileges
[apiInstance deletePrivilegesWith:viewName
    viewVersion:viewVersion
    instanceName:instanceName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var viewName = viewName_example; // {String} view name

var viewVersion = viewVersion_example; // {String} view version

var instanceName = instanceName_example; // {String} instance name


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

namespace Example
{
    public class deletePrivilegesExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var viewName = viewName_example;  // String | view name
            var viewVersion = viewVersion_example;  // String | view version
            var instanceName = instanceName_example;  // String | instance name

            try
            {
                // Delete view instance privileges
                apiInstance.deletePrivileges(viewName, viewVersion, instanceName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.deletePrivileges: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$viewName = viewName_example; // String | view name
$viewVersion = viewVersion_example; // String | view version
$instanceName = instanceName_example; // String | instance name

try {
    $api_instance->deletePrivileges($viewName, $viewVersion, $instanceName);
} catch (Exception $e) {
    echo 'Exception when calling ViewsApi->deletePrivileges: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ViewsApi;

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $viewName = viewName_example; # String | view name
my $viewVersion = viewVersion_example; # String | view version
my $instanceName = instanceName_example; # String | instance name

eval { 
    $api_instance->deletePrivileges(viewName => $viewName, viewVersion => $viewVersion, instanceName => $instanceName);
};
if ($@) {
    warn "Exception when calling ViewsApi->deletePrivileges: $@\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.ViewsApi()
viewName = viewName_example # String | view name
viewVersion = viewVersion_example # String | view version
instanceName = instanceName_example # String | instance name

try: 
    # Delete view instance privileges
    api_instance.deletePrivileges(viewName, viewVersion, instanceName)
except ApiException as e:
    print("Exception when calling ViewsApi->deletePrivileges: %s\n" % e)

Parameters

Path parameters
Name Description
viewName*
viewVersion*
instanceName*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


deleteService

Delete view instance


/views/{viewName}/versions/{version}/instances/{instanceName}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/views/{viewName}/versions/{version}/instances/{instanceName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | 
        String instanceName = instanceName_example; // String | instance name
        try {
            apiInstance.deleteService(viewName, version, instanceName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#deleteService");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | 
        String instanceName = instanceName_example; // String | instance name
        try {
            apiInstance.deleteService(viewName, version, instanceName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#deleteService");
            e.printStackTrace();
        }
    }
}
String *viewName = viewName_example; // view name
String *version = version_example; // 
String *instanceName = instanceName_example; // instance name

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

// Delete view instance
[apiInstance deleteServiceWith:viewName
    version:version
    instanceName:instanceName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var viewName = viewName_example; // {String} view name

var version = version_example; // {String} 

var instanceName = instanceName_example; // {String} instance name


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

namespace Example
{
    public class deleteServiceExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var viewName = viewName_example;  // String | view name
            var version = version_example;  // String | 
            var instanceName = instanceName_example;  // String | instance name

            try
            {
                // Delete view instance
                apiInstance.deleteService(viewName, version, instanceName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.deleteService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$viewName = viewName_example; // String | view name
$version = version_example; // String | 
$instanceName = instanceName_example; // String | instance name

try {
    $api_instance->deleteService($viewName, $version, $instanceName);
} catch (Exception $e) {
    echo 'Exception when calling ViewsApi->deleteService: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ViewsApi;

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $viewName = viewName_example; # String | view name
my $version = version_example; # String | 
my $instanceName = instanceName_example; # String | instance name

eval { 
    $api_instance->deleteService(viewName => $viewName, version => $version, instanceName => $instanceName);
};
if ($@) {
    warn "Exception when calling ViewsApi->deleteService: $@\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.ViewsApi()
viewName = viewName_example # String | view name
version = version_example # String | 
instanceName = instanceName_example # String | instance name

try: 
    # Delete view instance
    api_instance.deleteService(viewName, version, instanceName)
except ApiException as e:
    print("Exception when calling ViewsApi->deleteService: %s\n" % e)

Parameters

Path parameters
Name Description
viewName*
version*
instanceName*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


deleteUrl

Delete view URL


/view/urls/{urlName}

Usage and SDK Samples

curl -X delete "https://localhost/api/v1/view/urls/{urlName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

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

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String urlName = urlName_example; // String | 
        try {
            apiInstance.deleteUrl(urlName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#deleteUrl");
            e.printStackTrace();
        }
    }
}
String *urlName = urlName_example; // 

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

// Delete view URL
[apiInstance deleteUrlWith:urlName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var urlName = urlName_example; // {String} 


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

namespace Example
{
    public class deleteUrlExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var urlName = urlName_example;  // String | 

            try
            {
                // Delete view URL
                apiInstance.deleteUrl(urlName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.deleteUrl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$urlName = urlName_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $urlName = urlName_example; # String | 

eval { 
    $api_instance->deleteUrl(urlName => $urlName);
};
if ($@) {
    warn "Exception when calling ViewsApi->deleteUrl: $@\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.ViewsApi()
urlName = urlName_example # String | 

try: 
    # Delete view URL
    api_instance.deleteUrl(urlName)
except ApiException as e:
    print("Exception when calling ViewsApi->deleteUrl: %s\n" % e)

Parameters

Path parameters
Name Description
urlName*

Responses

Status: 200 - Successful operation

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


getPermission

Get single view permission


/views/{viewName}/versions/{version}/permissions/{permissionId}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/views/{viewName}/versions/{version}/permissions/{permissionId}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | view version
        String permissionId = permissionId_example; // String | permission id
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            ViewPermissionResponse result = apiInstance.getPermission(viewName, version, permissionId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getPermission");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | view version
        String permissionId = permissionId_example; // String | permission id
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            ViewPermissionResponse result = apiInstance.getPermission(viewName, version, permissionId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getPermission");
            e.printStackTrace();
        }
    }
}
String *viewName = viewName_example; // view name
String *version = version_example; // view version
String *permissionId = permissionId_example; // permission id
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to PermissionInfo/*)

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

// Get single view permission
[apiInstance getPermissionWith:viewName
    version:version
    permissionId:permissionId
    fields:fields
              completionHandler: ^(ViewPermissionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var viewName = viewName_example; // {String} view name

var version = version_example; // {String} view version

var permissionId = permissionId_example; // {String} permission id

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getPermissionExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var viewName = viewName_example;  // String | view name
            var version = version_example;  // String | view version
            var permissionId = permissionId_example;  // String | permission id
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to PermissionInfo/*)

            try
            {
                // Get single view permission
                ViewPermissionResponse result = apiInstance.getPermission(viewName, version, permissionId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.getPermission: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$viewName = viewName_example; // String | view name
$version = version_example; // String | view version
$permissionId = permissionId_example; // String | permission id
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $viewName = viewName_example; # String | view name
my $version = version_example; # String | view version
my $permissionId = permissionId_example; # String | permission id
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getPermission(viewName => $viewName, version => $version, permissionId => $permissionId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ViewsApi->getPermission: $@\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.ViewsApi()
viewName = viewName_example # String | view name
version = version_example # String | view version
permissionId = permissionId_example # String | permission id
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to PermissionInfo/*)

try: 
    # Get single view permission
    api_response = api_instance.getPermission(viewName, version, permissionId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ViewsApi->getPermission: %s\n" % e)

Parameters

Path parameters
Name Description
viewName*
version*
permissionId*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


getPermissions

Get all permissions for a view


/views/{viewName}/versions/{version}/permissions

Usage and SDK Samples

curl -X get "https://localhost/api/v1/views/{viewName}/versions/{version}/permissions?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | view version
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ViewPermissionResponse] result = apiInstance.getPermissions(viewName, version, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getPermissions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | view version
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ViewPermissionResponse] result = apiInstance.getPermissions(viewName, version, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getPermissions");
            e.printStackTrace();
        }
    }
}
String *viewName = viewName_example; // view name
String *version = version_example; // view version
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to PermissionInfo/*)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
Integer *from = 56; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
Integer *to = 56; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all permissions for a view
[apiInstance getPermissionsWith:viewName
    version:version
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[ViewPermissionResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var viewName = viewName_example; // {String} view name

var version = version_example; // {String} view version

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': 56, // {Integer} The starting page resource (inclusive).  "start" is also accepted.
  'to': 56 // {Integer} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class getPermissionsExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var viewName = viewName_example;  // String | view name
            var version = version_example;  // String | view version
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to PermissionInfo/*)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional) 
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = 56;  // Integer | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = 56;  // Integer | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all permissions for a view
                array[ViewPermissionResponse] result = apiInstance.getPermissions(viewName, version, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.getPermissions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$viewName = viewName_example; // String | view name
$version = version_example; // String | view version
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
$to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->getPermissions($viewName, $version, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ViewsApi->getPermissions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ViewsApi;

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $viewName = viewName_example; # String | view name
my $version = version_example; # String | view version
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = 56; # Integer | The starting page resource (inclusive).  "start" is also accepted.
my $to = 56; # Integer | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->getPermissions(viewName => $viewName, version => $version, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ViewsApi->getPermissions: $@\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.ViewsApi()
viewName = viewName_example # String | view name
version = version_example # String | view version
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to PermissionInfo/*)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = 56 # Integer | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = 56 # Integer | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all permissions for a view
    api_response = api_instance.getPermissions(viewName, version, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ViewsApi->getPermissions: %s\n" % e)

Parameters

Path parameters
Name Description
viewName*
version*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


getPrivilege

Get single view instance privilege


/views/{viewName}/versions/{version}/instances/{instanceName}/privileges/{privilegeId}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/views/{viewName}/versions/{version}/instances/{instanceName}/privileges/{privilegeId}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | view version
        String instanceName = instanceName_example; // String | instance name
        String privilegeId = privilegeId_example; // String | privilege id
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            ViewPrivilegeResponseWrapper result = apiInstance.getPrivilege(viewName, version, instanceName, privilegeId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getPrivilege");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | view version
        String instanceName = instanceName_example; // String | instance name
        String privilegeId = privilegeId_example; // String | privilege id
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            ViewPrivilegeResponseWrapper result = apiInstance.getPrivilege(viewName, version, instanceName, privilegeId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getPrivilege");
            e.printStackTrace();
        }
    }
}
String *viewName = viewName_example; // view name
String *version = version_example; // view version
String *instanceName = instanceName_example; // instance name
String *privilegeId = privilegeId_example; // privilege id
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to PrivilegeInfo/*)

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

// Get single view instance privilege
[apiInstance getPrivilegeWith:viewName
    version:version
    instanceName:instanceName
    privilegeId:privilegeId
    fields:fields
              completionHandler: ^(ViewPrivilegeResponseWrapper output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var viewName = viewName_example; // {String} view name

var version = version_example; // {String} view version

var instanceName = instanceName_example; // {String} instance name

var privilegeId = privilegeId_example; // {String} privilege id

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getPrivilegeExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var viewName = viewName_example;  // String | view name
            var version = version_example;  // String | view version
            var instanceName = instanceName_example;  // String | instance name
            var privilegeId = privilegeId_example;  // String | privilege id
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to PrivilegeInfo/*)

            try
            {
                // Get single view instance privilege
                ViewPrivilegeResponseWrapper result = apiInstance.getPrivilege(viewName, version, instanceName, privilegeId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.getPrivilege: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$viewName = viewName_example; // String | view name
$version = version_example; // String | view version
$instanceName = instanceName_example; // String | instance name
$privilegeId = privilegeId_example; // String | privilege id
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $viewName = viewName_example; # String | view name
my $version = version_example; # String | view version
my $instanceName = instanceName_example; # String | instance name
my $privilegeId = privilegeId_example; # String | privilege id
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getPrivilege(viewName => $viewName, version => $version, instanceName => $instanceName, privilegeId => $privilegeId, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ViewsApi->getPrivilege: $@\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.ViewsApi()
viewName = viewName_example # String | view name
version = version_example # String | view version
instanceName = instanceName_example # String | instance name
privilegeId = privilegeId_example # String | privilege id
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to PrivilegeInfo/*)

try: 
    # Get single view instance privilege
    api_response = api_instance.getPrivilege(viewName, version, instanceName, privilegeId, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ViewsApi->getPrivilege: %s\n" % e)

Parameters

Path parameters
Name Description
viewName*
version*
instanceName*
privilegeId*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


getPrivileges

Get all view instance privileges


/views/{viewName}/versions/{version}/instances/{instanceName}/privileges

Usage and SDK Samples

curl -X get "https://localhost/api/v1/views/{viewName}/versions/{version}/instances/{instanceName}/privileges?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | view version
        String instanceName = instanceName_example; // String | instance name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ViewPrivilegeResponseWrapper] result = apiInstance.getPrivileges(viewName, version, instanceName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getPrivileges");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | view version
        String instanceName = instanceName_example; // String | instance name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ViewPrivilegeResponseWrapper] result = apiInstance.getPrivileges(viewName, version, instanceName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getPrivileges");
            e.printStackTrace();
        }
    }
}
String *viewName = viewName_example; // view name
String *version = version_example; // view version
String *instanceName = instanceName_example; // instance name
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to PrivilegeInfo/*)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
Integer *from = 56; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
Integer *to = 56; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all view instance privileges
[apiInstance getPrivilegesWith:viewName
    version:version
    instanceName:instanceName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[ViewPrivilegeResponseWrapper] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var viewName = viewName_example; // {String} view name

var version = version_example; // {String} view version

var instanceName = instanceName_example; // {String} instance name

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': 56, // {Integer} The starting page resource (inclusive).  "start" is also accepted.
  'to': 56 // {Integer} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class getPrivilegesExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var viewName = viewName_example;  // String | view name
            var version = version_example;  // String | view version
            var instanceName = instanceName_example;  // String | instance name
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to PrivilegeInfo/*)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional) 
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = 56;  // Integer | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = 56;  // Integer | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all view instance privileges
                array[ViewPrivilegeResponseWrapper] result = apiInstance.getPrivileges(viewName, version, instanceName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.getPrivileges: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$viewName = viewName_example; // String | view name
$version = version_example; // String | view version
$instanceName = instanceName_example; // String | instance name
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
$to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->getPrivileges($viewName, $version, $instanceName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ViewsApi->getPrivileges: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ViewsApi;

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $viewName = viewName_example; # String | view name
my $version = version_example; # String | view version
my $instanceName = instanceName_example; # String | instance name
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = 56; # Integer | The starting page resource (inclusive).  "start" is also accepted.
my $to = 56; # Integer | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->getPrivileges(viewName => $viewName, version => $version, instanceName => $instanceName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ViewsApi->getPrivileges: $@\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.ViewsApi()
viewName = viewName_example # String | view name
version = version_example # String | view version
instanceName = instanceName_example # String | instance name
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to PrivilegeInfo/*)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = 56 # Integer | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = 56 # Integer | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all view instance privileges
    api_response = api_instance.getPrivileges(viewName, version, instanceName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ViewsApi->getPrivileges: %s\n" % e)

Parameters

Path parameters
Name Description
viewName*
version*
instanceName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


getService

Get single view instance


/views/{viewName}/versions/{version}/instances/{instanceName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/views/{viewName}/versions/{version}/instances/{instanceName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | 
        String instanceName = instanceName_example; // String | instance name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            ViewInstanceResponse result = apiInstance.getService(viewName, version, instanceName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getService");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | 
        String instanceName = instanceName_example; // String | instance name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            ViewInstanceResponse result = apiInstance.getService(viewName, version, instanceName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getService");
            e.printStackTrace();
        }
    }
}
String *viewName = viewName_example; // view name
String *version = version_example; // 
String *instanceName = instanceName_example; // instance name
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to ViewInstanceInfo/*)

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

// Get single view instance
[apiInstance getServiceWith:viewName
    version:version
    instanceName:instanceName
    fields:fields
              completionHandler: ^(ViewInstanceResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var viewName = viewName_example; // {String} view name

var version = version_example; // {String} 

var instanceName = instanceName_example; // {String} instance name

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getServiceExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var viewName = viewName_example;  // String | view name
            var version = version_example;  // String | 
            var instanceName = instanceName_example;  // String | instance name
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to ViewInstanceInfo/*)

            try
            {
                // Get single view instance
                ViewInstanceResponse result = apiInstance.getService(viewName, version, instanceName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.getService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$viewName = viewName_example; // String | view name
$version = version_example; // String | 
$instanceName = instanceName_example; // String | instance name
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $viewName = viewName_example; # String | view name
my $version = version_example; # String | 
my $instanceName = instanceName_example; # String | instance name
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getService(viewName => $viewName, version => $version, instanceName => $instanceName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ViewsApi->getService: $@\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.ViewsApi()
viewName = viewName_example # String | view name
version = version_example # String | 
instanceName = instanceName_example # String | instance name
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to ViewInstanceInfo/*)

try: 
    # Get single view instance
    api_response = api_instance.getService(viewName, version, instanceName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ViewsApi->getService: %s\n" % e)

Parameters

Path parameters
Name Description
viewName*
version*
instanceName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


getServices

Get all view instances


/views/{viewName}/versions/{version}/instances

Usage and SDK Samples

curl -X get "https://localhost/api/v1/views/{viewName}/versions/{version}/instances?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | 
        String version = version_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ViewInstanceResponse] result = apiInstance.getServices(viewName, version, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getServices");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | 
        String version = version_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ViewInstanceResponse] result = apiInstance.getServices(viewName, version, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getServices");
            e.printStackTrace();
        }
    }
}
String *viewName = viewName_example; // 
String *version = version_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to ViewInstanceInfo/*)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
Integer *from = 56; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
Integer *to = 56; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all view instances
[apiInstance getServicesWith:viewName
    version:version
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[ViewInstanceResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var viewName = viewName_example; // {String} 

var version = version_example; // {String} 

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': 56, // {Integer} The starting page resource (inclusive).  "start" is also accepted.
  'to': 56 // {Integer} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class getServicesExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var viewName = viewName_example;  // String | 
            var version = version_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to ViewInstanceInfo/*)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional) 
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = 56;  // Integer | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = 56;  // Integer | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all view instances
                array[ViewInstanceResponse] result = apiInstance.getServices(viewName, version, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.getServices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$viewName = viewName_example; // String | 
$version = version_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
$to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->getServices($viewName, $version, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ViewsApi->getServices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ViewsApi;

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $viewName = viewName_example; # String | 
my $version = version_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = 56; # Integer | The starting page resource (inclusive).  "start" is also accepted.
my $to = 56; # Integer | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->getServices(viewName => $viewName, version => $version, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ViewsApi->getServices: $@\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.ViewsApi()
viewName = viewName_example # String | 
version = version_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to ViewInstanceInfo/*)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = 56 # Integer | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = 56 # Integer | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all view instances
    api_response = api_instance.getServices(viewName, version, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ViewsApi->getServices: %s\n" % e)

Parameters

Path parameters
Name Description
viewName*
version*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


getVersion

Get single view version


/views/{viewName}/versions/{version}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/views/{viewName}/versions/{version}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            ViewVersionResponse result = apiInstance.getVersion(viewName, version, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            ViewVersionResponse result = apiInstance.getVersion(viewName, version, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getVersion");
            e.printStackTrace();
        }
    }
}
String *viewName = viewName_example; // view name
String *version = version_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to ViewVersionInfo/*)

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

// Get single view version
[apiInstance getVersionWith:viewName
    version:version
    fields:fields
              completionHandler: ^(ViewVersionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var viewName = viewName_example; // {String} view name

var version = version_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getVersionExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var viewName = viewName_example;  // String | view name
            var version = version_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to ViewVersionInfo/*)

            try
            {
                // Get single view version
                ViewVersionResponse result = apiInstance.getVersion(viewName, version, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.getVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$viewName = viewName_example; // String | view name
$version = version_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $viewName = viewName_example; # String | view name
my $version = version_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getVersion(viewName => $viewName, version => $version, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ViewsApi->getVersion: $@\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.ViewsApi()
viewName = viewName_example # String | view name
version = version_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to ViewVersionInfo/*)

try: 
    # Get single view version
    api_response = api_instance.getVersion(viewName, version, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ViewsApi->getVersion: %s\n" % e)

Parameters

Path parameters
Name Description
viewName*
version*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


getVersions

Get all versions for a view


/views/{viewName}/versions

Usage and SDK Samples

curl -X get "https://localhost/api/v1/views/{viewName}/versions?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ViewVersionResponse] result = apiInstance.getVersions(viewName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getVersions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ViewVersionResponse] result = apiInstance.getVersions(viewName, fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getVersions");
            e.printStackTrace();
        }
    }
}
String *viewName = viewName_example; // view name
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to ViewVersionInfo/*)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
Integer *from = 56; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
Integer *to = 56; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all versions for a view
[apiInstance getVersionsWith:viewName
    fields:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[ViewVersionResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var viewName = viewName_example; // {String} view name

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': 56, // {Integer} The starting page resource (inclusive).  "start" is also accepted.
  'to': 56 // {Integer} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class getVersionsExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var viewName = viewName_example;  // String | view name
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to ViewVersionInfo/*)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional) 
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = 56;  // Integer | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = 56;  // Integer | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all versions for a view
                array[ViewVersionResponse] result = apiInstance.getVersions(viewName, fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.getVersions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$viewName = viewName_example; // String | view name
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
$to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.

try {
    $result = $api_instance->getVersions($viewName, $fields, $sortBy, $pageSize, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ViewsApi->getVersions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ViewsApi;

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $viewName = viewName_example; # String | view name
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = 56; # Integer | The starting page resource (inclusive).  "start" is also accepted.
my $to = 56; # Integer | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->getVersions(viewName => $viewName, fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ViewsApi->getVersions: $@\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.ViewsApi()
viewName = viewName_example # String | view name
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to ViewVersionInfo/*)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = 56 # Integer | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = 56 # Integer | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all versions for a view
    api_response = api_instance.getVersions(viewName, fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ViewsApi->getVersions: %s\n" % e)

Parameters

Path parameters
Name Description
viewName*
Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


getView

Get single view


/views/{viewName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/views/{viewName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            ViewResponse result = apiInstance.getView(viewName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getView");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            ViewResponse result = apiInstance.getView(viewName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getView");
            e.printStackTrace();
        }
    }
}
String *viewName = viewName_example; // view name
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Views/*)

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

// Get single view
[apiInstance getViewWith:viewName
    fields:fields
              completionHandler: ^(ViewResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var viewName = viewName_example; // {String} view name

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getViewExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var viewName = viewName_example;  // String | view name
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Views/*)

            try
            {
                // Get single view
                ViewResponse result = apiInstance.getView(viewName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.getView: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$viewName = viewName_example; // String | view name
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $viewName = viewName_example; # String | view name
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getView(viewName => $viewName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ViewsApi->getView: $@\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.ViewsApi()
viewName = viewName_example # String | view name
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Views/*)

try: 
    # Get single view
    api_response = api_instance.getView(viewName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ViewsApi->getView: %s\n" % e)

Parameters

Path parameters
Name Description
viewName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


getViewUrl

Get single view URL


/view/urls/{urlName}

Usage and SDK Samples

curl -X get "https://localhost/api/v1/view/urls/{urlName}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String urlName = urlName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            ViewUrlResponseSwagger result = apiInstance.getViewUrl(urlName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getViewUrl");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String urlName = urlName_example; // String | 
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        try {
            ViewUrlResponseSwagger result = apiInstance.getViewUrl(urlName, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getViewUrl");
            e.printStackTrace();
        }
    }
}
String *urlName = urlName_example; // 
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to ViewUrlInfo/*)

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

// Get single view URL
[apiInstance getViewUrlWith:urlName
    fields:fields
              completionHandler: ^(ViewUrlResponseSwagger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var urlName = urlName_example; // {String} 

var opts = { 
  'fields': fields_example // {String} Filter fields in the response (identifier fields are mandatory)
};

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

namespace Example
{
    public class getViewUrlExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var urlName = urlName_example;  // String | 
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to ViewUrlInfo/*)

            try
            {
                // Get single view URL
                ViewUrlResponseSwagger result = apiInstance.getViewUrl(urlName, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.getViewUrl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$urlName = urlName_example; // String | 
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)

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

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $urlName = urlName_example; # String | 
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)

eval { 
    my $result = $api_instance->getViewUrl(urlName => $urlName, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ViewsApi->getViewUrl: $@\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.ViewsApi()
urlName = urlName_example # String | 
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to ViewUrlInfo/*)

try: 
    # Get single view URL
    api_response = api_instance.getViewUrl(urlName, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ViewsApi->getViewUrl: %s\n" % e)

Parameters

Path parameters
Name Description
urlName*
Query parameters
Name Description
fields

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


getViewUrls

Get all view URLs


/view/urls

Usage and SDK Samples

curl -X get "https://localhost/api/v1/view/urls?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ViewUrlResponseSwagger] result = apiInstance.getViewUrls(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getViewUrls");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ViewUrlResponseSwagger] result = apiInstance.getViewUrls(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getViewUrls");
            e.printStackTrace();
        }
    }
}
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to ViewUrlInfo/*)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
Integer *from = 56; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
Integer *to = 56; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all view URLs
[apiInstance getViewUrlsWith:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[ViewUrlResponseSwagger] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': 56, // {Integer} The starting page resource (inclusive).  "start" is also accepted.
  'to': 56 // {Integer} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class getViewUrlsExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to ViewUrlInfo/*)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional) 
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = 56;  // Integer | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = 56;  // Integer | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all view URLs
                array[ViewUrlResponseSwagger] result = apiInstance.getViewUrls(fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.getViewUrls: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
$to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.

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

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = 56; # Integer | The starting page resource (inclusive).  "start" is also accepted.
my $to = 56; # Integer | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->getViewUrls(fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ViewsApi->getViewUrls: $@\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.ViewsApi()
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to ViewUrlInfo/*)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = 56 # Integer | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = 56 # Integer | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all view URLs
    api_response = api_instance.getViewUrls(fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ViewsApi->getViewUrls: %s\n" % e)

Parameters

Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


getViews

Get all views

Returns details of all views.


/views

Usage and SDK Samples

curl -X get "https://localhost/api/v1/views?fields=&sortBy=&pageSize=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ViewResponse] result = apiInstance.getViews(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getViews");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
        String sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
        Integer pageSize = 56; // Integer | The number of resources to be returned for the paged response.
        Integer from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
        Integer to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.
        try {
            array[ViewResponse] result = apiInstance.getViews(fields, sortBy, pageSize, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#getViews");
            e.printStackTrace();
        }
    }
}
String *fields = fields_example; // Filter fields in the response (identifier fields are mandatory) (optional) (default to Views/*)
String *sortBy = sortBy_example; // Sort resources in result by (asc | desc) (optional) (default to Views/view_name.asc)
Integer *pageSize = 56; // The number of resources to be returned for the paged response. (optional) (default to 10)
Integer *from = 56; // The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
Integer *to = 56; // The ending page resource (inclusive).  "end" is also accepted. (optional)

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

// Get all views
[apiInstance getViewsWith:fields
    sortBy:sortBy
    pageSize:pageSize
    from:from
    to:to
              completionHandler: ^(array[ViewResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var opts = { 
  'fields': fields_example, // {String} Filter fields in the response (identifier fields are mandatory)
  'sortBy': sortBy_example, // {String} Sort resources in result by (asc | desc)
  'pageSize': 56, // {Integer} The number of resources to be returned for the paged response.
  'from': 56, // {Integer} The starting page resource (inclusive).  "start" is also accepted.
  'to': 56 // {Integer} The ending page resource (inclusive).  "end" is also accepted.
};

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

namespace Example
{
    public class getViewsExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var fields = fields_example;  // String | Filter fields in the response (identifier fields are mandatory) (optional)  (default to Views/*)
            var sortBy = sortBy_example;  // String | Sort resources in result by (asc | desc) (optional)  (default to Views/view_name.asc)
            var pageSize = 56;  // Integer | The number of resources to be returned for the paged response. (optional)  (default to 10)
            var from = 56;  // Integer | The starting page resource (inclusive).  "start" is also accepted. (optional)  (default to 0)
            var to = 56;  // Integer | The ending page resource (inclusive).  "end" is also accepted. (optional) 

            try
            {
                // Get all views
                array[ViewResponse] result = apiInstance.getViews(fields, sortBy, pageSize, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.getViews: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$fields = fields_example; // String | Filter fields in the response (identifier fields are mandatory)
$sortBy = sortBy_example; // String | Sort resources in result by (asc | desc)
$pageSize = 56; // Integer | The number of resources to be returned for the paged response.
$from = 56; // Integer | The starting page resource (inclusive).  "start" is also accepted.
$to = 56; // Integer | The ending page resource (inclusive).  "end" is also accepted.

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

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $fields = fields_example; # String | Filter fields in the response (identifier fields are mandatory)
my $sortBy = sortBy_example; # String | Sort resources in result by (asc | desc)
my $pageSize = 56; # Integer | The number of resources to be returned for the paged response.
my $from = 56; # Integer | The starting page resource (inclusive).  "start" is also accepted.
my $to = 56; # Integer | The ending page resource (inclusive).  "end" is also accepted.

eval { 
    my $result = $api_instance->getViews(fields => $fields, sortBy => $sortBy, pageSize => $pageSize, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ViewsApi->getViews: $@\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.ViewsApi()
fields = fields_example # String | Filter fields in the response (identifier fields are mandatory) (optional) (default to Views/*)
sortBy = sortBy_example # String | Sort resources in result by (asc | desc) (optional) (default to Views/view_name.asc)
pageSize = 56 # Integer | The number of resources to be returned for the paged response. (optional) (default to 10)
from = 56 # Integer | The starting page resource (inclusive).  "start" is also accepted. (optional) (default to 0)
to = 56 # Integer | The ending page resource (inclusive).  "end" is also accepted. (optional)

try: 
    # Get all views
    api_response = api_instance.getViews(fields=fields, sortBy=sortBy, pageSize=pageSize, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ViewsApi->getViews: %s\n" % e)

Parameters

Query parameters
Name Description
fields
sortBy
page_size
from
to

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


migrateData

Migrate view instance data

Migrates view instance persistence data from origin view instance specified in the path params.


/views/{viewName}/versions/{version}/instances/{instanceName}/migrate/{originVersion}/{originInstanceName}

Usage and SDK Samples

curl -X put "https://localhost/api/v1/views/{viewName}/versions/{version}/instances/{instanceName}/migrate/{originVersion}/{originInstanceName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | view version
        String instanceName = instanceName_example; // String | instance name
        String originVersion = originVersion_example; // String | origin version
        String originInstanceName = originInstanceName_example; // String | origin instance name
        try {
            apiInstance.migrateData(viewName, version, instanceName, originVersion, originInstanceName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#migrateData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | view version
        String instanceName = instanceName_example; // String | instance name
        String originVersion = originVersion_example; // String | origin version
        String originInstanceName = originInstanceName_example; // String | origin instance name
        try {
            apiInstance.migrateData(viewName, version, instanceName, originVersion, originInstanceName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#migrateData");
            e.printStackTrace();
        }
    }
}
String *viewName = viewName_example; // view name
String *version = version_example; // view version
String *instanceName = instanceName_example; // instance name
String *originVersion = originVersion_example; // origin version
String *originInstanceName = originInstanceName_example; // origin instance name

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

// Migrate view instance data
[apiInstance migrateDataWith:viewName
    version:version
    instanceName:instanceName
    originVersion:originVersion
    originInstanceName:originInstanceName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var viewName = viewName_example; // {String} view name

var version = version_example; // {String} view version

var instanceName = instanceName_example; // {String} instance name

var originVersion = originVersion_example; // {String} origin version

var originInstanceName = originInstanceName_example; // {String} origin instance name


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.migrateData(viewName, version, instanceName, originVersion, originInstanceName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class migrateDataExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var viewName = viewName_example;  // String | view name
            var version = version_example;  // String | view version
            var instanceName = instanceName_example;  // String | instance name
            var originVersion = originVersion_example;  // String | origin version
            var originInstanceName = originInstanceName_example;  // String | origin instance name

            try
            {
                // Migrate view instance data
                apiInstance.migrateData(viewName, version, instanceName, originVersion, originInstanceName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.migrateData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$viewName = viewName_example; // String | view name
$version = version_example; // String | view version
$instanceName = instanceName_example; // String | instance name
$originVersion = originVersion_example; // String | origin version
$originInstanceName = originInstanceName_example; // String | origin instance name

try {
    $api_instance->migrateData($viewName, $version, $instanceName, $originVersion, $originInstanceName);
} catch (Exception $e) {
    echo 'Exception when calling ViewsApi->migrateData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ViewsApi;

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $viewName = viewName_example; # String | view name
my $version = version_example; # String | view version
my $instanceName = instanceName_example; # String | instance name
my $originVersion = originVersion_example; # String | origin version
my $originInstanceName = originInstanceName_example; # String | origin instance name

eval { 
    $api_instance->migrateData(viewName => $viewName, version => $version, instanceName => $instanceName, originVersion => $originVersion, originInstanceName => $originInstanceName);
};
if ($@) {
    warn "Exception when calling ViewsApi->migrateData: $@\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.ViewsApi()
viewName = viewName_example # String | view name
version = version_example # String | view version
instanceName = instanceName_example # String | instance name
originVersion = originVersion_example # String | origin version
originInstanceName = originInstanceName_example # String | origin instance name

try: 
    # Migrate view instance data
    api_instance.migrateData(viewName, version, instanceName, originVersion, originInstanceName)
except ApiException as e:
    print("Exception when calling ViewsApi->migrateData: %s\n" % e)

Parameters

Path parameters
Name Description
viewName*
version*
instanceName*
originVersion*
originInstanceName*

Responses

Status: 200 - Successful operation

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster not found

Status: 500 - Internal server error


updatePrivileges

Update view instance privilege


/views/{viewName}/versions/{version}/instances/{instanceName}/privileges

Usage and SDK Samples

curl -X put "https://localhost/api/v1/views/{viewName}/versions/{version}/instances/{instanceName}/privileges"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | view version
        String instanceName = instanceName_example; // String | instance name
        ViewPrivilegeService body = ; // ViewPrivilegeService | 
        try {
            apiInstance.updatePrivileges(viewName, version, instanceName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#updatePrivileges");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | view version
        String instanceName = instanceName_example; // String | instance name
        ViewPrivilegeService body = ; // ViewPrivilegeService | 
        try {
            apiInstance.updatePrivileges(viewName, version, instanceName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#updatePrivileges");
            e.printStackTrace();
        }
    }
}
String *viewName = viewName_example; // view name
String *version = version_example; // view version
String *instanceName = instanceName_example; // instance name
ViewPrivilegeService *body = ; //  (optional)

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

// Update view instance privilege
[apiInstance updatePrivilegesWith:viewName
    version:version
    instanceName:instanceName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var viewName = viewName_example; // {String} view name

var version = version_example; // {String} view version

var instanceName = instanceName_example; // {String} instance name

var opts = { 
  'body':  // {ViewPrivilegeService} 
};

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

namespace Example
{
    public class updatePrivilegesExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var viewName = viewName_example;  // String | view name
            var version = version_example;  // String | view version
            var instanceName = instanceName_example;  // String | instance name
            var body = new ViewPrivilegeService(); // ViewPrivilegeService |  (optional) 

            try
            {
                // Update view instance privilege
                apiInstance.updatePrivileges(viewName, version, instanceName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.updatePrivileges: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$viewName = viewName_example; // String | view name
$version = version_example; // String | view version
$instanceName = instanceName_example; // String | instance name
$body = ; // ViewPrivilegeService | 

try {
    $api_instance->updatePrivileges($viewName, $version, $instanceName, $body);
} catch (Exception $e) {
    echo 'Exception when calling ViewsApi->updatePrivileges: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ViewsApi;

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $viewName = viewName_example; # String | view name
my $version = version_example; # String | view version
my $instanceName = instanceName_example; # String | instance name
my $body = WWW::SwaggerClient::Object::ViewPrivilegeService->new(); # ViewPrivilegeService | 

eval { 
    $api_instance->updatePrivileges(viewName => $viewName, version => $version, instanceName => $instanceName, body => $body);
};
if ($@) {
    warn "Exception when calling ViewsApi->updatePrivileges: $@\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.ViewsApi()
viewName = viewName_example # String | view name
version = version_example # String | view version
instanceName = instanceName_example # String | instance name
body =  # ViewPrivilegeService |  (optional)

try: 
    # Update view instance privilege
    api_instance.updatePrivileges(viewName, version, instanceName, body=body)
except ApiException as e:
    print("Exception when calling ViewsApi->updatePrivileges: %s\n" % e)

Parameters

Path parameters
Name Description
viewName*
version*
instanceName*
Body parameters
Name Description
body

Responses

Status: 200 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


updateService

Update view instance detail


/views/{viewName}/versions/{version}/instances/{instanceName}

Usage and SDK Samples

curl -X put "https://localhost/api/v1/views/{viewName}/versions/{version}/instances/{instanceName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | 
        String instanceName = instanceName_example; // String | instance name
        ViewInstanceResponse body = ; // ViewInstanceResponse | 
        try {
            apiInstance.updateService(viewName, version, instanceName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#updateService");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | view name
        String version = version_example; // String | 
        String instanceName = instanceName_example; // String | instance name
        ViewInstanceResponse body = ; // ViewInstanceResponse | 
        try {
            apiInstance.updateService(viewName, version, instanceName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#updateService");
            e.printStackTrace();
        }
    }
}
String *viewName = viewName_example; // view name
String *version = version_example; // 
String *instanceName = instanceName_example; // instance name
ViewInstanceResponse *body = ; //  (optional)

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

// Update view instance detail
[apiInstance updateServiceWith:viewName
    version:version
    instanceName:instanceName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var viewName = viewName_example; // {String} view name

var version = version_example; // {String} 

var instanceName = instanceName_example; // {String} instance name

var opts = { 
  'body':  // {ViewInstanceResponse} 
};

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

namespace Example
{
    public class updateServiceExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var viewName = viewName_example;  // String | view name
            var version = version_example;  // String | 
            var instanceName = instanceName_example;  // String | instance name
            var body = new ViewInstanceResponse(); // ViewInstanceResponse |  (optional) 

            try
            {
                // Update view instance detail
                apiInstance.updateService(viewName, version, instanceName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.updateService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$viewName = viewName_example; // String | view name
$version = version_example; // String | 
$instanceName = instanceName_example; // String | instance name
$body = ; // ViewInstanceResponse | 

try {
    $api_instance->updateService($viewName, $version, $instanceName, $body);
} catch (Exception $e) {
    echo 'Exception when calling ViewsApi->updateService: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ViewsApi;

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $viewName = viewName_example; # String | view name
my $version = version_example; # String | 
my $instanceName = instanceName_example; # String | instance name
my $body = WWW::SwaggerClient::Object::ViewInstanceResponse->new(); # ViewInstanceResponse | 

eval { 
    $api_instance->updateService(viewName => $viewName, version => $version, instanceName => $instanceName, body => $body);
};
if ($@) {
    warn "Exception when calling ViewsApi->updateService: $@\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.ViewsApi()
viewName = viewName_example # String | view name
version = version_example # String | 
instanceName = instanceName_example # String | instance name
body =  # ViewInstanceResponse |  (optional)

try: 
    # Update view instance detail
    api_instance.updateService(viewName, version, instanceName, body=body)
except ApiException as e:
    print("Exception when calling ViewsApi->updateService: %s\n" % e)

Parameters

Path parameters
Name Description
viewName*
version*
instanceName*
Body parameters
Name Description
body

Responses

Status: 200 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


updateServices

Update multiple view instance detail


/views/{viewName}/versions/{version}/instances

Usage and SDK Samples

curl -X put "https://localhost/api/v1/views/{viewName}/versions/{version}/instances"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | 
        String version = version_example; // String | 
        ViewInstanceResponse body = ; // ViewInstanceResponse | 
        try {
            apiInstance.updateServices(viewName, version, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#updateServices");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String viewName = viewName_example; // String | 
        String version = version_example; // String | 
        ViewInstanceResponse body = ; // ViewInstanceResponse | 
        try {
            apiInstance.updateServices(viewName, version, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#updateServices");
            e.printStackTrace();
        }
    }
}
String *viewName = viewName_example; // 
String *version = version_example; // 
ViewInstanceResponse *body = ; //  (optional)

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

// Update multiple view instance detail
[apiInstance updateServicesWith:viewName
    version:version
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var viewName = viewName_example; // {String} 

var version = version_example; // {String} 

var opts = { 
  'body':  // {ViewInstanceResponse} 
};

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

namespace Example
{
    public class updateServicesExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var viewName = viewName_example;  // String | 
            var version = version_example;  // String | 
            var body = new ViewInstanceResponse(); // ViewInstanceResponse |  (optional) 

            try
            {
                // Update multiple view instance detail
                apiInstance.updateServices(viewName, version, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.updateServices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$viewName = viewName_example; // String | 
$version = version_example; // String | 
$body = ; // ViewInstanceResponse | 

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

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $viewName = viewName_example; # String | 
my $version = version_example; # String | 
my $body = WWW::SwaggerClient::Object::ViewInstanceResponse->new(); # ViewInstanceResponse | 

eval { 
    $api_instance->updateServices(viewName => $viewName, version => $version, body => $body);
};
if ($@) {
    warn "Exception when calling ViewsApi->updateServices: $@\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.ViewsApi()
viewName = viewName_example # String | 
version = version_example # String | 
body =  # ViewInstanceResponse |  (optional)

try: 
    # Update multiple view instance detail
    api_instance.updateServices(viewName, version, body=body)
except ApiException as e:
    print("Exception when calling ViewsApi->updateServices: %s\n" % e)

Parameters

Path parameters
Name Description
viewName*
version*
Body parameters
Name Description
body

Responses

Status: 200 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


updateUrl

Update view URL


/view/urls/{urlName}

Usage and SDK Samples

curl -X put "https://localhost/api/v1/view/urls/{urlName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewsApi;

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

public class ViewsApiExample {

    public static void main(String[] args) {
        
        ViewsApi apiInstance = new ViewsApi();
        String urlName = urlName_example; // String | 
        ViewUrlResponseSwagger body = ; // ViewUrlResponseSwagger | 
        try {
            apiInstance.updateUrl(urlName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#updateUrl");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewsApi;

public class ViewsApiExample {

    public static void main(String[] args) {
        ViewsApi apiInstance = new ViewsApi();
        String urlName = urlName_example; // String | 
        ViewUrlResponseSwagger body = ; // ViewUrlResponseSwagger | 
        try {
            apiInstance.updateUrl(urlName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewsApi#updateUrl");
            e.printStackTrace();
        }
    }
}
String *urlName = urlName_example; // 
ViewUrlResponseSwagger *body = ; //  (optional)

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

// Update view URL
[apiInstance updateUrlWith:urlName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerSpecForAmbariRestApi = require('swagger_spec_for_ambari_rest_api');

var api = new SwaggerSpecForAmbariRestApi.ViewsApi()

var urlName = urlName_example; // {String} 

var opts = { 
  'body':  // {ViewUrlResponseSwagger} 
};

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

namespace Example
{
    public class updateUrlExample
    {
        public void main()
        {
            
            var apiInstance = new ViewsApi();
            var urlName = urlName_example;  // String | 
            var body = new ViewUrlResponseSwagger(); // ViewUrlResponseSwagger |  (optional) 

            try
            {
                // Update view URL
                apiInstance.updateUrl(urlName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewsApi.updateUrl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewsApi();
$urlName = urlName_example; // String | 
$body = ; // ViewUrlResponseSwagger | 

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

my $api_instance = WWW::SwaggerClient::ViewsApi->new();
my $urlName = urlName_example; # String | 
my $body = WWW::SwaggerClient::Object::ViewUrlResponseSwagger->new(); # ViewUrlResponseSwagger | 

eval { 
    $api_instance->updateUrl(urlName => $urlName, body => $body);
};
if ($@) {
    warn "Exception when calling ViewsApi->updateUrl: $@\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.ViewsApi()
urlName = urlName_example # String | 
body =  # ViewUrlResponseSwagger |  (optional)

try: 
    # Update view URL
    api_instance.updateUrl(urlName, body=body)
except ApiException as e:
    print("Exception when calling ViewsApi->updateUrl: %s\n" % e)

Parameters

Path parameters
Name Description
urlName*
Body parameters
Name Description
body

Responses

Status: 200 - Successful operation

Status: 202 - Request is accepted, but not completely processed yet

Status: 400 - Invalid arguments

Status: 401 - Not authenticated

Status: 403 - Not permitted to perform the operation

Status: 404 - Cluster or host not found

Status: 500 - Internal server error


Generated 2022-11-27T06:58:27.041+08:00