Query Application Instances with DescribeApplicationInstances API - Serverless App Engine - Alibaba Cloud - Serverless App Engine

Retrieves a list of application instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sae:DescribeApplicationInstances

get

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	d700e680-aa4d-4ec1-afc2-6566b5ff****
GroupId	string	Yes	The ID of the application group. Call the DescribeApplicationGroups operation to get the ID.	b2a8a925-477a-4ed7-b825-d5e22500****
CurrentPage	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10. The value must be in the range (0, 1000000000).	10
Reverse	boolean	No	Specifies the sort order of the application instances. Instances are sorted first by running status, and then by instance ID. Valid values: true: The instances are sorted in descending order. false: The instances are sorted in ascending order. Instance statuses in ascending order: Error: An error occurred during instance startup. CrashLoopBackOff: The container fails to start and enters a crash-restart loop. ErrImagePull: An error occurred while pulling the container image for the instance. ImagePullBackOff: The system is repeatedly trying and failing to pull the container image. Pending: The instance is waiting to be scheduled. Unknown: An unknown exception occurred. Terminating: The instance is being terminated. NotFound: The instance cannot be found. PodInitializing: The instance is being initialized. Init:0/1: The instance is being initialized. Running: The instance is running.	true
InstanceId	string	No	The application instance ID.	demo-faaca66c-5959-45cc-b3bf-d26093b2e9c0******
PipelineId	string	No	The batch ID. Call the DescribeChangeOrder operation to get the ID.	85750d48-6cfc-4dbf-8ea0-840397******

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The message returned for the request.	success
TraceId	string	The trace ID used to query request details.	0a98a02315955564772843261e****
Data	object	The information about the application instances.
CurrentPage	integer	The current page number.	1
TotalSize	integer	The total number of instances.	10
PageSize	integer	The number of entries returned per page.	10
Instances	array<object>	The list of application instances.
	array<object>	The details of an application instance.
CreateTimeStamp	integer	The time when instance creation began. Unit: milliseconds.	1558442609000
VSwitchId	string	The ID of the vSwitch where the instance is deployed.	vsw-***
InstanceContainerStatus	string	The status of the instance container. Valid values: Error: An error occurred during instance startup. CrashLoopBackOff: The container failed to start, encountered an error during startup, and then failed again after a restart. ErrImagePull: Failed to pull the instance's container image. ImagePullBackOff: The container image could not be pulled. Pending: The instance is waiting to be scheduled. Unknown: An unknown exception occurred. Terminating: The instance is being stopped. NotFound: The instance cannot be found. PodInitializing: The instance is being initialized. Init:0/1: The instance is being initialized. Running: The instance is running.	Running
InstanceHealthStatus	string	The health check status of the instance. Valid values: WithoutHealthCheckConfig: liveness and readiness health checks are not configured. WithoutLivenessConfig: The liveness health check is not configured. WithoutReadinessConfig: The readiness health check is not configured. NotCheckedYet: The instance is undergoing or waiting for a health check. LivenessUnhealthy: The liveness health check failed. The instance is unhealthy. ReadinessUnhealthy: The readiness health check failed. The instance is unhealthy. Unhealthy: Both the liveness and readiness health checks failed. The instance is unhealthy. Healthy: The health check passed. The instance is healthy.	WithoutHealthCheckConfig
InstanceContainerRestarts	integer	The number of times the instance's container has restarted.	0
GroupId	string	The ID of the group to which the instance belongs.	b2a8a925-477a-4ed7-b825-d5e22500****
InstanceContainerIp	string	The internal IP address of the instance.	192.168.X.X
InstanceId	string	The instance ID.	b2a8a925-477a-4ed7-b825-d5e22500****
ImageUrl	string	The URL of the container image. Note If you deploy an application using a JAR or WAR package, the container image generated by SAE is not available for download.	registry-vpc.cn-beijing.aliyuncs.com/sae-demo-image/cartservice:1.0
PackageVersion	string	The version of the deployment package.	1609939496200
Timestamp	integer	The timestamp.	1750061980000
Eip	string	The elastic IP address (EIP).	8.129.XX.XXX
FinishTimeStamp	integer	The time when instance creation was completed. Unit: milliseconds.	1642757283000
DebugStatus	boolean	Whether the instance is being debugged. Valid values: true: The instance is being debugged. false: The instance is not being debugged.	False
SidecarContainersStatus	array<object>	The status of the sidecar containers.
	object	The status of a sidecar container.
ContainerId	string	The ID of the sidecar container.	sidecar-test-01
ContainerStatus	string	The status of the container.	Running
ImageUrl	string	The URL of the container image.	registry.cn-beijing.aliyuncs.com/sae-dev-test/******
MainContainerStatus	string	The status of the main container.	Running
UnhealthyMessage	string	The error message for a failed health check on the application instance. This field is empty if the check is successful.
TrafficStatus	string	The traffic status of the instance.
Tags	array<object>	The tags attached to the instance.
	object
Key	string	The tag key.
Value	string	The tag value.
ErrorCode	string	The error code. Valid values: This parameter is not returned for successful requests. This parameter is returned for failed requests. For more information, see the Error codes section in this topic.
Code	string	The HTTP status code or POP error code. Valid values: 2xx: The request was successful. 3xx: The request was redirected. 4xx: A client error occurred. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

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": "",
        "Tags": [
          {
            "Key": "",
            "Value": ""
          }
        ]
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.