全部產品
Search
文件中心

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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情。