OperatorApi

All URIs are relative to http://127.0.0.1:4646/v1

Method	HTTP request	Description
deleteOperatorRaftPeer	DELETE /operator/raft/peer
getOperatorAutopilotConfiguration	GET /operator/autopilot/configuration
getOperatorAutopilotHealth	GET /operator/autopilot/health
getOperatorRaftConfiguration	GET /operator/raft/configuration
getOperatorSchedulerConfiguration	GET /operator/scheduler/configuration
postOperatorSchedulerConfiguration	POST /operator/scheduler/configuration
putOperatorAutopilotConfiguration	PUT /operator/autopilot/configuration

deleteOperatorRaftPeer

deleteOperatorRaftPeer(region, namespace, xNomadToken, idempotencyToken)

Example

// Import classes:
import io.nomadproject.client.ApiClient;
import io.nomadproject.client.ApiException;
import io.nomadproject.client.Configuration;
import io.nomadproject.client.auth.*;
import io.nomadproject.client.models.*;
import io.nomadproject.client.api.OperatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://127.0.0.1:4646/v1");
    
    // Configure API key authorization: X-Nomad-Token
    ApiKeyAuth X-Nomad-Token = (ApiKeyAuth) defaultClient.getAuthentication("X-Nomad-Token");
    X-Nomad-Token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //X-Nomad-Token.setApiKeyPrefix("Token");

    OperatorApi apiInstance = new OperatorApi(defaultClient);
    String region = "region_example"; // String | Filters results based on the specified region.
    String namespace = "namespace_example"; // String | Filters results based on the specified namespace.
    String xNomadToken = "xNomadToken_example"; // String | A Nomad ACL token.
    String idempotencyToken = "idempotencyToken_example"; // String | Can be used to ensure operations are only run once.
    try {
      apiInstance.deleteOperatorRaftPeer(region, namespace, xNomadToken, idempotencyToken);
    } catch (ApiException e) {
      System.err.println("Exception when calling OperatorApi#deleteOperatorRaftPeer");
      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
region	String	Filters results based on the specified region.	[optional]
namespace	String	Filters results based on the specified namespace.	[optional]
xNomadToken	String	A Nomad ACL token.	[optional]
idempotencyToken	String	Can be used to ensure operations are only run once.	[optional]

Return type

null (empty response body)

Authorization

X-Nomad-Token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200		-
400	Bad request	-
403	Forbidden	-
405	Method not allowed	-
500	Internal server error	-

getOperatorAutopilotConfiguration

AutopilotConfiguration getOperatorAutopilotConfiguration(region, namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken)

Example

// Import classes:
import io.nomadproject.client.ApiClient;
import io.nomadproject.client.ApiException;
import io.nomadproject.client.Configuration;
import io.nomadproject.client.auth.*;
import io.nomadproject.client.models.*;
import io.nomadproject.client.api.OperatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://127.0.0.1:4646/v1");
    
    // Configure API key authorization: X-Nomad-Token
    ApiKeyAuth X-Nomad-Token = (ApiKeyAuth) defaultClient.getAuthentication("X-Nomad-Token");
    X-Nomad-Token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //X-Nomad-Token.setApiKeyPrefix("Token");

    OperatorApi apiInstance = new OperatorApi(defaultClient);
    String region = "region_example"; // String | Filters results based on the specified region.
    String namespace = "namespace_example"; // String | Filters results based on the specified namespace.
    Integer index = 56; // Integer | If set, wait until query exceeds given index. Must be provided with WaitParam.
    String wait = "wait_example"; // String | Provided with IndexParam to wait for change.
    String stale = "stale_example"; // String | If present, results will include stale reads.
    String prefix = "prefix_example"; // String | Constrains results to jobs that start with the defined prefix
    String xNomadToken = "xNomadToken_example"; // String | A Nomad ACL token.
    Integer perPage = 56; // Integer | Maximum number of results to return.
    String nextToken = "nextToken_example"; // String | Indicates where to start paging for queries that support pagination.
    try {
      AutopilotConfiguration result = apiInstance.getOperatorAutopilotConfiguration(region, namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OperatorApi#getOperatorAutopilotConfiguration");
      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
region	String	Filters results based on the specified region.	[optional]
namespace	String	Filters results based on the specified namespace.	[optional]
index	Integer	If set, wait until query exceeds given index. Must be provided with WaitParam.	[optional]
wait	String	Provided with IndexParam to wait for change.	[optional]
stale	String	If present, results will include stale reads.	[optional]
prefix	String	Constrains results to jobs that start with the defined prefix	[optional]
xNomadToken	String	A Nomad ACL token.	[optional]
perPage	Integer	Maximum number of results to return.	[optional]
nextToken	String	Indicates where to start paging for queries that support pagination.	[optional]

Return type

AutopilotConfiguration

Authorization

X-Nomad-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
400	Bad request	-
403	Forbidden	-
405	Method not allowed	-
500	Internal server error	-

getOperatorAutopilotHealth

OperatorHealthReply getOperatorAutopilotHealth(region, namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken)

Example

// Import classes:
import io.nomadproject.client.ApiClient;
import io.nomadproject.client.ApiException;
import io.nomadproject.client.Configuration;
import io.nomadproject.client.auth.*;
import io.nomadproject.client.models.*;
import io.nomadproject.client.api.OperatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://127.0.0.1:4646/v1");
    
    // Configure API key authorization: X-Nomad-Token
    ApiKeyAuth X-Nomad-Token = (ApiKeyAuth) defaultClient.getAuthentication("X-Nomad-Token");
    X-Nomad-Token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //X-Nomad-Token.setApiKeyPrefix("Token");

    OperatorApi apiInstance = new OperatorApi(defaultClient);
    String region = "region_example"; // String | Filters results based on the specified region.
    String namespace = "namespace_example"; // String | Filters results based on the specified namespace.
    Integer index = 56; // Integer | If set, wait until query exceeds given index. Must be provided with WaitParam.
    String wait = "wait_example"; // String | Provided with IndexParam to wait for change.
    String stale = "stale_example"; // String | If present, results will include stale reads.
    String prefix = "prefix_example"; // String | Constrains results to jobs that start with the defined prefix
    String xNomadToken = "xNomadToken_example"; // String | A Nomad ACL token.
    Integer perPage = 56; // Integer | Maximum number of results to return.
    String nextToken = "nextToken_example"; // String | Indicates where to start paging for queries that support pagination.
    try {
      OperatorHealthReply result = apiInstance.getOperatorAutopilotHealth(region, namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OperatorApi#getOperatorAutopilotHealth");
      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
region	String	Filters results based on the specified region.	[optional]
namespace	String	Filters results based on the specified namespace.	[optional]
index	Integer	If set, wait until query exceeds given index. Must be provided with WaitParam.	[optional]
wait	String	Provided with IndexParam to wait for change.	[optional]
stale	String	If present, results will include stale reads.	[optional]
prefix	String	Constrains results to jobs that start with the defined prefix	[optional]
xNomadToken	String	A Nomad ACL token.	[optional]
perPage	Integer	Maximum number of results to return.	[optional]
nextToken	String	Indicates where to start paging for queries that support pagination.	[optional]

Return type

OperatorHealthReply

Authorization

X-Nomad-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
400	Bad request	-
403	Forbidden	-
405	Method not allowed	-
500	Internal server error	-

getOperatorRaftConfiguration

RaftConfiguration getOperatorRaftConfiguration(region, namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken)

Example

// Import classes:
import io.nomadproject.client.ApiClient;
import io.nomadproject.client.ApiException;
import io.nomadproject.client.Configuration;
import io.nomadproject.client.auth.*;
import io.nomadproject.client.models.*;
import io.nomadproject.client.api.OperatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://127.0.0.1:4646/v1");
    
    // Configure API key authorization: X-Nomad-Token
    ApiKeyAuth X-Nomad-Token = (ApiKeyAuth) defaultClient.getAuthentication("X-Nomad-Token");
    X-Nomad-Token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //X-Nomad-Token.setApiKeyPrefix("Token");

    OperatorApi apiInstance = new OperatorApi(defaultClient);
    String region = "region_example"; // String | Filters results based on the specified region.
    String namespace = "namespace_example"; // String | Filters results based on the specified namespace.
    Integer index = 56; // Integer | If set, wait until query exceeds given index. Must be provided with WaitParam.
    String wait = "wait_example"; // String | Provided with IndexParam to wait for change.
    String stale = "stale_example"; // String | If present, results will include stale reads.
    String prefix = "prefix_example"; // String | Constrains results to jobs that start with the defined prefix
    String xNomadToken = "xNomadToken_example"; // String | A Nomad ACL token.
    Integer perPage = 56; // Integer | Maximum number of results to return.
    String nextToken = "nextToken_example"; // String | Indicates where to start paging for queries that support pagination.
    try {
      RaftConfiguration result = apiInstance.getOperatorRaftConfiguration(region, namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OperatorApi#getOperatorRaftConfiguration");
      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
region	String	Filters results based on the specified region.	[optional]
namespace	String	Filters results based on the specified namespace.	[optional]
index	Integer	If set, wait until query exceeds given index. Must be provided with WaitParam.	[optional]
wait	String	Provided with IndexParam to wait for change.	[optional]
stale	String	If present, results will include stale reads.	[optional]
prefix	String	Constrains results to jobs that start with the defined prefix	[optional]
xNomadToken	String	A Nomad ACL token.	[optional]
perPage	Integer	Maximum number of results to return.	[optional]
nextToken	String	Indicates where to start paging for queries that support pagination.	[optional]

Return type

RaftConfiguration

Authorization

X-Nomad-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
400	Bad request	-
403	Forbidden	-
405	Method not allowed	-
500	Internal server error	-

getOperatorSchedulerConfiguration

SchedulerConfigurationResponse getOperatorSchedulerConfiguration(region, namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken)

Example

// Import classes:
import io.nomadproject.client.ApiClient;
import io.nomadproject.client.ApiException;
import io.nomadproject.client.Configuration;
import io.nomadproject.client.auth.*;
import io.nomadproject.client.models.*;
import io.nomadproject.client.api.OperatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://127.0.0.1:4646/v1");
    
    // Configure API key authorization: X-Nomad-Token
    ApiKeyAuth X-Nomad-Token = (ApiKeyAuth) defaultClient.getAuthentication("X-Nomad-Token");
    X-Nomad-Token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //X-Nomad-Token.setApiKeyPrefix("Token");

    OperatorApi apiInstance = new OperatorApi(defaultClient);
    String region = "region_example"; // String | Filters results based on the specified region.
    String namespace = "namespace_example"; // String | Filters results based on the specified namespace.
    Integer index = 56; // Integer | If set, wait until query exceeds given index. Must be provided with WaitParam.
    String wait = "wait_example"; // String | Provided with IndexParam to wait for change.
    String stale = "stale_example"; // String | If present, results will include stale reads.
    String prefix = "prefix_example"; // String | Constrains results to jobs that start with the defined prefix
    String xNomadToken = "xNomadToken_example"; // String | A Nomad ACL token.
    Integer perPage = 56; // Integer | Maximum number of results to return.
    String nextToken = "nextToken_example"; // String | Indicates where to start paging for queries that support pagination.
    try {
      SchedulerConfigurationResponse result = apiInstance.getOperatorSchedulerConfiguration(region, namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OperatorApi#getOperatorSchedulerConfiguration");
      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
region	String	Filters results based on the specified region.	[optional]
namespace	String	Filters results based on the specified namespace.	[optional]
index	Integer	If set, wait until query exceeds given index. Must be provided with WaitParam.	[optional]
wait	String	Provided with IndexParam to wait for change.	[optional]
stale	String	If present, results will include stale reads.	[optional]
prefix	String	Constrains results to jobs that start with the defined prefix	[optional]
xNomadToken	String	A Nomad ACL token.	[optional]
perPage	Integer	Maximum number of results to return.	[optional]
nextToken	String	Indicates where to start paging for queries that support pagination.	[optional]

Return type

SchedulerConfigurationResponse

Authorization

X-Nomad-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		* X-Nomad-Index - A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. * X-Nomad-KnownLeader - Boolean indicating if there is a known cluster leader. * X-Nomad-LastContact - The time in milliseconds that a server was last contacted by the leader node.
400	Bad request	-
403	Forbidden	-
405	Method not allowed	-
500	Internal server error	-

postOperatorSchedulerConfiguration

SchedulerSetConfigurationResponse postOperatorSchedulerConfiguration(schedulerConfiguration, region, namespace, xNomadToken, idempotencyToken)

Example

// Import classes:
import io.nomadproject.client.ApiClient;
import io.nomadproject.client.ApiException;
import io.nomadproject.client.Configuration;
import io.nomadproject.client.auth.*;
import io.nomadproject.client.models.*;
import io.nomadproject.client.api.OperatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://127.0.0.1:4646/v1");
    
    // Configure API key authorization: X-Nomad-Token
    ApiKeyAuth X-Nomad-Token = (ApiKeyAuth) defaultClient.getAuthentication("X-Nomad-Token");
    X-Nomad-Token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //X-Nomad-Token.setApiKeyPrefix("Token");

    OperatorApi apiInstance = new OperatorApi(defaultClient);
    SchedulerConfiguration schedulerConfiguration = new SchedulerConfiguration(); // SchedulerConfiguration | 
    String region = "region_example"; // String | Filters results based on the specified region.
    String namespace = "namespace_example"; // String | Filters results based on the specified namespace.
    String xNomadToken = "xNomadToken_example"; // String | A Nomad ACL token.
    String idempotencyToken = "idempotencyToken_example"; // String | Can be used to ensure operations are only run once.
    try {
      SchedulerSetConfigurationResponse result = apiInstance.postOperatorSchedulerConfiguration(schedulerConfiguration, region, namespace, xNomadToken, idempotencyToken);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OperatorApi#postOperatorSchedulerConfiguration");
      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
schedulerConfiguration	SchedulerConfiguration
region	String	Filters results based on the specified region.	[optional]
namespace	String	Filters results based on the specified namespace.	[optional]
xNomadToken	String	A Nomad ACL token.	[optional]
idempotencyToken	String	Can be used to ensure operations are only run once.	[optional]

Return type

SchedulerSetConfigurationResponse

Authorization

X-Nomad-Token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		* X-Nomad-Index - A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1.
400	Bad request	-
403	Forbidden	-
405	Method not allowed	-
500	Internal server error	-

putOperatorAutopilotConfiguration

Boolean putOperatorAutopilotConfiguration(autopilotConfiguration, region, namespace, xNomadToken, idempotencyToken)

Example

// Import classes:
import io.nomadproject.client.ApiClient;
import io.nomadproject.client.ApiException;
import io.nomadproject.client.Configuration;
import io.nomadproject.client.auth.*;
import io.nomadproject.client.models.*;
import io.nomadproject.client.api.OperatorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://127.0.0.1:4646/v1");
    
    // Configure API key authorization: X-Nomad-Token
    ApiKeyAuth X-Nomad-Token = (ApiKeyAuth) defaultClient.getAuthentication("X-Nomad-Token");
    X-Nomad-Token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //X-Nomad-Token.setApiKeyPrefix("Token");

    OperatorApi apiInstance = new OperatorApi(defaultClient);
    AutopilotConfiguration autopilotConfiguration = new AutopilotConfiguration(); // AutopilotConfiguration | 
    String region = "region_example"; // String | Filters results based on the specified region.
    String namespace = "namespace_example"; // String | Filters results based on the specified namespace.
    String xNomadToken = "xNomadToken_example"; // String | A Nomad ACL token.
    String idempotencyToken = "idempotencyToken_example"; // String | Can be used to ensure operations are only run once.
    try {
      Boolean result = apiInstance.putOperatorAutopilotConfiguration(autopilotConfiguration, region, namespace, xNomadToken, idempotencyToken);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OperatorApi#putOperatorAutopilotConfiguration");
      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
autopilotConfiguration	AutopilotConfiguration
region	String	Filters results based on the specified region.	[optional]
namespace	String	Filters results based on the specified namespace.	[optional]
xNomadToken	String	A Nomad ACL token.	[optional]
idempotencyToken	String	Can be used to ensure operations are only run once.	[optional]

Return type

Boolean

Authorization

X-Nomad-Token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400	Bad request	-
403	Forbidden	-
405	Method not allowed	-
500	Internal server error	-

FilesExpand file tree

OperatorApi.md

Latest commit

History

OperatorApi.md

File metadata and controls

OperatorApi

deleteOperatorRaftPeer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getOperatorAutopilotConfiguration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getOperatorAutopilotHealth

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getOperatorRaftConfiguration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getOperatorSchedulerConfiguration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

postOperatorSchedulerConfiguration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

putOperatorAutopilotConfiguration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details