DescribeMonitoringAgentHosts - 查詢所有已安裝和未安裝CloudMonitor外掛程式的主機列表 -

調用DescribeMonitoringAgentHosts介面查詢所有已安裝和未安裝CloudMonitor外掛程式的主機列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

cms:DescribeMonitoringAgentHosts

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
KeyWord	string	否	模糊搜尋索引鍵。	host1
HostName	string	否	主機名稱。	hostNam1
InstanceIds	string	否	執行個體 ID。	i-a3d1q1pm2f9yr29e****
SerialNumbers	string	否	主機序號。每台主機成功安裝CloudMonitor外掛程式之後會產生一個 SerialNumber，具備全域唯一性。非阿里雲主機無執行個體 ID，有 SerialNumber。說明該參數可用於精準尋找監控的任何一台主機。	a1ab31a3-1234-40f2-9e95-c8caa8f0****
PageNumber	integer	否	頁數。	1
PageSize	integer	否	每頁顯示記錄條數。取值： 10 20 50 100 說明雖然目前阿里雲未限制該參數的最大值，但是不建議設定的值過大，可能會導致逾時無法正常擷取。	10
InstanceRegionId	string	否	執行個體所在的地區。	cn-hangzhou
AliyunHost	boolean	否	阿里雲主機（ECS）。取值： true（預設值）：過濾出所有阿里雲主機（ECS）。 false：過濾出所有非阿里雲主機。	true
Status	string	否	主機狀態。取值： Running：運行中。 Stopped：已停止、未安裝或安裝失敗。	Running
SysomStatus	string	否	SysOM 的開啟狀態。取值： installing：開啟中。 running：運行中。 stopped：已停止。 uninstalling：關閉中。	running

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0
Success	boolean	操作是否成功。取值： true：成功。 false：失敗。	true
Code	string	狀態代碼。說明 200 表示成功。	200
Message	string	錯誤資訊。	The Request is not authorization.
PageNumber	integer	分頁頁碼。	1
PageSize	integer	分頁大小。	10
PageTotal	integer	頁數。	50
Total	integer	總記錄條數。	10
Hosts	object
Host	array<object>	主機列表。
	object	主機。
SerialNumber	string	主機序號。非阿里雲主機無執行個體 ID，有 SerialNumber。說明該參數可用於精準尋找監控的任何一台主機。	x12335-6cc8-4a22-9f21-1a00a719****
NatIp	string	NAT IP 位址。	192.168.XX.XX
HostName	string	主機名稱。	hostIP
AliUid	integer	阿里雲帳號 ID。	103201326074****
NetworkType	string	網路類型。	vpc
InstanceId	string	執行個體 ID。	i-a2d5q7pm3f9yr212****
isAliyunHost	boolean	是否為阿里雲主機。取值： true：是。 false：否。	true
EipAddress	string	EIP 的 IP 位址。	192.168.XX.XX
AgentVersion	string	外掛程式版本。	3.4.6
IpGroup	string	主機 IP 位址。說明多個 IP 位址之前用半形逗號（,）分隔。	192.168.XX.XX
EipId	string	EIP 的 ID。	eip-bp16i16k9gcezyfrp****
Region	string	地區。	cn-hangzhou
InstanceTypeFamily	string	ECS 執行個體規格。	ecs.n4
OperatingSystem	string	作業系統。	Linux

樣本

正常返回樣本

JSON格式

{
  "RequestId": "63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0",
  "Success": true,
  "Code": "200",
  "Message": "The Request is not authorization.",
  "PageNumber": 1,
  "PageSize": 10,
  "PageTotal": 50,
  "Total": 10,
  "Hosts": {
    "Host": [
      {
        "SerialNumber": "x12335-6cc8-4a22-9f21-1a00a719****",
        "NatIp": "192.168.XX.XX",
        "HostName": "hostIP",
        "AliUid": 0,
        "NetworkType": "vpc",
        "InstanceId": "i-a2d5q7pm3f9yr212****",
        "isAliyunHost": true,
        "EipAddress": "192.168.XX.XX",
        "AgentVersion": "3.4.6",
        "IpGroup": "192.168.XX.XX",
        "EipId": "eip-bp16i16k9gcezyfrp****",
        "Region": "cn-hangzhou",
        "InstanceTypeFamily": "ecs.n4",
        "OperatingSystem": "Linux"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	未找到指定資源。

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

變更歷史

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