API標準及多語言預置SDK
本產品（smc/2019-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概述 |
| DescribeSourceServers | 查詢一個或多個遷移源資訊 | 調用DescribeSourceServers查詢一個或多個遷移源資訊。 |
| ModifySourceServerAttribute | 修改一個遷移源的名稱和描述 | 調用ModifySourceServerAttribute修改一個遷移源的名稱和描述。 |
| DeleteSourceServer | 刪除一個遷移源 | 調用DeleteSourceServer刪除一個遷移源。 |
遷移任務
|
API |
標題 |
API概述 |
| CreateReplicationJob | 建立一個遷移任務 | 調用CreateReplicationJob為遷移源建立一個遷移任務。 |
| CreateCrossZoneMigrationJob | 建立跨可用性區域遷移任務 | SMC支援將阿里雲Elastic Compute Service遷移到同地區的不同可用性區域，同時也支援在同規格類型系列內更改執行個體規格（vCPU和記憶體），滿足您遷移Elastic Compute Service和變更配置執行個體規格的業務需求。您可以通過此介面建立跨可用性區域任務。 |
| ModifyReplicationJobAttribute | 修改遷移任務 | 調用ModifyReplicationJobAttribute修改遷移任務資訊。 |
| StartReplicationJob | 啟動一個遷移任務 | 調用StartReplicationJob啟動一個遷移任務。 |
| StopReplicationJob | 停止一個遷移任務 | 調用StopReplicationJob停止一個遷移任務。 |
| DescribeReplicationJobs | 查詢一個或多個遷移任務的詳細資料 | 調用DescribeReplicationJobs查詢一個或多個遷移任務的詳細資料。 |
| CutOverReplicationJob | 停止周期執行自動增量任務 | 將指定的自動增量遷移任務停止周期執行，並完成遷移任務。 |
| DeleteReplicationJob | 刪除一個遷移任務 | 調用DeleteReplicationJob刪除一個遷移任務。 |
工作群組
|
API |
標題 |
API概述 |
| CreateWorkgroup | 建立工作群組 | 工作群組可以同時管理多個遷移任務的生命週期，適用於需要批量遷移伺服器的情境。 |
| AssociateSourceServers | 遷移源關聯工作群組 | 如果您需要通過工作群組批量遷移伺服器，需要先將遷移源關聯到工作群組。 |
| DisassociateSourceServers | 遷移源取消關聯工作群組 | 如果某個遷移源後期無需通過工作群組批量遷移或者需要刪除工作群組，則可以取消關聯工作群組。 |
| DescribeWorkgroups | 查看工作群組 | 建立工作群組後，您可以查看工作群組的相關資訊，包括工作群組名稱、工作群組描述、警示資訊等。 |
| ModifyWorkgroupAttribute | 修改工作群組 | 建立工作群組後，您可以修改工作群組的名稱和描述資訊。 |
| DeleteWorkgroup | 刪除工作群組 | 如果您後期不再需要工作群組，可以刪除工作群組。 |
啟用碼
|
API |
標題 |
API概述 |
| CreateAccessToken | 建立啟用碼 | 調用CreateAccessToken建立啟用碼。 |
| DisableAccessToken | 禁用啟用碼 | 調用DisableAccessToken禁用啟用碼。 |
| ListAccessTokens | 查詢啟用碼 | 調用ListAccessTokens查詢已建立的啟用碼以及啟用碼的使用方式。 |
| DeleteAccessToken | 刪除啟用碼 | 調用DeleteAccessToken刪除啟用碼。 |
其他
|
API |
標題 |
API概述 |
| ListTagResources | 查詢標籤列表 | 調用ListTagResources查詢一個或多個SMC資源（遷移源和遷移任務）已經綁定的標籤列表。 |
| TagResources | 綁定標籤 | 調用TagResources為指定的SMC資源（遷移源和遷移任務）列表統一建立並綁定標籤。 |
| UntagResources | 解除綁定並刪除標籤 | 為指定的SMC資源（遷移源和遷移任務）統一解除綁定並刪除標籤。 |