ListAnsServiceClusters - - Centre de documentation Alibaba Cloud

Consulte les clusters d'un service Nacos.

Description de l'opération

Remarque

Cette opération n'est pas fournie dans les SDK Nacos. Pour plus d'informations sur les SDK Nacos, consultez la documentation officielle.

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

list

*Cluster

acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}

*EngineNamespace

acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
PageNum	integer	Oui	Le numéro de la page à renvoyer.	1
PageSize	integer	Oui	Le nombre d'entrées à renvoyer sur chaque page.	10
ClusterId `deprecated`	string	Non	L'identifiant du cluster MSE. Remarque Le cluster MSE est différent du cluster du service Nacos.	mse-09k1xxxx
ServiceName	string	Non	Le nom du service.	nacos.test.3
GroupName	string	Non	Le nom du groupe.	DEFAULT_GROUP
NamespaceId	string	Non	L'identifiant de l'espace de noms.	12233****
ClusterName	string	Non	L'alias du cluster.	qewr
InstanceId	string	Non	L'identifiant de l'instance.	mse_prepaid_public_cn-tl32a6****
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	Les paramètres de réponse.
Message	string	Le message renvoyé.	La requête a été traitée avec succès
RequestId	string	L'identifiant de la requête.	52BA6DA6-A702-4362-A32F-DFF79655****
Data	object	Les données renvoyées.
ProtectThreshold	number	Le seuil de protection.	0
GroupName	string	Le groupe de services auquel le service appartient.	DEFAULT_GROUP
Clusters	array<object>	Les informations du cluster.
	array<object>	La structure de données.
DefaultCheckPort	integer	The default port used for a health check.	80
HealthCheckerType	string	The type of the health check.	tcp
UseIPPort4Check	boolean	Indicates whether an end-to-end health check was initiated by the server. This parameter is valid only if the service is not a temporary service.	true
ServiceName	string	The full name of the service.	DEFAULT_GROUP@@nacos.test.3
Name	string	The cluster name.	test
DefaultPort	integer	The default port.	80
Metadata	object	The metadata of the cluster.	111
Name	string	Le nom du service.	nacos.test.3
SelectorType	string	Le mode d'élection.	none
Metadata	object	Les métadonnées du service.	111
Ephemeral	boolean	Indique si le service est un service temporaire. Valeurs valides : `true` : oui `false` : non	true
Source	string	Le type de source du service. Valeurs valides : console : le service a été enregistré dans la console. sdk : le service a été enregistré à l'aide du SDK. governance : le service a été enregistré sur Microservices Governance.	console
AppDetail	object	Les informations sur l'application associée pour laquelle Microservices Governance est activé lorsque le paramètre Source est défini sur governance.
AppId	string	The ID of the application for which Microservices Governance is enabled.	hkhon1po62@904cba2c0xxxxxx
AppName	string	The name of the application for which Microservices Governance is enabled.	spring-cloud-b
Port	integer	The port number of the application for which Microservices Governance is enabled.	6001
CheckType	string	The type of the health check. Valid values: connection: connection status check tcp: TCP connection check http: HTTP connection check	tcp
CheckPath	string	The path of the health check. This parameter is required only when the CheckType parameter is set to http.	/health
CheckTimeout	integer	The timeout period of the health check response. Unit: seconds.	5
CheckInternal	integer	The health check interval. Unit: seconds.	2
HealthyCheckTimes	integer	The maximum number of health check retries when the instance state changes from unhealthy to healthy.	2
UnhealthyCheckTimes	integer	The maximum number of health check retries when the instance state changes from healthy to unhealthy.	2
ErrorCode	string	Le code d'erreur renvoyé si la requête a échoué.	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
HttpCode	string	Le code d'état HTTP.	200

Exemples

JSON format

{
  "Message": "The request is processed successfully.",
  "RequestId": "52BA6DA6-A702-4362-A32F-DFF79655****",
  "Data": {
    "ProtectThreshold": 0,
    "GroupName": "DEFAULT_GROUP",
    "Clusters": [
      {
        "DefaultCheckPort": 80,
        "HealthCheckerType": "tcp",
        "UseIPPort4Check": true,
        "ServiceName": "DEFAULT_GROUP@@nacos.test.3",
        "Name": "test",
        "DefaultPort": 80,
        "Metadata": 111
      }
    ],
    "Name": "nacos.test.3",
    "SelectorType": "none",
    "Metadata": 111,
    "Ephemeral": true,
    "Source": "console",
    "AppDetail": {
      "AppId": "hkhon1po62@904cba2c0xxxxxx",
      "AppName": "spring-cloud-b",
      "Port": 6001,
      "CheckType": "tcp",
      "CheckPath": "/health",
      "CheckTimeout": 5,
      "CheckInternal": 2,
      "HealthyCheckTimes": 2,
      "UnhealthyCheckTimes": 2
    }
  },
  "ErrorCode": "mse-100-000",
  "Success": true,
  "HttpCode": "200"
}

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.