InstallMonitoringAgent - - Centre de documentation Alibaba Cloud

Description de l'opération

Prérequis

Assurez-vous que Cloud Assistant est installé sur l'hôte Alibaba Cloud. Pour plus d'informations, consultez Présentation de Cloud Assistant.

Informations générales

Cette API s'applique uniquement aux hôtes Alibaba Cloud, qui sont des instances Elastic Compute Service (ECS). Le taux de réussite de l'installation de l'agent CloudMonitor à l'aide de cette API est d'environ 95 %. En cas d'échec de l'installation, vous devez installer l'agent manuellement. Pour plus d'informations sur l'installation de l'agent CloudMonitor, consultez Installer et désinstaller l'agent C++.

Exemple

Cet exemple montre comment forcer l'installation de la dernière version de l'agent CloudMonitor sur l'instance ECS i-m5e0k0bexac8tykr****.

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:InstallMonitoringAgent

create

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Force	boolean	Non	Indique si l'agent CloudMonitor doit être installé de force. Valeurs valides : true (valeur par défaut) : force l'installation de l'agent. false : ne force pas l'installation de l'agent.	true
InstanceIds	array	Non	Les identifiants des hôtes Alibaba Cloud. Vous pouvez spécifier de 1 à 10 identifiants d'instance. Remarque Vous devez spécifier soit InstallCommand, soit InstanceIds.	i-m5e0k0bexac8tykr****
	string	Non	L'identifiant de l'hôte Alibaba Cloud. Vous pouvez spécifier de 1 à 10 identifiants d'instance. Remarque Vous devez spécifier soit InstallCommand, soit InstanceIds.	i-m5e0k0bexac8tykr****
InstallCommand	string	Non	La commande d'installation. Cette commande installe l'agent CloudMonitor sur tous les hôtes Alibaba Cloud qui appartiennent à votre compte Alibaba Cloud. Valeurs valides : onlyInstallNotHasAgent : installe la dernière version de l'agent CloudMonitor uniquement sur les hôtes Alibaba Cloud sur lesquels l'agent n'est pas installé. onlyUpgradeAgent : met à niveau l'agent CloudMonitor uniquement sur les hôtes Alibaba Cloud sur lesquels une version antérieure de l'agent est installée. installAndUpgrade : installe la dernière version de l'agent CloudMonitor sur les hôtes Alibaba Cloud sur lesquels l'agent n'est pas installé, et met à niveau l'agent sur les hôtes Alibaba Cloud sur lesquels une version antérieure de l'agent est installée. Remarque Si vous définissez ce paramètre, le paramètre InstanceIds n'est pas valide.	onlyInstallNotHasAgent

Pour plus d'informations sur les paramètres de requête courants, consultez Paramètres courants.

Éléments de réponse

Élément	Type	Description	Exemple
	object
Code	string	Le code d'état. Remarque Une valeur de 200 indique que la requête a réussi.	200
Message	string	Le message d'erreur.	La ressource spécifiée est introuvable
RequestId	string	L'identifiant de la requête.	0BDAF8A8-04DC-5F0C-90E4-724D42C41945
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

Exemples

JSON format

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "0BDAF8A8-04DC-5F0C-90E4-724D42C41945",
  "Success": true
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	ParameterInvalid	Parameter invalid.
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.