API 概覽 - Serverless App Engine

API標準及多語言預置SDK

本產品（sae/2019-05-06）的OpenAPI採用ROA簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。

在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。

帳號與安全準備

阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。

服務開通

API	標題	API概述
OpenSaeService	OpenSaeService	免費開通SAE服務。

服務通用管理

API	標題	API概述
命名空間和VPC	命名空間和VPC
CreateIngress	建立一條路由規則	建立一條路由規則。
DeleteIngress	刪除 ingress 執行個體	刪除ingress執行個體。
UpdateNamespaceVpc	更新命名空間綁定的vpc	調用UpdateNamespaceVpc介面更新命名空間綁定的VPC。
UpdateApplicationVswitches	更新交換器配置	更新交換器配置。
UpdateIngress	更新ingress執行個體配置	更新Ingress執行個體配置。
DescribeNamespaces	查詢命名空間列表	調用DescribeNamespaces介面查詢命名空間列表。
DescribeNamespaceList	擷取命名空間列表	調用DescribeNamespaceList介面擷取命名空間列表。
ListAppEvents	查看應用事件	調用ListAppEvents介面查看應用事件。
ListNamespaceChangeOrders	擷取命名空間發布單列表	擷取命名空間發布單列表。
DescribeNamespaceResources	查詢命名空間內的資源資訊	查詢命名空間內的資源資訊。
DescribeIngress	查詢ingress配置詳情	查詢Ingress配置詳情。
ListIngresses	擷取ingress列表	調用ListIngresses介面擷取Ingress列表。
DescribePipeline	擷取Logstash執行個體的管道資訊	查看批次資訊。
概覽頁TOP N監控	概覽頁TOP N監控
GetArmsTopNMetric	GetArmsTopNMetric	調用GetArmsTopNMetric介面擷取應用監控的Top N應用列表。
GetChangeOrderMetric	GetChangeOrderMetric	調用GetChangeOrderMetric介面擷取異常變更單的Top N 應用列表。
GetScaleAppMetric	GetScaleAppMetric	調用GetScaleAppMetric介面擷取彈性生效的Top N應用列表。
GetWarningEventMetric	GetWarningEventMetric	調用GetWarningEventMetric介面擷取Warning事件的Top N應用列表。

微服務應用程式

API	標題	API概述
應用程式生命週期	應用程式生命週期
StopApplication	停止應用	停止應用。
StartApplication	啟動應用	調用StartApplication介面啟動應用。
ReduceApplicationCapacityByInstanceIds	應用縮容	根據執行個體ID縮容。
UpdateApplicationDescription	更新應用描述	更新應用描述。
UpdateAppSecurityGroup	更新應用安全性群組	調用UpdateAppSecurityGroup介面更新應用安全性群組。
DescribeApplicationStatus	擷取應用的狀態資訊	調用DescribeApplicationStatus介面擷取應用的狀態資訊。
ListChangeOrders	擷取變更單列表	擷取變更單列表。
DescribeChangeOrder	查詢變更單資訊	調用DescribeChangeOrder介面查詢變更單資訊。
DescribeInstanceSpecifications	擷取應用執行個體規格資訊	調用DescribeInstanceSpecifications介面擷取應用執行個體規格資訊。
DeployApplication	部署應用	部署應用。
RescaleApplicationVertically	改變應用執行個體規格	更改應用執行個體規格。
ConfirmPipelineBatch	是否開始一下批次	確認是否開始下一批次。
AbortAndRollbackChangeOrder	中止或復原變更單	調用AbortAndRollbackChangeOrder介面終止或復原變更單。
RestartApplication	重啟應用	調用RestartApplication介面重啟應用。
AbortChangeOrder	中止變更單	調用AbortChangeOrder介面終止變更單。
BatchStopApplications	大量停止應用	大量停止應用。
BatchStartApplications	大量啟動應用	大量啟動應用。
DowngradeApplicationApmService	關閉ARMS進階版監控	關閉ARMS進階版監控。
UpgradeApplicationApmService	開通ARMS進階版監控	開通ARMS進階版監控。
微服務清單	微服務清單
ListConsumedServices	擷取訂閱的微服務列表	調用ListConsumedServices介面擷取訂閱的微服務列表。
ListPublishedServices	擷取發布的微服務列表	調用ListPublishedServices介面擷取發布的微服務列表。
ListAppServices	查詢微服務的服務列表	查詢微服務的服務列表。
設定項目管理	設定項目管理
CreateConfigMap	建立ConfigMap執行個體	建立命名空間中的ConfigMap執行個體。
DeleteConfigMap	刪除ConfigMap執行個體	調用DeleteConfigMap介面刪除ConfigMap執行個體。
UpdateConfigMap	更新ConfigMap執行個體	更新ConfigMap執行個體。
DescribeConfigMap	查詢ConfigMap執行個體詳情	調用DescribeConfigMap介面查詢ConfigMap執行個體詳情。
ListNamespacedConfigMaps	擷取ConfigMap執行個體列表	擷取命名空間內ConfigMap執行個體列表。
灰階標籤路由	灰階標籤路由
CreateGreyTagRoute	CreateGreyTagRoute	為Spring Cloud或Dubbo應用建立灰階規則。
DeleteGreyTagRoute	DeleteGreyTagRoute	根據規則ID刪除灰階規則。
UpdateGreyTagRoute	UpdateGreyTagRoute	更新灰階規則。
DescribeGreyTagRoute	DescribeGreyTagRoute	根據規則ID查詢灰階規則詳情。
ListGreyTagRoute	ListGreyTagRoute	根據應用ID查詢灰階規則詳情。
全鏈路灰階	全鏈路灰階
CreateOrUpdateSwimmingLaneGroup	建立或更新泳道組	建立或者更新泳道組。
CreateOrUpdateSwimmingLane	建立或更新泳道	建立或者更新泳道。
ListApplicationsForSwimmingLane	查詢泳道組應用列表	擷取應用列表，供全鏈路灰階拉取應用列表。
ListSwimmingLaneGatewayRoutes	查詢泳道可選的網關路由	查詢泳道可選的網關路由
ListSwimmingLaneGroupTags	查詢所有泳道標籤列表	查詢所有泳道標籤列表。
DescribeSwimmingLane	查詢泳道詳情	查詢泳道詳情。
ListAllSwimmingLanes	查詢所有泳道	查詢所有泳道。
ListAllSwimmingLaneGroups	查詢所有泳道組	查詢所有泳道組。
DeleteSwimmingLaneGroup	刪除泳道組	刪除泳道組。
UpdateSwimmingLaneEnableAttribute	更新泳道的啟用屬性	更新泳道的啟用屬性。
應用程式資訊查詢	應用程式資訊查詢
DescribeApplicationConfig	擷取應用配置資訊	擷取應用配置資訊。
DescribeInstanceLog	擷取執行個體日誌	擷取執行個體日誌。
DescribeComponents	擷取應用建立部署時所需的組件版本	調用DescribeComponents介面擷取應用建立部署時所需的組件版本。
DescribeEdasContainers	擷取應用微服務容器組件列表	調用DescribeEdasContainers介面擷取應用微服務容器組件列表。
DescribeApplicationImage	描述應用鏡像資訊	調用DescribeApplicationImage介面描述應用鏡像資訊。
DescribeApplicationInstances	擷取應用執行個體列表	擷取應用執行個體列表。
DescribeApplicationGroups	擷取應用執行個體分組	調用DescribeApplicationGroups介面擷取應用執行個體分組。
QueryResourceStatics	擷取應用的資源使用量	擷取應用的資源使用量。
ListLogConfigs	擷取應用日誌列表	擷取應用日誌列表。
RestartInstances	重啟應用執行個體	調用RestartInstances介面重啟應用執行個體。
GetAvailabilityMetric	GetAvailabilityMetric	調用GetAvailabilityMetric介面擷取執行個體總數異常的Top N應用列表。
DescribeAppServiceDetail	DescribeAppServiceDetail	擷取應用服務的中繼資料詳情。
ListAppServicesPage	ListAppServicesPage	調用ListAppServicesPage介面擷取應用服務列表。
SLB管理	SLB管理
DescribeApplicationNlbs	查看應用綁定的NLB配置	查看應用綁定的NLB配置。
BindNlb	為應用綁定NLB	應用訪問支援NLB
DescribeApplicationSlbs	擷取應用SLB配置資訊	擷取應用SLB配置資訊。
BindSlb	為應用綁定SLB	為應用綁定SLB。
UnbindSlb	解除綁定內網或公網SLB	調用UnbindSlb介面解除綁定私網或公網SLB。
UnbindNlb	應用訪問刪除NLB監聽	調用UnbindNlb刪除應用訪問綁定的NLB監聽
應用程式伸縮規則	應用程式伸縮規則
CreateApplicationScalingRule	建立應用Auto Scaling策略	建立應用Auto Scaling策略。
DeleteApplicationScalingRule	DeleteApplicationScalingRule	調用CreateApplicationScalingRule介面刪除應用Auto Scaling策略。
DisableApplicationScalingRule	禁用應用Auto Scaling策略	調用DisableApplicationScalingRule介面禁用應用Auto Scaling策略。
EnableApplicationScalingRule	EnableApplicationScalingRule	啟用應用Auto Scaling策略。
UpdateApplicationScalingRule	修改彈性策略	更新應用Auto Scaling策略
DescribeApplicationScalingRule	查詢應用的單個Auto Scaling策略	s介面查詢應用的單個Auto Scaling策略。
DescribeApplicationScalingRules	查詢應用Auto Scaling策略	查詢應用Auto Scaling策略。

Web應用程式

API	標題	API概述
應用程式管控	應用程式管控
應用程式維運	應用程式維運
自訂網域	自訂網域
可觀測性	可觀測性

Job任務

API	標題	API概述
DeleteHistoryJob	DeleteHistoryJob	刪除任務。
DescribeJobStatus	DescribeJobStatus	調用DescribeJobStatus介面查詢任務狀態。
DescribeJob	擷取工作範本配置資訊	調用DescribeJob介面擷取工作範本配置資訊。
ExecJob	ExecJob	調用ExecJob介面執行任務
SuspendJob	啟動或暫停任務	暫停任務。
DescribeJobHistory	DescribeJobHistory	調用DescribeJobHistory介面查詢任務記錄。

其他

API	標題	API概述
DescribeConfigurationPrice	查詢配置價格資訊	查詢configurationprice。
GetWebshellToken	擷取遠程登入Token	擷取遠程登入執行個體 Web Shell 的 Token。
UpdateAppMode	更新應用閑置模式	應用閑置模式更新
QueryArmsEnable	查詢應用監控開啟狀態	查詢指定app是否開啟應用監控。
DescribeApplicationMseService	查詢關聯的MSE微服務治理應用	查詢應用關聯的MSE微服務治理應用資訊
BatchRestartApplications	大量重啟應用	大量重啟應用
UpdateNamespaceSlsConfigs	更新命名空間的sls配置	更新命名空間層級sls配置
DisableArms	DisableArms	停止Arms監控。
ResumeTraffic	恢複執行個體的流量	將執行個體上來自 CLB 應用訪問、NLB 應用訪問、CLB 網關路由、ALB 網關路由、K8S Service 上的流量恢複
SuspendTraffic	將流量從執行個體摘除	將執行個體上來自 CLB 應用訪問、NLB 應用訪問、CLB 網關路由、ALB 網關路由、K8S Service 上的流量摘除

Others

API	標題	API概述
CreateApplication	建立一個SAE應用	建立一個應用。
CreateJob	建立工作範本	建立工作範本。
CreateNamespace	建立命名空間	建立命名空間
CreateSecret	CreateSecret	建立命名空間中的Secret執行個體。
DeleteApplication	刪除應用	調用DeleteApplication介面刪除應用。
DeleteInstances	刪除執行個體	刪除應用執行個體。
DeleteJob	DeleteJob	刪除工作範本。
DeleteNamespace	刪除命名空間	刪除命名空間。
DeleteSecret	DeleteSecret	調用DeleteSecret介面刪除Secret執行個體。
DescribeNamespace	查詢命名空間詳細資料	調用DescribeNamespace介面查詢命名空間詳細資料。
DescribeRegions	查詢可用地區	調用DescribeRegions介面查詢可用地區。
DescribeSecret	查詢Secret執行個體詳情	查詢Secret執行個體詳情。
GetApplication	查詢應用基本資料	查詢應用基本資料。
ListAppVersions	查看應用的歷史版本	查看應用的歷史版本。
ListApplications	擷取應用列表	擷取應用列表。
ListJobs	ListJobs	調用ListJobs介面擷取工作範本列表。
ListSecrets	ListSecrets	調用ListSecrets介面擷取命名空間內Secret執行個體列表。
ListTagResources	查詢應用和標籤的對應關係	調用ListTagResources介面查詢應用和標籤的對應關係。
RescaleApplication	應用擴縮容	完成應用擴縮容。
RollbackApplication	回退應用歷史版本	調用RollbackApplication介面回退應用歷史版本。
TagResources	給指定的資源打上標籤	調用TagResources介面為指定資源添加標籤。
UntagResources	移除指定資源和標籤之間的綁定關係	調用UntagResources介面解除指定資源和標籤之間的綁定關係。
UpdateJob	UpdateJob	調用UpdateJob介面更新工作範本。
UpdateNamespace	更新命名空間資訊	更新命名空間資訊。
UpdateSecret	UpdateSecret	調用UpdateSecret介面更新Secret執行個體。