Nacos Open API 概览

Nacos Open API 按调用者和使用场景分为 Client Open API、Admin Open API 和 Console Open API。本页用于帮助你先选对 API 类型，并了解统一返回体、错误码等公共约定。

如果已经确定要调用哪一类 API，请直接阅读对应 API 页中的“0. 相关说明”。那里会说明该类 API 的路径前缀、端口、鉴权和 Swagger 入口。

1. 先选择 API 类型

业务应用优先使用 Client SDK。只有在语言运行时暂时没有合适 SDK，或者只需要少量 HTTP 调用时，才建议直接使用 Client Open API。

不要把 Console Open API 当成通用运维接口。自定义控制台可以使用 Console Open API；运维自动化、发布平台和审计工具应优先使用 Admin Open API 或 Maintainer SDK。

2. Nacos Open API 访问协议

Nacos 3.0 主要支持两种访问协议， 分别为 gRPC 和 HTTP 1.1（下文简称HTTP）。根据不同的Nacos Open API分类的特点，分别使用不同的协议进行。

• Client Open API : 主要使用 gRPC协议进行访问，相比与HTTP 1.1， gRPC基于性能更高的 HTTP 2协议进行构建， 同时使用了多语言通用的protobuf序列化能力，能够快速构建多种编程语言的通信协议客户端，更能满足Client Open API对于高吞吐及响应速度的要求。考虑到部分编程语言可能未提供稳定的gRPC能力，Client Open API也提供HTTP 1.1协议的部分接口，允许开发者选择适合自己的编程语言进行开发。
• Admin Open API 和 Console Open API : 使用HTTP 1.1协议进行访问，允许开发者使用任何编程语言进行开发，同时对浏览器UI等有更好的兼容性。

3. Nacos Open API 定义规范

3.1. gRPC API 统一返回体格式

3.0版本的gRPC Open API，所有接口请求的响应均通过proto文件中的Payload承载，必然包含字段如下

3.2. HTTP API 统一返回体格式

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

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

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

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

3.3. API 错误码汇总

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