使用資料庫移轉服務 API

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

總覽

資料庫移轉服務提供 REST API，可透過程式輔助方式管理連線設定檔和遷移工作。REST API 是由與建立及管理連線設定檔和遷移工作的資源定義。如要進一步瞭解所有資源及其方法，請參閱 資料庫移轉服務 API 參考資料。

直接將要求傳送至資料庫遷移服務 REST API 時，您必須建立正確的要求表單、以已驗證使用者的身分授權要求，並處理任何傳回的回應。本說明文件中的許多工作都提供使用 cURL 的 API 範例。

如需更多 API 使用範例，請參閱 資料庫移轉服務 API 參考資料中的要求頁面。每個頁面都提供多種程式設計語言的 API 呼叫範例，以及針對要求的 Explorer，協助您瞭解正確格式要求的內容，以及回應中應有的內容。

您也可以間接使用資料庫移轉服務 API，方法是使用下列任一方式管理執行個體：

• Google Cloud CLI：可用於操作執行個體的指令列介面 (CLI)。

• Google Cloud console：圖形網頁介面。

使用這些方法 (尤其是Google Cloud 控制台) 的好處在於，它們可以大幅簡化連線設定檔和遷移工作的管理作業 (視您的使用情境而定)。如果您剛開始使用資料庫遷移服務，建議您先使用其中一個工具，再直接使用 REST API。

啟用 API

如要使用資料庫移轉服務 API，您必須先啟用該 API：

權限

您必須具備必要權限，才能使用資料庫移轉服務 API。這些權限包括：

• 資料庫遷移管理員：使用者取得這項權限後，即可存取資料庫移轉服務的所有資源，用於管理連線設定檔和遷移工作。
• 資料庫遷移檢視器：使用者具備這項權限時，可對資料庫遷移服務中的連線設定檔和遷移工作擁有唯讀存取權。
• Cloud SQL 管理員：使用者具備這項權限，即可在資料庫移轉服務中建立及管理 Cloud SQL 的連線設定檔和遷移作業。

Google Cloud 提供「身分與存取權管理」(IAM) 功能，可讓您以更精細的方式授予使用者特定 Google Cloud 資源的存取權限，避免其他資源遭到未經授權者擅自存取。您可以使用 Google Cloud console、API 的 IAM 方法或 Google Cloud CLI，取得及設定資料庫移轉服務的權限。詳情請參閱「授予、變更及撤銷資源的存取權」。

API 範例

如需使用資料庫移轉服務 API 搭配 cURL 的範例，請參閱「使用 API 管理連線設定檔」和「使用 API 管理遷移工作」。

提供檔案中的 JSON 資料

使用 cURL 搭配 API 時，您必須使用命令列提供屬性值。如果您要使用密碼或安全性金鑰等機密值，在指令列上提供這些值會造成安全性風險。為提高安全性，您可以建立包含 API 呼叫 JSON 資料的檔案，並在指令列提供檔案路徑。

如要透過檔案向 cURL API 呼叫提供 JSON 資料，請按照下列步驟操作：

1. 建立檔案，並在 --data 欄位中加入所有以單引號括住的內容。

   請加入彎號，但不要加入單引號。

2. 在指令列中，提供檔案路徑 (前面加上 @ 字元) 做為 --data 參數：

   --data @<path-to-file>/<filename>

   舉例來說，如要為 Cloud SQL 來源資料庫建立連線設定檔，您可以建立名為 request.json 的檔案，並加入以下內容：

   {
     "displayName": "my Cloud SQL connection profile",
     "mysql": {
       "host": "10.11.12.13",
       "port": 3306,
       "username": "myusername",
       "password": "mypassword"
     }
   }
   

   接著，請在指令列中使用下列 cURL 指令：

   curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
        --header 'Content-Type: application/json' \
        --data @./request.json \
        -X POST \
        https://datamigration.googleapis.com/v1/projects/myProject/locations/myLocation/connectionProfiles?connectionProfileId=myCloudSQLconnectionprofile

使用長時間執行的 API 呼叫

某些 API 呼叫 (例如物件建立) 可能需要一段時間才能完成。由於 API 為非同步，因此即使作業仍在進行中，呼叫也會立即傳回。如果後續的 API 呼叫使用新建立的物件，則必須等待第一個作業完成，才能繼續進行。

您可以使用資料庫移轉服務 API 管理作業。包括：

• 顯示作業詳細資料
• 列出區域的作業
• 刪除作業

資料庫移轉服務和 Google API Discovery 服務

Google API 探索服務可用來探索 Google API。舉例來說，當您使用 Google APIs Explorer 工具時，就會使用 Discovery Service。

在探索服務中，資料庫移轉服務會以「datamigration」表示 (例如：https://datamigration.googleapis.com/$discovery/rest?version=v1)。