API overview - Serverless App Engine

API standard and pre-built SDKs in multi-language

The OpenAPI specification of this product (sae/2019-05-06) follows the ROA standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.

Custom signature

If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).

Before you begin

An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.

Service opening

API	Title	Description
OpenSaeService	OpenSaeService	Activates Serverless App Engine (SAE) for free.

Common Service Management

API	Title	Description
Namespaces and VPCs	Namespaces and VPCs
CreateIngress	CreateIngress	Creates a routing rule.
DeleteNamespace	DeleteNamespace	Delete a namespace.
DeleteIngress	DeleteIngress	Deletes a routing rule.
UpdateNamespace	UpdateNamespace	Update the information about a namespace.
UpdateNamespaceVpc	UpdateNamespaceVpc	cn-beijing:test
UpdateIngress	UpdateIngress	Update the configurations of an Ingress instance.
DescribeNamespace	DescribeNamespace	Queries the details of a namespace.
DescribeNamespaces	DescribeNamespaces	Queries a list of namespaces.
DescribeNamespaceList	DescribeNamespaceList	Queries a list of namespaces.
ListAppEvents	ListAppEvents	Queries the events that occurred in an application.
ListNamespaceChangeOrders	ListNamespaceChangeOrders	Queries a list of change orders in a namespace.
DescribeNamespaceResources	DescribeNamespaceResources	Query the information about resources in a namespace.
DescribePipeline	DescribePipeline	View batch information
Overview Page TOP N Monitoring	Overview Page TOP N Monitoring
GetArmsTopNMetric	GetArmsTopNMetric	Queries the top N applications in Application Monitoring.
GetChangeOrderMetric	GetChangeOrderMetric	Queries top N applications in abnormal change orders.
GetWarningEventMetric	GetWarningEventMetric	Queries the top N applications in which Warning events occur.

Microservice applications

API	Title	Description
Application Lifecycle	Application Lifecycle
CreateApplication	CreateApplication	Creates an application.
DeleteInstances	DeleteInstances	Deletes an application instance.
StopApplication	StopApplication	Stops an application.
StartApplication	StartApplication	Starts an application.
ReduceApplicationCapacityByInstanceIds	ReduceApplicationCapacityByInstanceIds	Scales in an application based on instance IDs.
UpdateApplicationDescription	UpdateApplicationDescription	Updates the description of an application.
UpdateAppSecurityGroup	UpdateAppSecurityGroup	Updates the security group of an application.
DescribeApplicationStatus	DescribeApplicationStatus	Queries the status of an application.
ListChangeOrders	ListChangeOrders	Query a list of change orders.
DescribeChangeOrder	DescribeChangeOrder	Queries the information of a change order.
DescribeInstanceSpecifications	DescribeInstanceSpecifications	Queries all instance types.
DeployApplication	DeployApplication	Deploys an application.
RescaleApplicationVertically	RescaleApplicationVertically	Changes the instance specifications of an application.
ConfirmPipelineBatch	ConfirmPipelineBatch	Confirms whether to start the next batch.
AbortAndRollbackChangeOrder	AbortAndRollbackChangeOrder	Terminates a change order and rolls back the corresponding application.
RescaleApplication	RescaleApplication	Rescale an application.
RestartApplication	RestartApplication	Restarts an application.
BatchStopApplications	BatchStopApplications	Stop applications in batches.
BatchStartApplications	BatchStartApplications	Starts multiple applications at a time.
DowngradeApplicationApmService	DowngradeApplicationApmService	Disable ARMS Advanced Edition monitoring.
UpgradeApplicationApmService	UpgradeApplicationApmService	Enables the advanced monitoring feature of Application Real-Time Monitoring Service (ARMS).
List of Microservices	List of Microservices
ListConsumedServices	ListConsumedServices	Queries a list of microservices that are subscribed.
ListPublishedServices	ListPublishedServices	Queries a list of microservices that are published.
ListAppServices	ListAppServices	Queries the list of microservices.
confidential dictionary management	confidential dictionary management
CreateSecret	CreateSecret	Creates a Secret in a namespace.
DescribeSecret	DescribeSecret	Queries the details of a Secret.
ListSecrets	ListSecrets	Queries the information about Secrets in a namespace.
DeleteSecret	DeleteSecret	Deletes a Secret.
Label Management	Label Management
ListTagResources	ListTagResources	Queries the mapping relationships between applications and tags.
UntagResources	UntagResources	Removes tags from resources.
TagResources	TagResources	Adds tags to resources.
Configuration Item Management	Configuration Item Management
DeleteConfigMap	DeleteConfigMap	Deletes a ConfigMap.
UpdateConfigMap	UpdateConfigMap	Update a ConfigMap.
DescribeConfigMap	DescribeConfigMap	Queries the details of a ConfigMap.
ListNamespacedConfigMaps	ListNamespacedConfigMaps	Queries the ConfigMap instances in a namespace.
Grayscale Label Routing	Grayscale Label Routing
DeleteGreyTagRoute	DeleteGreyTagRoute	Deletes a canary release rule based on the specified rule ID.
UpdateGreyTagRoute	UpdateGreyTagRoute	Updates a canary release rule.
DescribeGreyTagRoute	DescribeGreyTagRoute	Queries the details of a canary release rule based on the specified rule ID.
End-to-End Canary Release	End-to-End Canary Release
CreateOrUpdateSwimmingLaneGroup	CreateOrUpdateSwimmingLaneGroup	Creates or updates a lane group.
CreateOrUpdateSwimmingLane	CreateOrUpdateSwimmingLane	Creates or updates a lane.
ListApplicationsForSwimmingLane	ListApplicationsForSwimmingLane	Obtains the application list for the end-to-end grayscale pull application list.
ListSwimmingLaneGatewayRoutes	ListSwimmingLaneGatewayRoutes	Query the gateway routes that are available for a lane
ListSwimmingLaneGroupTags	ListSwimmingLaneGroupTags	Queries all lane tags.
DescribeSwimmingLane	DescribeSwimmingLane	Queries details about swimlanes.
ListAllSwimmingLanes	ListAllSwimmingLanes	Queries all swimlanes.
ListAllSwimmingLaneGroups	ListAllSwimmingLaneGroups	Queries all lane groups.
DeleteSwimmingLaneGroup	DeleteSwimmingLaneGroup	Deletes a lane group.
UpdateSwimmingLaneEnableAttribute	UpdateSwimmingLaneEnableAttribute	Update the enabled property of the swimlane.
Application Information Query	Application Information Query
GetApplication	GetApplication	Queries the basic information of an application.
DescribeRegions	DescribeRegions	Queries available regions.
DescribeInstanceLog	DescribeInstanceLog	Queries the logs of a sidecar container instance.
DescribeEdasContainers	DescribeEdasContainers	Queries the container components of a microservices application.
DescribeApplicationImage	DescribeApplicationImage	Queries the information about the image of an application.
DescribeApplicationInstances	DescribeApplicationInstances	Queries a list of application instances.
DescribeApplicationGroups	DescribeApplicationGroups	Queries the instance groups of an application.
ListApplications	ListApplications	Query a list of applications.
QueryResourceStatics	QueryResourceStatics	Queries the resource usage of an application.
ListLogConfigs	ListLogConfigs	Queries a list of application logs.
ListAppVersions	ListAppVersions	Queries the deployment versions of an application.
RestartInstances	RestartInstances	Restarts one or more instances in an application.
GetAvailabilityMetric	GetAvailabilityMetric	Queries the top N applications in which abnormal instances exist. The applications are sorted by the total number of abnormal instances.
DescribeAppServiceDetail	DescribeAppServiceDetail	Queries the metadata details of the service of an application.
SLB Management	SLB Management
DescribeApplicationNlbs	DescribeApplicationNlbs	Queries the Network Load Balancer (NLB) instances bound to an application and their listeners.
BindNlb	BindNlb	Associates a Network Load Balancer (NLB) instance with an application.
BindSlb	BindSlb	Binds a Server Load Balancer (SLB) instance to the application.
UnbindSlb	UnbindSlb	Disassociates an internal-facing or Internet-facing SLB instance from an application.
UnbindNlb	UnbindNlb	Calls the UnbindNlb operation to delete an NLB listener bound for application access
Apply scaling rules	Apply scaling rules
CreateApplicationScalingRule	CreateApplicationScalingRule	Creates an auto scaling policy for an application.
DeleteApplicationScalingRule	DeleteApplicationScalingRule	7171a6ca-d1cd-4928-8642-7d5cfe69\\\\\\\\
DisableApplicationScalingRule	DisableApplicationScalingRule	Disables an auto scaling policy for an application.
EnableApplicationScalingRule	EnableApplicationScalingRule	Enables an auto scaling policy for an application.
UpdateApplicationScalingRule	UpdateApplicationScalingRule	Updates the auto scaling policy of an application.
DescribeApplicationScalingRule	DescribeApplicationScalingRule	Queries an Auto Scaling policy of an application.

Job Task

API	Title	Description
SuspendJob	SuspendJob	Suspends one or more jobs.

Other

API	Title	Description
GetWebshellToken	GetWebshellToken	Obtains the token used to remotely log on to the Webshell of an instance.
UpdateAppMode	UpdateAppMode	Application Idle Mode Update
QueryArmsEnable	QueryArmsEnable	Queries whether ARMS monitoring is enabled for a specified application.
DescribeApplicationMseService	DescribeApplicationMseService	Queries the information of the associated MSE microservice governance application.
BatchRestartApplications	BatchRestartApplications	Restarts applications in batches.
UpdateNamespaceSlsConfigs	UpdateNamespaceSlsConfigs	Updates the Simple Log Service configuration for a namespace.

Others

API	Title	Description
AbortChangeOrder	AbortChangeOrder	Terminate a change order.
CreateConfigMap	CreateConfigMap	Create a ConfigMap in a namespace.
CreateGreyTagRoute	CreateGreyTagRoute	Creates a canary release rule for a Spring Cloud or Dubbo application.
CreateJob	CreateJob	Create a job template.
CreateNamespace	CreateNamespace	Create a namespace.
DeleteApplication	DeleteApplication	Deletes an application.
DeleteHistoryJob	DeleteHistoryJob	Delete a job.
DeleteJob	DeleteJob	Delete a job template.
DescribeApplicationConfig	DescribeApplicationConfig	Queries the configurations of an application.
DescribeApplicationScalingRules	DescribeApplicationScalingRules	Queries the auto scaling policies of an application.
DescribeApplicationSlbs	DescribeApplicationSlbs	Obtain the SLB configuration of an application.
DescribeComponents	DescribeComponents	Queries the version of the component that is required when you create and deploy an application.
DescribeConfigurationPrice	DescribeConfigurationPrice	Query configuration price.
DescribeIngress	DescribeIngress	Call the DescribeIngress operation to query the details of an Ingress.
DescribeJob	DescribeJob	Queries the configurations of a job template.
DescribeJobHistory	DescribeJobHistory	Query the information about jobs.
DescribeJobStatus	DescribeJobStatus	Queries the status of a job.
DisableArms	DisableArms	Disables ARMS monitoring.
ExecJob	ExecJob	Executes a job.
GetScaleAppMetric	GetScaleAppMetric	Queries the top N applications in which auto scaling takes effect.
ListAppServicesPage	ListAppServicesPage	Queries the services of an application.
ListGreyTagRoute	ListGreyTagRoute	Queries the details of a canary release rule based on an application ID.
ListIngresses	ListIngresses	Use ListIngress API call to query Ingress list
ListJobs	ListJobs	Queries the information about job templates.
ResumeTraffic	ResumeTraffic	Resumes traffic from Classic Load Balancer (CLB) application access, Network Load Balancer (NLB) application access, CLB gateway routing, Application Load Balancer (ALB) gateway routing, and Kubernetes Services on an instance.
RollbackApplication	RollbackApplication	Rolls back an application.
SuspendTraffic	SuspendTraffic	Removes traffic routed from Classic Load Balancer (CLB) application access, Network Load Balancer (NLB) application access, CLB gateway routes, Application Load Balancer (ALB) gateway routes, or Kubernetes (K8s) services.
UpdateApplicationVswitches	UpdateApplicationVswitches	Update the configuration of a vSwitch.
UpdateJob	UpdateJob	Updates a job template.
UpdateSecret	UpdateSecret	The HTTP status code. Valid values: \* \\2xx\\: The call was successful. \* \\3xx\\: The call was redirected. \* \\4xx\\: The call failed. \* \\5xx\\: A server error occurred.