获取ES插件列表
最近更新时间: 2026-09-17 00:05:51
1. 接口描述
接口请求域名： tbdsnew.api3.fincloud.tencent.cn。
获取ES插件列表
默认接口请求频率限制：20次/秒。
接口更新时间：2025-09-12 15:00:08。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeESPlugins |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-01-03 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 集群ID 示例值： tbds-bn9ktz3o |
| Offset | 否 | 否 | Int64 | 偏移 示例值： 0 |
| Limit | 否 | 否 | Int64 | 限制数 示例值： 10 |
| Filters | 否 | 否 | Array of Filters | 过滤数组，目前主要为name过滤 示例值：查看 |
| PluginIds | 否 | 否 | Array of Int64 | 插件ID列表 示例值： 1 |
| OrderFields | 否 | 否 | Array of OrderField | 排序列表 示例值：查看 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 总数 示例值： 1 |
| Plugins | Array of ESPluginInfo | 插件列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound.InstanceNotFound | 无法找到该实例。 |
5. 示例
示例1 获取ES插件列表
输入示例
POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: DescribeESPlugins
<公共请求参数>
{
"Limit": 10,
"Offset": 0,
"OrderFields": [
{
"Name": "Type",
"Direction": "DESC"
}
],
"InstanceId": "tbds-bn9ktz3o",
"Filters": []
}
输出示例
{
"Response": {
"Plugins": [
{
"CreateTime": "2025-05-20T03:29:55Z",
"CreateUser": "110000000000",
"Description": "module into elasticsearch.",
"Id": 12,
"Name": "analysis-smartcn",
"Status": 2,
"SupportOperations": [
"install",
"uninstall",
"reinstall"
],
"Type": 0,
"UpdateTime": "2025-05-20T03:30:13Z"
},
{
"CreateTime": "2025-05-20T03:29:55Z",
"CreateUser": "110000000000",
"Description": "Query elasticsearch using SQL",
"Id": 13,
"Name": "sql",
"Status": 2,
"SupportOperations": [
"install",
"uninstall",
"reinstall"
],
"Type": 0,
"UpdateTime": "2025-05-20T03:30:13Z"
},
{
"CreateTime": "2025-05-20T03:29:55Z",
"CreateUser": "110000000000",
"Description": "STConvert is a analysis plugin that convert characters between traditional and simplified.",
"Id": 14,
"Name": "analysis-stconvert",
"Status": 0,
"SupportOperations": [
"install",
"uninstall",
"reinstall"
],
"Type": 0,
"UpdateTime": "2025-05-20T03:29:55Z"
},
{
"CreateTime": "2025-05-20T03:29:55Z",
"CreateUser": "110000000000",
"Description": "Pinyin Analysis for Elasticsearch.",
"Id": 15,
"Name": "analysis-pinyin",
"Status": 0,
"SupportOperations": [
"install",
"uninstall",
"reinstall"
],
"Type": 0,
"UpdateTime": "2025-05-20T03:29:55Z"
},
{
"CreateTime": "2025-05-20T03:29:55Z",
"CreateUser": "110000000000",
"Description": "The ICU Analysis plugin integrates the Lucene ICU module into Elasticsearch, adding ICU-related analysis components.",
"Id": 16,
"Name": "analysis-icu",
"Status": 0,
"SupportOperations": [
"install",
"uninstall",
"reinstall"
],
"Type": 0,
"UpdateTime": "2025-05-20T03:29:55Z"
},
{
"CreateTime": "2025-05-20T03:29:55Z",
"CreateUser": "110000000000",
"Description": "Open Distro Index Management Plugin",
"Id": 17,
"Name": "opendistro-index-management",
"Status": 2,
"SupportOperations": [],
"Type": 0,
"UpdateTime": "2025-05-20T03:29:55Z"
},
{
"CreateTime": "2025-05-20T03:29:55Z",
"CreateUser": "110000000000",
"Description": "Open Distro Cross Cluster Replication Plugin",
"Id": 18,
"Name": "opendistro-cross-cluster-replication",
"Status": 2,
"SupportOperations": [],
"Type": 0,
"UpdateTime": "2025-05-20T03:29:55Z"
},
{
"CreateTime": "2025-05-20T03:29:55Z",
"CreateUser": "110000000000",
"Description": "Provide access control related features for Elasticsearch 7",
"Id": 19,
"Name": "opendistro_security",
"Status": 2,
"SupportOperations": [],
"Type": 0,
"UpdateTime": "2025-05-20T03:29:55Z"
},
{
"CreateTime": "2025-05-20T03:29:55Z",
"CreateUser": "110000000000",
"Description": "IK Analyzer for Elasticsearch",
"Id": 20,
"Name": "analysis-ik",
"Status": 2,
"SupportOperations": [
"install",
"reinstall",
"dictmanagement"
],
"Type": 0,
"UpdateTime": "2025-05-20T03:29:55Z"
},
{
"CreateTime": "2025-05-20T03:29:55Z",
"CreateUser": "110000000000",
"Description": "Open Distro for Elasticsearch job schduler plugin",
"Id": 21,
"Name": "opendistro-job-scheduler",
"Status": 2,
"SupportOperations": [],
"Type": 0,
"UpdateTime": "2025-05-20T03:29:55Z"
}
],
"RequestId": "c14922a9-c9bb-435f-ab79-2943d4f30619",
"TotalCount": 11
}
}