Retrieve App Metadata via GetApplication API - Serverless App Engine

Retrieves basic application information.

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

get

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	No	Application ID.	017f39b8-dfa4-4e16-a84b-1dcee4b1****
AppName	string	No	Application name.	test
NamespaceId	string	No	Namespace ID.	cn-shenzhen

Response elements

Element	Type	Description	Example
	object	Response result.
RequestId	string	Request ID.	01CF26C7-00A3-4AA6-BA76-7E95F2A3****
Message	string	Additional information. Possible values: If the request succeeds, returns success. If the request fails, returns a specific error code.	success
TraceId	string	Trace ID used for precise query of call information.	ac1a0b2215622920113732501e****
Application	object	Detailed application information.
AppId	string	Application ID.	443d638a-ef76-47c4-b707-61197d******
AppName	string	Application name.	test
AppDescription	string	Application description.	测试
NamespaceId	string	Namespace ID.	cn-shenzhen
ScaleRuleType	string	Auto Scaling policy type. Possible values: timing: Scheduled scaling. metric: Metric-based scaling. mix: Mixed scaling.	timing
ScaleRuleEnabled	string	Whether Auto Scaling is enabled. Possible values: true: Enabled. false: Disabled.	true
RunningInstances	integer	Number of running instances.	6
Instances	integer	Number of application instances.	6
Cpu	integer	CPU required per instance, in milli-cores. This value cannot be 0. The following defined specifications are currently supported: 500 1000 2000 4000 8000 12000 16000 32000	2000
Mem	integer	Memory required per instance, in MB. This value cannot be 0. Memory and CPU have a one-to-one mapping. The following defined specifications are currently supported: 1024: Corresponds to CPU values of 500 and 1000 milli-cores. 2048: Corresponds to CPU values of 500, 1000, and 2000 milli-cores. 4096: Corresponds to CPU values of 1000, 2000, and 4000 milli-cores. 8192: Corresponds to CPU values of 2000, 4000, and 8000 milli-cores. 12288: Corresponds to CPU value of 12000 milli-cores. 16384: Corresponds to CPU values of 4000, 8000, and 16000 milli-cores. 24576: Corresponds to CPU value of 12000 milli-cores. 32768: Corresponds to CPU value of 16000 milli-cores. 65536: Corresponds to CPU values of 8000, 16000, and 32000 milli-cores. 131072: Corresponds to CPU value of 32000 milli-cores.	4096
MseEnabled	boolean	Whether WebAssemblyFilter is enabled. Values: true: Enabled. false: Disabled.	true
MseNamespaceId	string	Namespace ID of the MSE instance.	test
ProgrammingLanguage	string	Technology stack language used to create the application. Possible values: java: Java. php: PHP. other: Multi-language, such as Python, C++, Go, .NET, and Node.js.	java
BaseAppId	string	Base application ID.	ee99cce6-1c8e-4bfa-96c3-3e2fa9******
IsStateful	boolean

Examples

Success response

JSON format

{
  "RequestId": "01CF26C7-00A3-4AA6-BA76-7E95F2A3****",
  "Message": "success",
  "TraceId": "ac1a0b2215622920113732501e****",
  "Application": {
    "AppId": "443d638a-ef76-47c4-b707-61197d******",
    "AppName": "test",
    "AppDescription": "测试",
    "NamespaceId": "cn-shenzhen",
    "ScaleRuleType": "timing",
    "ScaleRuleEnabled": "true",
    "RunningInstances": 6,
    "Instances": 6,
    "Cpu": 2000,
    "Mem": 4096,
    "MseEnabled": true,
    "MseNamespaceId": "test",
    "ProgrammingLanguage": "java",
    "BaseAppId": "ee99cce6-1c8e-4bfa-96c3-3e2fa9******",
    "IsStateful": false
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidApplication.NotFound	The current application does not exist.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.NoPermission	Resource no permission
404	InvalidAppId.NotFound	The specified AppId does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.