ListApplications - Serverless App Engine - Alibaba Cloud Documentation Center

Lists applications.

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

get

*All Resource

*

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 entries per page for paged queries. Valid values: 0 to 10000.	20
AppName	string	No	The application name.	demo-app
NamespaceId	string	No	The namespace ID.	cn-beijing:demo
Tags	string	No	The key-value pairs of tags. Values are described as follows: Key: The tag key. Length: 1 to 128 characters. Value: The tag value. Length: 1 to 128 characters. Tag keys and values are case-sensitive. If you specify multiple tags, all tags are created and attached to the specified resource. Each tag key on a resource can have only one tag value. If you add a tag with an existing key, the value is updated to the new value. Tag keys and values cannot start with `aliyun` or `acs:`. They cannot contain `http://` or `https://`.	[{"key":"key","value":"value"}]
OrderBy	string	No	Sorts applications. Valid values: runnings: Sort by the current number of instances. instances: Sort by the target number of instances.	runnings
Reverse	boolean	No	Sorts applications by instance status. If statuses are identical, sort by instance ID. Valid values: true: Sort in ascending order. This reflects the startup sequence. For example, to reach the running state, an instance must first start its container, pull its image, and initialize. false: Sort in descending order. Ascending order of instance states: Error: An error occurred during instance startup. CrashLoopBackOff: The container failed to start, crashed, and failed again after restart. ErrImagePull: Failed to pull the container image for the instance. ImagePullBackOff: Failed to retrieve the container image. Pending: The instance is waiting for scheduling. Unknown: An unknown error occurred. Terminating: The instance is terminating. NotFound: The instance was not found. PodInitializing: The instance is initializing. Init:0/1: The instance is initializing. Running: The instance is running.	true
FieldType	string	No	The dimension used to filter applications. Valid values: appName: Application name. appIds: Application ID. slbIps: SLB IP address. instanceIps: Instance IP address.	appName
FieldValue	string	No	The application name, application ID, SLB IP address, or instance IP address of the target application.	demo-app
AppSource	string	No	The SAE application type. Valid values: micro_service web job	micro_service
IsStateful	string	No
NewSaeVersion	string	No

Response elements

Element	Type	Description	Example
	object	The response data.
Message	string	Additional information about the call result.	success
RequestId	string	The request ID.	B4D805CA-926D-41B1-8E63-7AD0C1ED****
Data	object	The list of applications.
CurrentPage	integer	The current page number.	1
TotalSize	integer	The total number of applications.	2
PageSize	integer	The page size.	20
Applications	array<object>	The list of applications.
	array<object>	Application information.
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 application tags.
	object	The application tag information.
Key	string	The tag key.	key
Value	string	The tag value.	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 application description.	description
Cpu	integer	The CPU required per instance, in millicores. Cannot be zero. Only the following defined specifications are supported: 500 1000 2000 4000 8000 16000 32000	1000
Mem	integer	The memory required per instance, in MB. Cannot be zero. Memory is paired with CPU. Only the following defined specifications are supported: 1024: Paired with 500 and 1000 millicores. 2048: Paired with 500, 1000, and 2000 millicores. 4096: Paired with 1000, 2000, and 4000 millicores. 8192: Paired with 2000, 4000, and 8000 millicores. 12288: Paired with 12000 millicores. 16384: Paired with 4000, 8000, and 16000 millicores. 24576: Paired with 12000 millicores. 32768: Paired with 16000 millicores. 65536: Paired with 8000, 16000, and 32000 millicores. 131072: Paired with 32000 millicores.	1024
MseEnabled	boolean	Indicates whether MSE microservice governance is enabled for this application.	true
MseNamespaceId	string	The MSE microservice governance namespace. Valid values: default: Free Edition sae-pro: Professional Edition sae-ent: Enterprise Edition	sae-ent
BaseAppId	string	The base application ID. This property exists only for grayscale applications.	xxx-xxx-xx-xxx
ProgrammingLanguage	string	The programming language of the application.	java
Children	array<object>	The list of grayscale applications for this application.
	array<object>	Detailed information.
AppName	string	The application name.	app1
NamespaceId	string	The namespace ID.	cn-beijing:demo
AppDeletingStatus	boolean	Indicates whether this application is being deleted.	false
AppId	string	The application ID.	xxx-xxx-xxx-xxx
ScaleRuleEnabled	boolean	Indicates whether elastic scaling rules are enabled.	false
ScaleRuleType	string	The type of elastic scaling rule.	timing
Tags	array<object>	The application tags.
	object	The application tags.
Key	string	The tag key.	key
Value	string	The tag value.	value
RunningInstances	integer	The number of running instances.	2
Instances	integer	The number of instances.	2
RegionId	string	The region ID.	cn-beijing
AppDescription	string	The application description.	测试应用
Cpu	integer	The CPU size.	2000
Mem	integer	The memory size.	2048
MseEnabled	boolean	Indicates whether MSE microservice governance is enabled for this application.	true
BaseAppId	string	The base application ID.	ee99cce6-1c8e-4bfa-96c3-3e2fa9******
ProgrammingLanguage	string	The programming language used by the application.	java
AppType	string	The deployment method of the application.	Image
NamespaceName	string	The namespace name.	demo
IsStateful	boolean
NewSaeVersion	string	The application version. Valid values: lite: Light Edition std: Standard Edition pro: Professional Edition	pro
ResourceType	string
EnableIdle	string
ImageUrl	string	Registry Address.	registry.cn-hangzhou.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0
PackageUrl	string	The deployment 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 deployment method of the application.	Image
NamespaceName	string	The namespace name.	demo
IsStateful	boolean
NewSaeVersion	string	The application version. Valid values: lite: Light Edition std: Standard Edition pro: Professional Edition	pro
EnableIdle	string	Indicates whether idle mode is enabled.	false
DiskSize	integer	The disk storage size, in GB.	20
VpcId	string
ResourceType	string
Labels	object
	string
ErrorCode	string	The error code. Valid values: Success: The ErrorCode field is not returned. Failure: The ErrorCode field is returned. For more information, see the Error codes section in this topic.	空
Code	string	The API status or POP error code. Valid values: 2xx: Success. 3xx: Redirection. 4xx: Request error. 5xx: Server error.	200
Success	boolean	Indicates whether the application list was retrieved. Valid values: true: Success. false: Failure.	true
CurrentPage	integer	The current page number.	1
TotalSize	integer	The total number of applications.	2
PageSize	integer	The page size.	20

Examples

Success response

JSON format

{
  "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": "测试应用",
            "Cpu": 2000,
            "Mem": 2048,
            "MseEnabled": true,
            "BaseAppId": " ee99cce6-1c8e-4bfa-96c3-3e2fa9******",
            "ProgrammingLanguage": "java",
            "AppType": "Image",
            "NamespaceName": "demo",
            "IsStateful": false,
            "NewSaeVersion": "pro",
            "ResourceType": "",
            "EnableIdle": ""
          }
        ],
        "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": false,
        "NewSaeVersion": "pro",
        "EnableIdle": "false",
        "DiskSize": 20,
        "VpcId": "",
        "ResourceType": "",
        "Labels": {
          "key": ""
        }
      }
    ]
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true,
  "CurrentPage": 1,
  "TotalSize": 2,
  "PageSize": 20
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.