DescribeMonitoringAgentHosts - - Centre de documentation Alibaba Cloud

Interroge la liste de tous les hôtes, que l'agent CloudMonitor soit installé ou non.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

cms:DescribeMonitoringAgentHosts

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
KeyWord	string	Non	Le mot-clé pour une recherche approximative.	host1
HostName	string	Non	Le nom d'hôte.	hostNam1
InstanceIds	string	Non	L'identifiant de l'instance.	i-a3d1q1pm2f9yr29e****
SerialNumbers	string	Non	Le numéro de série de l'hôte. Un numéro de série globalement unique est généré après l'installation réussie de l'agent CloudMonitor sur un hôte. Les hôtes qui ne sont pas des instances Alibaba Cloud n'ont pas d'identifiant d'instance, mais possèdent un numéro de série. Remarque Utilisez ce paramètre pour rechercher un hôte surveillé spécifique.	a1ab31a3-1234-40f2-9e95-c8caa8f0****
PageNumber	integer	Non	Le numéro de page.	1
PageSize	integer	Non	Le nombre d'entrées à renvoyer sur chaque page. Valeurs valides : 10 20 50 100 Remarque Alibaba Cloud ne limite pas la valeur maximale de ce paramètre. Cependant, définir ce paramètre sur une valeur élevée peut entraîner un dépassement du délai d'attente.	10
InstanceRegionId	string	Non	La région où réside l'instance.	cn-hangzhou
AliyunHost	boolean	Non	Indique s'il faut filtrer les instances Elastic Compute Service (ECS) d'Alibaba Cloud. Valeurs valides : true (par défaut) : renvoie uniquement les instances ECS. false : renvoie uniquement les hôtes qui ne sont pas des instances ECS.	true
Status	string	Non	L'état de l'hôte. Valeurs valides : Running : l'hôte est en cours d'exécution. Stopped : l'hôte est arrêté, l'agent n'est pas installé ou l'installation de l'agent a échoué.	Running
SysomStatus	string	Non	L'état de SysOM. Valeurs valides : installing : SysOM est en cours d'activation. running : SysOM est en cours d'exécution. stopped : SysOM est arrêté. uninstalling : SysOM est en cours de désactivation.	running

Éléments de réponse

Élément	Type	Description	Exemple
	object	La réponse.
RequestId	string	L'identifiant de la requête.	63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0
Success	boolean	Indique si l'opération a réussi. Valeurs valides : true : l'opération a réussi. false : l'opération a échoué.	true
Code	string	Le code d'état. Remarque Un code d'état de 200 indique une réponse réussie.	200
Message	string	Le message d'erreur.	The Request is not authorization
PageNumber	integer	Le numéro de page.	1
PageSize	integer	Le nombre d'entrées par page.	10
PageTotal	integer	Le nombre de pages.	50
Total	integer	Le nombre total d'entrées.	10
Hosts	object
Host	array<object>	La liste des hôtes.
	object	L'hôte.
SerialNumber	string	The serial number of the host. Hosts that are not Alibaba Cloud instances do not have an instance ID, but have a serial number. Remarque Use this parameter to find a specific monitored host.	x12335-6cc8-4a22-9f21-1a00a719****
NatIp	string	The NAT IP address.	192.168.XX.XX
HostName	string	The hostname.	hostIP
AliUid	integer	The ID of the Alibaba Cloud account.	103201326074****
NetworkType	string	The network type.	vpc
InstanceId	string	The instance ID.	i-a2d5q7pm3f9yr212****
isAliyunHost	boolean	Indicates whether the host is an Alibaba Cloud instance. Valid values: true: The host is an Alibaba Cloud instance. false: The host is not an Alibaba Cloud instance.	true
EipAddress	string	The elastic IP address (EIP).	192.168.XX.XX
AgentVersion	string	The agent version.	3.4.6
IpGroup	string	The IP address of the host. Remarque Multiple IP addresses are separated by commas (,).	192.168.XX.XX
EipId	string	The ID of the EIP.	eip-bp16i16k9gcezyfrp****
Region	string	The region.	cn-hangzhou
InstanceTypeFamily	string	The ECS instance type family.	ecs.n4
OperatingSystem	string	The operating system.	Linux

Exemples

JSON format

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

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
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.	The specified resource is not found.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.