查询实例插件列表

最近更新时间:2024-07-17 01:15:58

我的收藏

1. 接口描述

接口请求域名: es.tencentcloudapi.com 。

查询实例插件列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstancePluginList。
Version String 公共参数,本接口取值:2018-04-16。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID
示例值:es-xxxxxxxx
Offset Integer 分页起始值, 默认值0
示例值:0
Limit Integer 分页大小,默认值10
示例值:10
OrderBy String 排序字段
  • 1:插件名 pluginName

  • 示例值:pluginName
    OrderByType String 排序方式
  • 0:升序 asc
  • 1:降序 desc

  • 示例值:asc
    PluginType Integer 0:系统插件
    示例值:0

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 返回的插件个数
    示例值:1
    PluginList Array of DescribeInstancePluginInfo 插件信息列表
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询实例插件列表

    查询实例插件列表

    输入示例

    https://es.tencentcloudapi.com/?Action=DescribeInstancePluginList
    &InstanceId=es-xxxxxxxx
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "PluginList": [
                {
                    "PluginDesc": "1",
                    "Status": 0,
                    "PluginType": 0,
                    "PluginVersion": "1",
                    "PluginUpdateTime": "1",
                    "PluginName": "1",
                    "Removable": true
                }
            ],
            "RequestId": "1"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InternalError 内部错误。
    InvalidParameter.InvalidInstanceId 无效的InstanceId,没有找到对应资源。
    InvalidParameterValue.ConfigInfo 组件配置值有误。
    ResourceNotFound.ClusterInfoNotFound 集群资源获取失败。
    ResourceNotFound.DBInfoNotFound 数据库资源获取失败。