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

Consulte les environnements.

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

list

*Environment

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
EnvironmentType	string	Non	Le type d'environnement. Vous devez spécifier au moins l'un des paramètres AddonName et EnvironmentType. Valeurs valides : CS : Service de conteneurs. ECS : Service ECS. Cloud : Service cloud.	CS
RegionId	string	Non	L'identifiant de la région.	cn-hangzhou
AddonName	string	Non	Le nom de l'add-on. Vous devez spécifier au moins l'un des paramètres AddonName et EnvironmentType.	trace-java
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-aekzfurdatohtka
Tag	array<object>	Non	Les balises.
	object	Non	Valeur de la balise de ressource.
Key	string	Non	La clé de la balise.	env
Value	string	Non	La valeur de la balise.	gfn_web_outbound_add
BindResourceId	string	Non	L'identifiant de la ressource.	cb9229c48e41144dc96af190841808cb0
FeePackage	string	Non	Le plan de ressources payant. Valeurs valides : CS_Pro : Container Monitoring Pro. CS_Basic : Container Monitoring Basic.	CS_Pro
FilterRegionIds	string	Non	Les identifiants des régions à interroger.	cn-beijing,cn-hangzhou

Éléments de réponse

Élément	Type	Description	Exemple
	object	Réponse.
RequestId	string	L'identifiant de la requête.	1A9C645C-C83F-4C9D-8CCB-29BEC9E1****
Success	boolean	Indique si la requête a réussi. Valeurs valides : true et false.	true
Code	integer	Le code d'état HTTP. Le code d'état 200 indique que la requête a réussi.	200
Message	string	Le message renvoyé.	success
Data	object	La structure renvoyée.
Environments	array<object>	Les environnements interrogés.
	array<object>	Détails de l'environnement.
Addons	array<object>	Les composants.
	object	Détails du composant.
Alias	string	L'alias du composant.	Sonde Prometheus
Description	string	La description du composant.	Collecte les données de métriques selon les spécifications de collecte Prometheus
Icon	string	L'URL de l'icône.	http://xxxx
Name	string	Le nom du composant.	metric-agent
UserId	string	L'identifiant de l'utilisateur.	13990957477389
BindResourceId	string	L'identifiant de la ressource liée à l'instance d'environnement. La ressource peut être un cluster Kubernetes ou un VPC.	vpc-bp1bgo8ronn
BindResourceProfile	string	Le profil lié à la ressource.	xxx
BindResourceType	string	Le type de ressource.	VPC
BindVpcCidr	string	Le bloc CIDR lié au VPC.	172.16.0.0/12
CreateTime	string	L'heure de création de l'instance d'environnement.	2023-03-24 11:58:35 +0800
CreatedUserId	string	L'identifiant de l'utilisateur.	12378523784982
EnvironmentId	string	L'identifiant de l'instance d'environnement.	env-xxx
EnvironmentName	string	Le nom de l'instance d'environnement.	feiliks-biz-prod-edas
EnvironmentType	string	Le type de l'instance d'environnement. Valeurs valides : Valeurs valides : CS : Service de conteneurs. ECS : Service ECS. Cloud : Service cloud.	CS
Features	array<object>	Les paramètres de la fonctionnalité.
	object	Détails de la fonctionnalité.
Alias	string	L'alias de la fonctionnalité.	Sonde Prometheus
Description	string	La description de la fonctionnalité.	Collecte les données de métriques selon les spécifications de collecte Prometheus
Icon	string	L'URL de l'icône.	http://xxx
Name	string	Le nom de la fonctionnalité.	metirc-agent
GrafanaFolderTitle	string	Le nom du dossier Grafana.	filepath
GrafanaFolderUid	string	L'identifiant unique du dossier Grafana.	1798319482935
PrometheusId	integer	L'identifiant Prometheus.	124769812
PrometheusInstanceId	string	L'identifiant de l'instance Prometheus.	vpc-m5e4alj2i24ndbn
RegionId	string	L'identifiant de la région.	cn-zhangjiakou
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-acfmvt3xpr5aema
Tags	array<object>	Les balises de la ressource d'environnement.
	object	Valeur de la balise de ressource.
Key	string	La clé de la balise.	fpx-tag
Value	string	La valeur de la balise.	cn-beijing
GrafanaDatasourceUid	string	L'identifiant unique de la source de données Grafana.	12374890
ReleaseCount	integer	Le nombre de composants installés.	122
LatestReleaseCreateTime	string	L'heure de création du dernier composant.	2023-09-22T16:56:29+08:00
ManagedType	string	Indique si les agents ou les exportateurs sont gérés. Valeurs valides :	agent
FeePackage	string	Le plan de ressources payant.	CS_Pro
Total	integer	Le nombre total d'entrées renvoyées.	12

Exemples

JSON format

{
  "RequestId": "1A9C645C-C83F-4C9D-8CCB-29BEC9E1****",
  "Success": true,
  "Code": 200,
  "Message": "success",
  "Data": {
    "Environments": [
      {
        "Addons": [
          {
            "Alias": "Sonde Prometheus",
            "Description": "Collecte les données de métriques selon les spécifications de collecte Prometheus",
            "Icon": "http://xxxx",
            "Name": "metric-agent"
          }
        ],
        "UserId": "13990957477389",
        "BindResourceId": "vpc-bp1bgo8ronn",
        "BindResourceProfile": "xxx",
        "BindResourceType": "VPC",
        "BindVpcCidr": "172.16.0.0/12",
        "CreateTime": "2023-03-24 11:58:35 +0800",
        "CreatedUserId": "12378523784982",
        "EnvironmentId": "env-xxx",
        "EnvironmentName": "feiliks-biz-prod-edas",
        "EnvironmentType": "CS",
        "Features": [
          {
            "Alias": "Sonde Prometheus",
            "Description": "Collecte les données de métriques selon les spécifications de collecte Prometheus",
            "Icon": "http://xxx",
            "Name": "metirc-agent"
          }
        ],
        "GrafanaFolderTitle": "filepath",
        "GrafanaFolderUid": "1798319482935",
        "PrometheusId": 124769812,
        "PrometheusInstanceId": "vpc-m5e4alj2i24ndbn",
        "RegionId": "cn-zhangjiakou",
        "ResourceGroupId": "rg-acfmvt3xpr5aema",
        "Tags": [
          {
            "Key": "fpx-tag",
            "Value": "cn-beijing"
          }
        ],
        "GrafanaDatasourceUid": "12374890",
        "ReleaseCount": 122,
        "LatestReleaseCreateTime": "2023-09-22T16:56:29+08:00",
        "ManagedType": "agent",
        "FeePackage": "CS_Pro"
      }
    ],
    "Total": 12
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.