You need to enable JavaScript to run this app.
导航

DescribeInstancePlugins - 查询实例插件列表

最近更新时间2024.04.09 15:04:00

首次发布时间2023.11.30 14:19:26

调用 DescribeInstancePlugins 接口,查询实例中已经安装的插件列表。

请求说明

  • 请求方式:POST
  • 请求地址:/?Action=DescribeInstancePlugins&Version=2023-01-01 HTTP/1.1

请求参数

Query

参数类型是否必选示例值描述
ActionStringDescribeInstancePlugins接口名称。当前 API 的名称为 DescribeInstancePlugins
VersionString2023-01-01接口版本。当前 API 的版本为 2023-01-01

Body

参数类型是否必选示例值描述
InstanceIdStringo-00k***718需要查询已安装插件列表的实例 ID。

返回参数

参数类型示例值描述
InstancePluginsArray of ESPluginDTO实例已安装的插件列表信息。

ESPluginDTO

参数类型示例值描述
StatusStringPreInstalled插件状态,包含 PreInstalled(系统预装)、Installed(已安装)、Uninstalled(已卸载)、Installing(安装中)、Uninstalling(卸载中)。
VersionString7.10.2.1插件版本号。
PluginNameStringanalysis-dynamic-synonym插件名称。
DescriptionStringAnalysis-plugin for synonym插件描述。

请求示例

POST https://open.volcengineapi.com/?Action=DescribeInstancePlugins&Version=2023-01-01
Content-Type: application/json
X-Date: 20231003T104027Z
Authorization: HMAC-SHA256 
Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZ****/20231003/cn-beijing/ESCloud/request, SignedHeaders=content-type;host;x-date, Signature=88dd0a9ea555d8609ec83eb46054b52f6cd4f79b8d5094fa784c66fa3f2b****
{
    "InstanceId": "o-00k***718"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "DescribeInstancePlugins",
        "Region": "cn-beijing",
        "RequestId": "2023060411042001001002322***",
        "Service": "escloud",
        "Version": "2023-01-01"
    },
    "Result": {
        "InstancePlugins": [
            {
                "Description": "Analysis-plugin for synonym",
                "PluginName": "analysis-dynamic-synonym",
                "Status": "PreInstalled",
                "Version": "7.10.2.1"
            }
        ]
    }
}