ListApplications - Serverless App Engine - Alibaba Cloud Documentation Center

Query a list of applications.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:ListApplications	get	All Resources ``	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
CurrentPage	integer	No	The current page number.	1
PageSize	integer	No	The number of records in each page. Value range: [0,10000]	20
AppName	string	No	The application name.	demo-app
NamespaceId	string	No	The namespace ID.	cn-beijing:demo
Tags	string	No	The tag in the format of a key-value pair. key: the tag key. It cannot exceed 128 characters in length. value: the tag value. It cannot exceed 128 characters in length. Tag keys and tag values are case-sensitive. If you specify multiple tags, the system adds all the tags to the specified resources. Each tag key on a resource can have only one tag value. If you create a tag that has the same key as an existing tag, the value of the existing tag is overwritten. Tag keys and tag values cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	[{"key":"key","value":"value"}]
OrderBy	string	No	Specifies how applications are sorted. Valid values: running: The applications are sorted based on the number of running instances. instances: The applications are sorted based on the number of destination instances.	running
Reverse	boolean	No	Sort by the running status of application instances. If the statuses are the same, sort by instance ID. The value options are as follows: true: Sort in ascending order. Instances are arranged according to the startup process, for example: to ultimately reach the running state, an instance must first go through steps such as starting containers, pulling images, and initializing the instance. false: Sort in descending order.	true
FieldType	string	No	Set the filtering criteria for applications. The value options are as follows: appName: Application name. appIds: Application IDs. slbIps: SLB IP addresses. instanceIps: Instance IP addresses.	appName
FieldValue	string	No	The name, ID, SLB IP, or instance IP of the target application.	demo-app
AppSource	string	No	The SAE application type. Valid values: micro_service web job	micro_service

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Message	string	Additional message.	success
RequestId	string	Request ID.	B4D805CA-926D-41B1-8E63-7AD0C1ED****
Data	object	The queried applications.
CurrentPage	integer	The current page number.	1
TotalSize	integer	The number of applications.	2
PageSize	integer	The number of records in each page.	20
Applications	array<object>	The queried applications.
Application	object	The information about the 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 tags of the application.
Tags	object	The tag information.
Key	string	The key of the tag.	key
Value	string	The value of the tag.	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 description of the application.	description
Cpu	integer	The CPU specifications that are required for each instance. Unit: millicores. This parameter cannot be set to 0. Valid values: 500 1000 2000 4000 8000 16000 32000	1000
Mem	integer	The memory size that is required by each instance. Unit: MB. This parameter cannot be set to 0. The values of this parameter correspond to the values of the Cpu parameter: This parameter is set to 1024 if the Cpu parameter is set to 500 or 1000. This parameter is set to 2048 if the Cpu parameter is set to 500, 1000, or 2000. This parameter is set to 4096 if the Cpu parameter is set to 1000, 2000, or 4000. This parameter is set to 8192 if the Cpu parameter is set to 2000, 4000, or 8000. This parameter is set to 12288 if the Cpu parameter is set to 12000. This parameter is set to 16384 if the Cpu parameter is set to 4000, 8000, or 16000. This parameter is set to 24576 if the Cpu parameter is set to 12000. This parameter is set to 32768 if the Cpu parameter is set to 16000. This parameter is set to 65536 if the Cpu parameter is set to 8000, 16000, or 32000. This parameter is set to 131072 if the Cpu parameter is set to 32000.	1024
MseEnabled	boolean	The application has enabled MSE or not.	true
MseNamespaceId	string	The name space of MSE: default: the free edition. sae-pro: the professional edition. sae-ent: the enterprise eiditon.	sae-ent
BaseAppId	string	The base app ID. Only gray-release applications have this property.	xxx-xxx-xx-xxx
ProgrammingLanguage	string	The programming language of the application.	java
Children	array<object>	The gray-release application list of this application.
children	object	Details.
AppName	string	The application name.	app1
NamespaceId	string	The namespace ID.	cn-beijing:demo
AppDeletingStatus	boolean	If is deleting this application.	false
AppId	string	The application ID.	xxx-xxx-xxx-xxx
ScaleRuleEnabled	boolean	If the scale rule is enabled.	false
ScaleRuleType	string	The type of the scale rule.	timing
Tags	array<object>	The application tag.
tags	object	The application tag.
Key	string	The tag key.	key
Value	string	The tag value.	value
RunningInstances	integer	The number of instances in running state.	2
Instances	integer	The number of instances.	2
RegionId	string	The region ID.	cn-beijing
AppDescription	string	The application description.	Test
Cpu	integer	The CPU sepcification.	2000
Mem	integer	The memory specification.	2048
MseEnabled	boolean	If this application has enabled MSE.	true
BaseAppId	string	The base application ID.	ee99cce6-1c8e-4bfa-96c3-3e2fa9******
ProgrammingLanguage	string	The programming language of this application.	java
AppType	string	The way to deploy applications.	Image
NamespaceName	string	The name of the namespace.	demo
NewSaeVersion	string	The application edition. lite: the lightweight edition. std: the standard edition. pro: the professional edition.	pro
ImageUrl	string	The image URL.	registry.cn-hangzhou.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0
PackageUrl	string	The 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 application type.	Image
NamespaceName	string	The name of the namespace.	demo
NewSaeVersion	string	The application edition. lite: the lightweight edition. std: the standard edition. pro: the professional edition.	pro
EnableIdle	string	If the idle mode is enabled.	false
DiskSize	integer	The disk size. Unit: GB.	20
VpcId	string	VPC ID.
ErrorCode	string	The returned error code. Valid values: If the call is successful, the ErrorCode parameter is not returned. If the call fails, the ErrorCode parameter is returned. For more information, see the "Error codes" section of this topic.	The ID of the request.
Code	string	The HTTP status code. Take note of the following rules: 2xx: The call was successful. 3xx: The call was redirected. 4xx: The call failed. 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
CurrentPage	integer	The current page number.	1
TotalSize	integer	The number of applications.	2
PageSize	integer	The page size.	20

Examples

Sample success responses

JSONformat

{
  "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",
            "Cpu": 2000,
            "Mem": 2048,
            "MseEnabled": true,
            "BaseAppId": " ee99cce6-1c8e-4bfa-96c3-3e2fa9******",
            "ProgrammingLanguage": "java",
            "AppType": "Image",
            "NamespaceName": "demo",
            "IsStateful": true,
            "NewSaeVersion": "pro"
          }
        ],
        "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": true,
        "NewSaeVersion": "pro",
        "EnableIdle": false,
        "DiskSize": 20,
        "VpcId": ""
      }
    ]
  },
  "ErrorCode": "The ID of the request.\n",
  "Code": 200,
  "Success": true,
  "CurrentPage": 1,
  "TotalSize": 2,
  "PageSize": 20
}

Error codes

HTTP status code	Error code	Error message
400	Illegal.argument	Illegal argument

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

Change history

Change time	Summary of changes	Operation
2025-12-05	The Error code has changed. The response structure of the API has changed	View Change Details
2025-12-01	The Error code has changed. The request parameters of the API has changed	View Change Details
2025-07-04	The Error code has changed. The request parameters of the API has changed	View Change Details
2025-06-24	The Error code has changed. The response structure of the API has changed	View Change Details
2025-04-07	The Error code has changed. The response structure of the API has changed	View Change Details
2025-03-14	The Error code has changed. The response structure of the API has changed	View Change Details
2025-03-12	The Error code has changed. The response structure of the API has changed	View Change Details
2025-02-27	The Error code has changed. The response structure of the API has changed	View Change Details
2024-09-13	The Error code has changed. The response structure of the API has changed	View Change Details
2024-05-24	The Error code has changed. The response structure of the API has changed	View Change Details
2024-05-21	The Error code has changed. The response structure of the API has changed	View Change Details
2024-01-22	The Error code has changed. The request parameters of the API has changed	View Change Details
2021-07-21	The Error code has changed	View Change Details