Nacos OpenAPI清单

• new,2022-08-24,[e-mail]

清单

#	模块	接口名	方法	路径	备注
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 指南