Nacos OpenAPI清单
Nacos OpenAPI清单
- new,2022-08-24,chenxizhan1995@163.com
清单
# | 模块 | 接口名 | 方法 | 路径 | 备注 |
---|---|---|---|---|---|
1 | 配置管理 | 获取配置 | GET | /nacos/v1/cs/configs | tenant,dataId,group |
2 | 配置管理 | 监听配置 | POST | /nacos/v1/cs/configs/listener | 首部 Long-Pulling-Timeout 必须有,不然配置无变更的时候不会等待,而立即返回 |
3 | 配置管理 | 发布配置 | POST | /nacos/v1/cs/configs | tenant,dataId,group,content,type |
4 | 配置管理 | 删除配置 | DELETE | /nacos/v1/cs/configs | tenant,dataId,group |
5 | 配置管理 | 查询历史版本 | GET | /nacos/v1/cs/history?search=accurate | tenant,dataId,group,pageNo,pageSize |
6 | 配置管理 | 查询历史版本详情 | GET | /nacos/v1/cs/history | nid,tenant,dataId,group |
7 | 配置管理 | 查询配置上一版本信息 | GET | /nacos/v1/cs/history/previous | id,tenant,dataId,group |
8 | 服务发现 | 注册实例 | POST | /nacos/v1/ns/instance | ip,port,serviceName,ephemeral,… |
9 | 服务发现 | 注销实例 | DELETE | /nacos/v1/ns/instance | serviceName,ip,port,ephemenral…,注:注册时设置永久实例,删除时必须指定ephemeral参数,否则删除无效 |
10 | 服务发现 | 修改实例 | PUT | /nacos/v1/ns/instance | serviceName,ip,port,ephemenral… |
11 | 服务发现 | 查询实例列表 | GET | /nacos/v1/ns/instance/list | serviceName,groupName,namespaceId,clusters,healthOnly |
12 | 服务发现 | 查询实例详情 | GET | /nacos/v1/ns/instance | serviceName,ip,port,ephemenral… |
13 | 服务发现 | 发送实例心跳 | PUT | /nacos/v1/ns/instance/beat | serviceName,ip,port,beat,ephemenral…,注:beat为json字符串 |
14 | 服务发现 | 创建服务 | POST | /nacos/v1/ns/service | serviceName,groupName,namespaceId,protectThreadhold,metadata,selector。注:protectThreadhold 为浮点数[0,1],selector为json串 |
15 | 服务发现 | 删除服务 | DELETE | /nacos/v1/ns/service | serviceName,groupName,namespaceId |
16 | 服务发现 | 修改服务 | PUT | /nacos/v1/ns/service | |
17 | 服务发现 | 查询服务 | GET | /nacos/v1/ns/service | serviceName,groupName,namespaceId |
18 | 服务发现 | 查询服务列表 | GET | /nacos/v1/ns/service/list | pageNo,pageSize,groupName,namespaceId |
19 | 服务发现 | 查询系统开关 | GET | /nacos/v1/ns/operator/switches | 无参数 |
20 | 服务发现 | 修改系统开关 | PUT | /nacos/v1/ns/operator/switches | entry,value,debug |
21 | 服务发现 | 查看系统当前数据指标 | GET | /nacos/v1/ns/operator/metrics | 无参数 |
22 | 服务发现 | 查看当前集群Server列表 | GET | /nacos/v1/ns/operator/servers | healthy |
23 | 服务发现 | 查看当前集群leader | GET | /nacos/v1/ns/raft/leader | |
24 | 服务发现 | 更新实例的健康状态 | PUT | /nacos/v1/ns/health/instance | …,更新实例的健康状态,仅在集群的健康检查关闭时才生效,当集群配置了健康检查时,该接口会返回错误 |
25 | 服务发现 | 批量更新实例元数据(Beta) | put | /nacos/v1/ns/instance/metadata/batch | 注意:该接口为Beta接口,后续版本可能有所修改,甚至删除,请谨慎使用。 |
26 | 服务发现 | 批量删除实例元数据(Beta) | DELETE | /nacos/v1/ns/instance/metadata/batch | 同上 |
27 | 命名空间 | 查询命名空间列表 | GET | /nacos/v1/console/namespaces | 无参数 |
28 | 命名空间 | 创建命名空间 | POST | /nacos/v1/console/namespaces | customNamespaceId,namespaceName,namespaceDesc |
29 | 命名空间 | 修改命名空间 | PUT | /nacos/v1/console/namespaces | namespace,namespaceShowName,namespaceDesc |
30 | 命名空间 | 删除命名空间 | DELETE | /nacos/v1/console/namespaces | namespaceId |
下载表格,请移步 https://download.csdn.net/download/chenxizhan1995/86443931
备注
参数
有列出参数的,粗体表示必选,未备注是String类型,有省略号的表示还有非必选参数未列出
关于名称空间
控制台页面创建名称空间时,填入名称空间名称,如果省略名称空间id,则自动生成。
查询名称空间列表接口,返回值中的 namespace 对应名称空间ID,而 namespaceShowName 对应名称空间名称。
使用此接口可以看到 PUBLIC 名称空间的名称空间id为空字符串 “”,而 namespaceShowName 为 PUBLIC。
调用创建接口创建时,customNamespaceId 对应名称空间id,是必填项,如果希望使用自动生成的ID,就指定空字符串(“”)。
控制台创建时,名称空间描述信息必填,但实际创建名称空间的接口对名称空间描述信息字段是可选的。
Q. PUBLIC 名称空间能删除吗?
Ans:经过实验,调用OpenAPI删除PUBLIC接口的返回消息是成功,但实际并没有删除。
类似的情况还有,删除服务实例的接口。是有意设计的吗,感觉逻辑不好。所以 nacos 的开发者也不是完美无缺的。
参考链接
Open API 指南
Nacos OpenAPI清单相关推荐
- python调用nacos账号密码_python-nacos-sdk
nacos-sdk-python A Python implementation of Nacos OpenAPI. Supported Python version: Python 2.7 Pyth ...
- Nacos通过OpenAPI主动发送心跳失效问题
一. 背景 由于之前使用永久实例时,因为使用的是TCP探测,后端PHP服务又经过Nginx服务,所以当Nginx正常,但是PHP挂掉,或者其它原因不影响时,服务不能正常从服务列表踢除,造成服务失败,所 ...
- Nacos高级特性Raft算法以及原理和源码分析
Nacos高级特性Raft算法以及原理和源码分析 对比springcloud-config配置中心 springcloud-config工作原理 Nacos的工作原理图 springcloud-con ...
- 【Nacos】Nacos入门
核心功能点 服务发现 Nacos使服务更容易注册,并通过DNS或HTTP接口发现其他服务 服务注册 Nacos Client会通过发送REST请求的方式向Nacos Server注册自己的服务,提供自 ...
- SpringCloudAlibaba:Nacos
目录 什么是Nacos Nacos 的关键特性 Nacos的核心功能 Nacos与Eureka注册中心的区别 Nacos Server 部署 Nacos Client搭建 Nacos注册中心配置项 N ...
- (一)Nacos注册中心集群环境搭建
目录 版本说明 组件版本关系 Nacos注册中心架构 Nacos核心功能 Nacos 注册中心搭建 Nacos部署 单机搭建 集群搭建 集群模式Nginx配置 附录: prometheus+grafa ...
- Spring Cloud Alibaba 基础教程:Nacos 生产级版本 0.8.0
Spring Cloud Alibaba 基础教程:Nacos 生产级版本 0.8.0 昨晚Nacos社区发布了第一个生产级版本:0.8.0.由于该版本除了Bug修复之外,还提供了几个生产管理非常重要 ...
- 支持 gRPC 长链接,深度解读 Nacos 2.0 架构设计及新模型
点击上方蓝色"方志朋",选择"设为星标" 回复"666"获取独家整理的学习资料! 作者 | 杨翊(席翁) Nacos PMC Nacos ...
- Nacos 1.3.0 发布, 全新内核构建
点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试文章 1.3.0版本开始修炼内功,聚焦"简单".&q ...
最新文章
- 非常认同的《SEO优化大全》
- SAP QM启用了Physical Sample Management后检验批有哪些特殊地方?
- leetcode 反转字符串
- 3.1.5 动态分区分配算法
- win7 linux 共享文件夹权限设置,samba 配置共享 win7 无权限访问
- oracle cast multiset table 语法演示
- 【计算机系统设计】实践笔记(6)改进数据通路:lw和sw指令
- unity3d由多个部分组成一个角色
- 现代软件工程 作业 个人项目
- java 方法 示例_Java语言环境getDisplayVariant()方法与示例
- win7旗舰版+caffe+vs2013+matlab2014b(无GPU版)
- linux的文件权限前面的东西,linux 文件权限解析
- Linux环境中的帮助命令有,Linux下的帮助命令
- java异常的捕获和处理
- Java 中时间处理SimpleDateFormat 中HH和hh的区别
- python 科学计数法转数值
- 那个只能在win7的扫雷游戏,你能通关吗?今天用Python教大家,上号!!!
- 打开图片时提示windows照片查看器无法显示图片内存不足该如何解决
- 第2节:支持向量机SVM即numpy
- 跳石头 解题报告【二分答案】