PublicIpApi

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

Method	HTTP request	Description
createPublicIp	POST /CreatePublicIp
deletePublicIp	POST /DeletePublicIp
linkPublicIp	POST /LinkPublicIp
readPublicIpRanges	POST /ReadPublicIpRanges
readPublicIps	POST /ReadPublicIps
unlinkPublicIp	POST /UnlinkPublicIp

createPublicIp

CreatePublicIpResponse createPublicIp(createPublicIpRequest)

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.PublicIpApi;

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");

    PublicIpApi apiInstance = new PublicIpApi(defaultClient);
    CreatePublicIpRequest createPublicIpRequest = new CreatePublicIpRequest(); // CreatePublicIpRequest | 
    try {
      CreatePublicIpResponse result = apiInstance.createPublicIp(createPublicIpRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PublicIpApi#createPublicIp");
      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
createPublicIpRequest	CreatePublicIpRequest		[optional]

Return type

CreatePublicIpResponse

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).	-

deletePublicIp

DeletePublicIpResponse deletePublicIp(deletePublicIpRequest)

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.PublicIpApi;

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");

    PublicIpApi apiInstance = new PublicIpApi(defaultClient);
    DeletePublicIpRequest deletePublicIpRequest = new DeletePublicIpRequest(); // DeletePublicIpRequest | 
    try {
      DeletePublicIpResponse result = apiInstance.deletePublicIp(deletePublicIpRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PublicIpApi#deletePublicIp");
      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
deletePublicIpRequest	DeletePublicIpRequest		[optional]

Return type

DeletePublicIpResponse

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).	-

linkPublicIp

LinkPublicIpResponse linkPublicIp(linkPublicIpRequest)

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.PublicIpApi;

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");

    PublicIpApi apiInstance = new PublicIpApi(defaultClient);
    LinkPublicIpRequest linkPublicIpRequest = new LinkPublicIpRequest(); // LinkPublicIpRequest | 
    try {
      LinkPublicIpResponse result = apiInstance.linkPublicIp(linkPublicIpRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PublicIpApi#linkPublicIp");
      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
linkPublicIpRequest	LinkPublicIpRequest		[optional]

Return type

LinkPublicIpResponse

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).	-

readPublicIpRanges

ReadPublicIpRangesResponse readPublicIpRanges(readPublicIpRangesRequest)

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.models.*;
import io.github.outscale.osc_sdk_java.client.api.PublicIpApi;

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")

    PublicIpApi apiInstance = new PublicIpApi(defaultClient);
    ReadPublicIpRangesRequest readPublicIpRangesRequest = new ReadPublicIpRangesRequest(); // ReadPublicIpRangesRequest | 
    try {
      ReadPublicIpRangesResponse result = apiInstance.readPublicIpRanges(readPublicIpRangesRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PublicIpApi#readPublicIpRanges");
      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
readPublicIpRangesRequest	ReadPublicIpRangesRequest		[optional]

Return type

ReadPublicIpRangesResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	The HTTP 200 response (OK).	-

readPublicIps

ReadPublicIpsResponse readPublicIps(readPublicIpsRequest)

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.PublicIpApi;

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");

    PublicIpApi apiInstance = new PublicIpApi(defaultClient);
    ReadPublicIpsRequest readPublicIpsRequest = new ReadPublicIpsRequest(); // ReadPublicIpsRequest | 
    try {
      ReadPublicIpsResponse result = apiInstance.readPublicIps(readPublicIpsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PublicIpApi#readPublicIps");
      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
readPublicIpsRequest	ReadPublicIpsRequest		[optional]

Return type

ReadPublicIpsResponse

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).	-

unlinkPublicIp

UnlinkPublicIpResponse unlinkPublicIp(unlinkPublicIpRequest)

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.PublicIpApi;

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");

    PublicIpApi apiInstance = new PublicIpApi(defaultClient);
    UnlinkPublicIpRequest unlinkPublicIpRequest = new UnlinkPublicIpRequest(); // UnlinkPublicIpRequest | 
    try {
      UnlinkPublicIpResponse result = apiInstance.unlinkPublicIp(unlinkPublicIpRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PublicIpApi#unlinkPublicIp");
      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
unlinkPublicIpRequest	UnlinkPublicIpRequest		[optional]

Return type

UnlinkPublicIpResponse

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).	-

Files

PublicIpApi.md

Latest commit

History

PublicIpApi.md

File metadata and controls

PublicIpApi

createPublicIp

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deletePublicIp

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

linkPublicIp

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

readPublicIpRanges

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

readPublicIps

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

unlinkPublicIp

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details