本產品（
輕量應用服務器/2020-06-01）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
實例
| API | 標題 | API概述 |
|---|---|---|
| CreateInstances | 創建實例 | 創建一臺或多臺包年包月的實例。 |
| StartInstance | 啟動實例 | 啟動一臺輕量應用服務器。 |
| StartInstances | 批量啟動實例 | 啟動一臺或多臺輕量應用服務器。 |
| ListInstanceStatus | 批量獲取實例狀態 | 查詢一個或多個實例的狀態。 |
| StopInstance | 停止實例 | 停止一臺輕量應用服務器。 |
| StopInstances | 批量停止實例 | 停止一臺或多臺輕量應用服務器。 |
| UpdateInstanceAttribute | 修改實例部分信息 | 修改實例的部分信息，包括實例名稱，密碼。 |
| ListInstances | 獲取實例列表 | 查詢指定地域下一個或多個實例的詳細信息。 |
| LoginInstance | 遠程登錄實例 | 使用Workbench遠程登錄輕量應用服務器。 |
| DescribeInstanceVncUrl | 獲取實例VNC連接地址 | 獲取指定輕量應用服務器的VNC連接地址。 |
| ModifyInstanceVncPassword | 修改實例VNC密碼 | 修改實例的VNC密碼。 |
| ListInstancePlansModification | 獲取當前實例可升級的套餐列表 | 查詢指定的輕量應用服務器可升級的套餐列表。 |
| ListInstancesTrafficPackages | 獲取指定服務器的流量包使用情況 | 查詢一個或多個實例的流量包詳情信息。 |
| DescribeInstancePasswordsSetting | 查詢實例是否設置過密碼 | 查詢輕量應用服務器是否設置過密碼。 |
| InstallCloudMonitorAgent | 安裝云監控插件 | 為指定的輕量應用服務器安裝云監控插件。 |
| DescribeCloudMonitorAgentStatuses | 查詢云監控插件狀態 | 查詢輕量應用服務器云監控插件的狀態。 |
| DescribeMonitorData | 獲取實例監控數據 | 獲取實例監控信息（vCPU、內存、磁盤IO、流量）。 |
| DescribeSecurityAgentStatus | 查詢安全中心Agent插件狀態 | 查詢指定輕量應用服務器的安全中心Agent插件狀態。 |
| RebootInstance | 重啟實例 | 重啟一臺輕量應用服務器。 |
| RebootInstances | 批量重啟實例 | 重啟一臺或多臺輕量應用服務器。 |
| UpgradeInstance | 升級實例 | 為指定的輕量應用服務器升級套餐配置。 |
| RenewInstance | 續費實例 | 續費一臺輕量應用服務器。 |
| ResetSystem | 重置系統 | 為指定的輕量應用服務器重置系統。 |
密鑰對
| API | 標題 | API概述 |
|---|---|---|
| CreateInstanceKeyPair | 創建實例密鑰對 | 創建輕量應用服務器密鑰對。 |
| CreateKeyPair | 創建密鑰對 | 創建輕量應用服務器密鑰對。 |
| UploadInstanceKeyPair | 導入密鑰對 | 為一臺輕量應用服務器導入密鑰對。 |
| ImportKeyPair | 導入密鑰對 | 導入已有密鑰對。 |
| DescribeInstanceKeyPair | 查詢實例密鑰對信息 | 查詢輕量應用服務器的密鑰對信息。 |
| ListKeyPairs | 查詢密鑰對 | 密鑰對列表。 |
| AttachKeyPair | 綁定密鑰對 | 輕量應用服務器綁定密鑰對。 |
| DetachKeyPair | 解綁密鑰對 | 解綁輕量應用服務器的密鑰對。 |
| DeleteInstanceKeyPair | 刪除實例密鑰對 | 刪除輕量應用服務器密鑰對。 |
| DeleteKeyPairs | 刪除密鑰對 | 刪除輕量應用服務器密鑰對。 |
防火墻模板
| API | 標題 | API概述 |
|---|---|---|
| CreateFirewallTemplate | 創建防火墻模板 | 創建一個防火墻模板。 |
| DescribeFirewallTemplates | 查詢防火墻模板 | 查詢防火墻模板的信息。 |
| CreateFirewallTemplateRules | 創建防火墻模板規則 | 對于已創建的防火墻模板，您可以根據業務需求為防火墻模板增加防火墻規則。 |
| ApplyFirewallTemplate | 應用防火墻模板 | 使用防火墻模板可以同時為多臺輕量應用服務器實例設置防火墻規則，提高設置防火墻規則的效率。 |
| ModifyFirewallTemplate | 修改防火墻模板 | 對于已創建的防火墻模板，您可以根據業務需求修改防火墻規則，并最終將這些規則通過防火墻模板設置到輕量應用服務器實例中。 |
| DescribeFirewallTemplateApplyResults | 查詢防火墻模板應用結果 | 查詢防火墻模板應用實例結果。 |
| DescribeFirewallTemplateRulesApplyResult | 查詢防火墻模板規則應用結果 | 查詢防火墻模板規則應用結果信息。 |
| DeleteFirewallTemplateRules | 刪除防火墻模板規則 | 對于已創建的防火墻模板，您可以根據業務需求刪除防火墻規則。 |
| DeleteFirewallTemplates | 刪除防火墻模板 | 刪除已創建的防火墻模板。 |
防火墻
| API | 標題 | API概述 |
|---|---|---|
| DeleteFirewallRules | 批量刪除實例防火墻規則 | 刪除指定輕量應用服務器的多條防火墻規則。 |
| CreateFirewallRule | 創建實例的防火墻規則 | 為指定的輕量應用服務器創建一條防火墻規則。 |
| CreateFirewallRules | 批量創建實例的防火墻規則 | 為指定的輕量應用服務器批量創建防火墻規則。 |
| ListFirewallRules | 獲取實例的防火墻規則 | 查詢指定輕量應用服務器的防火墻規則。 |
| ModifyFirewallRule | 修改實例防火墻規則 | 修改指定輕量應用服務器的防火墻規則。 |
| EnableFirewallRule | 開啟實例防火墻規則 | 開啟指定輕量應用服務器的一條防火墻策略。 |
| DisableFirewallRule | 禁用實例防火墻規則 | 禁用指定輕量應用服務器的一條防火墻策略。 |
| DeleteFirewallRule | 刪除實例防火墻規則 | 刪除指定輕量應用服務器的一條防火墻規則。 |
快照
| API | 標題 | API概述 |
|---|---|---|
| CreateSnapshot | 創建快照 | 為指定的磁盤創建快照。 |
| ListSnapshots | 獲取快照 | 查詢一個或多個已創建的快照信息。 |
| UpdateSnapshotAttribute | 修改快照備注信息 | 修改輕量應用服務器指定快照的備注信息。 |
| DeleteSnapshot | 刪除快照 | 刪除輕量應用服務器指定的快照。 |
| DeleteSnapshots | 批量刪除快照 | 刪除一個或多個已創建的快照。 |
磁盤
| API | 標題 | API概述 |
|---|---|---|
| UpdateDiskAttribute | 修改數據盤備注信息 | 修改輕量應用服務器指定數據盤的備注信息。 |
| ListDisks | 查詢一個或多個磁盤信息 | 查詢指定地域下一個或多個已創建的磁盤信息。 |
| ResetDisk | 回滾磁盤 | 根據快照回滾磁盤。 |
自定義鏡像
| API | 標題 | API概述 |
|---|---|---|
| CreateCustomImage | 創建自定義鏡像 | 通過快照創建用戶自定義鏡像。 |
| ListCustomImages | 查詢一個或多個自定義鏡像信息 | 查詢指定地域下一個或多個已創建的自定義鏡像信息。 |
| ModifyImageShareStatus | 共享、解除共享自定義鏡像 | 為指定的自定義鏡像共享或取消共享到ECS。 |
| AddCustomImageShareAccount | 跨賬號共享自定義鏡像 | 您可以將自定義鏡像共享給同地域下的其他阿里云賬號，快速為多個輕量應用服務器部署相同的環境配置，提高部署效率。 |
| ListCustomImageShareAccounts | 查看跨賬號共享鏡像信息 | 查詢跨賬號共享鏡像的信息。 |
| ListCustomImageShareAccounts | 查看跨賬號共享鏡像信息 | 查詢跨賬號共享鏡像的信息。 |
| RemoveCustomImageShareAccount | 取消跨賬號共享鏡像 | 為了安全考慮，跨賬號共享自定義鏡像后，您可以調用RemoveCustomImageShareAccount接口取消跨賬號共享自定義鏡像。 |
| DeleteCustomImage | 刪除自定義鏡像 | 刪除指定的自定義鏡像。 |
| DeleteCustomImages | 批量刪除鏡像 | 如果您不再需要某些自定義鏡像，可以將其批量刪除。自定義鏡像被刪除后，使用該鏡像創建的輕量應用服務器將無法使用該鏡像重置系統。 |
命令助手
| API | 標題 | API概述 |
|---|---|---|
| DescribeCloudAssistantAttributes | 查詢一臺或者多臺實例的命令助手信息 | 查詢一臺或者多臺實例的命令助手信息。 |
| UpdateCommandAttribute | 修改命令 | 修改一條命令相關參數。 |
| InvokeCommand | 執行命令 | 為一臺或多臺輕量應用服務器執行一條命令助手命令。 |
| DescribeCommands | 查詢命令 | 查詢您手動創建的命令或者阿里云提供的公共命令。 |
| DescribeCommandInvocations | 查詢命令執行列表和狀態 | 查詢命令助手執行命令的列表和狀態。 |
| DeleteCommand | 刪除命令 | 刪除一條命令助手命令。 |
| CreateCommand | 創建命令 | 新建一條命令助手命令。 |
| StartTerminalSession | 開啟免密登錄會話 | 為輕量應用服務器提供會話登錄能力。 |
| InstallCloudAssistant | 安裝云助手 | 為輕量應用服務器安裝云助手。 |
| DescribeCloudAssistantStatus | 查詢云助手安裝狀態 | 查詢輕量云服務器是否安裝云助手。 |
| DescribeInvocationResult | 查詢單個命令的執行結果 | 查詢單個命令的執行結果。 |
| RunCommand | 執行命令 | 在輕量應用服務器上執行命令。 |
| DescribeInvocations | 查看命令詳細信息 | 查看命令詳細信息。 |
輕量數據庫服務
| API | 標題 | API概述 |
|---|---|---|
| ModifyDatabaseInstanceParameter | 修改數據庫參數 | 輕量數據庫服務創建后，您可以查看數據庫的參數信息，或者根據業務需求，修改數據庫參數。 |
| StopDatabaseInstance | 停止輕量數據庫實例 | 停止輕量數據庫實例。 |
| StartDatabaseInstance | 啟動輕量數據庫實例 | 啟動輕量數據庫實例。 |
| ModifyDatabaseInstanceDescription | 修改輕量數據庫實例的描述信息 | 修改輕量數據庫實例的描述信息。 |
| DescribeDatabaseSlowLogRecords | 查詢輕量數據庫慢日志明細信息 | 查詢輕量數據庫慢日志明細信息。 |
| DescribeDatabaseErrorLogs | 查詢錯誤日志 | 查詢錯誤日志。 |
| DescribeDatabaseInstanceMetricData | 查詢數據庫實例監控信息 | 查詢數據庫實例監控信息。 |
| DescribeDatabaseInstanceParameters | 查看輕量數據庫實例的參數信息 | 查看輕量數據庫實例的參數信息。 |
| DescribeDatabaseInstances | 查看輕量數據庫實例信息 | 查看輕量數據庫實例信息。 |
| AllocatePublicConnection | 申請公網訪問地址 | 申請公網訪問地址。 |
| RestartDatabaseInstance | 重啟輕量數據庫實例 | 如果輕量數據庫實例處于運行狀態，您可以通過此接口重啟輕量數據庫實例。 |
| ResetDatabaseAccountPassword | 重置數據庫賬號的密碼 | 如果數據庫的密碼安全性較差，您也可以通過調用此接口可以修改數據庫administrator賬號的密碼。為了數據庫的安全，建議您定期更改數據庫密碼。 |
| ReleasePublicConnection | 釋放外網訪問地址 | 如果您不再需要使用外網地址訪問輕量數據庫實例，可以釋放外網訪問地址。 |
標簽
| API | 標題 | API概述 |
|---|---|---|
| TagResources | 綁定標簽 | 對輕量應用服務器、快照、自定義鏡像、命令、防火墻規則和磁盤綁定標簽，便于查看和管理輕量資源。 |
| ListTagResources | 查詢標簽列表 | 調用ListTagResources查詢一個或多個輕量資源（實例、快照、磁盤、鏡像、命令、防火墻規則）已經綁定的標簽信息。 |
| UntagResources | 解綁并刪除標簽 | 為指定的輕量資源（實例、快照、磁盤、鏡像、命令、防火墻規則）統一解綁并刪除標簽。 |
其他資源
| API | 標題 | API概述 |
|---|---|---|
| ListRegions | 查詢可用地域列表 | 查詢輕量服務器所有可用地域列表。 |
| ListImages | 獲取鏡像列表 | 查詢指定地域下一個或多個鏡像信息。 |
| ListPlans | 獲取套餐信息 | 查詢指定地域下輕量應用服務器所有的套餐信息。 |