ListPluginsInstances
获取插件的安装/更新/卸载实例列表
服务地址:
华东1(杭州)
输入参数
只看必填
operation_type通过实例的插件安装状态过滤实例
plugin_id指定本参数则过滤出指定Agent的实例列表
region通过区域过滤实例
instance_id_name通过实例id或实例名称过滤
instance_tag通过实例标签过滤
current页码分页时存在该字段
pageSize每页大小
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

当前接口获取的实例列表是已经被 SysOM 纳管的机器列表,如果某个 ECS 实例存在但是没有被 SysOM 纳管,则不会出现在列表当中。

请求语法

GET /api/v1/am/agent/listPluginsInstances HTTP/1.1

请求参数

字段名称字段详情
operation_typestring

通过实例的插件安装状态过滤实例

示例值:install
plugin_idstring

指定本参数则过滤出指定 Agent 的实例列表

示例值:74a86327-3170-412c-8e67-da3389ec56a9
regionstring

通过区域过滤实例

示例值:cn-shenzhen
instance_id_namestring

通过实例 id 或实例名称过滤,支持模糊查询

示例值:i-bpxx
instance_tagstring

通过实例标签过滤

示例值:{"key":"app","value":"sysom-aliyun-com"}参考取值来源:
    ListInstancesWithEcsInfo
currentinteger<int64>

页码分页时存在该字段,表示当前页

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:5
pageSizeinteger<int64>

每页大小,默认值为 10

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:20

返回参数

字段名称字段详情
codestring

状态码展开详情

示例值:Success
messagestring

描述信息

示例值:SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict
dataarray<object>

返回结果。

request_idstring

请求 RequestId

示例值:35F91AAB-5FDF-5A22-B211-C7C6B00817D0
totalinteger<int64>

查询结果总数。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:42
变更历史
暂无变更历史