DeleteNacosInstance - Microservices Engine - Alibaba Cloud Documentation Center

Deletes a persistent application instance from a Microservices Engine (MSE) Nacos instance.

Operation description

Note The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the official documentation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mse:DeleteNacosInstance		Cluster acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Nacos instance.	mse-cn-st21v5****
ServiceName	string	Yes	The name of the service.	hello_service
NamespaceId	string	No	The ID of the namespace.	9e78a671-4b9b-4dd4-99c1-0b9da87****
GroupName	string	Yes	The name of the group.	DEFAULT_GROUP
ClusterName	string	No	The alias of the cluster.	DEFAULT
Ip	string	Yes	The IP address of the Nacos instance.	10.237.1.32
Port	integer	Yes	The port of the Nacos instance.	8080
Ephemeral	boolean	Yes	Specifies whether the node is an ephemeral node. Valid values: `true`: yes `false`: no	false
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	RestResult
RequestId	string	The ID of the request.	8BD1E58D-0755-42AC-A599-E6B55112****
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Code	integer	The status code. The value 200 is returned if the request is successful.	200
ErrorCode	string	The error code returned if the request failed.	mse-100-000
HttpStatusCode	integer	The HTTP status code returned.	200
Message	string	The error message returned.	The request was successfully processed.
DynamicMessage	string	The dynamic part in the error message.	The specified parameter is invalid.
Data	string	The data of the node.	OK

Examples

Sample success responses

JSONformat

{
  "RequestId": "8BD1E58D-0755-42AC-A599-E6B55112****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "The request was successfully processed.\n",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": "OK"
}

Error codes

HTTP status code	Error code	Error message	Description
400	duplicatedClusterAliasName	duplicated cluster alias name	The instance name is duplicate. User another name.
400	illegalRequest	illegal request:%s	Invalid request: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	clusterNotFound	cluster not found	The cluster is not found.
500	systemError	system error	An error occurred on the system. Try again later.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-04-25	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-02-10	Add Operation	View Change Details