DescribeApplicationInstances - - Centre de documentation Alibaba Cloud

Obtient la liste des instances d'application.

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

get

*Toutes les ressources.

*

Aucune

Syntaxe de la requête

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

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
AppId	string	Oui	L'identifiant de l'application.	d700e680-aa4d-4ec1-afc2-6566b5ff****
GroupId	string	Oui	L'identifiant du groupe d'applications. Vous pouvez appeler l'opération DescribeApplicationGroups pour obtenir cet identifiant.	b2a8a925-477a-4ed7-b825-d5e22500****
CurrentPage	integer	Non	Le numéro de la page actuelle.	1
PageSize	integer	Non	Les paramètres de pagination pour le nombre d'entrées par page dans une requête paginée. Valeur par défaut : 10. Valeurs valides : (0, 1000000000).	10
Reverse	boolean	Non	Indique l'ordre de tri des instances d'application en fonction de leur état d'exécution. Si l'état est identique, les instances sont triées par identifiant d'instance. Valeurs valides : true : ordre décroissant. false : ordre croissant. La liste suivante présente les états des instances par ordre croissant : Error : une erreur s'est produite lors du démarrage de l'instance. CrashLoopBackOff : le conteneur n'a pas pu démarrer. Une erreur s'est produite lors du démarrage et a persisté après un redémarrage. ErrImagePull : une erreur s'est produite lors de l'extraction 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
InstanceId	string	Non	L'identifiant de l'instance d'application.	demo-faaca66c-5959-45cc-b3bf-d26093b2e9c0******
PipelineId	string	Non	L'identifiant du lot. Vous pouvez appeler l'opération DescribeChangeOrder pour obtenir cet identifiant.	85750d48-6cfc-4dbf-8ea0-840397******

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données de réponse.
RequestId	string	L'identifiant de la requête.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	Les informations supplémentaires sur le résultat de l'appel.	success
TraceId	string	L'identifiant de trace utilisé pour interroger les informations exactes de l'appel.	0a98a02315955564772843261e****
Data	object	Les informations sur l'instance d'application.
CurrentPage	integer	Le numéro de la page actuelle.	1
TotalSize	integer	Le nombre total d'instances.	10
PageSize	integer	Les paramètres de pagination pour le nombre d'entrées par page dans une requête paginée.	10
Instances	array<object>	La liste des instances d'application.
	array<object>	La liste des instances d'application.
CreateTimeStamp	integer	L'horodatage du début de la création de l'instance. Unité : millisecondes.	1558442609000
VSwitchId	string	La zone où réside l'instance.	vsw-***
InstanceContainerStatus	string	L'état d'exécution de l'instance. Valeurs valides : Error : une erreur s'est produite lors du démarrage de l'instance. CrashLoopBackOff : le conteneur n'a pas pu démarrer. Une erreur s'est produite lors du démarrage et a persisté après un redémarrage. ErrImagePull : une erreur s'est produite lors de l'extraction 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.	Running
InstanceHealthStatus	string	Les informations de configuration du contrôle de santé. Valeurs valides : WithoutHealthCheckConfig : aucun contrôle de santé de vivacité ni de disponibilité n'est configuré. WithoutLivenessConfig : le contrôle de santé de vivacité n'est pas configuré. WithoutReadinessConfig : le contrôle de santé de disponibilité n'est pas configuré. NotCheckedYet : l'instance est en cours de contrôle de santé ou en attente de celui-ci. LivenessUnhealthy : le contrôle de santé de vivacité a échoué et l'instance n'est pas saine. ReadinessUnhealthy : le contrôle de santé de disponibilité a échoué et l'instance n'est pas saine. Unhealthy : les contrôles de santé de vivacité et de disponibilité ont échoué et l'instance n'est pas saine. Healthy : les contrôles de santé ont réussi et l'instance est saine.	WithoutHealthCheckConfig
InstanceContainerRestarts	integer	Le nombre de fois où l'instance a été redémarrée.	0
GroupId	string	L'identifiant du groupe auquel l'instance appartient.	b2a8a925-477a-4ed7-b825-d5e22500****
InstanceContainerIp	string	L'adresse IP interne de l'instance.	192.168.X.X
InstanceId	string	L'identifiant de l'instance.	b2a8a925-477a-4ed7-b825-d5e22500****
ImageUrl	string	L'adresse du référentiel d'images. Remarque Si vous déployez l'application à l'aide d'un package JAR ou WAR, l'image générée par la plateforme Serverless App Engine (SAE) n'est pas disponible en téléchargement public.	registry-vpc.cn-beijing.aliyuncs.com/sae-demo-image/cartservice:1.0
PackageVersion	string	Les informations de version.	1609939496200
Timestamp	integer	L'horodatage.	1750061980000
Eip	string	L'adresse IP élastique.	8.129.XX.XXX
FinishTimeStamp	integer	L'horodatage de la création de l'instance. Unité : millisecondes.	1642757283000
DebugStatus	boolean	Indique si l'instance est en cours de débogage. Valeurs valides : True : oui. False : non.	False
SidecarContainersStatus	array<object>	Les informations d'état des conteneurs sidecar.
	object	Les informations d'état des conteneurs sidecar.
ContainerId	string	L'identifiant du conteneur sidecar.	sidecar-test-01
ContainerStatus	string	L'état du conteneur.	Running
ImageUrl	string	L'adresse de l'image.	registry.cn-beijing.aliyuncs.com/sae-dev-test/******
MainContainerStatus	string	L'état du conteneur principal.	Running
UnhealthyMessage	string	La cause spécifique ou le message d'erreur renvoyé lorsque le contrôle de santé de l'instance d'application échoue. Si le contrôle de santé réussit, aucune information n'est renvoyée dans ce champ.
TrafficStatus	string	L'état du trafic.	suspend
Tags	array<object>	Les informations de balise.
	object
Key	string	La clé de balise.	k1
Value	string	La valeur de balise.	v1
ErrorCode	string	Le code d'erreur. Valeurs valides : Requête réussie : le champ ErrorCode n'est pas renvoyé. Requête échouée : le champ ErrorCode est renvoyé. Pour plus d'informations, consultez la section Codes d'erreur de cette rubrique.
Code	string	Le code d'état 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 instances d'application a été récupérée avec succès. Valeurs valides : true : succès. false : échec.	true

Exemples

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 10,
    "PageSize": 10,
    "Instances": [
      {
        "CreateTimeStamp": 1558442609000,
        "VSwitchId": "vsw-***",
        "InstanceContainerStatus": "Running",
        "InstanceHealthStatus": "WithoutHealthCheckConfig",
        "InstanceContainerRestarts": 0,
        "GroupId": "b2a8a925-477a-4ed7-b825-d5e22500****",
        "InstanceContainerIp": "192.168.X.X",
        "InstanceId": "b2a8a925-477a-4ed7-b825-d5e22500****",
        "ImageUrl": "registry-vpc.cn-beijing.aliyuncs.com/sae-demo-image/cartservice:1.0",
        "PackageVersion": "1609939496200",
        "Timestamp": 1750061980000,
        "Eip": "8.129.XX.XXX",
        "FinishTimeStamp": 1642757283000,
        "DebugStatus": true,
        "SidecarContainersStatus": [
          {
            "ContainerId": "sidecar-test-01",
            "ContainerStatus": "Running",
            "ImageUrl": "registry.cn-beijing.aliyuncs.com/sae-dev-test/******"
          }
        ],
        "MainContainerStatus": "Running",
        "UnhealthyMessage": "",
        "TrafficStatus": "suspend",
        "Tags": [
          {
            "Key": "k1",
            "Value": "v1"
          }
        ]
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.