Open API 指南

Nacos 2.X 版本兼容 Nacos1.X 版本的OpenAPI, 请参考文档Nacos1.X OpenAPI使用。

注意：未特殊注明支持版本的OpenAPI均从2.2.0版本开始支持。

• 文档约定

  • API 统一返回体格式
  • API 错误码汇总

• 配置管理

  • 获取配置
  • 发布配置
  • 删除配置
  • 查询配置历史版本列表
  • 查询具体版本的历史配置
  • 查询配置上一版本信息
  • 查询指定命名空间下的配置列表

• 服务发现

  • 注册实例
  • 注销实例
  • 更新实例
  • 查询实例详情
  • 查询指定服务下的实例列表
  • 批量更新实例元数据(Beta)
  • 批量删除实例元数据(Beta)
  • 创建服务
  • 删除服务
  • 修改服务
  • 查询服务详情
  • 查询服务列表
  • 查询系统开关
  • 修改系统开关
  • 查看系统当前数据指标
  • 更新实例的健康状态
  • 查询客户端列表（新）
  • 查询客户端信息（新）
  • 查询客户端的注册信息（新）
  • 查询客户端的订阅信息（新）
  • 查询注册指定服务的客户端信息（新）
  • 查询订阅指定服务的客户端信息（新）

• 命名空间

  • 查询命名空间列表
  • 查询具体命名空间
  • 新增命名空间
  • 编辑命名空间
  • 删除命名空间

• 集群管理

  • 查询当前节点信息
  • 查询集群节点列表
  • 查询当前节点健康状态
  • 切换寻址模式

文档规定

API 统一返回体格式

2.0版本Open API，所有接口请求的响应均为json类型的返回体，返回体具有相同的格式

{
  "code": 0,
  "message": "success",
  "data": {}
}

返回体中各字段的含义如下表所示

由于执行成功的情况下code字段与message字段相同，后续在介绍接口的返回结果时，只介绍返回数据的data字段

API 错误码汇总

API接口返回体中的错误码及对应提示信息汇总见下表

配置管理

获取配置

接口描述

获取指定配置

请求方式

GET

请求URL

/nacos/v2/cs/config

请求参数

返回数据

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/cs/config?dataId=nacos.example&group=DEFAULT_GROUP&namespaceId=public'

• 返回示例

  {
        "code": 0,
        "message": "success",
        "data": "contentTest"
  }

发布配置

接口描述

发布指定配置

当配置已存在时，则对配置进行更新

请求方式

POST

Content-Type:application/x-www-form-urlencoded

请求URL

/nacos/v2/cs/config

请求Body

返回数据

示例

• 请求示例

  curl -d 'dataId=nacos.example' \
    -d 'group=DEFAULT_GROUP' \
    -d 'namespaceId=public' \
    -d 'content=contentTest' \
    -X POST 'http://127.0.0.1:8848/nacos/v2/cs/config'

• 返回示例

  {
        "code": 0,
        "message": "success",
        "data": true
  }

删除配置

接口描述

删除指定配置

请求方式

DELETE

请求URL

/nacos/v2/cs/config

请求参数

返回数据

示例

• 请求示例

  curl -X DELETE 'http://127.0.0.1:8848/nacos/v2/cs/config?dataId=nacos.example&group=DEFAULT_GROUP&namespaceId=public'

• 返回示例

  {
        "code": 0,
        "message": "success",
        "data": true
  }

查询配置历史列表

接口描述

获取指定配置的历史版本列表

请求方式

GET

请求URL

/nacos/v2/cs/history/list

请求参数

返回数据

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/cs/history/list?dataId=nacos.example&group=com.alibaba.nacos&namespaceId='

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": {
      "totalCount": 1,
      "pageNumber": 1,
      "pagesAvailable": 1,
      "pageItems": [
        {
                  "id": "203",
                  "lastId": -1,
                  "dataId": "nacos.example",
                  "group": "com.alibaba.nacos",
                  "tenant": "",
                  "appName": "",
                  "md5": "9f67e6977b100e00cab385a75597db58",
            "content": "contentTest",
                  "srcIp": "0:0:0:0:0:0:0:1",
                  "srcUser": null,
                  "opType": "I",
                  "createdTime": "2010-05-04T16:00:00.000+0000",
                  "lastModifiedTime": "2020-12-05T01:48:03.380+0000"
        }
      ]
    }
  }

查询具体版本的历史配置

接口描述

获取指定版本的历史配置

请求方式

GET

请求URL

/nacos/v2/cs/history

请求参数

返回数据

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/cs/history?dataId=nacos.example&group=com.alibaba.nacos&namespaceId=&nid=203'

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": {
          "id": "203",
          "lastId": -1,
          "dataId": "nacos.example",
          "group": "com.alibaba.nacos",
          "tenant": "",
          "appName": "",
          "md5": "9f67e6977b100e00cab385a75597db58",
        "content": "contentTest",
          "srcIp": "0:0:0:0:0:0:0:1",
          "srcUser": null,
          "opType": "I",
          "createdTime": "2010-05-04T16:00:00.000+0000",
          "lastModifiedTime": "2020-12-05T01:48:03.380+0000"
    }
  }

查询配置上一版本信息

接口描述

获取指定配置的上一版本

请求方式

GET

请求URL

/nacos/v2/cs/history/previous

请求参数

返回数据

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/cs/history/previous?id=309135486247505920&dataId=nacos.example&group=com.alibaba.nacos&namespaceId='

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": {
          "id": "203",
          "lastId": -1,
          "dataId": "nacos.example",
          "group": "com.alibaba.nacos",
          "tenant": "",
          "appName": "",
          "md5": "9f67e6977b100e00cab385a75597db58",
        "content": "contentTest",
          "srcIp": "0:0:0:0:0:0:0:1",
          "srcUser": null,
          "opType": "I",
          "createdTime": "2010-05-04T16:00:00.000+0000",
          "lastModifiedTime": "2020-12-05T01:48:03.380+0000"
    }
  }

查询指定命名空间下的配置列表

接口描述

获取指定命名空间下的配置信息列表

请求方式

GET

请求URL

/nacos/v2/cs/history/configs

请求参数

返回数据

返回数据中的配置信息只有dataId, group, tenant, appName, type字段有效，其他字段为默认值

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/cs/history/configs?namespaceId='

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": [
      {
        "id": "0",
        "dataId": "nacos.example",
            "group": "com.alibaba.nacos",
        "content": null,
        "md5": null,
        "encryptedDataKey": null,
        "tenant": "",
        "appName": "",
        "type": "yaml",
        "lastModified": 0
      }
      ]
  }

服务发现

注册实例

接口描述

注册一个实例

请求方式

POST

Content-Type:application/x-www-form-urlencoded

请求URL

/nacos/v2/ns/instance

请求Body

返回数据

示例

• 请求示例

  curl -d 'serviceName=test_service' \
    -d 'ip=127.0.0.1' \
    -d 'port=8090' \
    -d 'weight=0.9' \
    -d 'ephemeral=true' \
    -X POST 'http://127.0.0.1:8848/nacos/v2/ns/instance'

• 返回示例

  {
        "code": 0,
        "message": "success",
        "data": true
  }

注销实例

接口描述

注销指定实例

请求方式

DELETE

Content-Type:application/x-www-form-urlencoded

请求URL

/nacos/v2/ns/instance

请求Body

返回数据

示例

• 请求示例

  curl -d 'serviceName=test_service' \
    -d 'ip=127.0.0.1' \
    -d 'port=8090' \
    -d 'weight=0.9' \
    -d 'ephemeral=true' \
    -X DELETE 'http://127.0.0.1:8848/nacos/v2/ns/instance'

• 返回示例

  {
        "code": 0,
        "message": "success",
        "data": true
  }

更新实例

接口描述

修改实例信息

通过该接口更新的元数据拥有更高的优先级，且具有记忆能力；会在对应实例删除后，依旧存在一段时间，如果在此期间实例重新注册，该元数据依旧生效；您可以通过nacos.naming.clean.expired-metadata.expired-time及nacos.naming.clean.expired-metadata.interval对记忆时间进行修改

请求方式

PUT

Content-Type:application/x-www-form-urlencoded

请求URL

/nacos/v2/ns/instance

请求Body

返回数据

示例

• 请求示例

  curl -d 'serviceName=test_service' \
    -d 'ip=127.0.0.1' \
    -d 'port=8090' \
    -d 'weight=0.9' \
    -d 'ephemeral=true' \
    -X PUT 'http://127.0.0.1:8848/nacos/v2/ns/instance'

• 返回示例

  {
        "code": 0,
        "message": "success",
        "data": true
  }

查询实例详情

接口描述

查询某个具体实例的详情信息

请求方式

GET

请求URL

/nacos/v2/ns/instance

请求参数

返回数据

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/ns/instance?namespaceId=public&groupName=&serviceName=test_service&ip=127.0.0.1&port=8080'

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": {
      "serviceName": "DEFAULT_GROUP@@test_service",
      "ip": "127.0.0.1",
      "port": 8080,
      "clusterName": "DEFAULT",
      "weight": 1.0,
      "healthy": true,
      "instanceId": null,
      "metadata": {
        "value": "1"
      }
    }
  }

查询指定服务的实例列表

接口描述

查询指定服务下的实例详情信息列表

请求方式

GET

请求URL

/nacos/v2/ns/instance/list

请求头

请求参数

返回数据

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/ns/instance/list?serviceName=test_service&ip=127.0.0.1'

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": {
      "name": "DEFAULT_GROUP@@test_service",
      "groupName": "DEFAULT_GROUP",
      "clusters": "",
      "cacheMillis": 10000,
      "hosts": [
        {
          "ip": "127.0.0.1",
          "port": 8080,
          "weight": 1.0,
          "healthy": true,
          "enabled": true,
          "ephemeral": true,
          "clusterName": "DEFAULT",
          "serviceName": "DEFAULT_GROUP@@test_service",
          "metadata": {
            "value": "1"
          },
          "instanceHeartBeatTimeOut": 15000,
          "ipDeleteTimeout": 30000,
          "instanceHeartBeatInterval": 5000
        }
      ],
      "lastRefTime": 1662554390814,
      "checksum": "",
      "allIPs": false,
      "reachProtectionThreshold": false,
      "valid": true
    }
  }

批量更新实例元数据

接口描述

批量更新实例的元数据,

对应元数据的键不存在时，则添加对应元数据

请求方式

PUT

Content-Type:application/x-www-form-urlencoded

请求URL

/nacos/v2/ns/instance/metadata/batch

请求Body

参数说明

• consistencyType: 实例的持久化类型，当为‘persist’，表示对持久化实例的元数据进行更新；否则表示对临时实例的元数据进行更新
• instances: 待更新的实例列表，json数组，通过ip+port+ephemeral+cluster定位到某一实例，为空则表示更新指定服务下所有实例的元数据

返回数据

示例

• 请求示例

  curl -d 'serviceName=test_service' \
    -d 'consistencyType=ephemeral' \
    -d 'instances=[{"ip":"3.3.3.3","port": "8080","ephemeral":"true","clusterName":"xxxx-cluster"},{"ip":"2.2.2.2","port":"8080","ephemeral":"true","clusterName":"xxxx-cluster"}]' \
    -d 'metadata={"age":"20","name":"cocolan"}' \
    -X PUT 'http://127.0.0.1:8848/nacos/v2/ns/instance/metadata/batch'

• 返回示例

  {
        "code": 0,
        "message": "success",
        "data": true
  }

批量删除实例元数据

接口描述

批量删除实例的元数据,

对应元数据的键不存在时，则不做操作

请求方式

DELETE

Content-Type:application/x-www-form-urlencoded

请求URL

/nacos/v2/ns/instance/metadata/batch

请求Body

参数说明

• consistencyType: 实例的持久化类型，当为‘persist’，表示对持久化实例的元数据进行删除；否则表示对临时实例的元数据进行
• instances: 待更新的实例列表，json数组，通过ip+port+ephemeral+cluster定位到某一实例，为空则表示更新指定服务下所有实例的元数据

返回数据

示例

• 请求示例

  curl -d 'serviceName=test_service' \
    -d 'consistencyType=ephemeral' \
    -d 'instances=[{"ip":"3.3.3.3","port": "8080","ephemeral":"true","clusterName":"xxxx-cluster"},{"ip":"2.2.2.2","port":"8080","ephemeral":"true","clusterName":"xxxx-cluster"}]' \
    -d 'metadata={"age":"20","name":"cocolan"}' \
    -X DELETE 'http://127.0.0.1:8848/nacos/v2/ns/instance/metadata/batch'

• 返回示例

  {
        "code": 0,
        "message": "success",
        "data": true
  }

创建服务

接口描述

创建一个服务

服务已存在时会创建失败

请求方式

POST

Content-Type:application/x-www-form-urlencoded

请求URL

/nacos/v2/ns/service

请求Body

返回数据

示例

• 请求示例

  curl -d 'serviceName=nacos.test.1' \
    -d 'ephemeral=true' \
    -d 'metadata={"k1":"v1"}' \
    -X POST 'http://127.0.0.1:8848/nacos/v2/ns/service'

• 返回示例

  {
        "code": 0,
        "message": "success",
        "data": true
  }

删除服务

接口描述

删除指定服务

服务不存在时会报错，且服务还存在实例时会删除失败

请求方式

DELETE

请求URL

/nacos/v2/ns/service

请求参数

返回数据

示例

• 请求示例

  curl -X DELETE 'http://127.0.0.1:8848/nacos/v2/ns/service?serviceName=nacos.test.1'

• 返回示例

  {
        "code": 0,
        "message": "success",
        "data": true
  }

修改服务

接口描述

更新指定服务

服务不存在时会报错

请求方式

POST

Content-Type:application/x-www-form-urlencoded

请求URL

/nacos/v2/ns/service

请求参数

返回数据

示例

• 请求示例

  curl -d 'serviceName=nacos.test.1' \
    -d 'metadata={"k1":"v2"}' \
    -X PUT 'http://127.0.0.1:8848/nacos/v2/ns/service'

• 返回示例

  {
        "code": 0,
        "message": "success",
        "data": true
  }

查询服务详情

接口描述

查询某个具体服务的详情信息

服务不存在时会报错

请求方式

GET

请求URL

/nacos/v2/ns/service

请求参数

返回数据

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/ns/service?serviceName=nacos.test.1'

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": {
      "namespace": "public",
      "serviceName": "nacos.test.1",
      "groupName": "DEFAULT_GROUP",
      "clusterMap": {},
      "metadata": {},
      "protectThreshold": 0,
      "selector": {
        "type": "none",
        "contextType": "NONE"
      },
      "ephemeral": false
    }
  }

查询服务列表

接口描述

查询符合条件的服务列表

请求方式

GET

请求URL

/nacos/v2/ns/service/list

请求参数

返回数据

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/ns/service/list'

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": {
      "count": 2,
      "services": [
        "nacos.test.1",
        "nacos.test.2"
      ]
    }
  }

查询系统开关

接口描述

查询系统开关

请求方式

GET

请求URL

/nacos/v2/ns/operator/switches

返回数据

示例

• 请求示例

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

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": {
      "masters": null,
      "adWeightMap": {},
      "defaultPushCacheMillis": 10000,
      "clientBeatInterval": 5000,
      "defaultCacheMillis": 3000,
      "distroThreshold": 0.7,
      "healthCheckEnabled": true,
      "autoChangeHealthCheckEnabled": 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": 2000,
      "serviceStatusSynchronizationPeriodMillis": 5000,
      "disableAddIP": false,
      "sendBeatOnly": false,
      "lightBeatEnabled": true,
      "doubleWriteEnabled": false,
      "limitedUrlMap": {},
      "distroServerExpiredMillis": 10000,
      "pushGoVersion": "0.1.0",
      "pushJavaVersion": "0.1.0",
      "pushPythonVersion": "0.4.3",
      "pushCVersion": "1.0.12",
      "pushCSharpVersion": "0.9.0",
      "enableAuthentication": false,
      "overriddenServerStatus": null,
      "defaultInstanceEphemeral": true,
      "healthCheckWhiteList": [],
      "name": "00-00---000-NACOS_SWITCH_DOMAIN-000---00-00",
      "checksum": null
    }
  }

修改系统开关

接口描述

修改系统开关

请求方式

PUT

Content-Type:application/x-www-form-urlencoded

请求URL

/nacos/v2/ns/operator/switches

请求Body

返回数据

示例

• 请求示例

  curl -d 'entry=pushEnabled' \
    -d 'value=false' \
    -d 'debug=true' \
    -X PUT 'http://127.0.0.1:8848/nacos/v2/ns/operator/switches'

• 返回示例

  {
        "code": 0,
        "message": "success",
        "data": "ok"
  }

查询系统当前数据指标

接口描述

查询系统当前数据指标

请求方式

GET

请求URL

/nacos/v2/ns/operator/metrics

请求参数

当onlyStatus设置为true时，只返回表示系统状态的字符串

返回数据

示例

• 请求示例

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

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": {
      "status": "UP",
      "serviceCount": 2,
      "instanceCount": 2,
      "subscribeCount": 2,
      "raftNotifyTaskCount": 0,
      "responsibleServiceCount": 0,
      "responsibleInstanceCount": 0,
      "clientCount": 2,
      "connectionBasedClientCount": 2,
      "ephemeralIpPortClientCount": 0,
      "persistentIpPortClientCount": 0,
      "responsibleClientCount": 2,
      "cpu": 0,
      "load": -1,
      "mem": 1
    }
  }

更新实例健康状态

接口描述

更新实例的健康状态

请求方式

PUT

Content-Type:application/x-www-form-urlencoded

请求URL

/nacos/v2/ns/health/instance

请求Body

返回数据

示例

• 请求示例

  curl -d 'serviceName=nacos.test.1' \
    -d 'ip=127.0.0.1' \
    -d 'port=8080' \
    -d 'healthy=false' \
    -X PUT 'http://127.0.0.1:8848/nacos/v2/ns/health/instance'

• 返回示例

  {
        "code": 0,
        "message": "success",
        "data": "ok"
  }

查询客户端列表（新）

接口描述

查询当前所有的客户端列表

请求方式

GET

请求URL

/nacos/v2/ns/client/list

返回数据

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/ns/client/list'

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": [
      "10.128.164.35:9956#true",
      "1664358687402_127.0.0.1_2300",
      "1664358642902_127.0.0.1_2229",
      "192.168.139.1:49825#true",
      "10.128.164.35:9954#true",
      "192.168.139.1:53556#true"
    ]
  }

对于不同版本的nacos client，建立客户端的方式不同。

对于1.x版本，每个实例会建立两个基于ip+port的客户端，分别对应实例注册与服务订阅，clientId格式为 ip:port#ephemeral

对于2.x版本的nacos client, 每个实例会建立一个RPC连接，对应一个基于RPC连接的客户端，兼具注册与订阅功能，clientId 格式为time_ip_port

查询客户端信息（新）

接口描述

查询指定客户端的详细信息

客户端不存在时会报错

请求方式

GET

请求URL

/nacos/v2/ns/client

请求参数

返回数据

只有当clientType为connection时，会显示connectType，appName和appName字段

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/ns/client?clientId=1664527081276_127.0.0.1_4400'

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": {
      "clientId": "1664527081276_127.0.0.1_4400",
      "ephemeral": true,
      "lastUpdatedTime": 1664527081642,
      "clientType": "connection",
      "connectType": "GRPC",
      "appName": "-",
      "version": "Nacos-Java-Client:v2.1.0",
      "clientIp": "10.128.164.35",
      "clientPort": "4400"
    }
  }

查询客户端的注册信息（新）

接口描述

查询指定客户端的注册信息

客户端不存在时会报错

请求方式

GET

请求URL

/nacos/v2/ns/client/publish/list

请求参数

返回数据

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/ns/client/publish/list?clientId=1664527081276_127.0.0.1_4400'

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": [
      {
        "namespace": "public",
        "group": "DEFAULT_GROUP",
        "serviceName": "nacos.test.1",
        "registeredInstance": {
          "ip": "10.128.164.35",
          "port": 9950,
          "cluster": "DEFAULT"
        }
      }
    ]
  }

查询客户端的订阅信息（新）

接口描述

查询指定客户端的订阅信息

客户端不存在时会报错

请求方式

GET

请求URL

/nacos/v2/ns/client/subscribe/list

请求参数

返回数据

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/ns/client/subscribe/list?clientId=1664527081276_127.0.0.1_4400'

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": [
      {
        "namespace": "public",
        "group": "DEFAULT_GROUP",
        "serviceName": "nacos.test.1",
        "subscriberInfo": {
          "app": "unknown",
          "agent": "Nacos-Java-Client:v2.1.0",
          "addr": "10.128.164.35"
        }
      }
    ]
  }

查询注册指定服务的客户端信息（新）

接口描述

查询注册指定服务的客户端信息

请求方式

GET

请求URL

/nacos/v2/ns/client/service/publisher/list

请求参数

返回数据

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/ns/client/service/publisher/list?serviceName=nacos.test.1&ip=&port='

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": [
      {
        "clientId": "1664527081276_127.0.0.1_4400",
        "ip": "10.128.164.35",
        "port": 9950
      },
      {
        "clientId": "10.128.164.35:9954#true",
        "ip": "10.128.164.35",
        "port": 9954
      }
    ]
  }

查询订阅指定服务的客户端信息（新）

接口描述

查询订阅指定服务的客户端信息

请求方式

GET

请求URL

/nacos/v2/ns/client/service/subscriber/list

请求参数

返回数据

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/ns/client/service/subscriber/list?serviceName=nacos.test.1&ip=&port='

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": [
      {
        "clientId": "1664527125645_127.0.0.1_4443",
        "ip": "10.128.164.35",
        "port": 0
      },
      {
        "clientId": "172.24.144.1:54126#true",
        "ip": "172.24.144.1",
        "port": 54126
      }
    ]
  }

命名空间

查询命名空间列表

接口描述

查询当前所有的命名空间

请求方式

GET

请求URL

/nacos/v2/console/namespace/list

返回数据

命名空间分为3种类型，0 - 全局命名空间 1 - 默认私有命名空间 2 - 自定义命名空间

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/console/namespace/list'

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": [
      {
        "namespace": "",
        "namespaceShowName": "public",
        "namespaceDesc": null,
        "quota": 200,
        "configCount": 1,
        "type": 0
      }
    ]
  }

查询具体命名空间

接口描述

查询具体命名空间的信息

命名空间不存在时会报错

请求方式

GET

请求URL

/nacos/v2/console/namespace

请求参数

返回数据

命名空间分为3种类型，0 - 全局命名空间 1 - 默认私有命名空间 2 - 自定义命名空间

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/console/namespace?namespaceId=test_namespace'

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": {
      "namespace": "test_namespace",
      "namespaceShowName": "test",
      "namespaceDesc": null,
      "quota": 200,
      "configCount": 0,
      "type": 2
    }
  }

创建命名空间

接口描述

创建一个命名空间

命名空间已存在时会报错

请求方式

POST

Content-Type:application/x-www-form-urlencoded

请求URL

/nacos/v2/console/namespace

请求Body

返回数据

示例

• 请求示例

  curl -d 'namespaceId=test_namespace' \
    -d 'namespaceName=test' \
    -X POST 'http://127.0.0.1:8848/nacos/v2/console/namespace'

• 返回示例

  {
        "code": 0,
        "message": "success",
        "data": true
  }

编辑命名空间

接口描述

编辑命名空间信息

请求方式

PUT

Content-Type:application/x-www-form-urlencoded

请求URL

/nacos/v2/console/namespace

请求Body

返回数据

示例

• 请求示例

  curl -d 'namespaceId=test_namespace' \
    -d 'namespaceName=test.nacos' \
    -X PUT 'http://127.0.0.1:8848/nacos/v2/console/namespace'

• 返回示例

  {
        "code": 0,
        "message": "success",
        "data": true
  }

删除命名空间

接口描述

删除指定命名空间

请求方式

DELETE

请求URL

/nacos/v2/console/namespace

请求参数

返回数据

示例

• 请求示例

  curl -d 'namespaceId=test_namespace' \
    -X DELETE 'http://127.0.0.1:8848/nacos/v2/console/namespace'

• 返回示例

  {
        "code": 0,
        "message": "success",
        "data": true
  }

集群管理

查询当前节点信息

接口描述

查询当前nacos节点信息

请求方式

GET

请求URL

/nacos/v2/core/cluster/node/self

返回数据

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/core/cluster/node/self'

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": {
      "ip": "10.128.164.35",
      "port": 8848,
      "state": "UP",
      "extendInfo": {
        "lastRefreshTime": 1664521263623,
        "raftMetaData": {
          "metaDataMap": {
            "naming_instance_metadata": {
              "leader": "10.128.164.35:7848",
              "raftGroupMember": [
                "10.128.164.35:7848"
              ],
              "term": 12
            },
            "naming_persistent_service_v2": {
              "leader": "10.128.164.35:7848",
              "raftGroupMember": [
                "10.128.164.35:7848"
              ],
              "term": 12
            },
            "naming_service_metadata": {
              "leader": "10.128.164.35:7848",
              "raftGroupMember": [
                "10.128.164.35:7848"
              ],
              "term": 12
            }
          }
        },
        "raftPort": "7848",
        "readyToUpgrade": true,
        "version": "2.1.0"
      },
      "address": "10.128.164.35:8848",
      "failAccessCnt": 0,
      "abilities": {
        "remoteAbility": {
          "supportRemoteConnection": true
        },
        "configAbility": {
          "supportRemoteMetrics": false
        },
        "namingAbility": {
          "supportJraft": true
        }
      }
    }
  }

查询集群节点列表

接口描述

查询集群节点列表

请求方式

GET

请求URL

/nacos/v2/core/cluster/node/list

请求参数

address 对应于需要查询的节点地址的前缀匹配条件，为空时不做限制

state对应节点状态的筛选条件，为空时不做限制

返回数据

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/core/cluster/node/list'

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": [
      {
        "ip": "10.128.164.35",
        "port": 8848,
        "state": "UP",
        "extendInfo": {
          "lastRefreshTime": 1664521263623,
          "raftMetaData": {
            "metaDataMap": {
              "naming_instance_metadata": {
                "leader": "10.128.164.35:7848",
                "raftGroupMember": [
                  "10.128.164.35:7848"
                ],
                "term": 12
              },
              "naming_persistent_service_v2": {
                "leader": "10.128.164.35:7848",
                "raftGroupMember": [
                  "10.128.164.35:7848"
                ],
                "term": 12
              },
              "naming_service_metadata": {
                "leader": "10.128.164.35:7848",
                "raftGroupMember": [
                  "10.128.164.35:7848"
                ],
                "term": 12
              }
            }
          },
          "raftPort": "7848",
          "readyToUpgrade": true,
          "version": "2.1.0"
        },
        "address": "10.128.164.35:8848",
        "failAccessCnt": 0,
        "abilities": {
          "remoteAbility": {
            "supportRemoteConnection": true
          },
          "configAbility": {
            "supportRemoteMetrics": false
          },
          "namingAbility": {
            "supportJraft": true
          }
        }
      }
    ]
  }

查询当前节点健康状态

接口描述

查询当前nacos节点健康状态

请求方式

GET

请求URL

/nacos/v2/core/cluster/node/self/health

返回数据

节点共有 STARTING， UP，SUSPICIOUS，DOWN，ISOLATION五种状态

示例

• 请求示例

  curl -X GET 'http://127.0.0.1:8848/nacos/v2/core/cluster/node/self/health'

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": "UP"
  }

切换集群寻址模式

接口描述

切换集群寻址模式

请求方式

PUT

Content-Type:application/x-www-form-urlencoded

请求URL

/nacos/v2/core/cluster/lookup

请求Body

寻址模式有两种：file（文件配置）和 address-server（地址服务器）

返回数据

示例

• 请求示例

  curl -d 'type=file' \
    -X PUT 'http://127.0.0.1:8848/nacos/v2/core/cluster/lookup'

• 返回示例

  {
    "code": 0,
    "message": "success",
    "data": true
  }