Skip to content

Latest commit

 

History

History
301 lines (233 loc) · 10.4 KB

NetApi.md

File metadata and controls

301 lines (233 loc) · 10.4 KB
Raw

NetApi

All URIs are relative to https://api.eu-west-2.outscale.com/api/v1

Method HTTP request Description
createNet POST /CreateNet
deleteNet POST /DeleteNet
readNets POST /ReadNets
updateNet POST /UpdateNet

createNet

CreateNetResponse createNet(createNetRequest)

Example

// Import classes:
import io.github.outscale.osc_sdk_java.client.ApiClient;
import io.github.outscale.osc_sdk_java.client.ApiException;
import io.github.outscale.osc_sdk_java.client.Configuration;
import io.github.outscale.osc_sdk_java.client.auth.*;
import io.github.outscale.osc_sdk_java.client.models.*;
import io.github.outscale.osc_sdk_java.client.api.NetApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.eu-west-2.outscale.com/api/v1");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    NetApi apiInstance = new NetApi(defaultClient);
    CreateNetRequest createNetRequest = new CreateNetRequest(); // CreateNetRequest | 
    try {
      CreateNetResponse result = apiInstance.createNet(createNetRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling NetApi#createNet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
createNetRequest CreateNetRequest [optional]

Return type

CreateNetResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 The HTTP 200 response (OK). -
400 The HTTP 400 response (Bad Request). -
401 The HTTP 401 response (Unauthorized). -
409 The HTTP 409 response (Conflict). -
500 The HTTP 500 response (Internal Server Error). -

deleteNet

DeleteNetResponse deleteNet(deleteNetRequest)

Example

// Import classes:
import io.github.outscale.osc_sdk_java.client.ApiClient;
import io.github.outscale.osc_sdk_java.client.ApiException;
import io.github.outscale.osc_sdk_java.client.Configuration;
import io.github.outscale.osc_sdk_java.client.auth.*;
import io.github.outscale.osc_sdk_java.client.models.*;
import io.github.outscale.osc_sdk_java.client.api.NetApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.eu-west-2.outscale.com/api/v1");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    NetApi apiInstance = new NetApi(defaultClient);
    DeleteNetRequest deleteNetRequest = new DeleteNetRequest(); // DeleteNetRequest | 
    try {
      DeleteNetResponse result = apiInstance.deleteNet(deleteNetRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling NetApi#deleteNet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
deleteNetRequest DeleteNetRequest [optional]

Return type

DeleteNetResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 The HTTP 200 response (OK). -
400 The HTTP 400 response (Bad Request). -
401 The HTTP 401 response (Unauthorized). -
500 The HTTP 500 response (Internal Server Error). -

readNets

ReadNetsResponse readNets(readNetsRequest)

Example

// Import classes:
import io.github.outscale.osc_sdk_java.client.ApiClient;
import io.github.outscale.osc_sdk_java.client.ApiException;
import io.github.outscale.osc_sdk_java.client.Configuration;
import io.github.outscale.osc_sdk_java.client.auth.*;
import io.github.outscale.osc_sdk_java.client.models.*;
import io.github.outscale.osc_sdk_java.client.api.NetApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.eu-west-2.outscale.com/api/v1");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    NetApi apiInstance = new NetApi(defaultClient);
    ReadNetsRequest readNetsRequest = new ReadNetsRequest(); // ReadNetsRequest | 
    try {
      ReadNetsResponse result = apiInstance.readNets(readNetsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling NetApi#readNets");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
readNetsRequest ReadNetsRequest [optional]

Return type

ReadNetsResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 The HTTP 200 response (OK). -
400 The HTTP 400 response (Bad Request). -
401 The HTTP 401 response (Unauthorized). -
500 The HTTP 500 response (Internal Server Error). -

updateNet

UpdateNetResponse updateNet(updateNetRequest)

Example

// Import classes:
import io.github.outscale.osc_sdk_java.client.ApiClient;
import io.github.outscale.osc_sdk_java.client.ApiException;
import io.github.outscale.osc_sdk_java.client.Configuration;
import io.github.outscale.osc_sdk_java.client.auth.*;
import io.github.outscale.osc_sdk_java.client.models.*;
import io.github.outscale.osc_sdk_java.client.api.NetApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.eu-west-2.outscale.com/api/v1");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    NetApi apiInstance = new NetApi(defaultClient);
    UpdateNetRequest updateNetRequest = new UpdateNetRequest(); // UpdateNetRequest | 
    try {
      UpdateNetResponse result = apiInstance.updateNet(updateNetRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling NetApi#updateNet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
updateNetRequest UpdateNetRequest [optional]

Return type

UpdateNetResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 The HTTP 200 response (OK). -
400 The HTTP 400 response (Bad Request). -
401 The HTTP 401 response (Unauthorized). -
500 The HTTP 500 response (Internal Server Error). -