Skip to content

Latest commit

 

History

History
227 lines (175 loc) · 7.81 KB

TagApi.md

File metadata and controls

227 lines (175 loc) · 7.81 KB

TagApi

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

Method HTTP request Description
createTags POST /CreateTags
deleteTags POST /DeleteTags
readTags POST /ReadTags

createTags

CreateTagsResponse createTags(createTagsRequest)

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

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

    TagApi apiInstance = new TagApi(defaultClient);
    CreateTagsRequest createTagsRequest = new CreateTagsRequest(); // CreateTagsRequest | 
    try {
      CreateTagsResponse result = apiInstance.createTags(createTagsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TagApi#createTags");
      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
createTagsRequest CreateTagsRequest [optional]

Return type

CreateTagsResponse

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

deleteTags

DeleteTagsResponse deleteTags(deleteTagsRequest)

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

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

    TagApi apiInstance = new TagApi(defaultClient);
    DeleteTagsRequest deleteTagsRequest = new DeleteTagsRequest(); // DeleteTagsRequest | 
    try {
      DeleteTagsResponse result = apiInstance.deleteTags(deleteTagsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TagApi#deleteTags");
      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
deleteTagsRequest DeleteTagsRequest [optional]

Return type

DeleteTagsResponse

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

readTags

ReadTagsResponse readTags(readTagsRequest)

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

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

    TagApi apiInstance = new TagApi(defaultClient);
    ReadTagsRequest readTagsRequest = new ReadTagsRequest(); // ReadTagsRequest | 
    try {
      ReadTagsResponse result = apiInstance.readTags(readTagsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TagApi#readTags");
      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
readTagsRequest ReadTagsRequest [optional]

Return type

ReadTagsResponse

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