• Nacos OpenAPI清单


    Nacos OpenAPI清单

    • new,2022-08-24,chenxizhan1995@163.com

    清单

    #模块接口名方法路径备注
    1配置管理获取配置GET/nacos/v1/cs/configstenant,dataId,group
    2配置管理监听配置POST/nacos/v1/cs/configs/listener首部 Long-Pulling-Timeout 必须有,不然配置无变更的时候不会等待,而立即返回
    3配置管理发布配置POST/nacos/v1/cs/configstenant,dataId,group,content,type
    4配置管理删除配置DELETE/nacos/v1/cs/configstenant,dataId,group
    5配置管理查询历史版本GET/nacos/v1/cs/history?search=accuratetenant,dataId,group,pageNo,pageSize
    6配置管理查询历史版本详情GET/nacos/v1/cs/historynid,tenant,dataId,group
    7配置管理查询配置上一版本信息GET/nacos/v1/cs/history/previousid,tenant,dataId,group
    8服务发现注册实例POST/nacos/v1/ns/instanceip,port,serviceName,ephemeral,…
    9服务发现注销实例DELETE/nacos/v1/ns/instanceserviceName,ip,port,ephemenral…,注:注册时设置永久实例,删除时必须指定ephemeral参数,否则删除无效
    10服务发现修改实例PUT/nacos/v1/ns/instanceserviceName,ip,port,ephemenral…
    11服务发现查询实例列表GET/nacos/v1/ns/instance/listserviceName,groupName,namespaceId,clusters,healthOnly
    12服务发现查询实例详情GET/nacos/v1/ns/instanceserviceName,ip,port,ephemenral…
    13服务发现发送实例心跳PUT/nacos/v1/ns/instance/beatserviceName,ip,port,beat,ephemenral…,注:beat为json字符串
    14服务发现创建服务POST/nacos/v1/ns/serviceserviceName,groupName,namespaceId,protectThreadhold,metadata,selector。注:protectThreadhold 为浮点数[0,1],selector为json串
    15服务发现删除服务DELETE/nacos/v1/ns/serviceserviceName,groupName,namespaceId
    16服务发现修改服务PUT/nacos/v1/ns/service
    17服务发现查询服务GET/nacos/v1/ns/serviceserviceName,groupName,namespaceId
    18服务发现查询服务列表GET/nacos/v1/ns/service/listpageNo,pageSize,groupName,namespaceId
    19服务发现查询系统开关GET/nacos/v1/ns/operator/switches无参数
    20服务发现修改系统开关PUT/nacos/v1/ns/operator/switchesentry,value,debug
    21服务发现查看系统当前数据指标GET/nacos/v1/ns/operator/metrics无参数
    22服务发现查看当前集群Server列表GET/nacos/v1/ns/operator/servershealthy
    23服务发现查看当前集群leaderGET/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/namespacescustomNamespaceId,namespaceName,namespaceDesc
    29命名空间修改命名空间PUT/nacos/v1/console/namespacesnamespace,namespaceShowName,namespaceDesc
    30命名空间删除命名空间DELETE/nacos/v1/console/namespacesnamespaceId

    下载表格,请移步 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 指南

  • 相关阅读:
    python继承
    说一下 ArrayList 和 LinkedList 的区别?
    【BackEnd--Mongodb】学习笔记(完整详细版)
    【小沐学前端】Windows下搭建WordPress(nginx1.25、PHP8.2、WordPress6.3、MySQL5.7)
    msyql锁分类
    C++代码编程学习:inline函数学习(Essential C++ 第二章)
    步力宝科技爆款产品定位,开创智能物联网新商业
    pdd.order.list.get拼多多店铺订单列表查询接口(拼多多店铺订单详情接口,订单明文接口,订单解密接口,订单插旗接口,订单备注接口)代码对接教程
    结构体及应用;结构体指针及应用;union、enum、typedef三个关键字
    Flutter学习2 - Dart
  • 原文地址:https://blog.csdn.net/chenxizhan1995/article/details/126499863