配置管理

获取配置

描述

获取Nacos上的配置。

请求类型

GET

请求URL

/nacos/v1/cs/configs

请求参数

返回参数

错误编码

示例

• 请求示例

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

• 返回示例

contentTest

监听配置

描述

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

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

请求类型

POST

请求URL

/nacos/v1/cs/configs/listener

请求参数

|
名称
|
类型
|
是否必须
|
描述

|
Listening-Configs
|
string
|
是
|
监听数据报文。格式为 dataId^2Group^2contentMD5^2tenant^1或者dataId^2Group^2contentMD5^1。

• dataId：配置 ID

• group：配置分组

• contentMD5：配置内容 MD5 值

• tenant：租户信息，对应 Nacos 的命名空间字段(非必填)

Header 参数

参数说明

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

返回参数

错误编码

示例

• 请求示例

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

请求参数

返回参数

错误编码

示例

• 请求示例

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

• 返回示例

true

删除配置

描述

删除 Nacos 上的配置。

请求类型

DELETE

请求 URL

/nacos/v1/cs/configs

请求参数

返回参数

错误编码

示例

• 请求示例

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

• 返回示例

true

服务发现API

注册实例

描述

注册一个实例到服务。

请求类型

PUT

请求路径

/nacos/v1/ns/instance

请求参数

示例请求

curl -X PUT '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&tenant=n1''

示例返回

ok

删除实例

描述

删除服务下的一个实例。

请求类型

DELETE

请求路径

/nacos/v1/ns/instance

请求参数

示例请求

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

示例返回

ok

修改实例

描述

修改服务下的一个实例。

请求类型

POST

请求路径

/nacos/v1/ns/instance

请求参数

示例请求

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

示例返回

ok

查询实例列表

描述

查询服务下的实例列表

请求类型

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

请求参数

示例请求

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
}

原文: https://nacos.io/zh-cn/docs/open-API.html