DescribeApplicationInstances - Serverless App Engine - Alibaba Cloud Documentation Center

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 obtain the ID.	b2a8a925-477a-4ed7-b825-d5e22500****
CurrentPage	integer	No	The current page number.	1
PageSize	integer	No	The number of entries to return on each page for a paged query. The default value is 10. The value must be in the range of (0, 1000000000).	10
Reverse	boolean	No	The order in which to sort the application instances. The instances are first sorted by their running status. If their statuses are the same, they are then sorted by instance ID. Valid values: true: Sorts the instances in descending order. false: Sorts the instances in ascending order. The ascending order of instance statuses is as follows: Error: An error occurred during instance startup. CrashLoopBackOff: The container failed to start, encountered an error during startup, and failed again after a restart. ErrImagePull: An error occurred when the system pulled the container image for the instance. ImagePullBackOff: The container image could not be obtained. 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.	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 obtain the ID.	85750d48-6cfc-4dbf-8ea0-840397******

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The additional information returned.	success
TraceId	string	The trace ID, which is used for term queries.	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 in a paged query.	10
Instances	array<object>	The list of application instances.
	array<object>	The list of application instances.
CreateTimeStamp	integer	The timestamp when the instance started to be created. Unit: milliseconds.	1558442609000
VSwitchId	string	The zone where the instance is located.	vsw-***
InstanceContainerStatus	string	The running status of the instance. Valid values: Error: An error occurred during instance startup. CrashLoopBackOff: The container failed to start, encountered an error during startup, and failed again after a restart. ErrImagePull: An error occurred when the system pulled the container image for the instance. ImagePullBackOff: The container image could not be obtained. 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. Valid values: WithoutHealthCheckConfig: No liveness and readiness health checks are configured. WithoutLivenessConfig: No liveness health check is configured. WithoutReadinessConfig: No readiness health check is 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 has been 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 address of the image repository. Note If you deploy the application using a JAR or WAR package, the image generated by the SAE platform cannot be downloaded.	registry-vpc.cn-beijing.aliyuncs.com/sae-demo-image/cartservice:1.0
PackageVersion	string	The version information.	1609939496200
Timestamp	integer	The timestamp.	1750061980000
Eip	string	The Elastic IP Address (EIP).	8.129.XX.XXX
FinishTimeStamp	integer	The timestamp when the instance creation was complete. Unit: milliseconds.	1642757283000
DebugStatus	boolean	Indicates whether the instance is being debugged. Valid values: True: Yes. False: No.	False
SidecarContainersStatus	array<object>	The status of the sidecar containers.
	object	The status of the sidecar containers.
ContainerId	string	The ID of the sidecar container.	sidecar-test-01
ContainerStatus	string	The status of the container.	Running
ImageUrl	string	The image address.	registry.cn-beijing.aliyuncs.com/sae-dev-test/******
MainContainerStatus	string	The status of the main container.	Running
UnhealthyMessage	string	If the health check of the application instance fails, this field returns the specific cause or error message. If the health check is successful, this field is empty.	空
TrafficStatus	string
Tags	array<object>
	object
Key	string
Value	string
ErrorCode	string	The error code. Valid values: If the request is successful, this parameter is not returned. If the request fails, this parameter is returned. For more information, see the Error codes section in this topic.	空
Code	string	The status of the API call or the POP error code. Valid values: 2xx: The request was successful. 3xx: The request was redirected. 4xx: A request error occurred. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the API call was successful. Valid values: true: The call was successful. false: The call 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.