本產品（
加密服務/2023-11-13）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
審計日志
| API | 標題 | API概述 |
|---|---|---|
| ConfigAuditLog | 配置審計日志 | 開通或關閉審計日志、配置審計日志投遞Bucket。 |
| GetAuditLogStatus | 查詢審計日志開通狀態 | 查詢當前地域下審計日志開通狀態。 |
| InitializeAuditLog | 初始化審計日志 | 授權加密服務投遞日志。 |
鏡像
| API | 標題 | API概述 |
|---|---|---|
| GetImage | 查詢鏡像 | 查詢指定鏡像信息。 |
| ListImages | 查詢鏡像列表 | 查詢符合條件的鏡像集合。 |
| ConfigImageRemark | 配置鏡像備注 | 修改鏡像備注信息。 |
| CopyImage | 復制鏡像 | 復制鏡像到其他地域。 |
| ExportImage | 導出鏡像 | 導出指定密碼機的鏡像。 |
備份
| API | 標題 | API概述 |
|---|---|---|
| EnableBackup | 啟用備份 | 將備份與指定實例綁定。 |
| GetBackup | 查詢備份 | 查詢指定備份信息。 |
| ListBackups | 查詢備份列表 | 獲取符合查詢條件的備份集合。 |
| ConfigBackupTask | 配置備份任務 | 修改備份任務執行模式。 |
| ResetBackup | 重置備份 | 將備份與當前實例解綁。 |
| ConfigBackupRemark | 配置備份備注信息 | 配置備份的名稱及備注信息。 |
集群
| API | 標題 | API概述 |
|---|---|---|
| DeleteCluster | 刪除集群 | 刪除指定集群。 |
| JoinCluster | 加入集群 | 將集群外的一臺密碼機加入當前集群。 |
| ConfigClusterSubnet | 配置集群交換機 | 修改集群綁定的交換機列表。 |
| SyncCluster | 同步集群 | 同步集群內實例數據。 |
| InitializeCluster | 初始化集群 | 初始化集群。 |
| SwitchClusterMaster | 切換集群主密碼機 | 將集群內一臺子密碼機切換為主密碼機。 |
| ConfigClusterName | 配置集群名稱 | 修改集群名稱。 |
| LeaveCluster | 移出集群 | 將集群內的一臺密碼機移出當前集群。 |
| CreateCluster | 創建集群 | 選擇一臺密碼機作為主密碼機創建集群。 |
| ListClusters | 查詢集群列表 | 獲取符合查詢條件的集群集合。 |
| ConfigClusterCertificate | 配置集群證書 | 為非中國內地密碼機集群配置證書。 |
| GetCluster | 查詢集群 | 查詢指定集群信息。 |
| ConfigClusterWhitelist | 配置集群白名單 | 修改集群可訪問的白名單列表。 |
實例
| API | 標題 | API概述 |
|---|---|---|
| ConfigInstanceIpAddress | 配置實例VPC網絡地址 | 修改實例VPC網絡地址。 |
| RestoreInstance | 恢復實例數據 | 使用鏡像恢復實例數據。 |
| ResetInstance | 重置實例 | 重置實例數據。 |
| QuickInitInstance | 快速初始化實例 | 快速初始化實例。 |
| ConfigInstanceWhitelist | 配置實例白名單 | 修改實例白名單。 |
| ResumeInstance | 恢復實例 | 恢復停用的實例。 |
| GetInstance | 查詢實例 | 查詢指定實例信息。 |
| PauseInstance | 停用實例 | 停用實例。 |
| ListInstances | 查詢實例列表 | 獲取符合查詢條件的實例集合。 |
| ConfigInstanceRemark | 配置實例備注 | 修改實例備注。 |
其他
| API | 標題 | API概述 |
|---|---|---|
| GetJob | 獲取異步任務 | 獲取異步任務的詳細信息。 |
| MoveResourceGroup | 移動資源所在的資源組 | 移動資源所在的資源組。 |
| DescribeRegions | 查詢支持加密服務的區域列表 | 查詢支持加密服務的地域。 |