DescribeApplicationInstances - - Alibaba Cloud Documentation Center

Queries a list of application instances.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
sae:DescribeApplicationInstances	get	All Resources *	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	d700e680-aa4d-4ec1-afc2-6566b5ff****	d700e680-aa4d-4ec1-afc2-6566b5ff****
GroupId	string	Yes	b2a8a925-477a-4ed7-b825-d5e22500****	b2a8a925-477a-4ed7-b825-d5e22500****
CurrentPage	integer	No	1	1
PageSize	integer	No	10	10
Reverse	boolean	No	true	true

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message.	success
TraceId	string	The ID of the trace. It is used to query the details of a request.	0a98a02315955564772843261e****
Data	object	The details of the application instances.
CurrentPage	integer	The number of the returned page.	1
TotalSize	integer	The total number of returned instances.	10
PageSize	integer	The number of entries returned on each page.	10
Instances	array<object>	The list of application instances.
Instance	object
CreateTimeStamp	long	The start time of the instance creation process. Unit: milliseconds.	1558442609000
VSwitchId	string	The ID of the zone where the instance is deployed.	vsw-***
InstanceContainerStatus	string	The state of the instance. Valid values: Error: An error occurred during the instance startup. CrashLoopBackOff: The container failed to start. An error occurred during the startup process and persisted after the restart. ErrImagePull: An error occurred while the container image was being pulled from 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 creation process is being terminated. NotFound: The instance cannot be found. PodInitializing: The instance is being initialized. Init:0/1: The instance is initialized. Running: The instance is running.	Running
InstanceHealthStatus	string	The configurations of health checks. Valid values: WithoutHealthCheckConfig: Liveness and readiness checks are not configured. WithoutLivenessConfig: The liveness check is not configured. WithoutReadinessConfig: The readiness check is not configured. NotCheckedYet: The health checks are not performed or are in progress. LivenessUnhealthy: The instance failed the liveness check. ReadinessUnhealthy: The instance failed the readiness check. Unhealthy: The instance failed both liveness and readiness checks. Healthy: The instance passed both liveness and readiness checks.	WithoutHealthCheckConfig
InstanceContainerRestarts	long	The number of times that the instance 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 ID of the instance.	b2a8a925-477a-4ed7-b825-d5e22500****
ImageUrl	string	The address of the repository. Note If you deploy the application by using a JAR or WAR package, the 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 package.	1609939496200
Eip	string	The elastic IP address (EIP).	8.129.XX.XXX
FinishTimeStamp	long	The end time of the instance creation process. Unit: milliseconds.	1642757283000
ErrorCode	string	The error code. The ErrorCode parameter is not returned when the request succeeds. The ErrorCode parameter is returned when the request fails. For more information, see Error codes in this topic.
Code	string	The HTTP status code. Valid values: 2xx: indicates that the request was successful. 3xx: indicates that the request was redirected. 4xx: indicates that the request was invalid. 5xx: indicates that a server error occurred.	200
Success	boolean	Indicates whether the list of application instances was obtained. Valid values: true: indicates that the list was obtained. false: indicates that the list could not be obtained.	true

Examples

Sample success responses

JSONformat

{
  "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",
        "Eip": "8.129.XX.XXX",
        "FinishTimeStamp": 1642757283000,
        "DebugStatus": true
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history