Register Nacos Instances for Service Discovery via API - MSE - Alibaba Cloud - Microservices Engine

Creates a Nacos instance.

Operation description

Note

This operation is not available in Nacos SDKs. For Nacos SDK details, see the official documentation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mse:CreateNacosInstance

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	mse-cn-123456
ServiceName	string	Yes	The name of the service.	hello_service
GroupName	string	Yes	The name of the group.	DEFAULT_GROUP
NamespaceId	string	No	The ID of the namespace.	9e78a671-4b9b-4dd4-99c1-0b9da87****
ClusterName	string	No	The name of the Nacos instance.	DEFAULT
Ip	string	Yes	The IP address of the Nacos instance.	1.2.xx.xx
Port	integer	Yes	The port number of the Nacos instance.	12281
Ephemeral	boolean	Yes	Whether to mark the instance as a temporary node.	false
Weight	string	Yes	The weight. Valid values: 0 to 10000. Must be an integer. A larger value indicates higher access frequency.	1
Enabled	boolean	Yes	Whether to enable the service for the instance.	true
Metadata	string	No	The node metadata of the instance.	{\"grayversion\":\"1.0\",\"preserved.register.source\":\"SPRING_CLOUD\",\"management.context-path\":\"\"}
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object	The data structure.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	9e78a671-4b9b-4dd4-99c1-0b9da87d3dec
Message	string	The response message.	The request is successfully processed.
Code	integer	The response code.	200
Success	boolean	Whether the request was successful.	true
Data	string	The response data.	ok

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "9e78a671-4b9b-4dd4-99c1-0b9da87d3dec",
  "Message": "The request is successfully processed.\n",
  "Code": 200,
  "Success": true,
  "Data": "ok"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.