KubeVela Restful API

Applications

createApplication

creates an application

/envs/{envName}/apps

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
-H "Content-Type: */*"\
"//127.0.0.1:38081/api/envs/{envName}/apps"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        
        ApplicationsApi apiInstance = new ApplicationsApi();
        Appfile.AppFile body = ; // Appfile.AppFile | application parameters
        String envName = envName_example; // String | environment name
        try {
            inline_response_200 result = apiInstance.createApplication(body, envName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#createApplication");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        Appfile.AppFile body = ; // Appfile.AppFile | application parameters
        String envName = envName_example; // String | environment name
        try {
            inline_response_200 result = apiInstance.createApplication(body, envName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#createApplication");
            e.printStackTrace();
        }
    }
}

Appfile.AppFile *body = ; // application parameters
String *envName = envName_example; // environment name

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

// creates an application
[apiInstance createApplicationWith:body
    envName:envName
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var KubeVelaRestfulApi = require('kube_vela_restful_api');

var api = new KubeVelaRestfulApi.ApplicationsApi()
var body = ; // {{Appfile.AppFile}} application parameters
var envName = envName_example; // {{String}} environment name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createApplication(bodyenvName, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApplicationsApi();
            var body = new Appfile.AppFile(); // Appfile.AppFile | application parameters
            var envName = envName_example;  // String | environment name

            try
            {
                // creates an application
                inline_response_200 result = apiInstance.createApplication(body, envName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.createApplication: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApplicationsApi();
$body = ; // Appfile.AppFile | application parameters
$envName = envName_example; // String | environment name

try {
    $result = $api_instance->createApplication($body, $envName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->createApplication: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $body = WWW::SwaggerClient::Object::Appfile.AppFile->new(); # Appfile.AppFile | application parameters
my $envName = envName_example; # String | environment name

eval { 
    my $result = $api_instance->createApplication(body => $body, envName => $envName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->createApplication: $@\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.ApplicationsApi()
body =  # Appfile.AppFile | application parameters
envName = envName_example # String | environment name

try: 
    # creates an application
    api_response = api_instance.create_application(body, envName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationsApi->createApplication: %s\n" % e)

Parameters

Path parameters

Name	Description
envName*	String environment name Required

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

Status: 500 - Internal Server Error

Schema

listApplications

list all applications

/envs/{envName}/apps

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"//127.0.0.1:38081/api/envs/{envName}/apps"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        
        ApplicationsApi apiInstance = new ApplicationsApi();
        String envName = envName_example; // String | environment name
        try {
            inline_response_200_2 result = apiInstance.listApplications(envName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#listApplications");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String envName = envName_example; // String | environment name
        try {
            inline_response_200_2 result = apiInstance.listApplications(envName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#listApplications");
            e.printStackTrace();
        }
    }
}

String *envName = envName_example; // environment name

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

// list all applications
[apiInstance listApplicationsWith:envName
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var KubeVelaRestfulApi = require('kube_vela_restful_api');

var api = new KubeVelaRestfulApi.ApplicationsApi()
var envName = envName_example; // {{String}} environment name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listApplications(envName, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ApplicationsApi();
            var envName = envName_example;  // String | environment name

            try
            {
                // list all applications
                inline_response_200_2 result = apiInstance.listApplications(envName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.listApplications: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApplicationsApi();
$envName = envName_example; // String | environment name

try {
    $result = $api_instance->listApplications($envName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->listApplications: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $envName = envName_example; # String | environment name

eval { 
    my $result = $api_instance->listApplications(envName => $envName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->listApplications: $@\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.ApplicationsApi()
envName = envName_example # String | environment name

try: 
    # list all applications
    api_response = api_instance.list_applications(envName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationsApi->listApplications: %s\n" % e)

Parameters

Path parameters

Name	Description
envName*	String environment name Required

Responses

Status: 200 - OK

Schema

Status: 500 - Internal Server Error

Schema

Definitions

getDefinition

gets OpenAPI schema from Cue section of a WorkloadDefinition/TraitDefinition

/definitions/{definitionName}

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"//127.0.0.1:38081/api/definitions/{definitionName}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefinitionsApi;

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

public class DefinitionsApiExample {

    public static void main(String[] args) {
        
        DefinitionsApi apiInstance = new DefinitionsApi();
        String definitionName = definitionName_example; // String | name of workload type or trait
        try {
            inline_response_200 result = apiInstance.getDefinition(definitionName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefinitionsApi#getDefinition");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DefinitionsApi;

public class DefinitionsApiExample {

    public static void main(String[] args) {
        DefinitionsApi apiInstance = new DefinitionsApi();
        String definitionName = definitionName_example; // String | name of workload type or trait
        try {
            inline_response_200 result = apiInstance.getDefinition(definitionName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefinitionsApi#getDefinition");
            e.printStackTrace();
        }
    }
}

String *definitionName = definitionName_example; // name of workload type or trait

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

// gets OpenAPI schema from Cue section of a WorkloadDefinition/TraitDefinition
[apiInstance getDefinitionWith:definitionName
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var KubeVelaRestfulApi = require('kube_vela_restful_api');

var api = new KubeVelaRestfulApi.DefinitionsApi()
var definitionName = definitionName_example; // {{String}} name of workload type or trait

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDefinition(definitionName, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DefinitionsApi();
            var definitionName = definitionName_example;  // String | name of workload type or trait

            try
            {
                // gets OpenAPI schema from Cue section of a WorkloadDefinition/TraitDefinition
                inline_response_200 result = apiInstance.getDefinition(definitionName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefinitionsApi.getDefinition: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDefinitionsApi();
$definitionName = definitionName_example; // String | name of workload type or trait

try {
    $result = $api_instance->getDefinition($definitionName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefinitionsApi->getDefinition: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefinitionsApi;

my $api_instance = WWW::SwaggerClient::DefinitionsApi->new();
my $definitionName = definitionName_example; # String | name of workload type or trait

eval { 
    my $result = $api_instance->getDefinition(definitionName => $definitionName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefinitionsApi->getDefinition: $@\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.DefinitionsApi()
definitionName = definitionName_example # String | name of workload type or trait

try: 
    # gets OpenAPI schema from Cue section of a WorkloadDefinition/TraitDefinition
    api_response = api_instance.get_definition(definitionName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefinitionsApi->getDefinition: %s\n" % e)

Parameters

Path parameters

Name	Description
definitionName*	String name of workload type or trait Required

Responses

Status: 200 - OK

Schema

Status: 500 - Internal Server Error

Schema

Environments

createEnvironment

/envs/

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
"//127.0.0.1:38081/api/envs/"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EnvironmentsApi;

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

public class EnvironmentsApiExample {

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

import io.swagger.client.api.EnvironmentsApi;

public class EnvironmentsApiExample {

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


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

[apiInstance createEnvironmentWithCompletionHandler: 
              ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var KubeVelaRestfulApi = require('kube_vela_restful_api');

var api = new KubeVelaRestfulApi.EnvironmentsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createEnvironment(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new EnvironmentsApi();

            try
            {
                inline_response_200 result = apiInstance.createEnvironment();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EnvironmentsApi.createEnvironment: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

try {
    $result = $api_instance->createEnvironment();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EnvironmentsApi->createEnvironment: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EnvironmentsApi;

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

eval { 
    my $result = $api_instance->createEnvironment();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EnvironmentsApi->createEnvironment: $@\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.EnvironmentsApi()

try: 
    api_response = api_instance.create_environment()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnvironmentsApi->createEnvironment: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Schema

Status: 500 - Internal Server Error

Schema

deleteEnvironment

/envs/{envName}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: */*"\
"//127.0.0.1:38081/api/envs/{envName}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EnvironmentsApi;

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

public class EnvironmentsApiExample {

    public static void main(String[] args) {
        
        EnvironmentsApi apiInstance = new EnvironmentsApi();
        String envName = envName_example; // String | envName
        try {
            inline_response_200 result = apiInstance.deleteEnvironment(envName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnvironmentsApi#deleteEnvironment");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.EnvironmentsApi;

public class EnvironmentsApiExample {

    public static void main(String[] args) {
        EnvironmentsApi apiInstance = new EnvironmentsApi();
        String envName = envName_example; // String | envName
        try {
            inline_response_200 result = apiInstance.deleteEnvironment(envName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnvironmentsApi#deleteEnvironment");
            e.printStackTrace();
        }
    }
}

String *envName = envName_example; // envName

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

[apiInstance deleteEnvironmentWith:envName
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var KubeVelaRestfulApi = require('kube_vela_restful_api');

var api = new KubeVelaRestfulApi.EnvironmentsApi()
var envName = envName_example; // {{String}} envName

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteEnvironment(envName, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new EnvironmentsApi();
            var envName = envName_example;  // String | envName

            try
            {
                inline_response_200 result = apiInstance.deleteEnvironment(envName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EnvironmentsApi.deleteEnvironment: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiEnvironmentsApi();
$envName = envName_example; // String | envName

try {
    $result = $api_instance->deleteEnvironment($envName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EnvironmentsApi->deleteEnvironment: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EnvironmentsApi;

my $api_instance = WWW::SwaggerClient::EnvironmentsApi->new();
my $envName = envName_example; # String | envName

eval { 
    my $result = $api_instance->deleteEnvironment(envName => $envName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EnvironmentsApi->deleteEnvironment: $@\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.EnvironmentsApi()
envName = envName_example # String | envName

try: 
    api_response = api_instance.delete_environment(envName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnvironmentsApi->deleteEnvironment: %s\n" % e)

Parameters

Path parameters

Name	Description
envName*	String envName Required

Responses

Status: 200 - OK

Schema

Status: 500 - Internal Server Error

Schema

getEnvironment

/envs/{envName}

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"//127.0.0.1:38081/api/envs/{envName}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EnvironmentsApi;

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

public class EnvironmentsApiExample {

    public static void main(String[] args) {
        
        EnvironmentsApi apiInstance = new EnvironmentsApi();
        String envName = envName_example; // String | envName
        try {
            inline_response_200_1 result = apiInstance.getEnvironment(envName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnvironmentsApi#getEnvironment");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.EnvironmentsApi;

public class EnvironmentsApiExample {

    public static void main(String[] args) {
        EnvironmentsApi apiInstance = new EnvironmentsApi();
        String envName = envName_example; // String | envName
        try {
            inline_response_200_1 result = apiInstance.getEnvironment(envName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnvironmentsApi#getEnvironment");
            e.printStackTrace();
        }
    }
}

String *envName = envName_example; // envName

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

[apiInstance getEnvironmentWith:envName
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var KubeVelaRestfulApi = require('kube_vela_restful_api');

var api = new KubeVelaRestfulApi.EnvironmentsApi()
var envName = envName_example; // {{String}} envName

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEnvironment(envName, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new EnvironmentsApi();
            var envName = envName_example;  // String | envName

            try
            {
                inline_response_200_1 result = apiInstance.getEnvironment(envName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EnvironmentsApi.getEnvironment: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiEnvironmentsApi();
$envName = envName_example; // String | envName

try {
    $result = $api_instance->getEnvironment($envName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EnvironmentsApi->getEnvironment: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EnvironmentsApi;

my $api_instance = WWW::SwaggerClient::EnvironmentsApi->new();
my $envName = envName_example; # String | envName

eval { 
    my $result = $api_instance->getEnvironment(envName => $envName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EnvironmentsApi->getEnvironment: $@\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.EnvironmentsApi()
envName = envName_example # String | envName

try: 
    api_response = api_instance.get_environment(envName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnvironmentsApi->getEnvironment: %s\n" % e)

Parameters

Path parameters

Name	Description
envName*	String envName Required

Responses

Status: 200 - OK

Schema

Status: 500 - Internal Server Error

Schema

listEnvironments

/envs/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//127.0.0.1:38081/api/envs/"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EnvironmentsApi;

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

public class EnvironmentsApiExample {

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

import io.swagger.client.api.EnvironmentsApi;

public class EnvironmentsApiExample {

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


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

[apiInstance listEnvironmentsWithCompletionHandler: 
              ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var KubeVelaRestfulApi = require('kube_vela_restful_api');

var api = new KubeVelaRestfulApi.EnvironmentsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listEnvironments(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new EnvironmentsApi();

            try
            {
                inline_response_200_1 result = apiInstance.listEnvironments();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EnvironmentsApi.listEnvironments: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

try {
    $result = $api_instance->listEnvironments();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EnvironmentsApi->listEnvironments: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EnvironmentsApi;

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

eval { 
    my $result = $api_instance->listEnvironments();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EnvironmentsApi->listEnvironments: $@\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.EnvironmentsApi()

try: 
    api_response = api_instance.list_environments()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnvironmentsApi->listEnvironments: %s\n" % e)

Parameters

Responses

Status: 200 - OK

Schema

Status: 500 - Internal Server Error

Schema

setEnvironment

/envs/{envName}

Usage and SDK Samples

curl -X PATCH\
-H "Accept: */*"\
"//127.0.0.1:38081/api/envs/{envName}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EnvironmentsApi;

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

public class EnvironmentsApiExample {

    public static void main(String[] args) {
        
        EnvironmentsApi apiInstance = new EnvironmentsApi();
        String envName = envName_example; // String | envName
        try {
            inline_response_200 result = apiInstance.setEnvironment(envName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnvironmentsApi#setEnvironment");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.EnvironmentsApi;

public class EnvironmentsApiExample {

    public static void main(String[] args) {
        EnvironmentsApi apiInstance = new EnvironmentsApi();
        String envName = envName_example; // String | envName
        try {
            inline_response_200 result = apiInstance.setEnvironment(envName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnvironmentsApi#setEnvironment");
            e.printStackTrace();
        }
    }
}

String *envName = envName_example; // envName

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

[apiInstance setEnvironmentWith:envName
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var KubeVelaRestfulApi = require('kube_vela_restful_api');

var api = new KubeVelaRestfulApi.EnvironmentsApi()
var envName = envName_example; // {{String}} envName

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setEnvironment(envName, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new EnvironmentsApi();
            var envName = envName_example;  // String | envName

            try
            {
                inline_response_200 result = apiInstance.setEnvironment(envName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EnvironmentsApi.setEnvironment: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiEnvironmentsApi();
$envName = envName_example; // String | envName

try {
    $result = $api_instance->setEnvironment($envName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EnvironmentsApi->setEnvironment: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EnvironmentsApi;

my $api_instance = WWW::SwaggerClient::EnvironmentsApi->new();
my $envName = envName_example; # String | envName

eval { 
    my $result = $api_instance->setEnvironment(envName => $envName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EnvironmentsApi->setEnvironment: $@\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.EnvironmentsApi()
envName = envName_example # String | envName

try: 
    api_response = api_instance.set_environment(envName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnvironmentsApi->setEnvironment: %s\n" % e)

Parameters

Path parameters

Name	Description
envName*	String envName Required

Responses

Status: 200 - OK

Schema

Status: 500 - Internal Server Error

Schema

updateEnvironment

/envs/{envName}

Usage and SDK Samples

curl -X PUT\
-H "Accept: */*"\
-H "Content-Type: */*"\
"//127.0.0.1:38081/api/envs/{envName}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EnvironmentsApi;

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

public class EnvironmentsApiExample {

    public static void main(String[] args) {
        
        EnvironmentsApi apiInstance = new EnvironmentsApi();
        Apis.EnvironmentBody body = ; // Apis.EnvironmentBody | envName
        String envName = envName_example; // String | envName
        try {
            inline_response_200 result = apiInstance.updateEnvironment(body, envName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnvironmentsApi#updateEnvironment");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.EnvironmentsApi;

public class EnvironmentsApiExample {

    public static void main(String[] args) {
        EnvironmentsApi apiInstance = new EnvironmentsApi();
        Apis.EnvironmentBody body = ; // Apis.EnvironmentBody | envName
        String envName = envName_example; // String | envName
        try {
            inline_response_200 result = apiInstance.updateEnvironment(body, envName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EnvironmentsApi#updateEnvironment");
            e.printStackTrace();
        }
    }
}

Apis.EnvironmentBody *body = ; // envName
String *envName = envName_example; // envName

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

[apiInstance updateEnvironmentWith:body
    envName:envName
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var KubeVelaRestfulApi = require('kube_vela_restful_api');

var api = new KubeVelaRestfulApi.EnvironmentsApi()
var body = ; // {{Apis.EnvironmentBody}} envName
var envName = envName_example; // {{String}} envName

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateEnvironment(bodyenvName, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new EnvironmentsApi();
            var body = new Apis.EnvironmentBody(); // Apis.EnvironmentBody | envName
            var envName = envName_example;  // String | envName

            try
            {
                inline_response_200 result = apiInstance.updateEnvironment(body, envName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EnvironmentsApi.updateEnvironment: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiEnvironmentsApi();
$body = ; // Apis.EnvironmentBody | envName
$envName = envName_example; // String | envName

try {
    $result = $api_instance->updateEnvironment($body, $envName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EnvironmentsApi->updateEnvironment: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EnvironmentsApi;

my $api_instance = WWW::SwaggerClient::EnvironmentsApi->new();
my $body = WWW::SwaggerClient::Object::Apis.EnvironmentBody->new(); # Apis.EnvironmentBody | envName
my $envName = envName_example; # String | envName

eval { 
    my $result = $api_instance->updateEnvironment(body => $body, envName => $envName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EnvironmentsApi->updateEnvironment: $@\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.EnvironmentsApi()
body =  # Apis.EnvironmentBody | envName
envName = envName_example # String | envName

try: 
    api_response = api_instance.update_environment(body, envName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnvironmentsApi->updateEnvironment: %s\n" % e)

Parameters

Path parameters

Name	Description
envName*	String envName Required

Body parameters

Name	Description
body *

KubeVela Restful API

API and SDK Documentation

Applications

createApplication

Usage and SDK Samples

Parameters

Responses

Status: 200 - OK

Status: 500 - Internal Server Error

listApplications

Usage and SDK Samples

Parameters

Responses

Status: 200 - OK

Status: 500 - Internal Server Error

Definitions

getDefinition

Usage and SDK Samples

Parameters

Responses

Status: 200 - OK

Status: 500 - Internal Server Error

Environments

createEnvironment

Usage and SDK Samples

Parameters

Responses

Status: 200 - OK

Status: 500 - Internal Server Error

deleteEnvironment

Usage and SDK Samples

Parameters

Responses

Status: 200 - OK

Status: 500 - Internal Server Error

getEnvironment

Usage and SDK Samples

Parameters

Responses

Status: 200 - OK

Status: 500 - Internal Server Error

listEnvironments

Usage and SDK Samples

Parameters

Responses

Status: 200 - OK

Status: 500 - Internal Server Error

setEnvironment

Usage and SDK Samples

Parameters

Responses

Status: 200 - OK

Status: 500 - Internal Server Error

updateEnvironment

Usage and SDK Samples

Parameters

Responses

Status: 200 - OK

Status: 500 - Internal Server Error