ListAnsServices - - Centre de documentation Alibaba Cloud

Consulte les détails des services Nacos.

Description de l'opération

Remarque

Cette OpenAPI n'est pas une API du SDK Nacos. Pour plus d'informations sur les API du 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:ListAnsServices

list

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ServiceName	string	Non	Le nom du service.	name
GroupName	string	Non	Le nom du groupe de contacts.	name
NamespaceId	string	Non	L'identifiant de l'espace de noms.	12233****
ClusterName	string	Non	Le paramètre requis pour interroger la liste des instances d'un cluster spécifique d'un service.	DEFAULT
HasIpCount	string	Non	Indique si le nombre d'instances du service doit être interrogé. Valeurs valides : false : Non. true : Oui.	true
ClusterId `deprecated`	string	Non	L'identifiant du cluster. Remarque Vous devez spécifier soit ce paramètre, soit InstanceId.	mse-09k1q11****
InstanceId	string	Non	L'identifiant de l'instance. Remarque Vous devez spécifier soit ce paramètre, soit ClusterId.	mse-cn-st21v5****
PageNum	integer	Oui	Le numéro de page.	1
PageSize	integer	Oui	Le nombre d'instances à afficher sur chaque page.	10
RegionId	string	Non	La région.	cn-hangzhou
RequestPars	string	Non	Les paramètres de requête étendus au format JSON.	{}
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	La structure de données.
HttpCode	string	Le code d'état HTTP.	202
TotalCount	integer	Le nombre total d'instances.	7
RequestId	string	L'identifiant de la requête.	52BA6DA6-A702-4362-A32F-DFF79655****
Message	string	Le message renvoyé.	Requête traitée avec succès
PageSize	integer	Le nombre d'instances affichées par page.	10
PageNumber	integer	Le numéro de page.	1
Data	array<object>	L'aperçu des données.
	object	La structure de données.
HealthyInstanceCount	integer	Le nombre total d'instances de service avec des signaux de présence sains.	1
GroupName	string	Le nom du groupe de contacts.	name
IpCount	integer	Le nombre total d'instances du service actuel.	1
Name	string	Le nom du service.	name
ClusterCount	integer	Le nombre total de clusters.	1
Source	string	Le type de service. Valeurs valides : console : enregistré sur la console. sdk : enregistré à l'aide d'un SDK. governance : enregistré à l'aide de l'administration des services.	console
ErrorCode	string	Le code d'erreur.	mse-100-000
Success	boolean	Le résultat de la requête. Valeurs valides : true : la requête a réussi. false : la requête a échoué.	true

Exemples

JSON format

{
  "HttpCode": "202",
  "TotalCount": 7,
  "RequestId": "52BA6DA6-A702-4362-A32F-DFF79655****",
  "Message": "The request is processed successfully.",
  "PageSize": 10,
  "PageNumber": 1,
  "Data": [
    {
      "HealthyInstanceCount": 1,
      "GroupName": "name",
      "IpCount": 1,
      "Name": "name",
      "ClusterCount": 1,
      "Source": "console"
    }
  ],
  "ErrorCode": "mse-100-000",
  "Success": true
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	OperationNotSupport	The current cluster does not support this operation, %s.	The current cluster does not support this operation, %s
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.