List of operations by function -

This product(sae/2019-05-06) OpenAPI adopts ROA Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.

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
CreateNamespace	CreateNamespace	Create a namespace.
DeleteNamespace	DeleteNamespace	Deletes a namespace.
DeleteIngress	DeleteIngress	Deletes a routing rule.
UpdateNamespace	UpdateNamespace	Updates a namespace.
UpdateNamespaceVpc	UpdateNamespaceVpc	cn-beijing:test
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.
DescribeIngress	DescribeIngress	Call the DescribeIngress operation to query the details of an Ingress.
ListIngresses	ListIngresses	Use ListIngress API call to query Ingress list
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.
GetScaleAppMetric	GetScaleAppMetric	Queries the top N applications in which auto scaling takes effect.
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.
DeleteApplication	DeleteApplication	Deletes an application.
StopApplication	StopApplication	0099b7be-5f5b-4512-a7fc-56049ef1\\\\\\\\
StartApplication	StartApplication	Starts an application.
ReduceApplicationCapacityByInstanceIds	ReduceApplicationCapacityByInstanceIds	Scales in an application based on instance IDs.
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	Checks 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.
AbortChangeOrder	AbortChangeOrder	Terminate a change order.
RollbackApplication	RollbackApplication	Rolls back an application.
BatchStopApplications	BatchStopApplications	Stop applications in batches.
BatchStartApplications	BatchStartApplications	cn-shanghai
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.
confidential dictionary management	confidential dictionary management
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
CreateConfigMap	CreateConfigMap	Create a ConfigMap in a namespace.
DeleteConfigMap	DeleteConfigMap	Deletes a ConfigMap.
UpdateConfigMap	UpdateConfigMap	Updates 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
CreateGreyTagRoute	CreateGreyTagRoute	Creates a canary release rule for a Spring Cloud or Dubbo application.
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.
ListGreyTagRoute	ListGreyTagRoute	Queries the details of a canary release rule based on an application ID.
Application Information Query	Application Information Query
DescribeApplicationConfig	DescribeApplicationConfig	Queries the configurations of an application.
DescribeRegions	DescribeRegions	Queries available regions.
DescribeInstanceLog	DescribeInstanceLog	Queries the log of an instance.
DescribeComponents	DescribeComponents	Queries the version of the component that is required when you create and deploy an application.
DescribeEdasContainers	DescribeEdasContainers	Queries the container components of a microservices application.
DescribeApplicationImage	DescribeApplicationImage	Queries the information about the image of an application.
DescribeApplicationInstances	DescribeApplicationInstances	Queries application instances.
DescribeApplicationGroups	DescribeApplicationGroups	Queries the instance groups of an application.
ListApplications	ListApplications	Queries a list of applications.
QueryResourceStatics	QueryResourceStatics	Queries the resource usage of an application.
ListLogConfigs	ListLogConfigs	Queries the logging configurations of an application.
ListAppVersions	ListAppVersions	7171a6ca-d1cd-4928-8642-7d5cfe69\\\\\\\\
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.
ListAppServicesPage	ListAppServicesPage	Queries the services of an application.
SLB Management	SLB Management
DescribeApplicationSlbs	DescribeApplicationSlbs	Obtain the SLB configuration of an application.
BindSlb	BindSlb	Associates a Server Load Balancer (SLB) instance with an application.
UnbindSlb	UnbindSlb	Disassociates an internal-facing or Internet-facing SLB instance from an application.
Apply scaling rules	Apply scaling rules
EnableApplicationScalingRule	EnableApplicationScalingRule	Enables an auto scaling policy for an application.
UpdateApplicationScalingRule	UpdateApplicationScalingRule	Updates the auto scaling policy of an application.
DescribeApplicationScalingRule	DescribeApplicationScalingRule	Queries a specified auto scaling policy of an application.
DescribeApplicationScalingRules	DescribeApplicationScalingRules	Queries the auto scaling policies of an application.