All Products
Search
Document Center

Microservices Engine:DeleteNacosInstance

Last Updated:Nov 20, 2024

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
mse:DeleteNacosInstancedelete
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the Nacos instance.

mse-cn-st21v5****
ServiceNamestringYes

The name of the service.

hello_service
NamespaceIdstringNo

The ID of the namespace.

9e78a671-4b9b-4dd4-99c1-0b9da87****
GroupNamestringYes

The name of the group.

DEFAULT_GROUP
ClusterNamestringNo

The alias of the cluster.

DEFAULT
IpstringYes

The IP address of the Nacos instance.

10.237.1.32
PortintegerYes

The port of the Nacos instance.

8080
EphemeralbooleanYes

Specifies whether the node is an ephemeral node. Valid values:

  • true: yes
  • false: no
false
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

RestResult

RequestIdstring

The ID of the request.

8BD1E58D-0755-42AC-A599-E6B55112****
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Codeinteger

The status code. The value 200 is returned if the request is successful.

200
ErrorCodestring

The error code returned if the request failed.

mse-100-000
HttpStatusCodeinteger

The HTTP status code returned.

200
Messagestring

The error message returned.

The request was successfully processed.
DynamicMessagestring

The dynamic part in the error message.

The specified parameter is invalid.
Datastring

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 codeError codeError messageDescription
400duplicatedClusterAliasNameduplicated cluster alias nameThe instance name is duplicate. User another name.
400illegalRequestillegal request:%sInvalid request: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404clusterNotFoundcluster not foundThe cluster is not found.
500systemErrorsystem errorAn error occurred on the system. Try again later.

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

Change history

Change timeSummary of changesOperation
2023-04-25The internal configuration of the API is changed, but the call is not affectedView Change Details
2022-02-10Add OperationView Change Details