Fermyon.Nomad.Api.NodesApi

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

Method	HTTP request	Description
GetNode	GET /node/{nodeId}
GetNodeAllocations	GET /node/{nodeId}/allocations
GetNodes	GET /nodes
UpdateNodeDrain	POST /node/{nodeId}/drain
UpdateNodeEligibility	POST /node/{nodeId}/eligibility
UpdateNodePurge	POST /node/{nodeId}/purge

GetNode

Node GetNode (string nodeId, string? region = null, string? _namespace = null, int? index = null, string? wait = null, string? stale = null, string? prefix = null, string? xNomadToken = null, int? perPage = null, string? nextToken = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Fermyon.Nomad.Api;
using Fermyon.Nomad.Client;
using Fermyon.Nomad.Model;

namespace Example
{
    public class GetNodeExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://127.0.0.1:4646/v1";
            // Configure API key authorization: X-Nomad-Token
            config.AddApiKey("X-Nomad-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-Nomad-Token", "Bearer");

            var apiInstance = new NodesApi(config);
            var nodeId = "nodeId_example";  // string | The ID of the node.
            var region = "region_example";  // string? | Filters results based on the specified region. (optional) 
            var _namespace = "_namespace_example";  // string? | Filters results based on the specified namespace. (optional) 
            var index = 56;  // int? | If set, wait until query exceeds given index. Must be provided with WaitParam. (optional) 
            var wait = "wait_example";  // string? | Provided with IndexParam to wait for change. (optional) 
            var stale = "stale_example";  // string? | If present, results will include stale reads. (optional) 
            var prefix = "prefix_example";  // string? | Constrains results to jobs that start with the defined prefix (optional) 
            var xNomadToken = "xNomadToken_example";  // string? | A Nomad ACL token. (optional) 
            var perPage = 56;  // int? | Maximum number of results to return. (optional) 
            var nextToken = "nextToken_example";  // string? | Indicates where to start paging for queries that support pagination. (optional) 

            try
            {
                Node result = apiInstance.GetNode(nodeId, region, _namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling NodesApi.GetNode: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetNodeWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<Node> response = apiInstance.GetNodeWithHttpInfo(nodeId, region, _namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling NodesApi.GetNodeWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
nodeId	string	The ID of the node.
region	string?	Filters results based on the specified region.	[optional]
_namespace	string?	Filters results based on the specified namespace.	[optional]
index	int?	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	int?	Maximum number of results to return.	[optional]
nextToken	string?	Indicates where to start paging for queries that support pagination.	[optional]

Return type

Node

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	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetNodeAllocations

List<AllocationListStub> GetNodeAllocations (string nodeId, string? region = null, string? _namespace = null, int? index = null, string? wait = null, string? stale = null, string? prefix = null, string? xNomadToken = null, int? perPage = null, string? nextToken = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Fermyon.Nomad.Api;
using Fermyon.Nomad.Client;
using Fermyon.Nomad.Model;

namespace Example
{
    public class GetNodeAllocationsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://127.0.0.1:4646/v1";
            // Configure API key authorization: X-Nomad-Token
            config.AddApiKey("X-Nomad-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-Nomad-Token", "Bearer");

            var apiInstance = new NodesApi(config);
            var nodeId = "nodeId_example";  // string | The ID of the node.
            var region = "region_example";  // string? | Filters results based on the specified region. (optional) 
            var _namespace = "_namespace_example";  // string? | Filters results based on the specified namespace. (optional) 
            var index = 56;  // int? | If set, wait until query exceeds given index. Must be provided with WaitParam. (optional) 
            var wait = "wait_example";  // string? | Provided with IndexParam to wait for change. (optional) 
            var stale = "stale_example";  // string? | If present, results will include stale reads. (optional) 
            var prefix = "prefix_example";  // string? | Constrains results to jobs that start with the defined prefix (optional) 
            var xNomadToken = "xNomadToken_example";  // string? | A Nomad ACL token. (optional) 
            var perPage = 56;  // int? | Maximum number of results to return. (optional) 
            var nextToken = "nextToken_example";  // string? | Indicates where to start paging for queries that support pagination. (optional) 

            try
            {
                List<AllocationListStub> result = apiInstance.GetNodeAllocations(nodeId, region, _namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling NodesApi.GetNodeAllocations: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetNodeAllocationsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<List<AllocationListStub>> response = apiInstance.GetNodeAllocationsWithHttpInfo(nodeId, region, _namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling NodesApi.GetNodeAllocationsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
nodeId	string	The ID of the node.
region	string?	Filters results based on the specified region.	[optional]
_namespace	string?	Filters results based on the specified namespace.	[optional]
index	int?	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	int?	Maximum number of results to return.	[optional]
nextToken	string?	Indicates where to start paging for queries that support pagination.	[optional]

Return type

List<AllocationListStub>

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	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetNodes

List<NodeListStub> GetNodes (string? region = null, string? _namespace = null, int? index = null, string? wait = null, string? stale = null, string? prefix = null, string? xNomadToken = null, int? perPage = null, string? nextToken = null, bool? resources = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Fermyon.Nomad.Api;
using Fermyon.Nomad.Client;
using Fermyon.Nomad.Model;

namespace Example
{
    public class GetNodesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://127.0.0.1:4646/v1";
            // Configure API key authorization: X-Nomad-Token
            config.AddApiKey("X-Nomad-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-Nomad-Token", "Bearer");

            var apiInstance = new NodesApi(config);
            var region = "region_example";  // string? | Filters results based on the specified region. (optional) 
            var _namespace = "_namespace_example";  // string? | Filters results based on the specified namespace. (optional) 
            var index = 56;  // int? | If set, wait until query exceeds given index. Must be provided with WaitParam. (optional) 
            var wait = "wait_example";  // string? | Provided with IndexParam to wait for change. (optional) 
            var stale = "stale_example";  // string? | If present, results will include stale reads. (optional) 
            var prefix = "prefix_example";  // string? | Constrains results to jobs that start with the defined prefix (optional) 
            var xNomadToken = "xNomadToken_example";  // string? | A Nomad ACL token. (optional) 
            var perPage = 56;  // int? | Maximum number of results to return. (optional) 
            var nextToken = "nextToken_example";  // string? | Indicates where to start paging for queries that support pagination. (optional) 
            var resources = true;  // bool? | Whether or not to include the NodeResources and ReservedResources fields in the response. (optional) 

            try
            {
                List<NodeListStub> result = apiInstance.GetNodes(region, _namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken, resources);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling NodesApi.GetNodes: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetNodesWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<List<NodeListStub>> response = apiInstance.GetNodesWithHttpInfo(region, _namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken, resources);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling NodesApi.GetNodesWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

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	int?	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	int?	Maximum number of results to return.	[optional]
nextToken	string?	Indicates where to start paging for queries that support pagination.	[optional]
resources	bool?	Whether or not to include the NodeResources and ReservedResources fields in the response.	[optional]

Return type

List<NodeListStub>

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	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateNodeDrain

NodeDrainUpdateResponse UpdateNodeDrain (string nodeId, NodeUpdateDrainRequest nodeUpdateDrainRequest, string? region = null, string? _namespace = null, int? index = null, string? wait = null, string? stale = null, string? prefix = null, string? xNomadToken = null, int? perPage = null, string? nextToken = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Fermyon.Nomad.Api;
using Fermyon.Nomad.Client;
using Fermyon.Nomad.Model;

namespace Example
{
    public class UpdateNodeDrainExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://127.0.0.1:4646/v1";
            // Configure API key authorization: X-Nomad-Token
            config.AddApiKey("X-Nomad-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-Nomad-Token", "Bearer");

            var apiInstance = new NodesApi(config);
            var nodeId = "nodeId_example";  // string | The ID of the node.
            var nodeUpdateDrainRequest = new NodeUpdateDrainRequest(); // NodeUpdateDrainRequest | 
            var region = "region_example";  // string? | Filters results based on the specified region. (optional) 
            var _namespace = "_namespace_example";  // string? | Filters results based on the specified namespace. (optional) 
            var index = 56;  // int? | If set, wait until query exceeds given index. Must be provided with WaitParam. (optional) 
            var wait = "wait_example";  // string? | Provided with IndexParam to wait for change. (optional) 
            var stale = "stale_example";  // string? | If present, results will include stale reads. (optional) 
            var prefix = "prefix_example";  // string? | Constrains results to jobs that start with the defined prefix (optional) 
            var xNomadToken = "xNomadToken_example";  // string? | A Nomad ACL token. (optional) 
            var perPage = 56;  // int? | Maximum number of results to return. (optional) 
            var nextToken = "nextToken_example";  // string? | Indicates where to start paging for queries that support pagination. (optional) 

            try
            {
                NodeDrainUpdateResponse result = apiInstance.UpdateNodeDrain(nodeId, nodeUpdateDrainRequest, region, _namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling NodesApi.UpdateNodeDrain: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the UpdateNodeDrainWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<NodeDrainUpdateResponse> response = apiInstance.UpdateNodeDrainWithHttpInfo(nodeId, nodeUpdateDrainRequest, region, _namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling NodesApi.UpdateNodeDrainWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
nodeId	string	The ID of the node.
nodeUpdateDrainRequest	NodeUpdateDrainRequest
region	string?	Filters results based on the specified region.	[optional]
_namespace	string?	Filters results based on the specified namespace.	[optional]
index	int?	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	int?	Maximum number of results to return.	[optional]
nextToken	string?	Indicates where to start paging for queries that support pagination.	[optional]

Return type

NodeDrainUpdateResponse

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	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateNodeEligibility

NodeEligibilityUpdateResponse UpdateNodeEligibility (string nodeId, NodeUpdateEligibilityRequest nodeUpdateEligibilityRequest, string? region = null, string? _namespace = null, int? index = null, string? wait = null, string? stale = null, string? prefix = null, string? xNomadToken = null, int? perPage = null, string? nextToken = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Fermyon.Nomad.Api;
using Fermyon.Nomad.Client;
using Fermyon.Nomad.Model;

namespace Example
{
    public class UpdateNodeEligibilityExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://127.0.0.1:4646/v1";
            // Configure API key authorization: X-Nomad-Token
            config.AddApiKey("X-Nomad-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-Nomad-Token", "Bearer");

            var apiInstance = new NodesApi(config);
            var nodeId = "nodeId_example";  // string | The ID of the node.
            var nodeUpdateEligibilityRequest = new NodeUpdateEligibilityRequest(); // NodeUpdateEligibilityRequest | 
            var region = "region_example";  // string? | Filters results based on the specified region. (optional) 
            var _namespace = "_namespace_example";  // string? | Filters results based on the specified namespace. (optional) 
            var index = 56;  // int? | If set, wait until query exceeds given index. Must be provided with WaitParam. (optional) 
            var wait = "wait_example";  // string? | Provided with IndexParam to wait for change. (optional) 
            var stale = "stale_example";  // string? | If present, results will include stale reads. (optional) 
            var prefix = "prefix_example";  // string? | Constrains results to jobs that start with the defined prefix (optional) 
            var xNomadToken = "xNomadToken_example";  // string? | A Nomad ACL token. (optional) 
            var perPage = 56;  // int? | Maximum number of results to return. (optional) 
            var nextToken = "nextToken_example";  // string? | Indicates where to start paging for queries that support pagination. (optional) 

            try
            {
                NodeEligibilityUpdateResponse result = apiInstance.UpdateNodeEligibility(nodeId, nodeUpdateEligibilityRequest, region, _namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling NodesApi.UpdateNodeEligibility: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the UpdateNodeEligibilityWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<NodeEligibilityUpdateResponse> response = apiInstance.UpdateNodeEligibilityWithHttpInfo(nodeId, nodeUpdateEligibilityRequest, region, _namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling NodesApi.UpdateNodeEligibilityWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
nodeId	string	The ID of the node.
nodeUpdateEligibilityRequest	NodeUpdateEligibilityRequest
region	string?	Filters results based on the specified region.	[optional]
_namespace	string?	Filters results based on the specified namespace.	[optional]
index	int?	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	int?	Maximum number of results to return.	[optional]
nextToken	string?	Indicates where to start paging for queries that support pagination.	[optional]

Return type

NodeEligibilityUpdateResponse

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	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateNodePurge

NodePurgeResponse UpdateNodePurge (string nodeId, string? region = null, string? _namespace = null, int? index = null, string? wait = null, string? stale = null, string? prefix = null, string? xNomadToken = null, int? perPage = null, string? nextToken = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Fermyon.Nomad.Api;
using Fermyon.Nomad.Client;
using Fermyon.Nomad.Model;

namespace Example
{
    public class UpdateNodePurgeExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://127.0.0.1:4646/v1";
            // Configure API key authorization: X-Nomad-Token
            config.AddApiKey("X-Nomad-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-Nomad-Token", "Bearer");

            var apiInstance = new NodesApi(config);
            var nodeId = "nodeId_example";  // string | The ID of the node.
            var region = "region_example";  // string? | Filters results based on the specified region. (optional) 
            var _namespace = "_namespace_example";  // string? | Filters results based on the specified namespace. (optional) 
            var index = 56;  // int? | If set, wait until query exceeds given index. Must be provided with WaitParam. (optional) 
            var wait = "wait_example";  // string? | Provided with IndexParam to wait for change. (optional) 
            var stale = "stale_example";  // string? | If present, results will include stale reads. (optional) 
            var prefix = "prefix_example";  // string? | Constrains results to jobs that start with the defined prefix (optional) 
            var xNomadToken = "xNomadToken_example";  // string? | A Nomad ACL token. (optional) 
            var perPage = 56;  // int? | Maximum number of results to return. (optional) 
            var nextToken = "nextToken_example";  // string? | Indicates where to start paging for queries that support pagination. (optional) 

            try
            {
                NodePurgeResponse result = apiInstance.UpdateNodePurge(nodeId, region, _namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling NodesApi.UpdateNodePurge: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the UpdateNodePurgeWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<NodePurgeResponse> response = apiInstance.UpdateNodePurgeWithHttpInfo(nodeId, region, _namespace, index, wait, stale, prefix, xNomadToken, perPage, nextToken);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling NodesApi.UpdateNodePurgeWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
nodeId	string	The ID of the node.
region	string?	Filters results based on the specified region.	[optional]
_namespace	string?	Filters results based on the specified namespace.	[optional]
index	int?	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	int?	Maximum number of results to return.	[optional]
nextToken	string?	Indicates where to start paging for queries that support pagination.	[optional]

Return type

NodePurgeResponse

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.
400	Bad request	-
403	Forbidden	-
405	Method not allowed	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

NodesApi.md

Latest commit

History

NodesApi.md

File metadata and controls

Fermyon.Nomad.Api.NodesApi

GetNode

Example

Using the GetNodeWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetNodeAllocations

Example

Using the GetNodeAllocationsWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetNodes

Example

Using the GetNodesWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

UpdateNodeDrain

Example

Using the UpdateNodeDrainWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

UpdateNodeEligibility

Example

Using the UpdateNodeEligibilityWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

UpdateNodePurge

Example

Using the UpdateNodePurgeWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details