API標準及多語言預置SDK
本產品（SWAS-OPEN/2020-06-01）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。
在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。
執行個體
|
API |
標題 |
API概述 |
| CreateInstances | 建立執行個體 | 建立一台或多台訂用帳戶的Simple Application Server執行個體。 |
| StartInstance | 啟動執行個體 | 啟動一台Simple Application Server。 |
| StartInstances | 大量啟動執行個體 | 啟動一台或多台Simple Application Server。 |
| ListInstanceStatus | 批量擷取執行個體狀態 | 查詢一個或多個執行個體的狀態。 |
| StopInstance | 停止執行個體 | 停止一台Simple Application Server。 |
| StopInstances | 大量停止執行個體 | 停止一台或多台Simple Application Server。 |
| UpdateInstanceAttribute | 修改執行個體部分資訊 | 修改執行個體的部分資訊，包括執行個體名稱，密碼。 |
| ListInstances | 擷取執行個體列表 | 查詢指定地區下，一個或多個執行個體的詳細資料。 |
| LoginInstance | 遠程登入執行個體 | 使用Workbench遠程登入Simple Application Server。 |
| DescribeInstanceVncUrl | 擷取執行個體VNC串連地址 | 擷取指定Simple Application Server的VNC串連地址。 |
| ModifyInstanceVncPassword | 修改執行個體VNC密碼 | 修改執行個體的VNC密碼。 |
| ListInstancePlansModification | 擷取當前執行個體可升級的套餐列表 | 查詢指定的Simple Application Server，可升級的套餐列表。 |
| ListInstancesTrafficPackages | 擷取指定伺服器的流量包使用方式 | 查詢一個或多個執行個體的流量包詳情資訊。 |
| DescribeInstancePasswordsSetting | 查詢執行個體是否設定過密碼 | 查詢Simple Application Server是否設定過密碼。 |
| InstallCloudMonitorAgent | 安裝CloudMonitor外掛程式 | 為指定的Simple Application Server安裝CloudMonitor外掛程式。 |
| DescribeCloudMonitorAgentStatuses | 查詢CloudMonitor外掛程式狀態 | 查詢Simple Application ServerCloudMonitor外掛程式的狀態。 |
| DescribeMonitorData | 擷取執行個體監控資料 | 擷取執行個體監控資訊（vCPU、記憶體、磁碟IO、流量）。 |
| DescribeSecurityAgentStatus | 查詢資訊安全中心Agent外掛程式狀態 | 查詢指定Simple Application Server的資訊安全中心Agent外掛程式狀態。 |
| RebootInstance | 重啟執行個體 | 重啟一台Simple Application Server。 |
| RebootInstances | 大量重啟執行個體 | 重啟一台或多台Simple Application Server。 |
| UpgradeInstance | 升級執行個體 | 為指定的Simple Application Server升級套餐配置。 |
| RenewInstance | 續約執行個體 | 續約一台Simple Application Server。 |
| ResetSystem | 重設系統 | 為指定的Simple Application Server重設系統。 |
金鑰對
|
API |
標題 |
API概述 |
| CreateInstanceKeyPair | 建立執行個體金鑰組 | 建立Simple Application Server金鑰組。 |
| CreateKeyPair | 建立金鑰組 | 建立Simple Application Server金鑰組。 |
| UploadInstanceKeyPair | 匯入金鑰組 | 為一台Simple Application Server匯入金鑰組。 |
| ImportKeyPair | 匯入金鑰組 | 匯入已有金鑰組。 |
| DescribeInstanceKeyPair | 查詢執行個體金鑰組資訊 | 查詢Simple Application Server的金鑰組資訊。 |
| ListKeyPairs | 查詢金鑰組 | 金鑰組列表。 |
| AttachKeyPair | 綁定金鑰組 | Simple Application Server綁定金鑰組。 |
| DetachKeyPair | 解除綁定金鑰組 | 解除綁定Simple Application Server的金鑰組。 |
| DeleteInstanceKeyPair | 刪除執行個體金鑰組 | 刪除Simple Application Server金鑰組。 |
| DeleteKeyPairs | 刪除金鑰組 | 刪除Simple Application Server金鑰組。 |
防火牆範本
|
API |
標題 |
API概述 |
| CreateFirewallTemplate | 建立防火牆模板 | 建立一個防火牆模板。 |
| DescribeFirewallTemplates | 查詢防火牆模板 | 查詢防火牆模板的資訊。 |
| CreateFirewallTemplateRules | 建立防火牆模板規則 | 對於已建立的防火牆模板，您可以根據業務需求為防火牆模板增加防火牆規則。 |
| ApplyFirewallTemplate | 應用防火牆模板 | 使用防火牆模板可以同時為多台Simple Application Server執行個體設定防火牆規則，提高設定防火牆規則的效率。 |
| ModifyFirewallTemplate | 修改防火牆模板 | 對於已建立的防火牆模板，您可以根據業務需求修改防火牆規則，並最終將這些規則通過防火牆模板設定到Simple Application Server執行個體中。 |
| DescribeFirewallTemplateApplyResults | 查詢防火牆模板應用結果 | 查詢防火牆模板應用執行個體結果。 |
| DescribeFirewallTemplateRulesApplyResult | 查詢防火牆模板規則應用結果 | 查詢防火牆模板規則應用結果資訊。 |
| DeleteFirewallTemplateRules | 刪除防火牆模板規則 | 對於已建立的防火牆模板，您可以根據業務需求刪除防火牆規則。 |
| DeleteFirewallTemplates | 刪除防火牆模板 | 刪除已建立的防火牆模板。 |
防火牆
|
API |
標題 |
API概述 |
| DeleteFirewallRules | 大量刪除執行個體防火牆規則 | 刪除指定Simple Application Server的多條防火牆規則。 |
| CreateFirewallRule | 建立執行個體的防火牆規則 | 為指定的Simple Application Server建立一條防火牆規則。 |
| CreateFirewallRules | 大量建立執行個體的防火牆規則 | 為指定的Simple Application Server大量建立防火牆規則。 |
| ListFirewallRules | 擷取執行個體的防火牆規則 | 查詢指定Simple Application Server的防火牆規則。 |
| ModifyFirewallRule | 修改執行個體防火牆規則 | 修改指定Simple Application Server的防火牆規則。 |
| EnableFirewallRule | 開啟執行個體防火牆規則 | 開啟指定Simple Application Server的一條防火牆策略。 |
| DisableFirewallRule | 禁用執行個體防火牆規則 | 禁用指定Simple Application Server的一條防火牆策略。 |
| DeleteFirewallRule | 刪除執行個體防火牆規則 | 刪除指定Simple Application Server的一條防火牆規則。 |
快照
|
API |
標題 |
API概述 |
| CreateSnapshot | 建立快照 | 為指定的磁碟建立快照。 |
| ListSnapshots | 擷取快照 | 查詢一個或多個已建立的快照資訊。 |
| UpdateSnapshotAttribute | 修改快照備忘資訊 | 修改Simple Application Server指定快照的備忘資訊。 |
| DeleteSnapshot | 刪除快照 | 刪除Simple Application Server指定的快照。 |
| DeleteSnapshots | 大量刪除快照 | 刪除一個或多個已建立的快照。 |
磁碟
|
API |
標題 |
API概述 |
| UpdateDiskAttribute | 修改資料盤備忘資訊 | 修改Simple Application Server指定資料盤的備忘資訊。 |
| ListDisks | 查詢一個或多個磁碟資訊 | 查詢指定地區下一個或多個已建立的磁碟資訊。 |
| ResetDisk | 復原磁碟 | 根據快照復原磁碟。 |
自訂映像
|
API |
標題 |
API概述 |
| CreateCustomImage | 建立自訂鏡像 | 通過快照建立使用者自訂鏡像。 |
| ListCustomImages | 查詢一個或多個自訂鏡像資訊 | 查詢指定地區下一個或多個已建立的自訂鏡像資訊。 |
| ModifyImageShareStatus | 共用、解除共用自訂鏡像 | 為指定的自訂鏡像共用或不共用到ECS。 |
| AddCustomImageShareAccount | 跨帳號共用自訂鏡像 | 您可以將自訂鏡像共用給同地區下的其他阿里雲帳號，快速為多個Simple Application Server部署相同的環境配置，提高部署效率。 |
| ListCustomImageShareAccounts | 查看跨帳號共用鏡像資訊 | 查詢跨帳號共用鏡像的資訊。 |
| RemoveCustomImageShareAccount | 取消跨帳號共用鏡像 | 為了安全考慮，跨帳號共用自訂鏡像後，您可以調用RemoveCustomImageShareAccount介面取消跨帳號共用自訂鏡像。 |
| DeleteCustomImage | 刪除自訂鏡像 | 刪除指定的自訂鏡像。 |
| DeleteCustomImages | 大量刪除鏡像 | 如果您不再需要某些自訂鏡像，可以將其大量刪除。自訂鏡像被刪除後，使用該鏡像建立的Simple Application Server將無法使用該鏡像重設系統。 |
命令助手
|
API |
標題 |
API概述 |
| DescribeCloudAssistantAttributes | 查詢一台或者多台執行個體的命令助手資訊 | 查詢一台或者多台執行個體的命令助手資訊。 |
| UpdateCommandAttribute | 修改命令 | 修改一條命令相關參數。 |
| InvokeCommand | 執行命令 | 為一台或多台Simple Application Server執行一條命令助手命令。 |
| DescribeCommands | 查詢命令 | 查詢您手動建立的命令或者阿里雲提供的公用命令。 |
| DescribeCommandInvocations | 查詢命令執行列表和狀態 | 查詢命令助手執行命令的列表和狀態。 |
| DeleteCommand | 刪除命令 | 刪除一條命令助手命令。 |
| CreateCommand | 建立命令 | 建立一條命令助手命令。 |
| StartTerminalSession | 開啟免密登入工作階段 | 為Simple Application Server提供會話登入能力。 |
| InstallCloudAssistant | 安裝雲助手 | 為Simple Application Server安裝雲助手。 |
| DescribeCloudAssistantStatus | 查詢雲助手安裝狀態 | 查詢輕量雲端服務器是否安裝雲助手。 |
| DescribeInvocationResult | 查詢單個命令的執行結果 | 查詢單個命令的執行結果。 |
| RunCommand | 執行命令 | 在Simple Application Server上執行命令。 |
| DescribeInvocations | 查看命令詳細資料 | 查看命令詳細資料。 |
輕量資料庫服務
|
API |
標題 |
API概述 |
| TagResources | 綁定標籤 | 對Simple Application Server、快照、自訂鏡像、命令、防火牆規則和磁碟綁定標籤，便於查看和管理輕量資源。 |
| ListTagResources | 查詢標籤列表 | 調用ListTagResources查詢一個或多個輕量資源（執行個體、快照、磁碟、鏡像、命令、防火牆規則）已經綁定的標籤資訊。 |
| UntagResources | 解除綁定並刪除標籤 | 為指定的輕量資源（執行個體、快照、磁碟、鏡像、命令、防火牆規則）統一解除綁定並刪除標籤。 |
標籤
|
API |
標題 |
API概述 |
| ListRegions | 查詢可用地區列表 | 查詢輕量伺服器所有可用地區列表。 |
| ListImages | 擷取鏡像列表 | 查詢指定地區下一個或多個鏡像資訊。 |
| ListPlans | 擷取套餐資訊 | 查詢指定地區下，Simple Application Server所有的套餐資訊。 |
| DescribePrice | 詢價 | 擷取輕量產品價格資訊 |
| CreateOrder | 建立訂單 | 擷取輕量產品價格資訊 |
其他資源
|
API |
標題 |
API概述 |