You need to enable JavaScript to run this app.
导航
DescribeInstancePlugins - 查询实例插件列表
最近更新时间:2024.10.21 16:51:11首次发布时间:2023.11.30 14:19:26

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

请求说明

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

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

DescribeInstancePlugins

要执行的操作,取值:DescribeInstancePlugins。

Version
String

2023-01-01

API的版本,取值:2023-01-01。

InstanceId
String

o-00k***718

需要查询已安装插件列表的实例 ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
InstancePlugins
Array of Object

--

实例已安装的插件列表信息。

请求示例

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"
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
200
InternalServerError
服务器内部异常

服务由于异常退出,无法完成接口请求操作

200
Unauthorized
unauthorized error

用户无权限调用接口

200
IllegalParameter
illegal parameter

非法参数。可能是参数缺失,也可能是参数不符合接口要求