PluginAnalysis - 上传自定义插件到插件库-检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:UploadPlugin

get

*Instance

acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}

无

请求语法

POST /openapi/instances/{instanceId}/plugins/actions/analysis HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
instanceId	string	否	实例 id。	es-cn-6ja1ro4jt000c****

请求参数

名称	类型	必填	描述	示例值
body	string	否	请求体参数 { "name": "plugin_name.zip",// plugin name "ossObject": { "bucketName": "bucketName",// oss bucket name "key": "my_plugin_dir/plugin_name.zip" // oss file name } } ] `	{ "name": "plugin_name.zip",// plugin name "ossObject": { "bucketName": "bucketName",// oss bucket name "key": "my_plugin_dir/plugin_name.zip" // oss file name } }
dryRun	string	否	是否进行升级前校验： true: 仅校验 false：直接上传	false

返回参数

名称	类型	描述	示例值
	object
RequestId	string	Id of the request	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
Result	array<object>	返回结果。
	object	返回结果。
description	string	插件描述。	plugin description
elasticsearchVersion	string	插件版本。	8.17.0
name	string	插件名称。	plugin_name
securityPolicy	string	插件的安全策略。	null
version	string	插件版本。	8.17.0

示例

正常返回示例

JSON格式

{
  "RequestId": "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****",
  "Result": [
    {
      "description": "plugin description",
      "elasticsearchVersion": "8.17.0",
      "name": "plugin_name\t",
      "securityPolicy": "null",
      "version": "8.17.0"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。