Nacos学习日记5 - 开源API使用手册

我不是女神ヾ 2023-02-18 03:13 15阅读 0赞

# Open API 指南 #

--------------------

**目录**

Open API 指南

配置管理

获取配置

描述

请求类型

请求URL

请求参数

返回参数

错误编码

示例

监听配置

描述

请求类型

请求URL

请求参数

Header 参数

参数说明

返回参数

错误编码

示例

发布配置

描述

请求类型

请求 URL

请求参数

返回参数

错误编码

示例

删除配置

描述

请求类型

请求 URL

请求参数

返回参数

错误编码

示例

服务发现

注册实例

描述

请求类型

请求路径

请求参数

示例请求

示例返回

注销实例

描述

请求类型

请求路径

请求参数

示例请求

示例返回

修改实例

描述

请求类型

请求路径

请求参数

示例请求

示例返回

查询实例列表

描述

请求类型

请求路径

请求参数

示例请求

示例返回

查询实例详情

描述

请求类型

请求路径

请求参数

示例请求

示例返回

发送实例心跳

描述

请求类型

请求路径

请求参数

示例请求

示例返回

创建服务

描述

请求类型

请求路径

请求参数

示例请求

示例返回

删除服务

描述

请求类型

请求路径

请求参数

示例请求

示例返回

修改服务

描述

请求类型

请求路径

请求参数

示例请求

示例返回

查询服务

描述

请求类型

请求路径

请求参数

示例请求

示例返回

查询服务列表

描述

请求类型

请求路径

请求参数

示例请求

示例返回

查询系统开关

描述

请求类型

请求路径

请求参数

示例请求

示例返回

修改系统开关

描述

请求类型

请求路径

请求参数

示例请求

示例返回

查看系统当前数据指标

描述

请求类型

请求路径

请求参数

示例请求

示例返回

查看当前集群Server列表

描述

请求类型

请求路径

请求参数

示例请求

示例返回

查看当前集群leader

描述

请求类型

请求路径

请求参数

示例请求

示例返回

更新实例的健康状态

描述

请求类型

请求路径

请求参数

示例请求

示例返回

--------------------

## 配置管理 ##

## 获取配置 ##

### 描述 ###

获取Nacos上的配置。

### 请求类型 ###

GET

### 请求URL ###

/nacos/v1/cs/configs

### 请求参数 ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>类型</th> 
   <th>是否必须</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>tenant</td> 
   <td>string</td> 
   <td>否</td> 
   <td>租户信息，对应 Nacos 的命名空间ID字段。</td> 
  </tr> 
  <tr> 
   <td>dataId</td> 
   <td>string</td> 
   <td>是</td> 
   <td>配置 ID。</td> 
  </tr> 
  <tr> 
   <td>group</td> 
   <td>string</td> 
   <td>是</td> 
   <td>配置分组。</td> 
  </tr> 
 </tbody> 
</table>

### 返回参数 ###

<table> 
 <thead> 
  <tr> 
   <th>参数类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>string</td> 
   <td>配置值</td> 
  </tr> 
 </tbody> 
</table>

### 错误编码 ###

<table> 
 <thead> 
  <tr> 
   <th>错误代码</th> 
   <th>描述</th> 
   <th>语义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>400</td> 
   <td>Bad Request</td> 
   <td>客户端请求中的语法错误</td> 
  </tr> 
  <tr> 
   <td>403</td> 
   <td>Forbidden</td> 
   <td>没有权限</td> 
  </tr> 
  <tr> 
   <td>404</td> 
   <td>Not Found</td> 
   <td>无法找到资源</td> 
  </tr> 
  <tr> 
   <td>500</td> 
   <td>Internal Server Error</td> 
   <td>服务器内部错误</td> 
  </tr> 
  <tr> 
   <td>200</td> 
   <td>OK</td> 
   <td>正常</td> 
  </tr> 
 </tbody> 
</table>

### 示例 ###

*  请求示例
    
        http:serverIp:8848/nacos/v1/cs/configs?dataId=dataIdparam&group=groupParam&tenant=tenantParam
        
        
 *  返回示例
    
        contentTest

## 监听配置 ##

### 描述 ###

监听 Nacos 上的配置，以便实时感知配置变更。如果配置变更，则用[获取配置][Link 1]接口获取配置的最新值，动态刷新本地缓存。

注册监听采用的是异步 Servlet 技术。注册监听本质就是带着配置和配置值的 MD5 值和后台对比。如果 MD5 值不一致，就立即返回不一致的配置。如果值一致，就等待住 30 秒。返回值为空。

### 请求类型 ###

POST

### 请求URL ###

/nacos/v1/cs/configs/listener

### 请求参数 ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>类型</th> 
   <th>是否必须</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Listening-Configs</td> 
   <td>string</td> 
   <td>是</td> 
   <td>监听数据报文。格式为 dataId^2Group^2contentMD5^2tenant^1或者dataId^2Group^2contentMD5^1。dataId：配置 IDgroup：配置分组contentMD5：配置内容 MD5 值tenant：租户信息，对应 Nacos 的命名空间字段(非必填)</td> 
  </tr> 
 </tbody> 
</table>

### Header 参数 ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>类型</th> 
   <th>是否必须</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Long-Pulling-Timeout</td> 
   <td>string</td> 
   <td>是</td> 
   <td>长轮训等待 30s，此处填写 30000。</td> 
  </tr> 
 </tbody> 
</table>

### 参数说明 ###

*  配置多个字段间分隔符：^2 = Character.toString((char) 2
 *  配置间分隔符：^1 = Character.toString((char) 1)
 *  contentMD5: MD5(content)，第一次本地缓存为空，所以这块为空串

### 返回参数 ###

<table> 
 <thead> 
  <tr> 
   <th>参数类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>string</td> 
   <td>配置值</td> 
  </tr> 
 </tbody> 
</table>

### 错误编码 ###

### 示例 ###

*  请求示例

http://serverIp:8848/nacos/v1/cs/configs/listener
    
    POST 请求体数据内容：
    
    Listening-Configs=dataId^2group^2contentMD5^2tenant^1

*  返回示例

如果配置变化
    
    dataId^2group^2tenant^1
    
    如果配置无变化：会返回空串

## 发布配置 ##

### 描述 ###

发布 Nacos 上的配置。

### 请求类型 ###

POST

### 请求 URL ###

/nacos/v1/cs/configs

### 请求参数 ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>类型</th> 
   <th>是否必须</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>tenant</td> 
   <td>string</td> 
   <td>否</td> 
   <td>租户信息，对应 Nacos 的命名空间ID字段</td> 
  </tr> 
  <tr> 
   <td>dataId</td> 
   <td>string</td> 
   <td>是</td> 
   <td>配置 ID</td> 
  </tr> 
  <tr> 
   <td>group</td> 
   <td>string</td> 
   <td>是</td> 
   <td>配置分组</td> 
  </tr> 
  <tr> 
   <td>content</td> 
   <td>string</td> 
   <td>是</td> 
   <td>配置内容</td> 
  </tr> 
  <tr> 
   <td>type</td> 
   <td>String</td> 
   <td>否</td> 
   <td>配置类型</td> 
  </tr> 
 </tbody> 
</table>

### 返回参数 ###

<table> 
 <thead> 
  <tr> 
   <th>参数类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>boolean</td> 
   <td>是否发布成功</td> 
  </tr> 
 </tbody> 
</table>

### 错误编码 ###

### 示例 ###

*  请求示例

http:serverIp:8848/nacos/v1/cs/configs
    
    http body：
    dataId=dataIdparam&group=groupParam&tenant=tenantParam&content=contentParam&type=typeParam

*  返回示例

true

## 删除配置 ##

### 描述 ###

删除 Nacos 上的配置。

### 请求类型 ###

DELETE

### 请求 URL ###

/nacos/v1/cs/configs

### 请求参数 ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>类型</th> 
   <th>是否必须</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>tenant</td> 
   <td>string</td> 
   <td>否</td> 
   <td>租户信息，对应 Naocs 的命名空间ID字段</td> 
  </tr> 
  <tr> 
   <td>dataId</td> 
   <td>string</td> 
   <td>是</td> 
   <td>配置 ID</td> 
  </tr> 
  <tr> 
   <td>group</td> 
   <td>string</td> 
   <td>是</td> 
   <td>配置分组</td> 
  </tr> 
 </tbody> 
</table>

### 返回参数 ###

<table> 
 <thead> 
  <tr> 
   <th>参数类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>boolean</td> 
   <td>是否删除成功</td> 
  </tr> 
 </tbody> 
</table>

### 错误编码 ###

### 示例 ###

*  请求示例

http:serverIp:8848/nacos/v1/cs/configs?dataId=dataIdparam&group=groupParam

*  返回示例

true

## 服务发现 ##

## 注册实例 ##

### 描述 ###

注册一个实例到服务。

### 请求类型 ###

POST

### 请求路径 ###

/nacos/v1/ns/instance

### 请求参数 ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>类型</th> 
   <th>是否必选</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>ip</td> 
   <td>字符串</td> 
   <td>是</td> 
   <td>服务实例IP</td> 
  </tr> 
  <tr> 
   <td>port</td> 
   <td>int</td> 
   <td>是</td> 
   <td>服务实例port</td> 
  </tr> 
  <tr> 
   <td>namespaceId</td> 
   <td>字符串</td> 
   <td>否</td> 
   <td>命名空间ID</td> 
  </tr> 
  <tr> 
   <td>weight</td> 
   <td>double</td> 
   <td>否</td> 
   <td>权重</td> 
  </tr> 
  <tr> 
   <td>enabled</td> 
   <td>boolean</td> 
   <td>否</td> 
   <td>是否上线</td> 
  </tr> 
  <tr> 
   <td>healthy</td> 
   <td>boolean</td> 
   <td>否</td> 
   <td>是否健康</td> 
  </tr> 
  <tr> 
   <td>metadata</td> 
   <td>字符串</td> 
   <td>否</td> 
   <td>扩展信息</td> 
  </tr> 
  <tr> 
   <td>clusterName</td> 
   <td>字符串</td> 
   <td>否</td> 
   <td>集群名</td> 
  </tr> 
  <tr> 
   <td>serviceName</td> 
   <td>字符串</td> 
   <td>是</td> 
   <td>服务名</td> 
  </tr> 
  <tr> 
   <td>groupName</td> 
   <td>字符串</td> 
   <td>否</td> 
   <td>分组名</td> 
  </tr> 
  <tr> 
   <td>ephemeral</td> 
   <td>boolean</td> 
   <td>否</td> 
   <td>是否临时实例</td> 
  </tr> 
 </tbody> 
</table>

### 示例请求 ###

curl -X POST 'http://127.0.0.1:8848/nacos/v1/ns/instance?port=8848&healthy=true&ip=11.11.11.11&weight=1.0&serviceName=nacos.test.3&encoding=GBK&namespaceId=n1''

### 示例返回 ###

## 注销实例 ##

### 描述 ###

删除服务下的一个实例。

### 请求类型 ###

DELETE

### 请求路径 ###

/nacos/v1/ns/instance

### 请求参数 ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>类型</th> 
   <th>是否必选</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>serviceName</td> 
   <td>字符串</td> 
   <td>是</td> 
   <td>服务名</td> 
  </tr> 
  <tr> 
   <td>groupName</td> 
   <td>字符串</td> 
   <td>否</td> 
   <td>分组名</td> 
  </tr> 
  <tr> 
   <td>ip</td> 
   <td>字符串</td> 
   <td>是</td> 
   <td>服务实例IP</td> 
  </tr> 
  <tr> 
   <td>port</td> 
   <td>int</td> 
   <td>是</td> 
   <td>服务实例port</td> 
  </tr> 
  <tr> 
   <td>clusterName</td> 
   <td>字符串</td> 
   <td>否</td> 
   <td>集群名称</td> 
  </tr> 
  <tr> 
   <td>namespaceId</td> 
   <td>字符串</td> 
   <td>否</td> 
   <td>命名空间ID</td> 
  </tr> 
  <tr> 
   <td>ephemeral</td> 
   <td>boolean</td> 
   <td>否</td> 
   <td>是否临时实例</td> 
  </tr> 
 </tbody> 
</table>

### 示例请求 ###

curl -X DELETE 127.0.0.1:8848/nacos/v1/ns/instance?serviceName=nacos.test.1&ip=1.1.1.1&port=8888&clusterName=TEST1

### 示例返回 ###

## 修改实例 ##

### 描述 ###

修改服务下的一个实例。

### 请求类型 ###

PUT

### 请求路径 ###

/nacos/v1/ns/instance

### 请求参数 ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>类型</th> 
   <th>是否必选</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>serviceName</td> 
   <td>字符串</td> 
   <td>是</td> 
   <td>服务名</td> 
  </tr> 
  <tr> 
   <td>groupName</td> 
   <td>字符串</td> 
   <td>否</td> 
   <td>分组名</td> 
  </tr> 
  <tr> 
   <td>ip</td> 
   <td>字符串</td> 
   <td>是</td> 
   <td>服务实例IP</td> 
  </tr> 
  <tr> 
   <td>port</td> 
   <td>int</td> 
   <td>是</td> 
   <td>服务实例port</td> 
  </tr> 
  <tr> 
   <td>clusterName</td> 
   <td>字符串</td> 
   <td>否</td> 
   <td>集群名称</td> 
  </tr> 
  <tr> 
   <td>namespaceId</td> 
   <td>字符串</td> 
   <td>否</td> 
   <td>命名空间ID</td> 
  </tr> 
  <tr> 
   <td>weight</td> 
   <td>double</td> 
   <td>否</td> 
   <td>权重</td> 
  </tr> 
  <tr> 
   <td>metadata</td> 
   <td>JSON</td> 
   <td>否</td> 
   <td>扩展信息</td> 
  </tr> 
  <tr> 
   <td>enabled</td> 
   <td>boolean</td> 
   <td>否</td> 
   <td>是否打开流量</td> 
  </tr> 
  <tr> 
   <td>ephemeral</td> 
   <td>boolean</td> 
   <td>否</td> 
   <td>是否临时实例</td> 
  </tr> 
 </tbody> 
</table>

### 示例请求 ###

curl -X PUT 127.0.0.1:8848/nacos/v1/ns/instance?serviceName=nacos.test.1&ip=1.1.1.1&port=8888&clusterName=TEST1&weight=8&metadata={}

### 示例返回 ###

## 查询实例列表 ##

### 描述 ###

查询服务下的实例列表

### 请求类型 ###

GET

### 请求路径 ###

/nacos/v1/ns/instance/list

### 请求参数 ###

### 示例请求 ###

curl -X GET 127.0.0.1:8848/nacos/v1/ns/instance/list?serviceName=nacos.test.1

### 示例返回 ###

{
        "dom": "nacos.test.1",
        "cacheMillis": 1000,
        "useSpecifiedURL": false,
        "hosts": [{
            "valid": true,
            "marked": false,
            "instanceId": "10.10.10.10-8888-DEFAULT-nacos.test.1",
            "port": 8888,
            "ip": "10.10.10.10",
            "weight": 1.0,
            "metadata": {}
        }],
        "checksum": "3bbcf6dd1175203a8afdade0e77a27cd1528787794594",
        "lastRefTime": 1528787794594,
        "env": "",
        "clusters": ""
    }

## 查询实例详情 ##

### 描述 ###

查询一个服务下个某个实例详情。

### 请求类型 ###

GET

### 请求路径 ###

/nacos/v1/ns/instance

### 请求参数 ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>类型</th> 
   <th>是否必选</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>serviceName</td> 
   <td>字符串</td> 
   <td>是</td> 
   <td>服务名</td> 
  </tr> 
  <tr> 
   <td>groupName</td> 
   <td>字符串</td> 
   <td>否</td> 
   <td>分组名</td> 
  </tr> 
  <tr> 
   <td>ip</td> 
   <td>字符串</td> 
   <td>是</td> 
   <td>实例IP</td> 
  </tr> 
  <tr> 
   <td>port</td> 
   <td>字符串</td> 
   <td>是</td> 
   <td>实例端口</td> 
  </tr> 
  <tr> 
   <td>namespaceId</td> 
   <td>字符串</td> 
   <td>否</td> 
   <td>命名空间ID</td> 
  </tr> 
  <tr> 
   <td>cluster</td> 
   <td>字符串</td> 
   <td>否</td> 
   <td>集群名称</td> 
  </tr> 
  <tr> 
   <td>healthyOnly</td> 
   <td>boolean</td> 
   <td>否，默认为false</td> 
   <td>是否只返回健康实例</td> 
  </tr> 
  <tr> 
   <td>ephemeral</td> 
   <td>boolean</td> 
   <td>否</td> 
   <td>是否临时实例</td> 
  </tr> 
 </tbody> 
</table>

### 示例请求 ###

curl -X GET '127.0.0.1:8848/nacos/v1/ns/instance?serviceName=nacos.test.2&ip=10.10.10.10&port=8888&cluster=DEFAULT'

### 示例返回 ###

{
        "metadata": {},
        "instanceId": "10.10.10.10-8888-DEFAULT-nacos.test.2",
        "port": 8888,
        "service": "nacos.test.2",
        "healthy": false,
        "ip": "10.10.10.10",
        "clusterName": "DEFAULT",
        "weight": 1.0
    }

## 发送实例心跳 ##

### 描述 ###

发送某个实例的心跳

### 请求类型 ###

PUT

### 请求路径 ###

/nacos/v1/ns/instance/beat

### 请求参数 ###

### 示例请求 ###

curl -X PUT '127.0.0.1:8848/nacos/v1/ns/instance/beat?serviceName=nacos.test.2&beat=%7b%22cluster%22%3a%22c1%22%2c%22ip%22%3a%22127.0.0.1%22%2c%22metadata%22%3a%7b%7d%2c%22port%22%3a8080%2c%22scheduled%22%3atrue%2c%22serviceName%22%3a%22jinhan0Fx4s.173TL.net%22%2c%22weight%22%3a1%7d'

### 示例返回 ###

## 创建服务 ##

### 描述 ###

创建一个服务

### 请求类型 ###

POST

### 请求路径 ###

/nacos/v1/ns/service

### 请求参数 ###

### 示例请求 ###

curl -X POST '127.0.0.1:8848/nacos/v1/ns/service?serviceName=nacos.test.2&metadata=k1%3dv1'

### 示例返回 ###

## 删除服务 ##

### 描述 ###

删除一个服务,只有当服务下实例数为0时允许删除

### 请求类型 ###

DELETE

### 请求路径 ###

/nacos/v1/ns/service

### 请求参数 ###

### 示例请求 ###

curl -X DELETE '127.0.0.1:8848/nacos/v1/ns/service?serviceName=nacos.test.2'

### 示例返回 ###

## 修改服务 ##

### 描述 ###

更新一个服务

### 请求类型 ###

PUT

### 请求路径 ###

/nacos/v1/ns/service

### 请求参数 ###

### 示例请求 ###

curl -X PUT '127.0.0.1:8848/nacos/v1/ns/service?serviceName=nacos.test.2&metadata=k1%3dv1'

### 示例返回 ###

## 查询服务 ##

### 描述 ###

查询一个服务

### 请求类型 ###

GET

### 请求路径 ###

/nacos/v1/ns/service

### 请求参数 ###

### 示例请求 ###

curl -X GET '127.0.0.1:8848/nacos/v1/ns/service?serviceName=nacos.test.2'

### 示例返回 ###

{
        metadata: { },
        groupName: "DEFAULT_GROUP",
        namespaceId: "public",
        name: "nacos.test.2",
        selector: {
            type: "none"
        },
        protectThreshold: 0,
        clusters: [
            {
                healthChecker: {
                    type: "TCP"
                },
                metadata: { },
                name: "c1"
            }
        ]
    }

## 查询服务列表 ##

### 描述 ###

查询服务列表

### 请求类型 ###

GET

### 请求路径 ###

/nacos/v1/ns/service/list

### 请求参数 ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>类型</th> 
   <th>是否必选</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>pageNo</td> 
   <td>int</td> 
   <td>是</td> 
   <td>当前页码</td> 
  </tr> 
  <tr> 
   <td>pageSize</td> 
   <td>int</td> 
   <td>是</td> 
   <td>分页大小</td> 
  </tr> 
  <tr> 
   <td>groupName</td> 
   <td>字符串</td> 
   <td>否</td> 
   <td>分组名</td> 
  </tr> 
  <tr> 
   <td>namespaceId</td> 
   <td>字符串</td> 
   <td>否</td> 
   <td>命名空间ID</td> 
  </tr> 
 </tbody> 
</table>

### 示例请求 ###

curl -X GET '127.0.0.1:8848/nacos/v1/ns/service/list?pageNo=1&pageSize=2'

### 示例返回 ###

{
        "count":148,
        "doms": [
            "nacos.test.1",
            "nacos.test.2"
        ]
    }

## 查询系统开关 ##

### 描述 ###

查询系统开关

### 请求类型 ###

GET

### 请求路径 ###

/nacos/v1/ns/operator/switches

### 请求参数 ###

### 示例请求 ###

curl -X GET '127.0.0.1:8848/nacos/v1/ns/operator/switches'

### 示例返回 ###

{
        name: "00-00---000-NACOS_SWITCH_DOMAIN-000---00-00",
        masters: null,
        adWeightMap: { },
        defaultPushCacheMillis: 10000,
        clientBeatInterval: 5000,
        defaultCacheMillis: 3000,
        distroThreshold: 0.7,
        healthCheckEnabled: true,
        distroEnabled: true,
        enableStandalone: true,
        pushEnabled: true,
        checkTimes: 3,
        httpHealthParams: {
            max: 5000,
            min: 500,
            factor: 0.85
        },
        tcpHealthParams: {
            max: 5000,
            min: 1000,
            factor: 0.75
        },
        mysqlHealthParams: {
            max: 3000,
            min: 2000,
            factor: 0.65
        },
        incrementalList: [ ],
        serverStatusSynchronizationPeriodMillis: 15000,
        serviceStatusSynchronizationPeriodMillis: 5000,
        disableAddIP: false,
        sendBeatOnly: false,
        limitedUrlMap: { },
        distroServerExpiredMillis: 30000,
        pushGoVersion: "0.1.0",
        pushJavaVersion: "0.1.0",
        pushPythonVersion: "0.4.3",
        pushCVersion: "1.0.12",
        enableAuthentication: false,
        overriddenServerStatus: "UP",
        defaultInstanceEphemeral: true,
        healthCheckWhiteList: [ ],
        checksum: null
    }

## 修改系统开关 ##

### 描述 ###

修改系统开关

### 请求类型 ###

PUT

### 请求路径 ###

/nacos/v1/ns/operator/switches

### 请求参数 ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>类型</th> 
   <th>是否必选</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>entry</td> 
   <td>字符串</td> 
   <td>是</td> 
   <td>开关名</td> 
  </tr> 
  <tr> 
   <td>value</td> 
   <td>字符串</td> 
   <td>是</td> 
   <td>开关值</td> 
  </tr> 
  <tr> 
   <td>debug</td> 
   <td>boolean</td> 
   <td>否</td> 
   <td>是否只在本机生效,true表示本机生效,false表示集群生效</td> 
  </tr> 
 </tbody> 
</table>

### 示例请求 ###

curl -X PUT '127.0.0.1:8848/nacos/v1/ns/operator/switches?entry=pushEnabled&value=false&debug=true'

### 示例返回 ###

## 查看系统当前数据指标 ##

### 描述 ###

查看系统当前数据指标

### 请求类型 ###

GET

### 请求路径 ###

/nacos/v1/ns/operator/metrics

### 请求参数 ###

### 示例请求 ###

curl -X GET '127.0.0.1:8848/nacos/v1/ns/operator/metrics'

### 示例返回 ###

{
        serviceCount: 336,
        load: 0.09,
        mem: 0.46210432,
        responsibleServiceCount: 98,
        instanceCount: 4,
        cpu: 0.010242796,
        status: "UP",
        responsibleInstanceCount: 0
    }

## 查看当前集群Server列表 ##

### 描述 ###

查看当前集群Server列表

### 请求类型 ###

GET

### 请求路径 ###

/nacos/v1/ns/operator/servers

### 请求参数 ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>类型</th> 
   <th>是否必选</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>healthy</td> 
   <td>boolean</td> 
   <td>否</td> 
   <td>是否只返回健康Server节点</td> 
  </tr> 
 </tbody> 
</table>

### 示例请求 ###

curl -X GET '127.0.0.1:8848/nacos/v1/ns/operator/servers'

### 示例返回 ###

{
        servers: [
            {
                ip: "1.1.1.1",
                servePort: 8848,
                site: "unknown",
                weight: 1,
                adWeight: 0,
                alive: false,
                lastRefTime: 0,
                lastRefTimeStr: null,
                key: "1.1.1.1:8848"
            },
            {
                ip: "1.1.1.2",
                servePort: 8848,
                site: "unknown",
                weight: 1,
                adWeight: 0,
                alive: false,
                lastRefTime: 0,
                lastRefTimeStr: null,
                key: "1.1.1.2:8848"
            },
            {
                ip: "1.1.1.3",
                servePort: 8848,
                site: "unknown",
                weight: 1,
                adWeight: 0,
                alive: false,
                lastRefTime: 0,
                lastRefTimeStr: null,
                key: "1.1.1.3:8848"
            }
        ]
    }

## 查看当前集群leader ##

### 描述 ###

查看当前集群leader

### 请求类型 ###

GET

### 请求路径 ###

/nacos/v1/ns/raft/leader

### 请求参数 ###

### 示例请求 ###

curl -X GET '127.0.0.1:8848/nacos/v1/ns/raft/leader'

### 示例返回 ###

{
        leader: "{"heartbeatDueMs":2500,"ip":"1.1.1.1:8848","leaderDueMs":12853,"state":"LEADER","term":54202,"voteFor":"1.1.1.1:8848"}"
    }

## 更新实例的健康状态 ##

### 描述 ###

更新实例的健康状态,仅在集群的健康检查关闭时才生效,当集群配置了健康检查时,该接口会返回错误

### 请求类型 ###

PUT

### 请求路径 ###

/nacos/v1/ns/health/instance

### 请求参数 ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>类型</th> 
   <th>是否必选</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>namespaceId</td> 
   <td>字符串</td> 
   <td>否</td> 
   <td>命名空间ID</td> 
  </tr> 
  <tr> 
   <td>serviceName</td> 
   <td>字符串</td> 
   <td>是</td> 
   <td>服务名</td> 
  </tr> 
  <tr> 
   <td>groupName</td> 
   <td>字符串</td> 
   <td>否</td> 
   <td>分组名</td> 
  </tr> 
  <tr> 
   <td>clusterName</td> 
   <td>字符串</td> 
   <td>否</td> 
   <td>集群名</td> 
  </tr> 
  <tr> 
   <td>ip</td> 
   <td>字符串</td> 
   <td>是</td> 
   <td>服务实例IP</td> 
  </tr> 
  <tr> 
   <td>port</td> 
   <td>int</td> 
   <td>是</td> 
   <td>服务实例port</td> 
  </tr> 
  <tr> 
   <td>healthy</td> 
   <td>boolean</td> 
   <td>是</td> 
   <td>是否健康</td> 
  </tr> 
 </tbody> 
</table>

### 示例请求 ###

curl -X PUT 'http://127.0.0.1:8848/nacos/v1/ns/health/instance?port=8848&healthy=true&ip=11.11.11.11&serviceName=nacos.test.3&namespaceId=n1''

### 示例返回 ###

[Link 1]: https://nacos.io/zh-cn/docs/~~64131~~