Lib.rs

› Web编程
#nomad #openapi #client #hashi-corp #api-client #api-bindings #api-version

已弃用 nomad-client

[已弃用] HashiCorp Nomad API的Rust客户端

由 Nathan Flurry，Futuristic Coder 编写

10个版本

0.0.10 2023年2月12日
0.0.9 2022年10月21日
0.0.7 2022年7月23日
0.0.6 2021年10月3日
0.0.1 2021年4月3日

#9 in #nomad

Download history 681/week @ 2024-03-14 792/week @ 2024-03-21 586/week @ 2024-03-28 563/week @ 2024-04-04 1166/week @ 2024-04-11 644/week @ 2024-04-18 150/week @ 2024-04-25 141/week @ 2024-05-02 133/week @ 2024-05-09 301/week @ 2024-05-16 189/week @ 2024-05-23 513/week @ 2024-05-30 125/week @ 2024-06-06 149/week @ 2024-06-13 206/week @ 2024-06-20 896/week @ 2024-06-27

1,420 每月下载次数

MIT 许可证

415KB
7.5K SLoC

nomad-client

Crates.io docs.rs License

Nomad OpenApi规范

概述

此API客户端是由OpenAPI Generator项目生成的。

  • API版本：0.11.0
  • 包版本：0.0.10
  • 构建包：org.openapitools.codegen.languages.RustClientCodegen

安装

将包放在您的项目文件夹中，并在Cargo.toml中的[dependencies]下添加以下内容

nomad-client = "0.0.10"

API端点文档

所有URI相对于https://127.0.0.1:4646/v1

类 方法 HTTP请求 描述
AgentApi force_leave post /agent/force-leave 强制将Gossip池中的成员从“失败”状态转换为“离开”状态。
AgentApi get_health get /agent/health 执行基本健康检查
AgentApi get_members get /agent/members 查询Gossip池中已知对等点
AgentApi get_self get /agent/self 查询我们连接到的代理的信息
AgentApi get_servers get /agent/servers 查询客户端模式下的代理的已知服务器列表
AgentApi join post /agent/join 使代理通过连接到给定地址之一的Gossip池来加入集群
AgentApi stream_logs get /agent/monitor 从特定的Nomad服务器节点流日志
AgentApi update_servers post /agent/servers 将已知服务器列表更新为给定地址，替换所有以前的地址
AllocationsApi get_allocation get /allocation/{alloc_id} 读取特定分配的信息
AllocationsApi get_allocations get /allocations 查询和交互分配
AllocationsApi restart_allocation post /allocation/{alloc_id}/restart 就地重启分配或任务
AllocationsApi signal_allocation post /allocation/{alloc_id}/signal 向分配或任务发送信号
AllocationsApi stop_allocation post /allocation/{alloc_id}/stop 停止并重新安排特定的分配
ClientApi garbage_collect_allocation get /client/allocation/{alloc_id}/gc 强制在节点上对特定的已停止分配进行垃圾收集
ClientApi garbage_collect_allocation_0 get /client/gc 强制在节点上对所有已停止的分配进行垃圾收集
ClientApi get_client_allocation_stats get /client/allocation/{alloc_id}/stats 查询分配的实际资源消耗
ClientApi get_client_file get /client/fs/cat/{alloc_id} 读取分配目录中文件的 内容
ClientApi get_client_file_at_offest get /client/fs/readat/{alloc_id} 在特定偏移量和限制下读取分配目录中文件的内容
ClientApi get_client_stats get /client/stats 查询节点上实际消耗的资源。该API端点由Nomad客户端托管，请求必须发送到对资源使用指标感兴趣的Nomad客户端
ClientApi list_client_files get /client/fs/ls/{alloc_id} 列出分配目录中的文件
ClientApi stat_client_file get /client/fs/stat/{alloc_id} 统计分配中的文件
ClientApi stream_client_file get /client/fs/stream/{alloc_id} 流式传输分配目录中文件的内容
ClientApi stream_client_logs get /client/fs/logs/{alloc_id} 流式传输任务的stderr/stdout日志
DeploymentsApi fail_deployment post /deployment/fail/{deployment_id} 将部署标记为失败。这应该执行以强制调度器停止创建部署中的分配，或者导致回滚到先前的工作版本。此端点仅在最新稳定版本的工作规范与要回滚的工作不同时触发回滚
DeploymentsApi get_allocations_for_deployment get /deployment/allocations/{deployment_id} 列出为给定部署创建或修改的分配
DeploymentsApi get_deployment get /deployment/{deployment_id} 通过ID读取特定部署的信息
DeploymentsApi get_deployments get /deployments 列出所有部署
DeploymentsApi pause_deployment post /deployment/pause/{deployment_id} 暂停或恢复部署。这用于暂停滚动升级或恢复它
DeploymentsApi promote_deployment post /deployment/promote/{deployment_id} 提升具有金丝雀的部署的任务组。这应在放置的金丝雀健康且剩余分配的滚动升级应开始时执行
DeploymentsApi set_allocation_health_in_deployment post /deployment/allocation-health/{deployment_id} 手动设置部署中的分配的健康状况
EvaluationsApi get_allocations_for_evaluation get /evaluation/{eval_id}/allocations 列出为给定评估创建或修改的分配
EvaluationsApi get_evaluation get /evaluation/{eval_id} 通过ID读取特定评估的信息
EvaluationsApi get_evaluations get /evaluations 列出所有评估
JobsApi dispatch_job post /job/{job_id}/dispatch 分发参数化作业的新实例
JobsApi evaluate_job post /job/{job_id}/evaluate 为给定的作业创建新的评估。这可以用于在必要时强制运行调度逻辑
JobsApi force_new_periodic_instance post /job/{job_id}/periodic/force 强制创建周期性作业的新实例。即使它违反了作业的prohibit_overlap设置，也会创建新实例。因此，此操作仅应用于立即运行周期性作业
JobsApi get_job get /job/{job_id} 读取关于单个作业的规范和状态的信息
JobsApi 获取作业分配 get /job/{job_id}/allocations 读取单个作业的分配信息
JobsApi 获取作业部署 get /job/{job_id}/deployments 列出单个作业的部署
JobsApi 获取作业评估 get /job/{job_id}/evaluations 读取单个作业的评估信息
JobsApi 获取作业最新部署 get /job/{job_id}/deployment 获取单个作业的最新部署
JobsApi 获取作业伸缩状态 get /job/{job_id}/scale 读取作业的伸缩信息
JobsApi 获取作业摘要 get /job/{job_id}/summary 读取作业的摘要信息
JobsApi 获取作业版本 get /job/{job_id}/versions 读取作业所有版本的信息
JobsApi 获取作业列表 get /jobs 列出系统中注册的所有已知的作业
JobsApi 解析HCL作业规范 post /jobs/parse 解析HCL作业规范并生成等价的JSON编码作业
JobsApi 计划作业 post /job/{job_id}/plan 对作业执行调度器的dry-run
JobsApi 注册作业 post /jobs 在系统中创建（即“注册”）一个新的作业
JobsApi 撤销作业 post /job/{job_id}/revert 将作业撤销到较旧版本
JobsApi 伸缩任务组 post /job/{job_id}/scale 对作业执行伸缩操作。目前，此端点支持伸缩任务组的数量
JobsApi 设置作业稳定性 post /job/{job_id}/stable 设置作业的稳定性
JobsApi 停止作业 delete /job/{job_id} 注销作业，并停止其所有分配
JobsApi 更新作业 post /job/{job_id} 注册一个新的作业或更新现有作业
JobsApi 验证作业 post /validate/job 验证对象结构、字段和类型
节点API 评估节点 post /node/{node_id}/evaluate 为给定节点创建一个新的评估。这可以用来强制运行调度逻辑
节点API 获取节点的分配 get /node/{node_id}/allocations 列出给定节点的所有分配
节点API 获取节点 get /node/{node_id} 查询客户端节点的状态
节点API 获取节点列表 get /nodes 列出所有已注册到Nomad的节点
节点API 搜索 post /search 返回给定前缀和上下文的匹配项，其中上下文可以是作业、分配、评估、节点或部署
节点API 更新节点排空模式 post /node/{node_id}/drain 切换节点的排空模式
节点API 更新节点资格 post /node/{node_id}/eligibility 切换节点的调度资格
地区API 获取地区 get /regions 列出所有已知的地区
状态API 获取领导者 get /status/leader 返回区域当前领导者的地址
状态API 获取对等节点 get /status/peers 返回区域中Raft对等节点的集合
系统API 强制垃圾回收 put /system/gc 初始化作业、评估、分配和节点的垃圾回收。这是一个异步操作
系统API 协调摘要 put /system/reconcile/summaries 协调所有已注册作业的摘要
卷API 注销卷 delete /volume/csi/{volume_id} 注销与Nomad关联的外部卷。注销正在使用的卷是错误的
卷API 获取卷 get /volume/csi/{volume_id} 读取特定卷的信息
卷API 获取卷列表 get /volumes 列出所有卷
卷API 注册卷 put /volume/csi/{volume_id} 在Nomad中注册外部卷。注册现有卷是一个错误

模型文档

Dependencies

~4–19MB
~247K SLoC