Skip to main content
Version: Next

nacos

基于 Nacos 的服务发现#

Nacos 服务发现模块目前是实验性的。

当前模块的性能有待改进:

  1. 并行发送请求。

Nacos 配置#

在文件 conf/config.yaml 中添加以下配置到:

discovery:  nacos:    host:      - "http://${username}:${password}@${host1}:${port1}"    prefix: "/nacos/v1/"    fetch_interval: 30    # default 30 sec    weight: 100           # default 100    timeout:      connect: 2000       # default 2000 ms      send: 2000          # default 2000 ms      read: 5000          # default 5000 ms

也可以这样简洁配置(未配置项使用默认值):

discovery:  nacos:    host:      - "http://192.168.33.1:8848"

Upstream 设置#

例如,转发 URI 匹配 "/nacos/*" 的请求到一个上游服务, 该服务在 Nacos 中的服务名是 APISIX-NACOS ,查询地址是 http://192.168.33.1:8848/nacos/v1/ns/instance/list?serviceName=APISIX-NACOS ,创建路由时指定服务发现类型为 nacos 。

$ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '{    "uri": "/nacos/*",    "upstream": {        "service_name": "APISIX-NACOS",        "type": "roundrobin",        "discovery_type": "nacos"    }}'

响应如下:

{  "node": {    "key": "\/apisix\/routes\/1",    "value": {      "id": "1",      "create_time": 1615796097,      "status": 1,      "update_time": 1615799165,      "upstream": {        "hash_on": "vars",        "pass_host": "pass",        "scheme": "http",        "service_name": "APISIX-NACOS",        "type": "roundrobin",        "discovery_type": "nacos"      },      "priority": 0,      "uri": "\/nacos\/*"    }  },  "action": "set"}

参数#

名字类型可选项默认值有效值说明
namespace_idstring可选public服务所在的命名空间
group_namestring可选DEFAULT_GROUP服务所在的组

指定命名空间#

例如,转发 URI 匹配 "/nacosWithNamespaceId/*" 的请求到一个上游服务, 该服务在 Nacos 中的服务名是 APISIX-NACOS,命名空间是 test_ns,查询地址是 http://192.168.33.1:8848/nacos/v1/ns/instance/list?serviceName=APISIX-NACOS&namespaceId=test_ns ,创建路由时指定服务发现类型为 nacos 。

$ curl http://127.0.0.1:9080/apisix/admin/routes/2 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '{    "uri": "/nacosWithNamespaceId/*",    "upstream": {        "service_name": "APISIX-NACOS",        "type": "roundrobin",        "discovery_type": "nacos",        "discovery_args": {          "namespace_id": "test_ns"        }    }}'

响应如下:

{  "node": {    "key": "\/apisix\/routes\/2",    "value": {      "id": "2",      "create_time": 1615796097,      "status": 1,      "update_time": 1615799165,      "upstream": {        "hash_on": "vars",        "pass_host": "pass",        "scheme": "http",        "service_name": "APISIX-NACOS",        "type": "roundrobin",        "discovery_type": "nacos",        "discovery_args": {          "namespace_id": "test_ns"        }      },      "priority": 0,      "uri": "\/nacosWithNamespaceId\/*"    }  },  "action": "set"}

指定组#

例如,转发 URI 匹配 "/nacosWithGroupName/*" 的请求到一个上游服务, 该服务在 Nacos 中的服务名是 APISIX-NACOS,组名是 test_group,查询地址是 http://192.168.33.1:8848/nacos/v1/ns/instance/list?serviceName=APISIX-NACOS&groupName=test_group ,创建路由时指定服务发现类型为 nacos 。

$ curl http://127.0.0.1:9080/apisix/admin/routes/3 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '{    "uri": "/nacosWithGroupName/*",    "upstream": {        "service_name": "APISIX-NACOS",        "type": "roundrobin",        "discovery_type": "nacos",        "discovery_args": {          "group_name": "test_group"        }    }}'

响应如下:

{  "node": {    "key": "\/apisix\/routes\/3",    "value": {      "id": "3",      "create_time": 1615796097,      "status": 1,      "update_time": 1615799165,      "upstream": {        "hash_on": "vars",        "pass_host": "pass",        "scheme": "http",        "service_name": "APISIX-NACOS",        "type": "roundrobin",        "discovery_type": "nacos",        "discovery_args": {          "group_name": "test_group"        }      },      "priority": 0,      "uri": "\/nacosWithGroupName\/*"    }  },  "action": "set"}

同时指定命名空间和组#

例如,转发 URI 匹配 "/nacosWithNamespaceIdAndGroupName/*" 的请求到一个上游服务, 该服务在 Nacos 中的服务名是 APISIX-NACOS,命名空间是 test_ns,组名是 test_group,查询地址是 http://192.168.33.1:8848/nacos/v1/ns/instance/list?serviceName=APISIX-NACOS&namespaceId=test_ns&groupName=test_group ,创建路由时指定服务发现类型为 nacos 。

$ curl http://127.0.0.1:9080/apisix/admin/routes/4 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '{    "uri": "/nacosWithNamespaceIdAndGroupName/*",    "upstream": {        "service_name": "APISIX-NACOS",        "type": "roundrobin",        "discovery_type": "nacos",        "discovery_args": {          "namespace_id": "test_ns",          "group_name": "test_group"        }    }}'

响应如下:

{  "node": {    "key": "\/apisix\/routes\/4",    "value": {      "id": "4",      "create_time": 1615796097,      "status": 1,      "update_time": 1615799165,      "upstream": {        "hash_on": "vars",        "pass_host": "pass",        "scheme": "http",        "service_name": "APISIX-NACOS",        "type": "roundrobin",        "discovery_type": "nacos",        "discovery_args": {          "namespace_id": "test_ns",          "group_name": "test_group"        }      },      "priority": 0,      "uri": "\/nacosWithNamespaceIdAndGroupName\/*"    }  },  "action": "set"}