{ "openapi": "3.1.0", "info": { "title": "Nacos控制台 API", "description": "Nacos控制台 API openAPI(swagger) 类型文档", "license": { "name": "Apache 2.0", "url": "https://github.com/alibaba/nacos/blob/develop/LICENSE" }, "version": "3.0.0-BETA" }, "servers": [ { "url": "http://localhost:8080", "description": "Generated server url" } ], "tags": [ { "name": "Nacos控制台注册中心服务实例相关API", "description": "Nacos控制台注册中心服务实例相关操作，包括查询服务实例列表，更新服务实例元数据。" }, { "name": "Nacos控制台命名空间相关API", "description": "Nacos控制台命名空间相关操作，获取命名空间列表，获取命名空间详情，创建命名空间，更新命名空间，删除命名空间，校验命名空间存在等。" }, { "name": "Nacos控制台配置中心相关API", "description": "Nacos控制台配置中心相关操作，获取配置列表，获取配置详情，发布配置，删除配置，批量删除配置，搜索配置，监听配置，导出配置，导入配置等。" }, { "name": "Nacos控制台注册中心服务相关API", "description": "Nacos控制台注册中心服务相关操作，包括创建服务，删除服务，查询服务列表，查询服务详情，查询服务订阅者列表等。" }, { "name": "Nacos控制台状态相关API", "description": "获取Nacos控制台的状态，公告和引导内容。" }, { "name": "Nacos控制台健康检查API", "description": "获取Nacos控制台健康状态的API。" }, { "name": "Nacos控制台配置历史相关API", "description": "Nacos控制台配置中心的配置历史版本相关操作，包括获取配置历史版本列表，获取配置历史版本详情等。" }, { "name": "Nacos控制台集群API", "description": "获取Nacos控制台所对应的Nacos集群的集群信息" } ], "paths": { "/v3/console/ns/service": { "get": { "tags": ["Nacos控制台注册中心服务相关API"], "summary": "查询服务详情", "description": "通过该接口，可以查询指定服务详情。", "operationId": "getServiceDetail", "parameters": [ { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query", "example": "DEFAULT_GROUP" }, { "name": "serviceName", "in": "query", "required": true, "example": "test" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": { "clusterMap": { "DEFAULT": { "clusterName": "DEFAULT", "healthChecker": { "type": "TCP" }, "healthyCheckPort": 80, "hosts": null, "metadata": {}, "useInstancePortForCheck": true } }, "ephemeral": false, "groupName": "DEFAULT_GROUP", "metadata": {}, "namespaceId": "public", "protectThreshold": 0.0, "selector": { "contextType": "NONE", "type": "none" }, "serviceName": "test" } } } } } } }, "security": [{ "nacos": [] }] }, "put": { "tags": ["Nacos控制台注册中心服务相关API"], "summary": "更新服务元数据", "description": "通过该接口，可以更新一个服务的元数据。仅能更新服务的元数据，如`metadata`、`selector` 等。服务的`serviceName`、`groupName`、`namespaceId`等不能更新。", "operationId": "updateService", "parameters": [ { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query", "example": "DEFAULT_GROUP" }, { "name": "serviceName", "in": "query", "required": true, "example": "test" }, { "name": "protectThreshold", "in": "query", "example": 0.5 }, { "name": "ephemeral", "in": "query", "example": false }, { "name": "selector", "in": "query", "example": { "type": "none" } }, { "name": "metadata", "in": "query", "example": { "version": "1.0" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": true } } } } } }, "security": [{ "nacos": [] }] }, "post": { "tags": ["Nacos控制台注册中心服务相关API"], "summary": "创建服务", "description": "通过该接口，可以创建一个空服务。", "operationId": "createService", "parameters": [ { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query", "example": "DEFAULT_GROUP" }, { "name": "serviceName", "in": "query", "required": true, "example": "test" }, { "name": "protectThreshold", "in": "query", "example": 0.5 }, { "name": "ephemeral", "in": "query", "example": false }, { "name": "selector", "in": "query", "example": { "type": "none" } }, { "name": "metadata", "in": "query", "example": { "version": "1.0" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": true } } } } } }, "security": [{ "nacos": [] }] }, "delete": { "tags": ["Nacos控制台注册中心服务相关API"], "summary": "删除服务", "description": "通过该接口，可以删除一个服务。 **注意此接口为删除服务，而不是删除服务实例（服务提供者），且当服务下还有服务实例存在时，服务会无法删除。**", "operationId": "deleteService", "parameters": [ { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query", "example": "DEFAULT_GROUP" }, { "name": "serviceName", "in": "query", "required": true, "example": "test" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": true } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/ns/service/cluster": { "put": { "tags": ["Nacos控制台注册中心服务相关API"], "summary": "更新服务集群元数据", "description": "通过该接口，可以更新指定服务集群的元数据。", "operationId": "updateCluster", "parameters": [ { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query", "example": "DEFAULT_GROUP" }, { "name": "serviceName", "in": "query", "required": true, "example": "test" }, { "name": "clusterName", "in": "query", "required": true, "example": "DEFAULT" }, { "name": "checkPort", "in": "query", "example": 8080 }, { "name": "useInstancePort4Check", "in": "query", "example": false }, { "name": "healthChecker", "in": "query", "example": { "type": "none" } }, { "name": "metadata", "in": "query", "example": { "version": "1.0" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": true } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/ns/instance": { "put": { "tags": ["Nacos控制台注册中心服务实例相关API"], "summary": "更新实例元数据", "description": "通过该接口，可以更新指定服务的实例元数据，包括`权重(weight)`和`上下线状态(enabled)`；`无法更新实例的服务名(serviceName)`、`分组名(groupName)`、`命名空间(namespace)`、`IP`及`端口(port)`。", "operationId": "updateInstance", "parameters": [ { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query", "example": "DEFAULT_GROUP" }, { "name": "serviceName", "in": "query", "required": true, "example": "test" }, { "name": "clusterName", "in": "query", "example": "DEFAULT" }, { "name": "ip", "in": "query", "required": true, "example": "127.0.0.1" }, { "name": "port", "in": "query", "required": true, "example": 8080 }, { "name": "weight", "in": "query", "example": 1.0 }, { "name": "healthy", "in": "query", "example": true }, { "name": "ephemeral", "in": "query", "example": true }, { "name": "enabled", "in": "query", "example": true }, { "name": "metadata", "in": "query", "example": { "zone": "a" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": true } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/core/namespace": { "get": { "tags": ["Nacos控制台命名空间相关API"], "summary": "获取命名空间详情", "description": "通过该接口，可以获取指定命名空间的详情。", "operationId": "getNamespaceDetail", "parameters": [ { "name": "namespaceId", "in": "query", "required": true, "example": "public" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": { "namespace": "public", "namespaceShowName": "public", "namespaceDesc": "Default Namespace", "quota": 200, "configCount": 0, "type": 0 } } } } } } }, "security": [{ "nacos": ["ADMIN:READ"] }] }, "put": { "tags": ["Nacos控制台命名空间相关API"], "summary": "更新命名空间", "description": "通过该接口，可以更新命名空间的信息，无法更新命名空间ID，仅能更新命名空间的名称和描述。", "operationId": "updateNamespace", "parameters": [ { "name": "namespaceId", "in": "query", "required": true, "example": "test" }, { "name": "namespaceName", "in": "query", "required": true, "example": "test" }, { "name": "namespaceDesc", "in": "query", "example": "test" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": true } } } } } }, "security": [{ "nacos": [] }] }, "post": { "tags": ["Nacos控制台命名空间相关API"], "summary": "创建新命名空间", "description": "通过该接口，可以创建新的命名空间。", "operationId": "createNamespace", "parameters": [ { "name": "customNamespaceId", "in": "query" }, { "name": "namespaceName", "in": "query", "required": true, "example": "test" }, { "name": "namespaceDesc", "in": "query", "example": "test" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": true } } } } } }, "security": [{ "nacos": [] }] }, "delete": { "tags": ["Nacos控制台命名空间相关API"], "summary": "删除命名空间", "description": "通过该接口，可以删除命名空间。默认命名空间`public`无法被删除。", "operationId": "deleteNamespace", "parameters": [ { "name": "namespaceId", "in": "query", "required": true, "example": "test" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": true } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/cs/config": { "get": { "tags": ["Nacos控制台配置中心相关API"], "summary": "获取配置详情", "description": "通过该接口，可以获取指定配置的详情。", "operationId": "getConfigDetail", "parameters": [ { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query", "required": true, "example": "DEFAULT_GROUP" }, { "name": "dataId", "in": "query", "required": true, "example": "test" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": { "appName": "", "configTags": null, "content": "test", "createIp": "127.0.0.1", "createTime": 1741681316620, "createUser": "nacos", "dataId": "test", "desc": null, "encryptedDataKey": "", "groupName": "test", "id": "873472517803610112", "md5": "098f6bcd4621d373cade4e832627b4f6", "modifyTime": 1741681316620, "namespaceId": "public", "type": "text" } } } } } } }, "security": [{ "nacos": [] }] }, "post": { "tags": ["Nacos控制台配置中心相关API"], "summary": "发布配置", "description": "通过该接口，可以创建新的配置或更新已有配置。", "operationId": "publishConfig", "parameters": [ { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query", "required": true, "example": "DEFAULT_GROUP" }, { "name": "dataId", "in": "query", "required": true, "example": "test" }, { "name": "content", "in": "query", "required": true, "example": "testContent" }, { "name": "desc", "in": "query", "example": "testDesc" }, { "name": "type", "in": "query", "example": "text" }, { "name": "configTags", "in": "query", "example": "customTag" }, { "name": "appName", "in": "query", "example": "testApp" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": false } } } } } }, "security": [{ "nacos": [] }] }, "delete": { "tags": ["Nacos控制台配置中心相关API"], "summary": "删除配置", "description": "通过该接口，可以删除指定配置。", "operationId": "deleteConfig", "parameters": [ { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query", "required": true, "example": "DEFAULT_GROUP" }, { "name": "dataId", "in": "query", "required": true, "example": "test" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": false } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/cs/config/import": { "post": { "tags": ["Nacos控制台配置中心相关API"], "summary": "导入配置", "description": "通过该接口，可以将从Nacos导出的zip文件导入到Nacos的指定命名空间中。**注意：目前导入配置接口能够同时支持旧版本导出的zip文件和新版本导出的zip文件，但后续版本将会移除对旧版本格式导入导出配置的支持，建议使用新的导出配置 接口进行配置文件的导出。**", "operationId": "importAndPublishConfig", "requestBody": { "content": { "multipart/form-data": {}, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "srcUser": { "type": "string" }, "namespaceId": { "type": "string" }, "policy": { "type": "string", "default": "ABORT", "enum": ["ABORT", "SKIP", "OVERWRITE"] }, "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result>", "example": { "code": 0, "message": "success", "data": { "succCount": 2, "skipCount": 0 } } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/cs/config/clone": { "post": { "tags": ["Nacos控制台配置中心相关API"], "summary": "克隆配置", "description": "通过该接口，可以将所选或所查询的配置克隆到其他命名空间。", "operationId": "cloneConfig", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result>", "example": { "code": 0, "message": "success", "data": { "succCount": 2, "skipCount": 0 } } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/server/state": { "get": { "tags": ["Nacos控制台状态相关API"], "summary": "获取集群状态信息", "description": "通过该接口，可以获取到Nacos 集群的基础状态和开关信息，例如：版本号，运行模式，鉴权是否开启等；该接口不会返回Nacos 集群的节点信息。", "operationId": "serverState", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "example": { "defaultMaxSize": "102400", "auth_system_type": "nacos", "auth_enabled": "false", "defaultMaxAggrSize": "1024", "maxHealthCheckFailCount": "12", "maxContent": "10485760", "console_ui_enabled": "true", "defaultMaxAggrCount": "10000", "auth_admin_request": "false", "defaultGroupQuota": "200", "config_retention_days": "30", "startup_mode": "standalone", "isHealthCheck": "true", "version": "3.0.0-SNAPSHOT", "function_mode": null, "isManageCapacity": "true", "isCapacityLimitCheck": "false", "datasource_platform": "", "notifyConnectTimeout": "100", "server_port": "8848", "notifySocketTimeout": "200", "defaultClusterQuota": "100000", "login_page_enabled": "false", "plugin_datasource_log_enabled": "false" } } } } } } } }, "/v3/console/server/guide": { "get": { "tags": ["Nacos控制台状态相关API"], "summary": "获取控制台引导内容", "description": "通过该接口，可以获取Nacos控制台的引导信息。Nacos默认控制台UI会在关闭Nacos控制台UI时调用，以获取引导信息，相关详情请参考控制台手册-关闭默认控制台。", "operationId": "getConsoleUiGuide", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": "当前节点已关闭Nacos开源控制台使用，请修改application.properties中的nacos.console.ui.enabled参数为true打开开源控制台使用，详情查看文档中关于关闭默认控制台部分。" } } } } } } } }, "/v3/console/server/announcement": { "get": { "tags": ["Nacos控制台状态相关API"], "summary": "获取控制台公告信息", "description": "通过该接口，可以获取到Nacos 控制台希望在浏览器中显示的公告信息。Nacos默认控制台UI会在未开启鉴权时调用此接口，返回集群未开启鉴权的提示。", "operationId": "getAnnouncement", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": "当前集群没有开启鉴权，请参考文档开启鉴权~" } } } } } } } }, "/v3/console/ns/service/subscribers": { "get": { "tags": ["Nacos控制台注册中心服务相关API"], "summary": "查询服务的订阅者列表", "description": "通过该接口，可以查询指定服务下的订阅者列表。", "operationId": "subscribers", "parameters": [ { "name": "pageNo", "in": "query", "required": true, "example": 1 }, { "name": "pageSize", "in": "query", "required": true, "example": 10 }, { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query", "example": "DEFAULT_GROUP" }, { "name": "serviceName", "in": "query", "required": true, "example": "test" }, { "name": "aggregation", "in": "query", "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result>", "example": { "code": 0, "data": { "pageItems": [ { "address": "127.0.0.1:0", "agent": "Nacos-Java-Client:v3.0.0-BETA", "appName": "unknown", "groupName": "DEFAULT_GROUP", "ip": "127.0.0.1", "namespaceId": "public", "port": 0, "serviceName": "test" } ], "pageNumber": 1, "pagesAvailable": 1, "totalCount": 1 }, "message": "success" } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/ns/service/selector/types": { "get": { "tags": ["Nacos控制台注册中心服务相关API"], "summary": "获取支持的服务路由选择器类型列表", "description": "通过该接口，可以获取支持的服务路由选择器类型列表，用于控制台UI在创建和更新服务时，选择对应的路由选择器类型的下拉选择框。", "operationId": "getSelectorTypeList", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result>", "example": { "code": 0, "message": "success", "data": ["label", "none"] } } } } } } } }, "/v3/console/ns/service/list": { "get": { "tags": ["Nacos控制台注册中心服务相关API"], "summary": "查询服务列表", "description": "通过该接口，可以查询指定命名空间下的服务列表。基于参数`withInstances`的不同，接口的返回内容可能不同，参数为`true`时，返回的列表中包含服务实例，对象为`ServiceDetailInfo`；参数为`false`时，返回的列表中不包含服务实例，对象为`ServiceView`；", "operationId": "getServiceList", "parameters": [ { "name": "pageNo", "in": "query", "required": true, "example": 1 }, { "name": "pageSize", "in": "query", "required": true, "example": 10 }, { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query", "example": "DEFAULT_GROUP" }, { "name": "serviceName", "in": "query", "required": true, "example": "test" }, { "name": "ignoreEmptyService", "in": "query", "example": true }, { "name": "withInstances", "in": "query", "example": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": { "pageItems": [ { "clusterCount": 1, "groupName": "DEFAULT_GROUP", "healthyInstanceCount": 1, "ipCount": 1, "name": "com.test.SyncCallbackService", "triggerFlag": "false" }, { "clusterCount": 1, "groupName": "DEFAULT_GROUP", "healthyInstanceCount": 0, "ipCount": 1, "name": "test", "triggerFlag": "true" } ], "pageNumber": 1, "pagesAvailable": 1, "totalCount": 2 } } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/ns/instance/list": { "get": { "tags": ["Nacos控制台注册中心服务实例相关API"], "summary": "查询服务的实例列表", "description": "通过该接口，可以查询指定服务的实例列表。", "operationId": "getInstanceList", "parameters": [ { "name": "pageNo", "in": "query", "required": true, "example": 1 }, { "name": "pageSize", "in": "query", "required": true, "example": 100 }, { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query", "example": "DEFAULT_GROUP" }, { "name": "serviceName", "in": "query", "required": true, "example": "test" }, { "name": "clusterName", "in": "query", "example": "DEFAULT" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result>", "example": { "code": 0, "message": "success", "data": { "pageItems": [ { "clusterName": "DEFAULT", "enabled": true, "ephemeral": false, "healthy": false, "instanceHeartBeatInterval": 5000, "instanceHeartBeatTimeOut": 15000, "instanceId": "1.1.1.1#3306#DEFAULT#DEFAULT_GROUP@@test", "instanceIdGenerator": "simple", "ip": "1.1.1.1", "ipDeleteTimeout": 30000, "metadata": {}, "port": 3306, "serviceName": "DEFAULT_GROUP@@test", "weight": 1.0 } ], "pageNumber": 1, "pagesAvailable": 1, "totalCount": 1 } } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/health/readiness": { "get": { "tags": ["Nacos控制台健康检查API"], "summary": "获取Nacos控制台的可读状态", "description": "通过该接口，可以获取Nacos控制台的是否处于可读取状态，即Nacos控制台是否可以读取到数据。", "operationId": "readiness", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": "ok" } } } } } } } }, "/v3/console/health/liveness": { "get": { "tags": ["Nacos控制台健康检查API"], "summary": "获取Nacos控制台的存活状态", "description": "通过该接口，可以获取Nacos控制台的存活状态，Nacos控制台是否可正常接受和响应请求。", "operationId": "liveness", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": "ok" } } } } } } } }, "/v3/console/cs/history": { "get": { "tags": ["Nacos控制台配置历史相关API"], "summary": "查询配置的某次历史变更记录", "description": "通过该接口，可以查询配置的某次历史变更记录。", "operationId": "getConfigHistoryInfo", "parameters": [ { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query", "required": true, "example": "DEFAULT_GROUP" }, { "name": "dataId", "in": "query", "required": true, "example": "test" }, { "name": "nid", "in": "query", "required": true, "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": { "pageItems": [ { "appName": "", "createTime": 1272988800000, "dataId": "111", "groupName": "DEFAULT_GROUP", "id": "18", "md5": null, "modifyTime": 1741683760489, "namespaceId": "public", "opType": "D", "publishType": "gray", "srcIp": "127.0.0.1", "srcUser": "nacos", "type": null }, { "appName": "", "createTime": 1272988800000, "dataId": "111", "groupName": "DEFAULT_GROUP", "id": "17", "md5": null, "modifyTime": 1741683449619, "namespaceId": "public", "opType": "I", "publishType": "gray", "srcIp": "0:0:0:0:0:0:0:1", "srcUser": "nacos", "type": null }, { "appName": "", "createTime": 1272988800000, "dataId": "111", "groupName": "DEFAULT_GROUP", "id": "7", "md5": null, "modifyTime": 1741682102157, "namespaceId": "public", "opType": "I", "publishType": "formal", "srcIp": "0:0:0:0:0:0:0:1", "srcUser": "nacos", "type": null } ], "pageNumber": 1, "pagesAvailable": 1, "totalCount": 3 } } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/cs/history/previous": { "get": { "tags": ["Nacos控制台配置历史相关API"], "summary": "查询配置最新状态的前一次变更历史", "description": "通过该接口，可以查询配置最新状态的前一次变更历史。", "operationId": "getPreviousConfigHistoryInfo", "parameters": [ { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query", "required": true, "example": "DEFAULT_GROUP" }, { "name": "dataId", "in": "query", "required": true, "example": "test" }, { "name": "id", "in": "query", "required": true, "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": { "appName": "", "content": "bbb11xx", "createTime": 1272988800000, "dataId": "111", "encryptedDataKey": "", "extInfo": "{\"src_user\":\"nacos\",\"type\":\"text\",\"c_desc\":\"111\"}", "grayName": "", "groupName": "DEFAULT_GROUP", "id": "7", "md5": "7d37afdb0b04d958d529bcb6de44fa71", "modifyTime": 1741682102157, "namespaceId": "public", "opType": "I", "publishType": "formal", "srcIp": "0:0:0:0:0:0:0:1", "srcUser": "nacos", "type": null } } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/cs/history/list": { "get": { "tags": ["Nacos控制台配置历史相关API"], "summary": "查询配置发布历史", "description": "通过该接口，可以查询配置的发布历史。", "operationId": "listConfigHistory", "parameters": [ { "name": "pageNo", "in": "query", "required": true, "example": 1 }, { "name": "pageSize", "in": "query", "required": true, "example": 100 }, { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query", "required": true }, { "name": "dataId", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result>", "example": { "code": 0, "message": "success", "data": { "appName": "", "content": "bbb11xx", "createTime": 1272988800000, "dataId": "111", "encryptedDataKey": "", "extInfo": "{\"src_user\":\"nacos\",\"type\":\"text\",\"c_desc\":\"111\"}", "grayName": "", "groupName": "DEFAULT_GROUP", "id": "7", "md5": "7d37afdb0b04d958d529bcb6de44fa71", "modifyTime": 1741682102157, "namespaceId": "public", "opType": "I", "publishType": "formal", "srcIp": "0:0:0:0:0:0:0:1", "srcUser": "nacos", "type": null } } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/cs/history/configs": { "get": { "tags": ["Nacos控制台配置历史相关API"], "summary": "查询命名空间下的配置列表", "description": "通过该接口，可以查询命名空间下的配置列表，仅查询`dataId`和`groupName`，用于配置历史UI的下拉选择。", "operationId": "getConfigsByTenant", "parameters": [ { "name": "namespaceId", "in": "query", "example": "public" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result>", "example": { "code": 0, "message": "success", "data": [ { "appName": "", "createTime": 0, "dataId": "111", "groupName": "DEFAULT_GROUP", "id": "0", "md5": null, "modifyTime": 1741682102161, "namespaceId": "public", "type": "text" }, { "appName": "", "createTime": 0, "dataId": "qtc-user.yaml", "groupName": "DEFAULT_GROUP", "id": "0", "md5": null, "modifyTime": 1741682291519, "namespaceId": "public", "type": "text" } ] } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/cs/config/searchDetail": { "get": { "tags": ["Nacos控制台配置中心相关API"], "summary": "通过配置内容查询配置", "description": "通过该接口，可以通过配置内容查询对应配置的列表。**注意：此接口性能较低，过多调用容易造成稳定性问题，请尽量使用其他接口。**", "operationId": "getConfigListByContent", "parameters": [ { "name": "configDetail", "in": "query", "required": true, "schema": { "type": "string" }, "example": "*test*" }, { "name": "pageNo", "in": "query", "required": true, "example": 1 }, { "name": "pageSize", "in": "query", "required": true, "example": 100 }, { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query" }, { "name": "dataId", "in": "query" }, { "name": "type", "in": "query", "example": "text" }, { "name": "configTags", "in": "query", "example": "customTag" }, { "name": "appName", "in": "query", "example": "testApp" }, { "name": "search", "in": "query", "description": "blur or accurate", "example": "blur" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result>", "example": { "code": 0, "message": "success", "data": { "pageItems": [ { "appName": "", "createTime": 0, "dataId": "111", "groupName": "DEFAULT_GROUP", "id": "873475812546842624", "md5": null, "modifyTime": 0, "namespaceId": "public", "type": "text" } ], "pageNumber": 1, "pagesAvailable": 1, "totalCount": 1 } } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/cs/config/listener": { "get": { "tags": ["Nacos控制台配置中心相关API"], "summary": "查询配置的监听者列表", "description": "通过该接口，可以查询指定配置的监听者列表。", "operationId": "getListeners", "parameters": [ { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query", "required": true, "example": "DEFAULT_GROUP" }, { "name": "dataId", "in": "query", "required": true, "example": "test" }, { "name": "aggregation", "in": "query", "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": { "listenersStatus": { "127.0.0.1": "32cacc65accfdab47954de3fc781e938" }, "queryType": "config" } } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/cs/config/listener/ip": { "get": { "tags": ["Nacos控制台配置中心相关API"], "summary": "查询某个订阅者IP订阅了哪些配置", "description": "通过该接口，可以查询某个订阅者IP订阅了哪些配置。", "operationId": "getAllSubClientConfigByIp", "parameters": [ { "name": "ip", "in": "query", "required": true, "example": "127.0.0.1" }, { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "aggregation", "in": "query", "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": { "listenersStatus": { "qtc-user.yaml+DEFAULT_GROUP+public": "32cacc65accfdab47954de3fc781e938" }, "queryType": "ip" } } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/cs/config/list": { "get": { "tags": ["Nacos控制台配置中心相关API"], "summary": "查询配置列表", "description": "通过该接口，可以查询指定命名空间下的配置列表。", "operationId": "getConfigList", "parameters": [ { "name": "pageNo", "in": "query", "required": true, "example": 1 }, { "name": "pageSize", "in": "query", "required": true, "example": 100 }, { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query", "required": true }, { "name": "dataId", "in": "query", "required": true }, { "name": "type", "in": "query", "example": "text" }, { "name": "configTags", "in": "query", "example": "customTag" }, { "name": "appName", "in": "query", "example": "testApp" }, { "name": "search", "in": "query", "description": "blur or accurate", "example": "blur" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result>", "example": { "code": 0, "message": "success", "data": { "pageItems": [ { "appName": "", "createTime": 0, "dataId": "aaa", "groupName": "DEFAULT_GROUP", "id": "873471898128748544", "md5": null, "modifyTime": 0, "namespaceId": "public", "type": "text" }, { "appName": "", "createTime": 0, "dataId": "bbb", "groupName": "DEFAULT_GROUP", "id": "873473460813172736", "md5": null, "modifyTime": 0, "namespaceId": "public", "type": "text" } ], "pageNumber": 1, "pagesAvailable": 1, "totalCount": 2 } } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/cs/config/export2": { "get": { "tags": ["Nacos控制台配置中心相关API"], "summary": "导出配置", "description": "通过该接口，可以将所选或所查询的配置，导出的配置为zip文件，进行备份或导入到其他Nacos集群。使用时建议分开使用 `ids` 和 `dataId + groupName` 的组合，只选择一种方式，另一类传入空字符串，否则可能导致导出文件为空内容。", "operationId": "exportConfigV2", "parameters": [ { "name": "namespaceId", "in": "query" }, { "name": "groupName", "in": "query" }, { "name": "dataId", "in": "query" }, { "name": "ids", "in": "query", "example": "1,2,3" } ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": {} } } }, "security": [{ "nacos": [] }] } }, "/v3/console/cs/config/beta": { "get": { "tags": ["Nacos控制台配置中心相关API"], "summary": "查询配置Beta发布状态", "description": "通过该接口，可以查询配置的BETA发布状态。**注意：只有在发布配置时设置了Header的betaIps后，将配置变更为BETA发布中的状态，调用此接口才能停止BETA发布状态。**", "operationId": "queryBeta", "parameters": [ { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query", "required": true, "example": "DEFAULT_GROUP" }, { "name": "dataId", "in": "query", "required": true, "example": "test" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": { "appName": "", "configTags": null, "content": "bbb11xxccc", "createIp": null, "createTime": 0, "createUser": "nacos", "dataId": "111", "desc": null, "encryptedDataKey": null, "grayName": "beta", "grayRule": "{\"type\":\"beta\",\"version\":\"1.0.0\",\"expr\":\"1.1.1.1\",\"priority\":2147483647}", "groupName": "DEFAULT_GROUP", "id": "873481464488923136", "md5": "2f080e5e21ba12bb8ca6894ac0fc5862", "modifyTime": 1741683449619, "namespaceId": "public", "type": null } } } } } } }, "security": [{ "nacos": [] }] }, "delete": { "tags": ["Nacos控制台配置中心相关API"], "summary": "停止配置BETA发布", "description": "通过该接口，可以将配置从BETA发布状态停止，即回滚配置的Beta发布状态。**注意：只有在发布配置时设置了Header的betaIps后，将配置变更为BETA发布中的状态，调用此接口才能停止BETA发布状态。**", "operationId": "stopBeta", "parameters": [ { "name": "namespaceId", "in": "query", "example": "public" }, { "name": "groupName", "in": "query", "required": true, "example": "DEFAULT_GROUP" }, { "name": "dataId", "in": "query", "required": true, "example": "test" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": true } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/core/namespace/list": { "get": { "tags": ["Nacos控制台命名空间相关API"], "summary": "获取Nacos命名空间列表", "description": "通过该接口，可以获取当前Nacos集群的命名空间列表。", "operationId": "getNamespaceList", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result>", "example": { "code": 0, "message": "success", "data": [ { "namespace": "public", "namespaceShowName": "public", "namespaceDesc": "Default Namespace", "quota": 200, "configCount": 0, "type": 0 } ] } } } } } } } }, "/v3/console/core/namespace/exist": { "get": { "tags": ["Nacos控制台命名空间相关API"], "summary": "检查命名空间是否存在", "description": "通过该接口，可以检查命名空间ID是否存在。默认控制台ID将在创建命名空间前调用，确认自定义的命名空间ID是否已经存在，以防冲突。", "operationId": "checkNamespaceIdExist", "parameters": [ { "name": "customNamespaceId", "in": "query", "required": true, "example": "public" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": false } } } } } } } }, "/v3/console/core/cluster/nodes": { "get": { "tags": ["Nacos控制台集群API"], "summary": "获取Nacos节点运行信息", "description": "通过该接口，可以获取Nacos节点运行信息，包括节点ip，节点运行状态，节点元数据等。", "operationId": "getNodeList", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result>", "example": { "code": 0, "message": "success", "data": [ { "ip": "127.0.0.1", "port": 8848, "state": "UP", "extendInfo": { "lastRefreshTime": 1733221062619, "raftMetaData": { "metaDataMap": { "naming_instance_metadata": { "leader": "127.0.0.1:7848", "raftGroupMember": ["127.0.0.1:7848"], "term": 1 }, "naming_persistent_service": { "leader": "127.0.0.1:7848", "raftGroupMember": ["127.0.0.1:7848"], "term": 1 }, "naming_persistent_service_v2": { "leader": "127.0.0.1:7848", "raftGroupMember": ["127.0.0.1:7848"], "term": 1 }, "naming_service_metadata": { "leader": "127.0.0.1:7848", "raftGroupMember": ["127.0.0.1:7848"], "term": 1 } } }, "raftPort": "7848", "readyToUpgrade": true, "supportGrayModel": true, "version": "3.0.0-SNAPSHOT" }, "address": "127.0.0.1:8848", "failAccessCnt": 0, "abilities": { "remoteAbility": { "supportRemoteConnection": true, "grpcReportEnabled": true }, "configAbility": { "supportRemoteMetrics": false }, "namingAbility": { "supportJraft": true } }, "grpcReportEnabled": true } ] } } } } } }, "security": [{ "nacos": [] }] } }, "/v3/console/cs/config/batchDelete": { "delete": { "tags": ["Nacos控制台配置中心相关API"], "summary": "批量删除配置", "description": "通过该接口，可以批量删除指定配置。", "operationId": "batchDeleteConfigs", "parameters": [ { "name": "id", "in": "query", "required": true, "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result", "example": { "code": 0, "message": "success", "data": false } } } } } }, "security": [{ "nacos": [] }] } } }, "components": { "schemas": { "Tcp": { "allOf": [{ "$ref": "#/components/schemas/AbstractHealthChecker" }] }, "Result>": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "data": { "properties": { "totalCount": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pagesAvailable": { "type": "integer", "format": "int32" }, "pageItems": { "type": "array", "items": { "properties": { "namespaceId": { "type": "string" }, "groupName": { "type": "string" }, "serviceName": { "type": "string" }, "ip": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "agent": { "type": "string" }, "appName": { "type": "string" }, "address": { "type": "string" } } } } } } } }, "Instance": { "properties": { "instanceId": { "type": "string" }, "ip": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "weight": { "type": "number", "format": "double" }, "healthy": { "type": "boolean" }, "enabled": { "type": "boolean" }, "ephemeral": { "type": "boolean" }, "clusterName": { "type": "string" }, "serviceName": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "ipDeleteTimeout": { "type": "integer", "format": "int64" }, "instanceIdGenerator": { "type": "string" }, "instanceHeartBeatInterval": { "type": "integer", "format": "int64" }, "instanceHeartBeatTimeOut": { "type": "integer", "format": "int64" } } }, "Result": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "data": { "type": "object", "$ref": "#/components/schemas/ConfigListenerInfo" } } }, "Result": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "data": { "type": "object", "$ref": "#/components/schemas/ConfigGrayInfo" } } }, "Result>": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "properties": { "namespace": { "type": "string" }, "namespaceShowName": { "type": "string" }, "namespaceDesc": { "type": "string" }, "quota": { "type": "integer", "format": "int32" }, "configCount": { "type": "integer", "format": "int32" }, "type": { "type": "integer", "format": "int32" } } } } } }, "Http": { "allOf": [ { "$ref": "#/components/schemas/AbstractHealthChecker" }, { "type": "object", "properties": { "path": { "type": "string" }, "headers": { "type": "string" }, "expectedResponseCode": { "type": "integer", "format": "int32" } } } ] }, "ServerConfigAbility": { "properties": { "supportRemoteMetrics": { "type": "boolean" } } }, "Result>": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "properties": { "ip": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "state": { "type": "string", "enum": ["STARTING", "UP", "SUSPICIOUS", "DOWN", "ISOLATION"] }, "extendInfo": { "type": "object", "additionalProperties": { "type": "object" } }, "address": { "type": "string" }, "abilities": { "$ref": "#/components/schemas/ServerAbilities" } } } } } }, "Result": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "data": { "type": "string" } } }, "Result>": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "format": "int64" }, "namespaceId": { "type": "string" }, "groupName": { "type": "string" }, "dataId": { "type": "string" }, "md5": { "type": "string" }, "type": { "type": "string" }, "appName": { "type": "string" }, "createTime": { "type": "integer", "format": "int64" }, "modifyTime": { "type": "integer", "format": "int64" } } } } } }, "ConfigBasicInfo": { "properties": { "id": { "type": "integer", "format": "int64" }, "namespaceId": { "type": "string" }, "groupName": { "type": "string" }, "dataId": { "type": "string" }, "md5": { "type": "string" }, "type": { "type": "string" }, "appName": { "type": "string" }, "createTime": { "type": "integer", "format": "int64" }, "modifyTime": { "type": "integer", "format": "int64" } } }, "ServiceDetailInfo": { "properties": { "namespaceId": { "type": "string" }, "serviceName": { "type": "string" }, "groupName": { "type": "string" }, "clusterMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ClusterInfo" } }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "protectThreshold": { "type": "number", "format": "float" }, "selector": { "$ref": "#/components/schemas/Selector" }, "ephemeral": { "type": "boolean" } } }, "Result": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "data": { "type": "object", "$ref": "#/components/schemas/ConfigHistoryDetailInfo" } } }, "Result>": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "data": { "properties": { "totalCount": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pagesAvailable": { "type": "integer", "format": "int32" }, "pageItems": { "type": "array", "items": { "properties": { "id": { "type": "integer", "format": "int64" }, "namespaceId": { "type": "string" }, "groupName": { "type": "string" }, "dataId": { "type": "string" }, "md5": { "type": "string" }, "type": { "type": "string" }, "appName": { "type": "string" }, "createTime": { "type": "integer", "format": "int64" }, "modifyTime": { "type": "integer", "format": "int64" } } } } } } } }, "Result": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "data": { "type": "boolean" } } }, "ConfigDetailInfo": { "properties": { "id": { "type": "integer", "format": "int64" }, "namespaceId": { "type": "string" }, "groupName": { "type": "string" }, "dataId": { "type": "string" }, "md5": { "type": "string" }, "type": { "type": "string" }, "appName": { "type": "string" }, "createTime": { "type": "integer", "format": "int64" }, "modifyTime": { "type": "integer", "format": "int64" }, "content": { "type": "string" }, "desc": { "type": "string" }, "encryptedDataKey": { "type": "string" }, "createUser": { "type": "string" }, "createIp": { "type": "string" }, "configTags": { "type": "string" } } }, "Result>": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "data": { "properties": { "totalCount": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pagesAvailable": { "type": "integer", "format": "int32" }, "pageItems": { "type": "array", "items": { "properties": { "id": { "type": "integer", "format": "int64" }, "namespaceId": { "type": "string" }, "groupName": { "type": "string" }, "dataId": { "type": "string" }, "md5": { "type": "string" }, "type": { "type": "string" }, "appName": { "type": "string" }, "createTime": { "type": "integer", "format": "int64" }, "modifyTime": { "type": "integer", "format": "int64" }, "srcIp": { "type": "string" }, "srcUser": { "type": "string" }, "opType": { "type": "string" }, "publishType": { "type": "string" } } } } } } } }, "Result": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "data": { "type": "object", "$ref": "#/components/schemas/Namespace" } } }, "Selector": { "discriminator": { "propertyName": "type" }, "properties": { "type": { "type": "string" }, "contextType": { "type": "string" } } }, "Result": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "data": { "type": "object", "$ref": "#/components/schemas/ServiceDetailInfo" } } }, "Result": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "data": {} } }, "NacosMember": { "properties": { "ip": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "state": { "type": "string", "enum": ["STARTING", "UP", "SUSPICIOUS", "DOWN", "ISOLATION"] }, "extendInfo": { "type": "object", "additionalProperties": { "type": "object" } }, "address": { "type": "string" }, "abilities": { "$ref": "#/components/schemas/ServerAbilities" } } }, "Result>": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "type": "string" } } } }, "ConfigHistoryDetailInfo": { "properties": { "id": { "type": "integer", "format": "int64" }, "namespaceId": { "type": "string" }, "groupName": { "type": "string" }, "dataId": { "type": "string" }, "md5": { "type": "string" }, "type": { "type": "string" }, "appName": { "type": "string" }, "createTime": { "type": "integer", "format": "int64" }, "modifyTime": { "type": "integer", "format": "int64" }, "srcIp": { "type": "string" }, "srcUser": { "type": "string" }, "opType": { "type": "string" }, "publishType": { "type": "string" }, "content": { "type": "string" }, "encryptedDataKey": { "type": "string" }, "grayName": { "type": "string" }, "extInfo": { "type": "string" } } }, "ConfigHistoryBasicInfo": { "properties": { "id": { "type": "integer", "format": "int64" }, "namespaceId": { "type": "string" }, "groupName": { "type": "string" }, "dataId": { "type": "string" }, "md5": { "type": "string" }, "type": { "type": "string" }, "appName": { "type": "string" }, "createTime": { "type": "integer", "format": "int64" }, "modifyTime": { "type": "integer", "format": "int64" }, "srcIp": { "type": "string" }, "srcUser": { "type": "string" }, "opType": { "type": "string" }, "publishType": { "type": "string" } } }, "ServerRemoteAbility": { "properties": { "supportRemoteConnection": { "type": "boolean" }, "grpcReportEnabled": { "type": "boolean" } } }, "ConfigListenerInfo": { "properties": { "queryType": { "type": "string" }, "listenersStatus": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AbstractHealthChecker": { "discriminator": { "propertyName": "type" }, "properties": { "type": { "type": "string" } }, "required": ["type"] }, "Namespace": { "properties": { "namespace": { "type": "string" }, "namespaceShowName": { "type": "string" }, "namespaceDesc": { "type": "string" }, "quota": { "type": "integer", "format": "int32" }, "configCount": { "type": "integer", "format": "int32" }, "type": { "type": "integer", "format": "int32" } } }, "Result>": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "data": { "properties": { "totalCount": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pagesAvailable": { "type": "integer", "format": "int32" }, "pageItems": { "type": "array", "items": { "properties": { "instanceId": { "type": "string" }, "ip": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "weight": { "type": "number", "format": "double" }, "healthy": { "type": "boolean" }, "enabled": { "type": "boolean" }, "ephemeral": { "type": "boolean" }, "clusterName": { "type": "string" }, "serviceName": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "ipDeleteTimeout": { "type": "integer", "format": "int64" }, "instanceIdGenerator": { "type": "string" }, "instanceHeartBeatInterval": { "type": "integer", "format": "int64" }, "instanceHeartBeatTimeOut": { "type": "integer", "format": "int64" } } } } } } } }, "ConfigGrayInfo": { "properties": { "id": { "type": "integer", "format": "int64" }, "namespaceId": { "type": "string" }, "groupName": { "type": "string" }, "dataId": { "type": "string" }, "md5": { "type": "string" }, "type": { "type": "string" }, "appName": { "type": "string" }, "createTime": { "type": "integer", "format": "int64" }, "modifyTime": { "type": "integer", "format": "int64" }, "content": { "type": "string" }, "desc": { "type": "string" }, "encryptedDataKey": { "type": "string" }, "createUser": { "type": "string" }, "createIp": { "type": "string" }, "configTags": { "type": "string" }, "grayName": { "type": "string" }, "grayRule": { "type": "string" } } }, "ClusterInfo": { "properties": { "clusterName": { "type": "string" }, "healthChecker": { "$ref": "#/components/schemas/AbstractHealthChecker" }, "healthyCheckPort": { "type": "integer", "format": "int32" }, "useInstancePortForCheck": { "type": "boolean" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "hosts": { "type": "array", "items": { "$ref": "#/components/schemas/Instance" } } } }, "Result": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "data": { "type": "object", "$ref": "#/components/schemas/ConfigDetailInfo" } } }, "Mysql": { "allOf": [ { "$ref": "#/components/schemas/AbstractHealthChecker" }, { "type": "object", "properties": { "user": { "type": "string" }, "pwd": { "type": "string" }, "cmd": { "type": "string" } } } ] }, "ServerNamingAbility": { "properties": { "supportJraft": { "type": "boolean" } } }, "Result>": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "data": { "type": "object", "additionalProperties": {} } } }, "ServerAbilities": { "properties": { "remoteAbility": { "$ref": "#/components/schemas/ServerRemoteAbility" }, "configAbility": { "$ref": "#/components/schemas/ServerConfigAbility" }, "namingAbility": { "$ref": "#/components/schemas/ServerNamingAbility" } } }, "None": { "allOf": [{ "$ref": "#/components/schemas/AbstractHealthChecker" }] }, "SubscriberInfo": { "properties": { "namespaceId": { "type": "string" }, "groupName": { "type": "string" }, "serviceName": { "type": "string" }, "ip": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "agent": { "type": "string" }, "appName": { "type": "string" }, "address": { "type": "string" } } } }, "securitySchemes": { "nacos": { "type": "apiKey", "description": "传入通过`login`接口获得的`accessToken`", "name": "accessToken", "in": "header" } } } }