DescribeMonitoringAgentHosts - CloudMonitor - Alibaba Cloud Documentation Center

Queries all hosts within the current Alibaba Cloud account, including hosts on which the CloudMonitor agent is installed and uninstalled.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
KeyWord	string	No	The keyword that is used in fuzzy match.	host1
HostName	string	No	The name of the host.	hostNam1
InstanceIds	string	No	The ID of the instance.	i-a3d1q1pm2f9yr29e****
SerialNumbers	string	No	The serial number of the host. After the CloudMonitor agent is installed on a host, a globally unique serial number is generated. A host that is not provided by Alibaba Cloud has a serial number instead of an instance ID. Note This parameter can be used to accurately search for a monitored host.	a1ab31a3-1234-40f2-9e95-c8caa8f0****
PageNumber	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 10 20 50 100 Note Although Alibaba Cloud does not limit the maximum value of this parameter, we recommend that you do not set it to an excessively large value. If you set it to an excessively large value, a timeout error may occur.	10
InstanceRegionId	string	No	The region ID of the instance.	cn-hangzhou
AliyunHost	boolean	No	Specifies whether to query Elastic Compute Service (ECS) instances that are provided by Alibaba Cloud or to query hosts that are not provided by Alibaba Cloud. Valid values: true (default value): queries all the ECS instances that are provided by Alibaba Cloud. false: queries all the hosts that are not provided by Alibaba Cloud.	true
Status	string	No	The status of the hosts that you want to query. Valid values: Running: queries the hosts that are running. Stopped: queries the hosts that are stopped, are not installed, or fail to be installed.	Running
SysomStatus	string	No	The status of SysOM. Valid values: installing: SysOM is being installed. running: SysOM is running. stopped: SysOM is stopped. uninstalling: SysOM is being uninstalled.	running

Response parameters

Parameter	Type	Description	Example
	object	The result of the request.
RequestId	string	The ID of the request.	63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call fails.	true
Code	string	The HTTP status code. Note The status code 200 indicates that the call is successful.	200
Message	string	The error message.	The Request is not authorization.
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	10
PageTotal	integer	The total number of returned pages.	50
Total	integer	The total number of returned entries.	10
Hosts	object []	The information about the hosts.
SerialNumber	string	The serial number of the host. A host that is not provided by Alibaba Cloud has a serial number instead of an instance ID. Note This parameter can be used to accurately search for a monitored host.	x12335-6cc8-4a22-9f21-1a00a719****
NatIp	string	The IP address of the Network Address Translation (NAT) gateway.	192.168.XX.XX
HostName	string	The name of the host.	hostIP
AliUid	long	The ID of the Alibaba Cloud account.	103201326074****
NetworkType	string	The network type.	vpc
InstanceId	string	The ID of the instance.	i-a2d5q7pm3f9yr212****
isAliyunHost	boolean	Indicates whether the host is provided by Alibaba Cloud. Valid values: true: The host is provided by Alibaba Cloud. false: The host is not provided by Alibaba Cloud.	true
EipAddress	string	The elastic IP address (EIP) of the host.	192.168.XX.XX
AgentVersion	string	The version of the CloudMonitor agent.	3.4.6
IpGroup	string	The IP address of the host. Note Multiple IP addresses are separated with commas (,).	192.168.XX.XX
EipId	string	The ID of the EIP.	eip-bp16i16k9gcezyfrp****
Region	string	The ID of the region.	cn-hangzhou
InstanceTypeFamily	string	The type of the ECS instance.	ecs.n4
OperatingSystem	string	The operating system.	Linux

Examples

Sample success responses

JSONformat

{
  "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"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	Illegal parameters.	-
403	AccessForbidden	User not authorized to operate on the specified resource.	-
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.
500	InternalError	The request processing has failed due to some unknown error.	-

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-05-25

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403
	delete Error Codes: 404
	delete Error Codes: 500

2022-04-08

API Description Update. The Error code has changed

see changesets

Change item	Change content
API Description	API Description Update.
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403
	delete Error Codes: 404
	delete Error Codes: 500