All Products
Search
Document Center

Elasticsearch:UninstallPlugin

更新時間:Jul 08, 2024

Uninstall the system plug-in from the Elasticsearch instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation does not have operation-specific request headers and uses only common request headers. For more information, refer to the documentation of common request parameters.

Request syntax

POST /openapi/instances/{InstanceId}/plugins/actions/uninstall HTTP/1.1

Request parameters

Parameter

Type

Position

Required

Example

Description

InstanceId String Path Yes es-cn-n6w1o1x0w001c****

The ID of the ApsaraMQ for RocketMQ instance.

clientToken String Query No. 5A2CFF0E-5718-45B5-9D4D-70B3FF****

that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

String Body No ["aliyun-sql","codec-compression"]

Enter the name of the system plug-in to be uninstalled.

force Boolean Query No. false

Whether to forcibly uninstall. You can cancel the installation of a plug-in that is being installed. This is limited to new architecture instances. Default value: false.

RequestBody

In RequestBody, you must also enter the name of the plug-in to be uninstalled in the format of ["pluginname1","pluginname2",…, "plugin_namen"], for example ["aliyun-sql","codec-compression"]. For more information about how to obtain the plug-ins installed on an instance, see ListPlugins.

Response parameters

Parameter

Type

Example

Description

RequestId String F99407AB-2FA9-489E-A259-40CF6DCC****

The request ID.

Result Array of String ["aliyun-mysql"]

The list of plug-ins that are requested to be uninstalled. If the request fails, an exception is returned.

Examples

Sample requests

POST /openapi/instances/es-cn-n6w1o1x0w001c****/plugins/actions/uninstall HTTP/1.1
Common request headers
["aliyun-sql","codec-compression"]

Sample success responses

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : [ "aliyun-mysql" ],
  "RequestId" : "5A5D8E74-565C-43DC-B031-29289FA9BAD6****"
}

Error codes

For a list of error codes, see Service error codes.