InstallAddon - Managed Service for Prometheus - Centre de documentation Alibaba Cloud

Installe un module complémentaire.

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.

arms:InstallAddon

none

*Environment

acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Name	string	Oui	Le nom du module complémentaire.	mysql
AddonVersion	string	Oui	La version du module complémentaire.	0.0.1
AliyunLang	string	Non	La langue. Valeurs valides : zh et en. Valeur par défaut : zh.	zh
EnvironmentId	string	Oui	L'identifiant de l'environnement.	env-xxx
Values	string	Non	Les métadonnées.	{"host":"mysql-service.default","port":3306,"username":"root","password":"roots"}
ReleaseName	string	Non	Le nom du module complémentaire après son installation. Si vous ne spécifiez pas ce paramètre, un nom de règle par défaut est généré.	mysql-xxxxx
DryRun	boolean	Non	Indique si un test à blanc uniquement doit être effectué, sans exécuter la requête réelle. Valeur par défaut : false.	false
RegionId	string	Non	L'identifiant de la région.	cn-hangzhou

Éléments de réponse

Élément	Type	Description	Exemple
	object	La réponse.
RequestId	string	L'identifiant de la requête.	C21AB7CF-B7AF-410F-BD61-82D1567F****
Code	integer	Le code d'état HTTP. Le code d'état 200 indique que la requête a réussi.	200
Success	boolean	Indique si la requête a réussi. Valeurs valides : true et false.	true
Message	string	Le message renvoyé.	success
Data	object	Les données renvoyées.
AddonName	string	Le nom du module complémentaire.	mysql
AlertRuleCount	integer	Le nombre de règles d'alerte.	1
Conditions	array<object>	La phase d'installation.
	object	Les informations sur la condition.
FirstTransitionTime	string	L'heure de la première transition.	2018-01-31T14:32:19Z
LastTransitionTime	string	L'heure de la dernière transition.	2018-01-31T14:32:19Z
Message	string	Le message renvoyé.	xxxx
Reason	string	La raison de l'échec.	xxxx
Status	string	L'état de la phase.	True
Type	string	Le type de la phase.	Loaded
CreateTime	string	L'heure à laquelle le module complémentaire a été créé.	2023-09-22T16:56:29+08:00
DashboardCount	integer	Le nombre de tableaux de bord.	1
ExporterCount	integer	Le nombre d'exportateurs.	2
HaveConfig	boolean	Indique si la configuration est disponible.	true
InstallUserId	string	L'identifiant de l'utilisateur.	123456
Language	string	La langue.	zh
ReleaseId	string	L'identifiant de la version après l'installation.	be29c093-3fd6-4fb6-9430-797030cc183a
ReleaseName	string	Le nom de la version.	mysql-1695372983039
Scene	string	Le scénario.	database
Status	string	L'état.	0
UpdateTime	string	L'heure à laquelle le module complémentaire a été mis à jour.	2023-09-22T16:56:29+08:00
UserId	string	L'identifiant de l'utilisateur.	111
Version	string	La version du module complémentaire.	0.0.1
EnvironmentId	string	L'identifiant de l'environnement.	env-xxxx
RegionId	string	L'identifiant de la région.	cn-heyuan
Managed	boolean	Indique si le composant est entièrement géré.	true

Exemples

JSON format

{
  "RequestId": "C21AB7CF-B7AF-410F-BD61-82D1567F****",
  "Code": 200,
  "Success": true,
  "Message": "success",
  "Data": {
    "AddonName": "mysql",
    "AlertRuleCount": 1,
    "Conditions": [
      {
        "FirstTransitionTime": "2018-01-31T14:32:19Z",
        "LastTransitionTime": "2018-01-31T14:32:19Z",
        "Message": "xxxx",
        "Reason": "xxxx",
        "Status": "True",
        "Type": "Loaded"
      }
    ],
    "CreateTime": "2023-09-22T16:56:29+08:00",
    "DashboardCount": 1,
    "ExporterCount": 2,
    "HaveConfig": true,
    "InstallUserId": "123456",
    "Language": "zh",
    "ReleaseId": "be29c093-3fd6-4fb6-9430-797030cc183a",
    "ReleaseName": "mysql-1695372983039",
    "Scene": "database",
    "Status": "0",
    "UpdateTime": "2023-09-22T16:56:29+08:00",
    "UserId": "111",
    "Version": "0.0.1",
    "EnvironmentId": "env-xxxx",
    "RegionId": "cn-heyuan",
    "Managed": true
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.