SnapshotApi

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

Method	HTTP request	Description
createSnapshot	POST /CreateSnapshot
createSnapshotExportTask	POST /CreateSnapshotExportTask
deleteSnapshot	POST /DeleteSnapshot
readSnapshotExportTasks	POST /ReadSnapshotExportTasks
readSnapshots	POST /ReadSnapshots
updateSnapshot	POST /UpdateSnapshot

createSnapshot

CreateSnapshotResponse createSnapshot(createSnapshotRequest)

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

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

    SnapshotApi apiInstance = new SnapshotApi(defaultClient);
    CreateSnapshotRequest createSnapshotRequest = new CreateSnapshotRequest(); // CreateSnapshotRequest | 
    try {
      CreateSnapshotResponse result = apiInstance.createSnapshot(createSnapshotRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SnapshotApi#createSnapshot");
      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
createSnapshotRequest	CreateSnapshotRequest		[optional]

Return type

CreateSnapshotResponse

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

createSnapshotExportTask

CreateSnapshotExportTaskResponse createSnapshotExportTask(createSnapshotExportTaskRequest)

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

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

    SnapshotApi apiInstance = new SnapshotApi(defaultClient);
    CreateSnapshotExportTaskRequest createSnapshotExportTaskRequest = new CreateSnapshotExportTaskRequest(); // CreateSnapshotExportTaskRequest | 
    try {
      CreateSnapshotExportTaskResponse result = apiInstance.createSnapshotExportTask(createSnapshotExportTaskRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SnapshotApi#createSnapshotExportTask");
      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
createSnapshotExportTaskRequest	CreateSnapshotExportTaskRequest		[optional]

Return type

CreateSnapshotExportTaskResponse

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

deleteSnapshot

DeleteSnapshotResponse deleteSnapshot(deleteSnapshotRequest)

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

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

    SnapshotApi apiInstance = new SnapshotApi(defaultClient);
    DeleteSnapshotRequest deleteSnapshotRequest = new DeleteSnapshotRequest(); // DeleteSnapshotRequest | 
    try {
      DeleteSnapshotResponse result = apiInstance.deleteSnapshot(deleteSnapshotRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SnapshotApi#deleteSnapshot");
      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
deleteSnapshotRequest	DeleteSnapshotRequest		[optional]

Return type

DeleteSnapshotResponse

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

readSnapshotExportTasks

ReadSnapshotExportTasksResponse readSnapshotExportTasks(readSnapshotExportTasksRequest)

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

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

    SnapshotApi apiInstance = new SnapshotApi(defaultClient);
    ReadSnapshotExportTasksRequest readSnapshotExportTasksRequest = new ReadSnapshotExportTasksRequest(); // ReadSnapshotExportTasksRequest | 
    try {
      ReadSnapshotExportTasksResponse result = apiInstance.readSnapshotExportTasks(readSnapshotExportTasksRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SnapshotApi#readSnapshotExportTasks");
      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
readSnapshotExportTasksRequest	ReadSnapshotExportTasksRequest		[optional]

Return type

ReadSnapshotExportTasksResponse

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

readSnapshots

ReadSnapshotsResponse readSnapshots(readSnapshotsRequest)

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

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

    SnapshotApi apiInstance = new SnapshotApi(defaultClient);
    ReadSnapshotsRequest readSnapshotsRequest = new ReadSnapshotsRequest(); // ReadSnapshotsRequest | 
    try {
      ReadSnapshotsResponse result = apiInstance.readSnapshots(readSnapshotsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SnapshotApi#readSnapshots");
      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
readSnapshotsRequest	ReadSnapshotsRequest		[optional]

Return type

ReadSnapshotsResponse

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

updateSnapshot

UpdateSnapshotResponse updateSnapshot(updateSnapshotRequest)

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

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

    SnapshotApi apiInstance = new SnapshotApi(defaultClient);
    UpdateSnapshotRequest updateSnapshotRequest = new UpdateSnapshotRequest(); // UpdateSnapshotRequest | 
    try {
      UpdateSnapshotResponse result = apiInstance.updateSnapshot(updateSnapshotRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SnapshotApi#updateSnapshot");
      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
updateSnapshotRequest	UpdateSnapshotRequest		[optional]

Return type

UpdateSnapshotResponse

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

SnapshotApi.md

Latest commit

History

SnapshotApi.md

File metadata and controls

SnapshotApi

createSnapshot

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createSnapshotExportTask

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteSnapshot

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

readSnapshotExportTasks

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

readSnapshots

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateSnapshot

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details