程序包 com.alibaba.nacos.naming.controllers.v2

类 InstanceControllerV2

java.lang.Object

com.alibaba.nacos.naming.controllers.v2.InstanceControllerV2

@NacosApi
@RestController
@RequestMapping("/v2/ns/instance")
public class InstanceControllerV2
extends java.lang.Object

Instance operation controller for v2.x.

作者:

hujun

字段概要

字段

修饰符和类型	字段	说明
private InstanceOperatorClientImpl	instanceServiceV2
private SwitchDomain	switchDomain

构造器概要

构造器

构造器	说明
InstanceControllerV2()

方法概要

修饰符和类型	方法	说明
com.alibaba.nacos.api.model.v2.Result<InstanceMetadataBatchOperationVo>	batchDeleteInstanceMetadata(InstanceMetadataBatchOperationForm form)	Batch delete instance's metadata. old key exist = delete, old key not exist = not operate
com.alibaba.nacos.api.model.v2.Result<InstanceMetadataBatchOperationVo>	batchUpdateInstanceMetadata(InstanceMetadataBatchOperationForm form)	Batch update instance's metadata. old key exist = update, old key not exist = add.
com.fasterxml.jackson.databind.node.ObjectNode	beat(java.lang.String namespaceId, java.lang.String serviceName, java.lang.String ip, java.lang.String clusterName, java.lang.Integer port, java.lang.String beat)	Create a beat for instance.
private java.lang.String	buildCompositeServiceName(InstanceForm instanceForm)
private java.lang.String	buildCompositeServiceName(InstanceMetadataBatchOperationForm form)
private com.alibaba.nacos.api.naming.pojo.Instance	buildInstance(InstanceForm instanceForm)
private InstanceOperationInfo	buildOperationInfo(java.lang.String serviceName, java.lang.String consistencyType, java.util.List<com.alibaba.nacos.api.naming.pojo.Instance> instances)
private void	checkWeight(java.lang.Double weight)
com.alibaba.nacos.api.model.v2.Result<java.lang.String>	deregister(InstanceForm instanceForm)	Deregister instances.
com.alibaba.nacos.api.model.v2.Result<InstanceDetailInfoVo>	detail(java.lang.String namespaceId, java.lang.String groupName, java.lang.String serviceName, java.lang.String clusterName, java.lang.String ip, java.lang.Integer port)	Get detail information of specified instance.
com.alibaba.nacos.api.model.v2.Result<com.alibaba.nacos.api.naming.pojo.ServiceInfo>	list(java.lang.String namespaceId, java.lang.String groupName, java.lang.String serviceName, java.lang.String clusterName, java.lang.String ip, java.lang.Integer port, java.lang.Boolean healthyOnly, java.lang.String app, java.lang.String userAgent, java.lang.String clientVersion)	Get all instance of input service.
com.fasterxml.jackson.databind.node.ObjectNode	listWithHealthStatus(java.lang.String key)	List all instance with health status.
private java.util.List<com.alibaba.nacos.api.naming.pojo.Instance>	parseBatchInstances(java.lang.String instances)
java.lang.String	patch(java.lang.String namespaceId, java.lang.String serviceName, java.lang.String ip, java.lang.String cluster, java.lang.Integer port, java.lang.Double weight, java.lang.Boolean enabled, java.lang.String metadata)	Patch instance.
com.alibaba.nacos.api.model.v2.Result<java.lang.String>	register(InstanceForm instanceForm)	Register new instance.
com.alibaba.nacos.api.model.v2.Result<java.lang.String>	update(InstanceForm instanceForm)	Update instance.

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

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

字段详细资料

switchDomain

@Autowired
private SwitchDomain switchDomain

instanceServiceV2

@Autowired
private InstanceOperatorClientImpl instanceServiceV2

构造器详细资料

InstanceControllerV2

public InstanceControllerV2()

方法详细资料

register

@PostMapping
public com.alibaba.nacos.api.model.v2.Result<java.lang.String> register(InstanceForm instanceForm)
                                                                 throws com.alibaba.nacos.api.exception.NacosException

Register new instance.

抛出:

com.alibaba.nacos.api.exception.NacosException

deregister

@DeleteMapping
public com.alibaba.nacos.api.model.v2.Result<java.lang.String> deregister(InstanceForm instanceForm)
                                                                   throws com.alibaba.nacos.api.exception.NacosException

Deregister instances.

抛出:

com.alibaba.nacos.api.exception.NacosException

update

@PutMapping
public com.alibaba.nacos.api.model.v2.Result<java.lang.String> update(InstanceForm instanceForm)
                                                               throws com.alibaba.nacos.api.exception.NacosException

Update instance.

抛出:

com.alibaba.nacos.api.exception.NacosException

batchUpdateInstanceMetadata

@PutMapping("/metadata/batch")
public com.alibaba.nacos.api.model.v2.Result<InstanceMetadataBatchOperationVo> batchUpdateInstanceMetadata(InstanceMetadataBatchOperationForm form)
                                                                                                    throws com.alibaba.nacos.api.exception.NacosException

Batch update instance's metadata. old key exist = update, old key not exist = add.

抛出:

com.alibaba.nacos.api.exception.NacosException

batchDeleteInstanceMetadata

@DeleteMapping("/metadata/batch")
public com.alibaba.nacos.api.model.v2.Result<InstanceMetadataBatchOperationVo> batchDeleteInstanceMetadata(InstanceMetadataBatchOperationForm form)
                                                                                                    throws com.alibaba.nacos.api.exception.NacosException

Batch delete instance's metadata. old key exist = delete, old key not exist = not operate

抛出:

com.alibaba.nacos.api.exception.NacosException

buildOperationInfo

private InstanceOperationInfo buildOperationInfo(java.lang.String serviceName,
                                                 java.lang.String consistencyType,
                                                 java.util.List<com.alibaba.nacos.api.naming.pojo.Instance> instances)

parseBatchInstances

private java.util.List<com.alibaba.nacos.api.naming.pojo.Instance> parseBatchInstances(java.lang.String instances)

patch

@PatchMapping
public java.lang.String patch(@RequestParam(defaultValue="public")
                              java.lang.String namespaceId,
                              @RequestParam
                              java.lang.String serviceName,
                              @RequestParam
                              java.lang.String ip,
                              @RequestParam(defaultValue="DEFAULT")
                              java.lang.String cluster,
                              @RequestParam
                              java.lang.Integer port,
                              @RequestParam
                              java.lang.Double weight,
                              @RequestParam
                              java.lang.Boolean enabled,
                              @RequestParam
                              java.lang.String metadata)
                       throws java.lang.Exception

Patch instance.

参数:

namespaceId - namespace id

serviceName - service name

metadata - service metadata

cluster - service cluster

ip - instance ip

port - instance port

weight - instance weight

enabled - instance enabled

返回:

'ok' if success

抛出:

java.lang.Exception - any error during patch

list

@GetMapping("/list")
public com.alibaba.nacos.api.model.v2.Result<com.alibaba.nacos.api.naming.pojo.ServiceInfo> list(@RequestParam(value="namespaceId",defaultValue="public")
                                                                                                 java.lang.String namespaceId,
                                                                                                 @RequestParam(value="groupName",defaultValue="DEFAULT_GROUP")
                                                                                                 java.lang.String groupName,
                                                                                                 @RequestParam("serviceName")
                                                                                                 java.lang.String serviceName,
                                                                                                 @RequestParam(value="clusterName",defaultValue="")
                                                                                                 java.lang.String clusterName,
                                                                                                 @RequestParam(value="ip",defaultValue="")
                                                                                                 java.lang.String ip,
                                                                                                 @RequestParam(value="port",defaultValue="0")
                                                                                                 java.lang.Integer port,
                                                                                                 @RequestParam(value="healthyOnly",defaultValue="false")
                                                                                                 java.lang.Boolean healthyOnly,
                                                                                                 @RequestParam(value="app",defaultValue="")
                                                                                                 java.lang.String app,
                                                                                                 @RequestHeader(value="User-Agent",required=false)
                                                                                                 java.lang.String userAgent,
                                                                                                 @RequestHeader(value="Client-Version",required=false)
                                                                                                 java.lang.String clientVersion)

Get all instance of input service.

参数:

namespaceId - namespace id

groupName - group name

serviceName - service name

clusterName - service clusterName

ip - ip

port - port

healthyOnly - healthyOnly

app - app

userAgent - [header] userAgent

clientVersion - [header] clientVersion

detail

@GetMapping
public com.alibaba.nacos.api.model.v2.Result<InstanceDetailInfoVo> detail(@RequestParam(value="namespaceId",defaultValue="public")
                                                                          java.lang.String namespaceId,
                                                                          @RequestParam(value="groupName",defaultValue="DEFAULT_GROUP")
                                                                          java.lang.String groupName,
                                                                          @RequestParam("serviceName")
                                                                          java.lang.String serviceName,
                                                                          @RequestParam(value="clusterName",defaultValue="DEFAULT")
                                                                          java.lang.String clusterName,
                                                                          @RequestParam("ip")
                                                                          java.lang.String ip,
                                                                          @RequestParam("port")
                                                                          java.lang.Integer port)
                                                                   throws com.alibaba.nacos.api.exception.NacosException

Get detail information of specified instance.

参数:

namespaceId - service namespaceId

serviceName - service serviceName

clusterName - service clusterName

ip - instance ip

port - instance port

返回:

detail information of instance

抛出:

com.alibaba.nacos.api.exception.NacosException - any error during get

beat

@PutMapping("/beat")
public com.fasterxml.jackson.databind.node.ObjectNode beat(@RequestParam(defaultValue="public")
                                                           java.lang.String namespaceId,
                                                           @RequestParam
                                                           java.lang.String serviceName,
                                                           @RequestParam(defaultValue="")
                                                           java.lang.String ip,
                                                           @RequestParam(defaultValue="DEFAULT")
                                                           java.lang.String clusterName,
                                                           @RequestParam(defaultValue="0")
                                                           java.lang.Integer port,
                                                           @RequestParam(defaultValue="")
                                                           java.lang.String beat)
                                                    throws java.lang.Exception

Create a beat for instance.

参数:

namespaceId - service namespaceId

serviceName - service serviceName

ip - instance ip

clusterName - service clusterName

port - instance port

beat - instance beat info

返回:

detail information of instance

抛出:

java.lang.Exception - any error during handle

listWithHealthStatus

@RequestMapping("/statuses/{key}")
public com.fasterxml.jackson.databind.node.ObjectNode listWithHealthStatus(@PathVariable
                                                                           java.lang.String key)
                                                                    throws com.alibaba.nacos.api.exception.NacosException

List all instance with health status.

参数:

key - (namespace##)?serviceName

返回:

list of instance

抛出:

com.alibaba.nacos.api.exception.NacosException - any error during handle

checkWeight

private void checkWeight(java.lang.Double weight)
                  throws com.alibaba.nacos.api.exception.NacosException

抛出:

com.alibaba.nacos.api.exception.NacosException

buildInstance

private com.alibaba.nacos.api.naming.pojo.Instance buildInstance(InstanceForm instanceForm)
                                                          throws com.alibaba.nacos.api.exception.NacosException

抛出:

com.alibaba.nacos.api.exception.NacosException

buildCompositeServiceName

private java.lang.String buildCompositeServiceName(InstanceForm instanceForm)

buildCompositeServiceName

private java.lang.String buildCompositeServiceName(InstanceMetadataBatchOperationForm form)