com.alibaba.nacos.config.server.controller

类 ConfigController

java.lang.Object

com.alibaba.nacos.config.server.controller.ConfigController

@RestController
 @RequestMapping(value="/v1/cs/configs")
public class ConfigController
extends Object

Special controller for soft load client to publish data.

作者:

leiwen

构造器概要

构造器

构造器和说明
ConfigController(ConfigServletInner configServletInner, PersistService persistService, ConfigSubService configSubService)

方法概要

限定符和类型	方法和说明
com.alibaba.nacos.common.model.RestResult<Map<String,Object>>	cloneConfig(javax.servlet.http.HttpServletRequest request, String srcUser, String namespace, List<SameNamespaceCloneConfigBean> configBeansList, SameConfigPolicy policy) Execute clone config operation.
Boolean	deleteConfig(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String dataId, String group, String tenant, String tag) Synchronously delete all pre-aggregation data under a dataId.
com.alibaba.nacos.common.model.RestResult<Boolean>	deleteConfigs(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, List<Long> ids) Execute delete config operation.
ConfigAllInfo	detailConfigInfo(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String dataId, String group, String tenant) Get the specific configuration information that the console USES.
org.springframework.http.ResponseEntity<byte[]>	exportConfig(String dataId, String group, String appName, String tenant, List<Long> ids) Execute export config operation.
org.springframework.http.ResponseEntity<byte[]>	exportConfigV2(String dataId, String group, String appName, String tenant, List<Long> ids) new version export config add metadata.yml file record config metadata.
Page<ConfigInfo>	fuzzySearchConfig(String dataId, String group, String appName, String tenant, String configTags, int pageNo, int pageSize) Fuzzy query configuration information.
void	getConfig(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String dataId, String group, String tenant, String tag) Get configure board information fail.
com.alibaba.nacos.common.model.RestResult<ConfigAdvanceInfo>	getConfigAdvanceInfo(String dataId, String group, String tenant)
GroupkeyListenserStatus	getListeners(String dataId, String group, String tenant, int sampleTime) Subscribe to configured client information.
com.alibaba.nacos.common.model.RestResult<Map<String,Object>>	importAndPublishConfig(javax.servlet.http.HttpServletRequest request, String srcUser, String namespace, SameConfigPolicy policy, org.springframework.web.multipart.MultipartFile file) Execute import and publish config operation.
void	listener(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) The client listens for configuration changes.
Boolean	publishConfig(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String dataId, String group, String tenant, String content, String tag, String appName, String srcUser, String configTags, String desc, String use, String effect, String type, String schema) Adds or updates non-aggregated data.
com.alibaba.nacos.common.model.RestResult<ConfigInfo4Beta>	queryBeta(String dataId, String group, String tenant) Execute to query beta operation.
Page<ConfigInfo>	searchConfig(String dataId, String group, String appName, String tenant, String configTags, int pageNo, int pageSize) Query the configuration information and return it in JSON format.
com.alibaba.nacos.common.model.RestResult<Boolean>	stopBeta(String dataId, String group, String tenant) Execute to remove beta operation.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ConfigController

@Autowired
public ConfigController(ConfigServletInner configServletInner,
                                    PersistService persistService,
                                    ConfigSubService configSubService)

方法详细资料

publishConfig

@PostMapping
public Boolean publishConfig(javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response,
                                           @RequestParam(value="dataId")
                                           String dataId,
                                           @RequestParam(value="group")
                                           String group,
                                           @RequestParam(value="tenant",required=false,defaultValue="")
                                           String tenant,
                                           @RequestParam(value="content")
                                           String content,
                                           @RequestParam(value="tag",required=false)
                                           String tag,
                                           @RequestParam(value="appName",required=false)
                                           String appName,
                                           @RequestParam(value="src_user",required=false)
                                           String srcUser,
                                           @RequestParam(value="config_tags",required=false)
                                           String configTags,
                                           @RequestParam(value="desc",required=false)
                                           String desc,
                                           @RequestParam(value="use",required=false)
                                           String use,
                                           @RequestParam(value="effect",required=false)
                                           String effect,
                                           @RequestParam(value="type",required=false)
                                           String type,
                                           @RequestParam(value="schema",required=false)
                                           String schema)
                                    throws NacosException

Adds or updates non-aggregated data.

抛出:

NacosException - NacosException.

getConfig

@GetMapping
public void getConfig(javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response,
                                   @RequestParam(value="dataId")
                                   String dataId,
                                   @RequestParam(value="group")
                                   String group,
                                   @RequestParam(value="tenant",required=false,defaultValue="")
                                   String tenant,
                                   @RequestParam(value="tag",required=false)
                                   String tag)
                            throws IOException,
                                   javax.servlet.ServletException,
                                   NacosException

Get configure board information fail.

抛出:

javax.servlet.ServletException - ServletException.

IOException - IOException.

NacosException - NacosException.

detailConfigInfo

@GetMapping(params="show=all")
public ConfigAllInfo detailConfigInfo(javax.servlet.http.HttpServletRequest request,
                                                                      javax.servlet.http.HttpServletResponse response,
                                                                      @RequestParam(value="dataId")
                                                                      String dataId,
                                                                      @RequestParam(value="group")
                                                                      String group,
                                                                      @RequestParam(value="tenant",required=false,defaultValue="")
                                                                      String tenant)
                                                               throws NacosException

Get the specific configuration information that the console USES.

抛出:

NacosException - NacosException.

deleteConfig

@DeleteMapping
public Boolean deleteConfig(javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response,
                                            @RequestParam(value="dataId")
                                            String dataId,
                                            @RequestParam(value="group")
                                            String group,
                                            @RequestParam(value="tenant",required=false,defaultValue="")
                                            String tenant,
                                            @RequestParam(value="tag",required=false)
                                            String tag)
                                     throws NacosException

Synchronously delete all pre-aggregation data under a dataId.

抛出:

NacosException - NacosException.

deleteConfigs

@DeleteMapping(params="delType=ids")
public com.alibaba.nacos.common.model.RestResult<Boolean> deleteConfigs(javax.servlet.http.HttpServletRequest request,
                                                                                                              javax.servlet.http.HttpServletResponse response,
                                                                                                              @RequestParam(value="ids")
                                                                                                              List<Long> ids)

Execute delete config operation.

返回:

java.lang.Boolean

getConfigAdvanceInfo

@GetMapping(value="/catalog")
public com.alibaba.nacos.common.model.RestResult<ConfigAdvanceInfo> getConfigAdvanceInfo(@RequestParam(value="dataId")
                                                                                                                        String dataId,
                                                                                                                        @RequestParam(value="group")
                                                                                                                        String group,
                                                                                                                        @RequestParam(value="tenant",required=false,defaultValue="")
                                                                                                                        String tenant)

listener

@PostMapping(value="/listener")
public void listener(javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response)
                                               throws javax.servlet.ServletException,
                                                      IOException

The client listens for configuration changes.

抛出:

javax.servlet.ServletException

IOException

getListeners

@GetMapping(value="/listener")
public GroupkeyListenserStatus getListeners(@RequestParam(value="dataId")
                                                                            String dataId,
                                                                            @RequestParam(value="group")
                                                                            String group,
                                                                            @RequestParam(value="tenant",required=false)
                                                                            String tenant,
                                                                            @RequestParam(value="sampleTime",required=false,defaultValue="1")
                                                                            int sampleTime)
                                                                     throws Exception

Subscribe to configured client information.

抛出:

Exception

searchConfig

@GetMapping(params="search=accurate")
public Page<ConfigInfo> searchConfig(@RequestParam(value="dataId")
                                                                            String dataId,
                                                                            @RequestParam(value="group")
                                                                            String group,
                                                                            @RequestParam(value="appName",required=false)
                                                                            String appName,
                                                                            @RequestParam(value="tenant",required=false,defaultValue="")
                                                                            String tenant,
                                                                            @RequestParam(value="config_tags",required=false)
                                                                            String configTags,
                                                                            @RequestParam(value="pageNo")
                                                                            int pageNo,
                                                                            @RequestParam(value="pageSize")
                                                                            int pageSize)

Query the configuration information and return it in JSON format.

fuzzySearchConfig

@GetMapping(params="search=blur")
public Page<ConfigInfo> fuzzySearchConfig(@RequestParam(value="dataId")
                                                                             String dataId,
                                                                             @RequestParam(value="group")
                                                                             String group,
                                                                             @RequestParam(value="appName",required=false)
                                                                             String appName,
                                                                             @RequestParam(value="tenant",required=false,defaultValue="")
                                                                             String tenant,
                                                                             @RequestParam(value="config_tags",required=false)
                                                                             String configTags,
                                                                             @RequestParam(value="pageNo")
                                                                             int pageNo,
                                                                             @RequestParam(value="pageSize")
                                                                             int pageSize)

Fuzzy query configuration information. Fuzzy queries based only on content are not allowed, that is, both dataId and group are NULL, but content is not NULL. In this case, all configurations are returned.

stopBeta

@DeleteMapping(params="beta=true")
public com.alibaba.nacos.common.model.RestResult<Boolean> stopBeta(@RequestParam(value="dataId")
                                                                                                       String dataId,
                                                                                                       @RequestParam(value="group")
                                                                                                       String group,
                                                                                                       @RequestParam(value="tenant",required=false,defaultValue="")
                                                                                                       String tenant)

Execute to remove beta operation.

参数:

dataId - dataId string value.

group - group string value.

tenant - tenant string value.

返回:

Execute to operate result.

queryBeta

@GetMapping(params="beta=true")
public com.alibaba.nacos.common.model.RestResult<ConfigInfo4Beta> queryBeta(@RequestParam(value="dataId")
                                                                                                             String dataId,
                                                                                                             @RequestParam(value="group")
                                                                                                             String group,
                                                                                                             @RequestParam(value="tenant",required=false,defaultValue="")
                                                                                                             String tenant)

Execute to query beta operation.

参数:

dataId - dataId string value.

group - group string value.

tenant - tenant string value.

返回:

RestResult for ConfigInfo4Beta.

exportConfig

@GetMapping(params="export=true")
public org.springframework.http.ResponseEntity<byte[]> exportConfig(@RequestParam(value="dataId",required=false)
                                                                                                       String dataId,
                                                                                                       @RequestParam(value="group",required=false)
                                                                                                       String group,
                                                                                                       @RequestParam(value="appName",required=false)
                                                                                                       String appName,
                                                                                                       @RequestParam(value="tenant",required=false,defaultValue="")
                                                                                                       String tenant,
                                                                                                       @RequestParam(value="ids",required=false)
                                                                                                       List<Long> ids)

Execute export config operation.

参数:

dataId - dataId string value.

group - group string value.

appName - appName string value.

tenant - tenant string value.

ids - id list value.

返回:

ResponseEntity.

exportConfigV2

@GetMapping(params="exportV2=true")
public org.springframework.http.ResponseEntity<byte[]> exportConfigV2(@RequestParam(value="dataId",required=false)
                                                                                                           String dataId,
                                                                                                           @RequestParam(value="group",required=false)
                                                                                                           String group,
                                                                                                           @RequestParam(value="appName",required=false)
                                                                                                           String appName,
                                                                                                           @RequestParam(value="tenant",required=false,defaultValue="")
                                                                                                           String tenant,
                                                                                                           @RequestParam(value="ids",required=false)
                                                                                                           List<Long> ids)

new version export config add metadata.yml file record config metadata.

参数:

dataId - dataId string value.

group - group string value.

appName - appName string value.

tenant - tenant string value.

ids - id list value.

返回:

ResponseEntity.

importAndPublishConfig

@PostMapping(params="import=true")
public com.alibaba.nacos.common.model.RestResult<Map<String,Object>> importAndPublishConfig(javax.servlet.http.HttpServletRequest request,
                                                                                                                                @RequestParam(value="src_user",required=false)
                                                                                                                                String srcUser,
                                                                                                                                @RequestParam(value="namespace",required=false)
                                                                                                                                String namespace,
                                                                                                                                @RequestParam(value="policy",defaultValue="ABORT")
                                                                                                                                SameConfigPolicy policy,
                                                                                                                                org.springframework.web.multipart.MultipartFile file)
                                                                                                                         throws NacosException

Execute import and publish config operation.

参数:

request - http servlet request .

srcUser - src user string value.

namespace - namespace string value.

policy - policy model.

file - MultipartFile.

返回:

RestResult Map.

抛出:

NacosException - NacosException.

cloneConfig

@PostMapping(params="clone=true")
public com.alibaba.nacos.common.model.RestResult<Map<String,Object>> cloneConfig(javax.servlet.http.HttpServletRequest request,
                                                                                                                    @RequestParam(value="src_user",required=false)
                                                                                                                    String srcUser,
                                                                                                                    @RequestParam(value="tenant",required=true)
                                                                                                                    String namespace,
                                                                                                                    @RequestBody(required=true)
                                                                                                                    List<SameNamespaceCloneConfigBean> configBeansList,
                                                                                                                    @RequestParam(value="policy",defaultValue="ABORT")
                                                                                                                    SameConfigPolicy policy)
                                                                                                             throws NacosException

Execute clone config operation.

参数:

request - http servlet request .

srcUser - src user string value.

namespace - namespace string value.

configBeansList - config beans list.

policy - config policy model.

返回:

RestResult for map.

抛出:

NacosException - NacosException.