全部产品
Search

搜索本产品

    Alibaba Cloud Linux：ListPluginsInstances - 获取组件的实例列表

    文档中心

    Alibaba Cloud Linux：ListPluginsInstances - 获取组件的实例列表

    更新时间：Sep 11, 2026

    获取插件的安装/更新/卸载实例列表

    接口说明

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

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    sysom:ListPluginsInstances

    get

    *全部资源

    *

    		 无 无

    请求语法

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

    请求参数

    名称

    类型

    必填

    描述

    示例值
    operation_type

    string

    是

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

    install
    plugin_id

    string

    是

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

    74a86327-3170-412c-8e67-da3389ec56a9
    region

    string

    是

    通过区域过滤实例

    cn-shenzhen
    instance_id_name

    string

    否

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

    i-bpxx
    instance_tag

    string

    否

    通过实例标签过滤

    {"key":"app","value":"sysom-aliyun-com"}
    current

    integer

    否

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

    5
    pageSize

    integer

    否

    每页大小，默认值为 10

    20

    返回参数

    名称

    类型

    描述

    示例值

    object

    Schema of Response

    code

    string

    状态码

    • code == Success 则代表授权成功；

    • 其它状态码代表授权失败，授权失败时查看 message 字段获取详细的错误信息；

    Success
    data

    array<object>

    返回结果。

    array<object>

    返回数据。

    instance_id

    string

    实例 ID

    i-bp118piqcio9tiwgh84b
    instance_name

    string

    组件实例名称。

    allowed-repos-qmf8w
    instance_tag

    array<object>

    实例标签

    object

    实例标签

    tag_key

    string

    标签的名称。

    test_tag_key
    tag_value

    string

    标签值。

    test_tag_value
    os_name

    string

    实例的操作系统名称

    Alibaba Cloud Linux 3.2104 LTS 64 bit
    private_ip

    string

    私网 ip

    1.1.1.1
    public_ip

    string

    公网 ip

    1.1.1.1
    region

    string

    实例所在区域

    cn-hangzhou
    resource_group_id

    string

    资源组 ID。

    rg-xxxx
    resource_group_name

    string

    资源组名称

    default resource group
    message

    string

    描述信息

    SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict
    request_id

    string

    请求 RequestId

    35F91AAB-5FDF-5A22-B211-C7C6B00817D0
    total

    integer

    查询结果总数。

    42

    示例

    正常返回示例

    JSON格式

    {
  "code": "Success",
  "data": [
    {
      "instance_id": "i-bp118piqcio9tiwgh84b",
      "instance_name": "allowed-repos-qmf8w",
      "instance_tag": [
        {
          "tag_key": "test_tag_key",
          "tag_value": "test_tag_value"
        }
      ],
      "os_name": "Alibaba Cloud Linux  3.2104 LTS 64 bit",
      "private_ip": "1.1.1.1",
      "public_ip": "1.1.1.1",
      "region": "cn-hangzhou",
      "resource_group_id": "rg-xxxx",
      "resource_group_name": "default resource group"
    }
  ],
  "message": "SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict",
  "request_id": "35F91AAB-5FDF-5A22-B211-C7C6B00817D0",
  "total": 42
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    更多信息，参考变更详情。