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

Obtient les modules complémentaires d'un environnement spécifié.

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

none

*Environnement.

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
EnvironmentId	string	Oui	L'identifiant de l'environnement.	env-xxx
RegionId	string	Non	L'identifiant de la région.	cn-hangzhou

Éléments de réponse

Élément	Type	Description	Exemple
	object	L'objet de réponse.
RequestId	string	L'identifiant de la requête.	32940175-181B-4B93-966E-4BB69176****
Code	integer	Le code d'état.	200
Message	string	Le message de réponse.	message
Success	boolean	Indique si l'opération a réussi. Valeurs valides : `true` (succès) et `false` (échec).	true
Data	object	Les données de réponse.
Addons	array<object>	La liste des modules complémentaires.
	array<object>	Informations sur le module complémentaire.
Alias	string	L'alias du module complémentaire.	MySQL
Categories	array	La liste des balises du module complémentaire.
	string	Une balise pour le module complémentaire.	cloud
Dashboards	array<object>	La liste des tableaux de bord.
	object	Les détails du tableau de bord.
Description	string	La description du tableau de bord.	Informations du tableau de bord de surveillance MySQL, supervisant des métriques telles que les informations de connexion et d'utilisation
Name	string	Le nom du tableau de bord.	mysql-overview
Url	string	L'URL du tableau de bord.	http://xxxx
Description	string	La description du module complémentaire.	Surveillance des métriques de la base de données via MySQL Exporter
Environments	array<object>	La liste des environnements pris en charge.
	array<object>	Les détails de l'environnement.
Dependencies	object	Les dépendances du module complémentaire au sein de l'environnement.
Features	object	Les fonctionnalités disponibles pour l'installation dans l'environnement.
	boolean	Indique si la fonctionnalité est prise en charge.	true
Services	array	Les services dépendants.
	string	Le nom du service.	ResourceCenter
ClusterTypes	array	Les types de cluster requis.
	string	Le type de cluster.	Edge
Description	string	La description de l'environnement.	Le service MySQL est déployé dans un cluster Kubernetes
Enable	boolean	Indique si le module complémentaire est pris en charge dans cet environnement.	true
Label	string	Le libellé de l'environnement.	Environnement de conteneurs
Name	string	Le nom de l'environnement.	CS
Policies	object	Les stratégies liées au module complémentaire dans cet environnement.
AlertDefaultStatus	string	L'état par défaut de l'alerte.	default
DefaultInstall	boolean	Indique si le module complémentaire est installé par défaut dans l'environnement.	false
TargetAddonName	string	Le nom cible du module complémentaire.	cloud-rds-mysql
Protocols	array<object>	La liste des protocoles pris en charge.
	object	Un protocole pris en charge.
Name	string	Le nom du protocole.	arms
Icon	string	L'URL de l'icône du protocole.	http://xxxxxxx
Label	string	Le libellé du protocole.	ARMS
Description	string	La description du protocole.	ARMS
MetricCheckRule	object	Les règles de vérification de l'état des métriques.
PromQL	array	Les instructions de requête PromQL.
	string	L'instruction de requête PromQL.	max(flink_taskmanager_job_task_operator_currentEmitEventTimeLag{deploymentId='983d8f2d-14a9-4af0-a23d-751a7818c239'}/1000) >= 600.0
NeedRestartAfterIntegration	boolean	Indique si un redémarrage est requis après l'installation du module complémentaire.	true
EnableServiceAccount	boolean	Indique si un compte de service est activé pour le module complémentaire.	true
Icon	string	L'URL de l'icône du module complémentaire.	http://xxxx
Keywords	array	Les mots-clés du module complémentaire.
	string	Un mot-clé pour le module complémentaire.	Java
Language	string	La langue des métadonnées du module complémentaire.	zh
Name	string	Le nom du module complémentaire.	mysql
Once	boolean	Indique si le module complémentaire peut être installé une seule fois par environnement.	false
Scene	string	Le scénario d'application du module complémentaire.	database
Version	string	La version du module complémentaire.	0.0.1
Weight	string	Le poids du module complémentaire, utilisé pour le tri dans l'interface utilisateur.	857
LatestReleaseCreateTime	string	L'heure de création de la dernière version du module complémentaire.	2023-09-22T16:56:29+08:00
Total	integer	Le nombre total de modules complémentaires.	1
ContainsV2Addon	boolean	Indique si la liste contient des modules complémentaires V2.

Exemples

JSON format

{
  "RequestId": "32940175-181B-4B93-966E-4BB69176****",
  "Code": 200,
  "Message": "message",
  "Success": true,
  "Data": {
    "Addons": [
      {
        "Alias": "MySQL",
        "Categories": [
          "cloud"
        ],
        "Dashboards": [
          {
            "Description": "Informations du tableau de bord de surveillance MySQL, supervisant des métriques telles que les informations de connexion et d'utilisation",
            "Name": "mysql-overview",
            "Url": "http://xxxx"
          }
        ],
        "Description": "Surveillance des métriques de la base de données via MySQL Exporter",
        "Environments": [
          {
            "Dependencies": {
              "Features": {
                "key": true
              },
              "Services": [
                "ResourceCenter"
              ],
              "ClusterTypes": [
                "Edge"
              ]
            },
            "Description": "Le service MySQL est déployé dans un cluster Kubernetes",
            "Enable": true,
            "Label": "Environnement de conteneurs",
            "Name": "CS",
            "Policies": {
              "AlertDefaultStatus": "default",
              "DefaultInstall": false,
              "TargetAddonName": "cloud-rds-mysql",
              "Protocols": [
                {
                  "Name": "arms",
                  "Icon": "http://xxxxxxx",
                  "Label": "ARMS",
                  "Description": "ARMS"
                }
              ],
              "MetricCheckRule": {
                "PromQL": [
                  "max(flink_taskmanager_job_task_operator_currentEmitEventTimeLag{deploymentId='983d8f2d-14a9-4af0-a23d-751a7818c239'}/1000) >= 600.0"
                ]
              },
              "NeedRestartAfterIntegration": true,
              "EnableServiceAccount": true
            }
          }
        ],
        "Icon": "http://xxxx",
        "Keywords": [
          "Java"
        ],
        "Language": "zh",
        "Name": "mysql",
        "Once": false,
        "Scene": "database",
        "Version": "0.0.1",
        "Weight": "857",
        "LatestReleaseCreateTime": "2023-09-22T16:56:29+08:00"
      }
    ],
    "Total": 1,
    "ContainsV2Addon": false
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.