Skip to content

Latest commit

 

History

History
254 lines (152 loc) · 10.5 KB

OperatorApi.md

File metadata and controls

254 lines (152 loc) · 10.5 KB
Raw

\OperatorApi

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

Method HTTP request Description
delete_operator_raft_peer DELETE /operator/raft/peer
get_operator_autopilot_configuration GET /operator/autopilot/configuration
get_operator_autopilot_health GET /operator/autopilot/health
get_operator_raft_configuration GET /operator/raft/configuration
get_operator_scheduler_configuration GET /operator/scheduler/configuration
post_operator_scheduler_configuration POST /operator/scheduler/configuration
put_operator_autopilot_configuration PUT /operator/autopilot/configuration

delete_operator_raft_peer

delete_operator_raft_peer(region, namespace, x_nomad_token, idempotency_token)

Parameters

Name Type Description Required Notes
region Option<String> Filters results based on the specified region.
namespace Option<String> Filters results based on the specified namespace.
x_nomad_token Option<String> A Nomad ACL token.
idempotency_token Option<String> Can be used to ensure operations are only run once.

Return type

(empty response body)

Authorization

X-Nomad-Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

get_operator_autopilot_configuration

crate::models::AutopilotConfiguration get_operator_autopilot_configuration(region, namespace, index, wait, stale, prefix, x_nomad_token, per_page, next_token)

Parameters

Name Type Description Required Notes
region Option<String> Filters results based on the specified region.
namespace Option<String> Filters results based on the specified namespace.
index Option<i32> If set, wait until query exceeds given index. Must be provided with WaitParam.
wait Option<String> Provided with IndexParam to wait for change.
stale Option<String> If present, results will include stale reads.
prefix Option<String> Constrains results to jobs that start with the defined prefix
x_nomad_token Option<String> A Nomad ACL token.
per_page Option<i32> Maximum number of results to return.
next_token Option<String> Indicates where to start paging for queries that support pagination.

Return type

crate::models::AutopilotConfiguration

Authorization

X-Nomad-Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

get_operator_autopilot_health

crate::models::OperatorHealthReply get_operator_autopilot_health(region, namespace, index, wait, stale, prefix, x_nomad_token, per_page, next_token)

Parameters

Name Type Description Required Notes
region Option<String> Filters results based on the specified region.
namespace Option<String> Filters results based on the specified namespace.
index Option<i32> If set, wait until query exceeds given index. Must be provided with WaitParam.
wait Option<String> Provided with IndexParam to wait for change.
stale Option<String> If present, results will include stale reads.
prefix Option<String> Constrains results to jobs that start with the defined prefix
x_nomad_token Option<String> A Nomad ACL token.
per_page Option<i32> Maximum number of results to return.
next_token Option<String> Indicates where to start paging for queries that support pagination.

Return type

crate::models::OperatorHealthReply

Authorization

X-Nomad-Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

get_operator_raft_configuration

crate::models::RaftConfiguration get_operator_raft_configuration(region, namespace, index, wait, stale, prefix, x_nomad_token, per_page, next_token)

Parameters

Name Type Description Required Notes
region Option<String> Filters results based on the specified region.
namespace Option<String> Filters results based on the specified namespace.
index Option<i32> If set, wait until query exceeds given index. Must be provided with WaitParam.
wait Option<String> Provided with IndexParam to wait for change.
stale Option<String> If present, results will include stale reads.
prefix Option<String> Constrains results to jobs that start with the defined prefix
x_nomad_token Option<String> A Nomad ACL token.
per_page Option<i32> Maximum number of results to return.
next_token Option<String> Indicates where to start paging for queries that support pagination.

Return type

crate::models::RaftConfiguration

Authorization

X-Nomad-Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

get_operator_scheduler_configuration

crate::models::SchedulerConfigurationResponse get_operator_scheduler_configuration(region, namespace, index, wait, stale, prefix, x_nomad_token, per_page, next_token)

Parameters

Name Type Description Required Notes
region Option<String> Filters results based on the specified region.
namespace Option<String> Filters results based on the specified namespace.
index Option<i32> If set, wait until query exceeds given index. Must be provided with WaitParam.
wait Option<String> Provided with IndexParam to wait for change.
stale Option<String> If present, results will include stale reads.
prefix Option<String> Constrains results to jobs that start with the defined prefix
x_nomad_token Option<String> A Nomad ACL token.
per_page Option<i32> Maximum number of results to return.
next_token Option<String> Indicates where to start paging for queries that support pagination.

Return type

crate::models::SchedulerConfigurationResponse

Authorization

X-Nomad-Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

post_operator_scheduler_configuration

crate::models::SchedulerSetConfigurationResponse post_operator_scheduler_configuration(scheduler_configuration, region, namespace, x_nomad_token, idempotency_token)

Parameters

Name Type Description Required Notes
scheduler_configuration SchedulerConfiguration [required]
region Option<String> Filters results based on the specified region.
namespace Option<String> Filters results based on the specified namespace.
x_nomad_token Option<String> A Nomad ACL token.
idempotency_token Option<String> Can be used to ensure operations are only run once.

Return type

crate::models::SchedulerSetConfigurationResponse

Authorization

X-Nomad-Token

HTTP request headers

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

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

put_operator_autopilot_configuration

bool put_operator_autopilot_configuration(autopilot_configuration, region, namespace, x_nomad_token, idempotency_token)

Parameters

Name Type Description Required Notes
autopilot_configuration AutopilotConfiguration [required]
region Option<String> Filters results based on the specified region.
namespace Option<String> Filters results based on the specified namespace.
x_nomad_token Option<String> A Nomad ACL token.
idempotency_token Option<String> Can be used to ensure operations are only run once.

Return type

bool

Authorization

X-Nomad-Token

HTTP request headers

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

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