ListApplication - - Centre de documentation Alibaba Cloud

Obtient la liste des applications.

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.

edas:ReadApplication

*All Resource

*

Aucune

Syntaxe de la requête

POST /pop/v5/app/app_list HTTP/1.1

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ClusterId	string	Non	Filtre la liste des applications par cluster.	c37aec2a-bcca-4ec1-**-**********
LogicalRegionId	string	Non	Filtre la liste des applications par espace de noms de microservices.	cn-beijing:test
AppName	string	Non	Filtre la liste des applications par nom d'application.	testapp
ResourceGroupId	string	Non	Filtre la liste des applications par groupe de ressources.	rg-aek24j4s4b*****
LogicalRegionIdFilter	string	Non	Filtre les applications par correspondance exacte de l'espace de noms de microservices.	cn-beijing:test
AppIds	string	Non	La liste des identifiants d'application.	[ "5657d271-**-4f03-9bb2-431f942886bb", "5657d271-**-4f03-9bb2-431f942bbddd" ]
CurrentPage	integer	Non	Le numéro de la page à renvoyer dans une requête paginée. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées à renvoyer sur chaque page dans une requête paginée.	20

Éléments de réponse

Élément	Type	Description	Exemple
	object	La réponse.
Code	integer	Le code d'état de la réponse.	200
Message	string	Les informations supplémentaires.	success
RequestId	string	L'identifiant de la requête.	5d6fa0bc-cc3**********
ApplicationList	object
Application	array<object>	La liste des applications.
	object	L'objet de la liste des applications.
AppId	string	The application ID.	00ee517d-dd7d-4d4e-**-**********
RegionId	string	The region ID.	cn-beijing:docTes
Name	string	The application name.	doc-test-consumer
Instances	integer	The number of application instances.	5
Port	integer	The service port of the application.	8080
State	string	The application status. Valid values: RUNNING: Running. STOPPED: Stopped. DEPLOYING: Being deployed. DELETING: Being deleted.	RUNNING
CreateTime	integer	The timestamp when the application was created.	1664208000000
SlbIp	string	The private SLB IP address.	192.168.0.***
SlbPort	integer	The private SLB port.	80
SlbListenerPort	integer	The private SLB listener port.	8088
ExtSlbListenerPort	integer	The Internet-facing SLB listener port.	8080
BuildPackageId	integer	The container version ID.	58
ExtSlbIp	string	The Internet-facing SLB IP address.	100.100.70.***
ApplicationType	string	The application deployment type. Valid values: War: deployed as a WAR package. FatJar: deployed as a JAR package. Image: deployed as an image. Empty: not deployed.	FatJar
ClusterType	integer	The cluster environment type of the application. Valid values: 2: ECS cluster. 3: EDAS built-in Kubernetes cluster. 5: Container service Kubernetes clusters.	2
RunningInstanceCount	integer	The number of running application instances.	0
ClusterId	string	The cluster ID.	c37aec2a-bcca-4ec1-**-**********
ResourceGroupId	string	The resource group ID.	rg-aek24j4s4b*****
K8sNamespace	string	The Kubernetes namespace.	default
NamespaceId	string	The microservices namespace ID.	cn-hangzhou:test

Exemples

JSON format

{
  "Code": 200,
  "Message": "success",
  "RequestId": "5d6fa0bc-cc3**********",
  "ApplicationList": {
    "Application": [
      {
        "AppId": "00ee517d-dd7d-4d4e-****-************",
        "RegionId": "cn-beijing:docTes",
        "Name": "doc-test-consumer",
        "Instances": 5,
        "Port": 8080,
        "State": "RUNNING",
        "CreateTime": 1664208000000,
        "SlbIp": "192.168.0.***",
        "SlbPort": 80,
        "SlbListenerPort": 8088,
        "ExtSlbListenerPort": 8080,
        "BuildPackageId": 58,
        "ExtSlbIp": "100.100.70.***",
        "ApplicationType": "FatJar",
        "ClusterType": 2,
        "RunningInstanceCount": 0,
        "ClusterId": "c37aec2a-bcca-4ec1-****-************",
        "ResourceGroupId": "rg-aek24j4s4b*****",
        "K8sNamespace": "default",
        "NamespaceId": "cn-hangzhou:test"
      }
    ]
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de versionNotes de version pour la liste complète.