ListApplications - - 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.

sae:ListApplications

get

*All Resource

*

Aucune

Syntaxe de la requête

GET /pop/v1/sam/app/listApplications HTTP/1.1

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
CurrentPage	integer	Non	Le numéro de la page actuelle.	1
PageSize	integer	Non	Le nombre d'entrées par page dans une requête paginée. Valeurs valides : [0,10000].	20
AppName	string	Non	Le nom de l'application.	demo-app
NamespaceId	string	Non	L'identifiant de l'espace de noms.	cn-beijing:demo
Tags	string	Non	Les paires clé-valeur des balises. Valeurs valides : key : la clé de la balise. La longueur doit être comprise dans la plage [1,128]. value : la valeur de la balise. La longueur doit être comprise dans la plage [1,128]. Les balises sont sensibles à la casse. Si vous spécifiez plusieurs balises, toutes les balises spécifiées sont créées et attachées à la ressource. Chaque clé de balise d'une même ressource ne peut avoir qu'une seule valeur de balise. Si vous ajoutez une clé de balise qui existe déjà, la valeur de balise correspondante est mise à jour avec la nouvelle valeur. Les balises ne peuvent pas commencer par `aliyun` ou `acs:`, et ne peuvent pas contenir `http://` ou `https://`.	[{"key":"clé","value":"valeur"}]
OrderBy	string	Non	Le champ selon lequel trier les applications. Valeurs valides : runnings : trie selon le nombre actuel d'instances cibles. instances : trie selon le nombre cible d'instances.	runnings
Reverse	boolean	Non	Indique si les instances d'application doivent être triées par état d'exécution. Si des instances ont le même état, elles sont triées par identifiant d'instance. Valeurs valides : true : trie par ordre croissant. Les instances sont organisées en fonction de la séquence de démarrage. Par exemple, pour atteindre l'état d'exécution, une instance doit passer par des étapes telles que le démarrage du conteneur, la récupération de l'image et l'initialisation de l'instance. false : trie par ordre décroissant. L'ordre croissant des instances est le suivant : Error : une erreur s'est produite lors du démarrage de l'instance. CrashLoopBackOff : le conteneur n'a pas réussi à démarrer, a rencontré une erreur lors du démarrage, et a rencontré une nouvelle erreur après le redémarrage. ErrImagePull : une erreur s'est produite lors de la récupération de l'image de conteneur pour l'instance. ImagePullBackOff : l'image de conteneur ne peut pas être récupérée. Pending : l'instance est en attente de planification. Unknown : une exception inconnue s'est produite. Terminating : l'instance est en cours d'arrêt. NotFound : l'instance est introuvable. PodInitializing : l'instance est en cours d'initialisation. Init:0/1 : l'instance est en cours d'initialisation. Running : l'instance est en cours d'exécution.	true
FieldType	string	Non	La dimension selon laquelle filtrer les applications. Valeurs valides : appName : nom de l'application. appIds : identifiant de l'application. slbIps : adresse IP du SLB. instanceIps : adresse IP de l'instance.	appName
FieldValue	string	Non	Le nom de l'application, l'identifiant de l'application, l'adresse IP du SLB ou l'adresse IP de l'instance de l'application cible.	demo-app
AppSource	string	Non	Le type d'application Serverless App Engine (SAE). micro_service. web. job.	micro_service
IsStateful	string	Non	Indique si l'application est avec état.
NewSaeVersion	string	Non	La version de l'application. Valeurs valides : lite : Édition Lite std : Édition Standard pro : Édition Professionnelle
ProgrammingLanguage	string	Non

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données de réponse.
Message	string	Les informations supplémentaires sur le résultat de l'appel.	success
RequestId	string	L'identifiant de la requête.	B4D805CA-926D-41B1-8E63-7AD0C1ED****
Data	object	La liste des applications.
CurrentPage	integer	Le numéro de la page actuelle.	1
TotalSize	integer	Le nombre total d'applications.	2
PageSize	integer	La taille de la page.	20
Applications	array<object>	La liste des applications.
	array<object>	Les informations de la liste des applications.
AppName	string	The application name.	demo-app
NamespaceId	string	The namespace ID.	cn-beijing:demo
AppDeletingStatus	boolean	Indicates whether the application is being deleted. Valid values: true: The application is being deleted. false: The application is not being deleted.	false
AppId	string	The application ID.	f7730764-d88f-4b9a-8d8e-cd8efbfe****
Tags	array<object>	The application tags.
	object	The application tag information.
Key	string	The tag key.	key
Value	string	The tag value.	value
RunningInstances	integer	The number of running instances.	2
Instances	integer	The number of application instances.	2
RegionId	string	The region ID.	cn-beijing
AppDescription	string	The application description.	description
Cpu	integer	The CPU required for each instance, in millicores. This value cannot be 0. Only the following defined specifications are supported: 500 1000 2000 4000 8000 16000 32000	1000
Mem	integer	The memory required for each instance, in MB. This value cannot be 0. The memory has a one-to-one mapping with CPU. Only the following defined specifications are supported: 1024: corresponds to 500 and 1000 millicores of CPU. 2048: corresponds to 500, 1000, and 2000 millicores of CPU. 4096: corresponds to 1000, 2000, and 4000 millicores of CPU. 8192: corresponds to 2000, 4000, and 8000 millicores of CPU. 12288: corresponds to 12000 millicores of CPU. 16384: corresponds to 4000, 8000, and 16000 millicores of CPU. 24576: corresponds to 12000 millicores of CPU. 32768: corresponds to 16000 millicores of CPU. 65536: corresponds to 8000, 16000, and 32000 millicores of CPU. 131072: corresponds to 32000 millicores of CPU.	1024
MseEnabled	boolean	Indicates whether MSE microservice governance is enabled for the application.	true
MseNamespaceId	string	The MSE microservice governance namespace. default: Free Edition sae-pro: Professional Edition sae-ent: Enterprise Edition	sae-ent
BaseAppId	string	The base application ID. This property exists only for canary release applications.	xxx-xxx-xx-xxx
ProgrammingLanguage	string	The programming language of the application.	java
Children	array<object>	The list of canary release applications for this application.
	array<object>	The detailed information.
AppName	string	The application name.	app1
NamespaceId	string	The namespace ID.	cn-beijing:demo
AppDeletingStatus	boolean	Indicates whether the application is being deleted.	false
AppId	string	The application ID.	xxx-xxx-xxx-xxx
ScaleRuleEnabled	boolean	Indicates whether the elastic scaling policy is enabled.	false
ScaleRuleType	string	The type of the elastic scaling rule.	timing
Tags	array<object>	The application tags.
	object	The application tags.
Key	string	The tag key.	key
Value	string	The tag value.	value
RunningInstances	integer	The number of running instances.	2
Instances	integer	The number of instances.	2
RegionId	string	The region ID.	cn-beijing
AppDescription	string	The application description.	Test application
Cpu	integer	The CPU size.	2000
Mem	integer	The memory size.	2048
MseEnabled	boolean	Indicates whether MSE microservice governance is enabled for the application.	true
BaseAppId	string	The base application ID.	ee99cce6-1c8e-4bfa-96c3-3e2fa9******
ProgrammingLanguage	string	The programming language of the application.	java
AppType	string	The deployment type of the application.	Image
NamespaceName	string	The namespace name.	demo
IsStateful	boolean	Specifies whether the application is stateful.
NewSaeVersion	string	The application version. Valid values: lite: Lite Edition std: Standard Edition pro: Professional Edition	pro
ResourceType	string	The resource type.
EnableIdle	string	Indicates whether idle mode is enabled.
ImageUrl	string	The image URL.	registry.cn-hangzhou.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0
PackageUrl	string	The deployment package URL.	https://sae-oss-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/apps/K8S_APP_ID/1421801774382676/adf2624a-66fd-4a2b-8caa-6921da******/hello-sae.jar
AppType	string	The deployment type of the application.	Image
NamespaceName	string	The namespace name.	demo
IsStateful	boolean	Specifies whether the application is stateful.
NewSaeVersion	string	The application version. Valid values: lite: Lite Edition std: Standard Edition pro: Professional Edition	pro
EnableIdle	string	Indicates whether idle mode is enabled.	false
DiskSize	integer	The disk storage size, in GB.	20
VpcId	string	VPC ID。
ResourceType	string	The resource type.
Labels	object	The labels.
	string
RaspEnabled	boolean
ErrorCode	string	Le code d'erreur. Valeurs valides : Si la requête réussit, le champ ErrorCode n'est pas renvoyé. Si la requête échoue, le champ ErrorCode est renvoyé. Pour plus d'informations, consultez la section Codes d'erreur de cette rubrique.
Code	string	Le statut de l'API ou le code d'erreur POP. Valeurs valides : 2xx : Succès. 3xx : Redirection. 4xx : Erreur de requête. 5xx : Erreur de serveur.	200
Success	boolean	Indique si la liste des applications est récupérée. Valeurs valides : true : Récupérée. false : Non récupérée.	true
CurrentPage	integer	Le numéro de la page actuelle.	1
TotalSize	integer	Le nombre total d'applications.	2
PageSize	integer	La taille de la page.	20

Exemples

JSON format

{
  "Message": "success",
  "RequestId": "B4D805CA-926D-41B1-8E63-7AD0C1ED****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 2,
    "PageSize": 20,
    "Applications": [
      {
        "AppName": "demo-app",
        "NamespaceId": "cn-beijing:demo",
        "AppDeletingStatus": false,
        "AppId": "f7730764-d88f-4b9a-8d8e-cd8efbfe****",
        "Tags": [
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "RunningInstances": 2,
        "Instances": 2,
        "RegionId": "cn-beijing",
        "AppDescription": "description",
        "Cpu": 1000,
        "Mem": 1024,
        "MseEnabled": true,
        "MseNamespaceId": "sae-ent",
        "BaseAppId": "xxx-xxx-xx-xxx",
        "ProgrammingLanguage": "java",
        "Children": [
          {
            "AppName": "app1",
            "NamespaceId": "cn-beijing:demo",
            "AppDeletingStatus": false,
            "AppId": "xxx-xxx-xxx-xxx",
            "ScaleRuleEnabled": false,
            "ScaleRuleType": "timing",
            "Tags": [
              {
                "Key": "key",
                "Value": "value"
              }
            ],
            "RunningInstances": 2,
            "Instances": 2,
            "RegionId": "cn-beijing",
            "AppDescription": "Test application",
            "Cpu": 2000,
            "Mem": 2048,
            "MseEnabled": true,
            "BaseAppId": " ee99cce6-1c8e-4bfa-96c3-3e2fa9******",
            "ProgrammingLanguage": "java",
            "AppType": "Image",
            "NamespaceName": "demo",
            "IsStateful": false,
            "NewSaeVersion": "pro",
            "ResourceType": "",
            "EnableIdle": ""
          }
        ],
        "ImageUrl": "registry.cn-hangzhou.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0",
        "PackageUrl": "https://sae-oss-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/apps/K8S_APP_ID/1421801774382676/adf2624a-66fd-4a2b-8caa-6921da******/hello-sae.jar",
        "AppType": "Image",
        "NamespaceName": "demo",
        "IsStateful": false,
        "NewSaeVersion": "pro",
        "EnableIdle": "false",
        "DiskSize": 20,
        "VpcId": "",
        "ResourceType": "",
        "Labels": {
          "key": ""
        },
        "RaspEnabled": false
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true,
  "CurrentPage": 1,
  "TotalSize": 2,
  "PageSize": 20
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	Illegal.argument	Illegal argument

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

Notes de version

Consultez Notes de version pour la liste complète.