API overview-Serverless App Engine(SAE)-阿里云帮助中心

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	Create a routing rule.
DeleteIngress	DeleteIngress	Deletes an ingress instance.
UpdateNamespaceVpc	UpdateNamespaceVpc	Updates the VPC that is attached to a namespace.
UpdateApplicationVswitches	UpdateApplicationVswitches	Updates the vSwitch configuration for an application.
UpdateIngress	UpdateIngress	Update the configuration of an Ingress instance.
DescribeNamespaces	DescribeNamespaces	Queries a list of namespaces.
DescribeNamespaceList	DescribeNamespaceList	Queries a list of namespaces.
ListAppEvents	ListAppEvents	To list application events, call the `ListAppEvents` API.
ListNamespaceChangeOrders	ListNamespaceChangeOrders	Lists deployment orders in a namespace.
DescribeNamespaceResources	DescribeNamespaceResources	Queries the resources in a namespace.
DescribeIngress	DescribeIngress	Queries the details of an Ingress.
ListIngresses	ListIngresses	Retrieves a list of Ingresses.
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	To retrieve the top N applications with abnormal change orders, call the `GetChangeOrderMetric` API.
GetWarningEventMetric	GetWarningEventMetric	Queries the top N applications in which Warning events occur.

Microservice applications

API	Title	Description
Application Lifecycle	Application Lifecycle
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 an application security group.
DescribeApplicationStatus	DescribeApplicationStatus	Call the DescribeApplicationStatus API to get an application's status.
ListChangeOrders	ListChangeOrders	Lists change orders.
DescribeChangeOrder	DescribeChangeOrder	Call DescribeChangeOrder to get information about a change order.
DescribeInstanceSpecifications	DescribeInstanceSpecifications	Retrieves a list of available application instance specifications.
DeployApplication	DeployApplication	Deploy an application.
RescaleApplicationVertically	RescaleApplicationVertically	Changes the instance type of an application.
ConfirmPipelineBatch	ConfirmPipelineBatch	Confirms whether to start the next batch.
AbortAndRollbackChangeOrder	AbortAndRollbackChangeOrder	Terminates a change order and rolls back the corresponding application.
RestartApplication	RestartApplication	Restarts an application.
AbortChangeOrder	AbortChangeOrder	This operation stops a change order.
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	You can call the ListConsumedServices operation to retrieve a list of subscribed microservices.
ListPublishedServices	ListPublishedServices	Queries a list of published microservices.
ListAppServices	ListAppServices	Lists microservices.
Configuration Item Management	Configuration Item Management
CreateConfigMap	CreateConfigMap	Create a ConfigMap in a namespace.
DeleteConfigMap	DeleteConfigMap	Deletes a ConfigMap instance.
UpdateConfigMap	UpdateConfigMap	Updates a ConfigMap instance.
DescribeConfigMap	DescribeConfigMap	Queries the details of a ConfigMap instance.
ListNamespacedConfigMaps	ListNamespacedConfigMaps	Lists ConfigMap instances in a namespace.
Grayscale Label Routing	Grayscale Label Routing
DeleteGreyTagRoute	DeleteGreyTagRoute	Deletes a grey tag route by the specified rule ID.
UpdateGreyTagRoute	UpdateGreyTagRoute	Updates a grey tag route.
DescribeGreyTagRoute	DescribeGreyTagRoute	Gets a canary release rule by rule ID.
ListGreyTagRoute	ListGreyTagRoute	Queries the details of a grayscale rule based on an application ID.
End-to-End Canary Release	End-to-End Canary Release
CreateOrUpdateSwimmingLaneGroup	CreateOrUpdateSwimmingLaneGroup	Creates or updates a swimming lane group.
CreateOrUpdateSwimmingLane	CreateOrUpdateSwimmingLane	Create or update a swimlane.
ListApplicationsForSwimmingLane	ListApplicationsForSwimmingLane	Retrieves a list of applications for full-link canary releases.
ListSwimmingLaneGatewayRoutes	ListSwimmingLaneGatewayRoutes	Lists the gateway routes that can be associated with a swimming lane.
ListSwimmingLaneGroupTags	ListSwimmingLaneGroupTags	Lists all swimming lane tags.
DescribeSwimmingLane	DescribeSwimmingLane	Retrieves the details of a swimlane.
ListAllSwimmingLanes	ListAllSwimmingLanes	Lists all swimlanes.
ListAllSwimmingLaneGroups	ListAllSwimmingLaneGroups	Returns a list of all swimlane groups.
DeleteSwimmingLaneGroup	DeleteSwimmingLaneGroup	Deletes a swimming lane group.
UpdateSwimmingLaneEnableAttribute	UpdateSwimmingLaneEnableAttribute	Updates the enabled status of a swimming lane.
Application Information Query	Application Information Query
DescribeApplicationConfig	DescribeApplicationConfig	Retrieves the configuration of an application.
DescribeInstanceLog	DescribeInstanceLog	Retrieves the log of an instance.
DescribeEdasContainers	DescribeEdasContainers	Retrieves the microservice container components for an application.
DescribeApplicationImage	DescribeApplicationImage	Retrieves information about an application image.
DescribeApplicationInstances	DescribeApplicationInstances	Retrieves a list of application instances.
DescribeApplicationGroups	DescribeApplicationGroups	Use `DescribeApplicationGroups` to retrieve application instance groups.
QueryResourceStatics	QueryResourceStatics	Gets the resource usage for an application.
ListLogConfigs	ListLogConfigs	Returns a list of application logs.
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	Describes the metadata details of an application service.
SLB Management	SLB Management
DescribeApplicationNlbs	DescribeApplicationNlbs	View the NLB configuration for the application.
BindNlb	BindNlb	Binds a Network Load Balancer (NLB) instance to an application.
DescribeApplicationSlbs	DescribeApplicationSlbs	Queries the configurations of Server Load Balancer (SLB) instances for an application.
BindSlb	BindSlb	Binds a Server Load Balancer (SLB) instance to the application.
UnbindSlb	UnbindSlb	Unbinds a public or private SLB instance from an application.
UnbindNlb	UnbindNlb	Unbinds an NLB listener from an application.
Apply scaling rules	Apply scaling rules
CreateApplicationScalingRule	CreateApplicationScalingRule	Create an application auto scaling policy.
DeleteApplicationScalingRule	DeleteApplicationScalingRule	Deletes an Auto Scaling policy for an application.
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 for an application.
DescribeApplicationScalingRule	DescribeApplicationScalingRule	Describes a single auto scaling policy for an application.
DescribeApplicationScalingRules	DescribeApplicationScalingRules	Describes the Auto Scaling policies for an application.

Job Task

API	Title	Description
DescribeJob	DescribeJob	Calls the `DescribeJob` API to retrieve job template configuration.
ExecJob	ExecJob	Call ExecJob to run a job.
SuspendJob	SuspendJob	Suspends one or more jobs.

Other

API	Title	Description
DescribeConfigurationPrice	DescribeConfigurationPrice	Queries the price of a configuration.
GetWebshellToken	GetWebshellToken	Obtains the token used to remotely log on to the Webshell of an instance.
UpdateAppMode	UpdateAppMode	Updates the idle mode for an application.
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 namespace-level SLS configuration.
DisableArms	DisableArms	Disables ARMS monitoring.
ResumeTraffic	ResumeTraffic	Resumes traffic on an instance from Classic Load Balancer (CLB), Network Load Balancer (NLB), CLB gateway routing, Application Load Balancer (ALB) gateway routing, and Kubernetes Service.
SuspendTraffic	SuspendTraffic	Stops routing traffic 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 to the specified instances.

Others

API	Title	Description
CreateApplication	CreateApplication	Create an application.
CreateGreyTagRoute	CreateGreyTagRoute	Create a canary release rule for a Spring Cloud or Dubbo application.
CreateJob	CreateJob	This operation creates a job template.
CreateNamespace	CreateNamespace	Creates a namespace.
CreateSecret	CreateSecret	Creates a Secret in a namespace.
DeleteApplication	DeleteApplication	Deletes an application.
DeleteHistoryJob	DeleteHistoryJob	Delete a job.
DeleteInstances	DeleteInstances	Deletes one or more application instances.
DeleteJob	DeleteJob	Delete a job template.
DeleteNamespace	DeleteNamespace	Deletes a namespace.
DeleteSecret	DeleteSecret	Deletes a secret.
DescribeComponents	DescribeComponents	Call the DescribeComponents API to retrieve the component versions required to create an application deployment.
DescribeJobHistory	DescribeJobHistory	Query the information about jobs.
DescribeJobStatus	DescribeJobStatus	Queries the status of a job.
DescribeNamespace	DescribeNamespace	Queries the details of a namespace.
DescribeRegions	DescribeRegions	Queries the available regions.
DescribeSecret	DescribeSecret	Queries the details of a Secret.
GetApplication	GetApplication	Retrieves basic information about an application.
GetScaleAppMetric	GetScaleAppMetric	Queries the top N applications in which auto scaling takes effect.
ListAppServicesPage	ListAppServicesPage	Call `ListAppServicesPage` to get a list of application services.
ListAppVersions	ListAppVersions	Lists the historical versions of an application.
ListApplications	ListApplications	Get a list of applications.
ListJobs	ListJobs	Retrieves a list of job templates.
ListSecrets	ListSecrets	Call ListSecrets to list Secrets in a namespace.
ListTagResources	ListTagResources	Call the `ListTagResources` API to list the tags associated with your applications.
RescaleApplication	RescaleApplication	Rescale an application.
RollbackApplication	RollbackApplication	Rolls back an application.
TagResources	TagResources	Adds one or more tags to specified resources.
UntagResources	UntagResources	Removes one or more tags from specified resources.
UpdateJob	UpdateJob	Call the UpdateJob API to update a job template.
UpdateNamespace	UpdateNamespace	Update the information about a namespace.
UpdateSecret	UpdateSecret	Updates a Secret instance.