ListPluginStatus - 查詢執行個體中雲助手外掛程式的狀態 - Elastic Compute Service

調用ListPluginStatus查詢執行個體中雲助手外掛程式的狀態。

介面說明

執行個體的雲助手 Agent 版本不低於以下版本，才可以查詢到執行個體內雲助手外掛程式狀態：
- Linux：2.2.3.344。
- Windows：2.1.3.344。
分頁查詢首頁時，僅需設定MaxResults以限制返回資訊的條目數，返回結果中的NextToken將作為查詢後續頁的憑證。查詢後續頁時，將NextToken參數設定為上一次返回結果中擷取到的NextToken作為查詢憑證，並設定MaxResults限制返回條目數。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:ListPluginStatus

get

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#InstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。	cn-hangzhou
InstanceId	array	否	執行個體 ID，單次請求最多支援 50 台執行個體，N 的取值範圍為 1~50。
	string	否	執行個體 ID，單次請求最多支援 50 台執行個體，N 的取值範圍為 1~50。	i-bp1iudwa5b1tqa****
RegionId	string	是	地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。	cn-hangzhou
Name	string	否	外掛程式名稱，支援全字元集。長度不得超過 255 個字元。若不指定該參數，會查詢執行個體中已安裝外掛程式的狀態。說明若不指定該參數，只能指定一個執行個體 ID。若指定該參數，會查詢出執行個體中指定外掛程式的狀態。	testPluginName
PageNumber	integer	否	說明該參數即將下線，推薦您使用 NextToken 與 MaxResults 完成分頁查詢操作。	1
PageSize	integer	否	說明該參數即將下線，推薦您使用 NextToken 與 MaxResults 完成分頁查詢操作。	10
MaxResults	integer	否	分頁查詢時每頁的最大條目數。最大值為 50。預設值為 10。	10
NextToken	string	否	查詢憑證（Token），取值為上一次 API 呼叫返回的 NextToken 參數值。	AAAAAdDWBF2

返回參數

名稱	類型	描述	樣本值
	object
PageSize	integer	每頁行數。	10
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumber	integer	查詢結果的頁碼。	1
TotalCount	integer	符合查詢條件的記錄條數。	1
NextToken	string	本次調用返回的查詢憑證值。	AAAAAdDWBF2
InstancePluginStatusSet	object
InstancePluginStatus	array<object>	執行個體外掛程式狀態列表。
	array<object>	執行個體外掛程式狀態列表。
InstanceId	string	執行個體 ID。	i-xxxxx
PluginStatusSet	object
PluginStatus	array<object>	外掛程式狀態列表。
	object	外掛程式狀態列表。
PluginStatus	string	外掛程式狀態。取值範圍： NotInstalled：外掛程式未安裝。 Installed：一次性外掛程式已安裝。 Running：常駐外掛程式運行中。 Stopped：常駐外掛程式未運行。 Crashed：外掛程式狀態異常。 Removed：外掛程式已卸載。 UnKnown：狀態未知。	Running
PluginVersion	string	外掛程式版本號碼。	1.1
PluginName	string	外掛程式名稱。	testName
FirstHeartbeatTime	string	雲助手第一次上報外掛程式狀態的時間。	2020-01-19T09:15:46Z
LastHeartbeatTime	string	雲助手最近一次上報外掛程式狀態的時間。	2020-01-19T09:15:46Z

樣本

正常返回樣本

JSON格式

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber": 1,
  "TotalCount": 1,
  "NextToken": "AAAAAdDWBF2",
  "InstancePluginStatusSet": {
    "InstancePluginStatus": [
      {
        "InstanceId": "i-xxxxx",
        "PluginStatusSet": {
          "PluginStatus": [
            {
              "PluginStatus": "Running",
              "PluginVersion": "1.1",
              "PluginName": "testName",
              "FirstHeartbeatTime": "2020-01-19T09:15:46Z",
              "LastHeartbeatTime": "2020-01-19T09:15:46Z"
            }
          ]
        }
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	RegionId.ApiNotSupported	The api is not supported in this region.	指定地區下不支援調用 API。請檢查 RegionId 參數取值是否正確。
400	InvalidParam.PageNumber	The specified parameter PageNumber is invalid.	指定的參數PageNumber不合法。
400	InvalidParam.PageSize	The specified parameter PageSize is invalid.	指定的參數PageSize不合法。
400	PluginName.MissingValue	The plugin name must be specified when the number of InstanceIds is not 1.	指定的執行個體數量不為1時，外掛程式名稱必須指定。
400	InstanceIds.ExceedLimit	The number of instance IDs exceeds the upper limit.
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.	指定的參數NextToken不合法。
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	指定的參數MaxResults不合法。
500	InternalError.Dispatch	An error occurred when you dispatched the request.	發送請求時發生錯誤，請稍後重試。
403	Operation.Forbidden	The operation is not permitted.	該操作是不被允許的。
404	InvalidInstance.NotFound	The specified instance does not exist.	指定的執行個體不存在。
404	InvalidPluginName.NotFound	The specified plugin name does not exist.	指定的外掛程式名稱不存在。

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

變更歷史

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