ListAppServices - - Centre de documentation Alibaba Cloud

Répertorie les microservices.

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.

sae:ListAppServices

list

*All Resource

*

Aucune

Syntaxe de la requête

GET /pop/v1/sam/service/listAppServices HTTP/1.1

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
AppId	string	Non	L'identifiant de l'application. Spécifiez exactement l'un des paramètres suivants : VpcId, NamespaceId ou AppId.	017f39b8-dfa4-4e16-a84b-1dcee4b1****
ServiceType	string	Non	Le type de service. Valeurs valides : dubbo springCloud hsf k8sService	springCloud
RegistryType	string	Non	Le type de registre de services. Valeurs valides : 0 : SAE Nacos 1 : registre de services auto-géré 2 : MSE Nacos 9 : SAE K8s Service	0
NacosInstanceId	string	Non	L'identifiant de l'instance MSE Nacos. Ce paramètre est requis si le registre de services est MSE Nacos.	mse-cn-sco3r0u****
NacosNamespaceId	string	Non	L'identifiant de l'espace de noms MSE Nacos. Ce paramètre est requis si le registre de services est MSE Nacos.	mse-test
PageNumber	integer	Non	Le numéro de page.	1
PageSize	integer	Non	Le nombre d'entrées par page.	10
VpcId	string	Non	L'identifiant du VPC. Spécifiez exactement l'un des paramètres suivants : VpcId, NamespaceId ou AppId.	vpc-2ze0i263cnn311nvj****
NamespaceId	string	Non	L'identifiant de l'espace de noms. Spécifiez exactement l'un des paramètres suivants : VpcId, NamespaceId ou AppId.	cn-beijing:test

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	Le message de réponse. Si la requête aboutit, success est renvoyé. Si la requête échoue, un message d'erreur est renvoyé.	success
TraceId	string	L'identifiant de trace. Vous pouvez utiliser cet identifiant pour interroger les détails d'un appel.	0a98a02315955564772843261e****
Data	array<object>	La liste des services.
	array<object>	Les détails d'un service.
ServiceName	string	Le nom du service.	frontend
ServiceGroup	string	Le groupe de services.	DEFAULT_GROUP
ServiceVersion	string	La version du service.	1.0.0
InstanceCount	string	Le nombre d'instances du service.	1
ServiceType	string	Le type du service. Valeurs valides : dubbo springCloud hsf k8sService	springCloud
ServiceProtocol	string	Le protocole utilisé par le service.	HTTP
ServicePorts	array	Une liste de ports.
	integer	Le numéro de port.	8000
ServicePortAndProtocol	object	Un mappage de ports et de protocoles.
	string	Une paire port et protocole.	8000:TCP
RegistryType	string	Le type de registre de services. Valeurs valides : 0 : SAE Nacos 1 : registre auto-géré 2 : MSE Nacos 9 : SAE K8s Service	0
NamespaceId	string	L'identifiant de l'espace de noms qui contient l'application.	cn-beijing:test
NamespaceName	string	Le nom de l'espace de noms.	Espace de noms de test
AppId	string	L'identifiant de l'application.	0099b7be-5f5b-4512-a7fc-56049ef1****
AppName	string	Le nom de l'application.	demo-app
SecurityGroupId	string	L'identifiant du groupe de sécurité.	sg-wz969ngg2e49q5i4****
ErrorCode	string	Le code d'erreur. Ce paramètre n'est renvoyé que si la requête échoue. Pour plus d'informations, consultez la section Codes d'erreur. Les requêtes abouties ne renvoient pas le champ ErrorCode. Les requêtes échouées renvoient le champ ErrorCode. Pour plus d'informations, consultez la liste des codes d'erreur dans cette rubrique.
Code	string	Le code d'état HTTP ou un code d'erreur POP. Valeurs valides : 2xx : la requête a abouti. 3xx : la requête est redirigée. 4xx : la requête n'est pas valide. 5xx : une erreur de serveur s'est produite.	200
Success	boolean	Indique si l'appel a abouti. Valeurs valides : true : l'appel a abouti. false : l'appel a échoué.	true

Exemples

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": [
    {
      "ServiceName": "frontend",
      "ServiceGroup": "DEFAULT_GROUP",
      "ServiceVersion": "1.0.0",
      "InstanceCount": "1",
      "ServiceType": "springCloud",
      "ServiceProtocol": "HTTP",
      "ServicePorts": [
        8000
      ],
      "ServicePortAndProtocol": {
        "key": "8000:TCP"
      },
      "RegistryType": "0",
      "NamespaceId": "cn-beijing:test",
      "NamespaceName": "Test namespace",
      "AppId": "0099b7be-5f5b-4512-a7fc-56049ef1****",
      "AppName": "demo-app",
      "SecurityGroupId": "sg-wz969ngg2e49q5i4****"
    }
  ],
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	Micro.Service.NotFound	The micro service not found {%s}.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.

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

Notes de version

Consultez Notes de version pour la liste complète.