資料庫遷移服務提供 REST API,可讓您透過程式輔助方式管理連線設定檔和遷移工作。REST API 是由與建立及管理連線設定檔和遷移工作相關聯的資源定義。如要進一步瞭解所有資源和方法,請參閱「資料庫遷移服務 API 參考資料」。
直接向資料庫遷移服務 REST API 傳送要求時,您必須建立正確的要求格式、以已驗證使用者的身分授權要求,並處理傳回的所有回應。本說明文件中的許多工作都提供使用 curl 的 API 範例。
如需更多 API 使用範例,請參閱資料庫遷移服務 API 參考資料中的要求頁面。每個頁面都提供以多種程式設計語言呼叫 API 的範例,以及要求專用的 Explorer,協助您瞭解格式正確的要求包含哪些內容,以及預期的回應。
當您使用下列任一方式管理執行個體時,也會間接使用資料庫遷移服務 API:
Google Cloud CLI:可用來處理執行個體的指令列介面 (CLI)。
Google Cloud 控制台:圖形網頁介面。
使用這些方法 (尤其是Google Cloud 控制台) 的優點,在於能大幅簡化連線設定檔和遷移工作的管理作業 (視用途而定)。如果您剛開始使用資料庫遷移服務,建議先從其中一項工具著手,再直接使用 REST API。
啟用 API
如要使用 資料庫遷移服務 API,請先啟用:
控制台
- 啟用資料庫遷移服務 API。
- 選取專案。
- 選取「繼續」。
gcloud
- 輸入下列指令,顯示 Google Cloud專案的專案 ID:
gcloud projects list
- 設定預設專案:
gcloud config set project YOUR_PROJECT_ID
- 啟用 Cloud SQL Admin API:
gcloud services enable datamigration.googleapis.com
權限
您必須具備必要權限,才能使用資料庫遷移服務 API。這些權限包括:
- 資料庫遷移管理員:這項權限可讓使用者存取資料庫遷移服務的所有資源,用於管理連線設定檔和遷移工作。
- 資料庫遷移檢視者:具備這項權限的使用者,可唯讀存取資料庫遷移服務中的連線設定檔和遷移工作。
- Cloud SQL 管理員:具備這項權限的使用者,可在資料庫遷移服務中,建立及管理 Cloud SQL 的連線設定檔和遷移工作。