All Products
Search
Document Center

Elasticsearch:InstallUserPlugins

Last Updated:Aug 07, 2024

Installs custom plug-ins that are uploaded to the Elasticsearch console.

Note The feature of installing a custom plug-in is being upgraded internally and is suspended. If you need to use this feature, submit a ticket.

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

The DeleteInstance 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.

Syntax

POST /openapi/instances/{InstanceId}/plugins/user/actions/install HTTP/1.1

Request parameters

Parameter

Type

Position

Required

Example

Description

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

The instance ID.

String Body No [ {"name": "pluginName1.zip"}, {"name": "pluginName2.zip"} ]

Specifies the list of custom plug-ins.

RequestBody

You must configure the following parameters in the request body to specify the information about the custom plug-ins.

Configuration item

Type

Required

Example

Description

RequestBody

Array

└ name

String

Yes

pluginName1.zip

The name of a custom plug-in that is uploaded to the Elasticsearch console.

└ indicates a child parameter.

The following figure shows an example.

[
    {"name": "pluginName1.zip"},
    {"name": "pluginName2.zip"}
]

Response parameters

Parameter

Type

Example

Description

RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6F*****

The request ID.

Result Array of String ["pluginName1.zip", "pluginName2.zip"]

The list of plug-ins to be installed. If the installation fails, the system returns an error code. For more information, see Error codes.

Examples

Sample requests

POST /openapi/instances/[es-cn-i7m27ausp001l****]/plugins/user/actions/install HTTP/1.1
Common request headers
```
[
    {"name": "pluginName1.zip"},
    {"name": "pluginName2.zip"}
]

Sample success responses

JSON format

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

{
  "RequestId" : "5FFD9ED4-C2EC-4E89-B22B-1ACB6F*****",
  "Result" : "[\"pluginName1.zip\", \"pluginName2.zip\"]"
}

Error codes

HttpCode

Error code

Error message

Error message

400 InstanceActivating Instance is activating. The instance is currently in effect.
400 InstanceNotFound The instanceId provided does not exist. The instance cannot be found. Check the instance status.

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