ListClusters - - Centre de documentation Alibaba Cloud

Répertorie les clusters du centre d'enregistrement et de configuration.

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.

mse:ListClusters

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RequestPars	string	Non	Les paramètres de requête étendus au format JSON.	{}
PageNum	integer	Oui	Le numéro de page à renvoyer.	1
PageSize	integer	Oui	Le nombre de clusters par page.	10
ClusterAliasName	string	Non	L'alias du cluster. Ce paramètre prend en charge la recherche approximative.	cluster
RegionId	string	Oui	L'identifiant de la région MSE dans laquelle le cluster est déployé.	cn-hangzhou
ResourceGroupId	string	Non	L'identifiant du groupe de ressources. Pour plus d'informations, consultez Afficher les informations de base du groupe de ressources.	rg-acfmxbzafebvvfa
Tag	array<object>	Non	Une liste de balises. Vous pouvez spécifier jusqu'à 20 balises.
	object	Non	Une balise.
Key	string	Non	La clé de la balise.	env
Value	string	Non	La valeur de la balise.	prd
KeyId	string	Non	Pour les clusters Nacos, renvoie les clusters dont les instances sont liées à l'identifiant de clé spécifié.	key-hzz67774641bsp21vhj4h
AcceptLanguage	string	Non	La langue de la réponse. Valeurs valides : `zh` : chinois `en` : anglais	zh

Éléments de réponse

Élément	Type	Description	Exemple
	object	L'objet de réponse.
HttpCode	string	Le code d'état HTTP.	202
TotalCount	integer	Le nombre total d'instances.	7
RequestId	string	L'identifiant de la requête.	69AD2AA7-DB47-449B-941B-B14409DF****
Message	string	Le message de réponse.	OK
PageSize	integer	Le nombre d'instances par page.	10
PageNumber	integer	Le numéro de page.	1
Data	array<object>	La liste des clusters.
	array<object>	Les détails du cluster.
EndDate	string	La date d'expiration de l'abonnement du cluster.	2021-08-01 00:00:00
IntranetDomain	string	Le nom de domaine intranet du cluster.	mse-7413****-eureka.mse.aliyuncs.com
InternetDomain	string	Le nom de domaine Internet du cluster.	mse-7413****-p.eureka.mse.aliyuncs.com
CreateTime	string	L'heure de création du cluster.	2020-07-31 11:36:08
ChargeType	string	La méthode de facturation. Valeurs valides : `subscription` et `pay-as-you-go`.	subscription
IntranetAddress	string	L'adresse IP intranet du cluster.	192.168.XX.XX
InstanceId	string	L'identifiant de l'instance.	mse-cn-st21ri2****
InternetAddress	string	L'adresse IP Internet du cluster.	47.98.XX.XX
ClusterAliasName	string	L'alias du cluster.	mse-7413****
ClusterType	string	Le type de cluster. Valeurs valides : `ZooKeeper`, `Nacos-Ans` et `Eureka`.	Eureka
InitStatus	string	L'état d'initialisation.	RESTART_SUCCESS
AppVersion	string	La version de l'application.	1.9.3
CanUpdate	boolean	Indique si le cluster peut être mis à niveau.	true
VersionCode	string	Le code de la version du cluster.	EUREKA_1_9_3
InstanceCount	integer	Le nombre d'instances dans le cluster.	2
ClusterName	string	Le nom du cluster.	mse-cn-st21ri2****
MseVersion	string	L'édition du cluster.	mse_pro
Tags	object	Les balises associées au cluster.
ResourceGroupId	string	L'identifiant du groupe de ressources qui contient le cluster.	rg-acfmv7jiavm4uxa
VpcId	string	L'identifiant du VPC dans lequel le cluster est déployé.	vpc-bp1hcg467ekqsv0zr****
MaintenancePeriod	object	La fenêtre de maintenance.
StartTime	string	The start time of the maintenance window.	02:00
EndTime	string	The end time of the maintenance window.	06:00
VersionLifecycle	string	Le cycle de vie de la version.
ErrorCode	string	Le code d'erreur renvoyé en cas d'échec de la requête.	mse-100-000
Success	boolean	Indique si la requête a réussi. Valeurs valides : `true` : la requête a réussi. `false` : la requête a échoué.	true

Exemples

JSON format

{
  "HttpCode": "202",
  "TotalCount": 7,
  "RequestId": "69AD2AA7-DB47-449B-941B-B14409DF****",
  "Message": "OK",
  "PageSize": 10,
  "PageNumber": 1,
  "Data": [
    {
      "EndDate": "2021-08-01 00:00:00",
      "IntranetDomain": "mse-7413****-eureka.mse.aliyuncs.com",
      "InternetDomain": "mse-7413****-p.eureka.mse.aliyuncs.com",
      "CreateTime": "2020-07-31 11:36:08",
      "ChargeType": "subscription",
      "IntranetAddress": "192.168.XX.XX",
      "InstanceId": "mse-cn-st21ri2****",
      "InternetAddress": "47.98.XX.XX",
      "ClusterAliasName": "mse-7413****",
      "ClusterType": "Eureka",
      "InitStatus": "RESTART_SUCCESS",
      "AppVersion": "1.9.3",
      "CanUpdate": true,
      "VersionCode": "EUREKA_1_9_3",
      "InstanceCount": 2,
      "ClusterName": "mse-cn-st21ri2****",
      "MseVersion": "mse_pro",
      "Tags": {
        "test": "test",
        "test2": 1
      },
      "ResourceGroupId": "rg-acfmv7jiavm4uxa",
      "VpcId": "vpc-bp1hcg467ekqsv0zr****",
      "MaintenancePeriod": {
        "StartTime": "02:00",
        "EndTime": "06:00"
      },
      "VersionLifecycle": ""
    }
  ],
  "ErrorCode": "mse-100-000",
  "Success": true
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

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

Notes de version

Consultez Notes de version pour la liste complète.