總覽
本頁說明如何使用資料庫移轉服務 API,管理 PostgreSQL 來源資料庫和 AlloyDB 目的地的連線設定檔。
您可以透過兩種方式使用資料庫移轉服務 API。您可以發出 REST API 呼叫,也可以使用 Google Cloud CLI (CLI)。
如要查看使用 gcloud 管理資料庫遷移服務連線設定檔的概略資訊,請按這裡。
為 PostgreSQL 來源資料庫建立連線設定檔
以下是建立 PostgreSQL 來源資料庫連線設定檔的要求。
REST
使用任何要求資料之前,請先替換以下項目:
- project-id:專案 ID
- region:專案區域
- connection-profile-id:連線設定檔 ID
- connection-profile-display-name:連線設定檔顯示名稱
- host-ip-address:來源 IP 位址
- username:資料庫使用者名稱
- password:資料庫使用者密碼
HTTP 方法和網址:
POST https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles?connectionProfileId=connection-profile-id
JSON 要求主體:
如要傳送要求,請展開以下其中一個選項:
您應該會收到如下的 JSON 回應:
{
"name": "projects/project-id/locations/region/operations/operation-1591973161667-5a7e422cb0ba4-3004980d-2ae97165",
"metadata": {
"@type": "type.googleapis.com/google.cloud.clouddms.v1.OperationMetadata",
"createTime": "2020-06-12T14:46:01.744267779Z",
"target": "projects/project-id/locations/region/connectionProfiles/connection-profile-id",
"verb": "create",
"requestedCancellation": false,
"apiVersion": "v1"
},
"done": false
}
gcloud
如要查看使用 gcloud 建立資料庫遷移服務連線設定檔的概略資訊,請按這裡。
建立完成後,您可以呼叫 connectionProfiles/get 方法,查看連線設定檔的相關資訊。
REST
使用任何要求資料之前,請先替換以下項目:
- project-id:專案 ID
- region:專案區域
- connection-profile-id:連線設定檔 ID
HTTP 方法和網址:
GET https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id
如要傳送要求,請展開以下其中一個選項:
您應該會收到如下的 JSON 回應:
gcloud
如要進一步瞭解如何使用 gcloud 擷取連結設定檔的相關資訊,請按這裡。
為 PostgreSQL 適用的 Cloud SQL 來源資料庫建立連線設定檔
以下是為 PostgreSQL 適用的 Cloud SQL 來源資料庫建立連線設定檔的要求。這個範例使用 PostgreSQL 連線設定檔,因為它會連線至 PostgreSQL 資料庫引擎,而非 Cloud SQL 管理層。
如要使用 Cloud SQL 建立來源和備用資源之間的配對關係,您必須提供 Cloud SQL 資料庫的執行個體 ID。您可以使用 Cloud SQL Admin API 的 databases/list 方法,找出執行個體 ID 值。
REST
使用任何要求資料之前,請先替換以下項目:
- project-id:專案 ID
- region:專案區域
- connection-profile-id:連線設定檔 ID
- connection-profile-display-name:連線設定檔顯示名稱
- host-ip-address:來源 IP 位址
- username:資料庫使用者名稱
- password:資料庫使用者密碼
- cloud-sql-instance-id:Cloud SQL 執行個體 ID
HTTP 方法和網址:
POST https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles?connectionProfileId=connection-profile-id
JSON 要求主體:
如要傳送要求,請展開以下其中一個選項:
您應該會收到如下的 JSON 回應:
{
"name": "projects/project-id/locations/region/operations/operation-1591973161667-5a7e422cb0ba4-3004980d-2ae97165",
"metadata": {
"@type": "type.googleapis.com/google.cloud.clouddms.v1.OperationMetadata",
"createTime": "2020-06-12T14:46:01.744267779Z",
"target": "projects/project-id/locations/region/connectionProfiles/connection-profile-id",
"verb": "create",
"requestedCancellation": false,
"apiVersion": "v1"
},
"done": false
}
gcloud
如要查看使用 gcloud 建立資料庫遷移服務連線設定檔的概略資訊,請按這裡。
為 AlloyDB for PostgreSQL 目的地建立連線設定檔
以下是建立 AlloyDB for PostgreSQL 目的地連線設定檔的要求。資料庫遷移服務會使用這項要求中的資訊,建立新的 AlloyDB 執行個體。
REST
使用任何要求資料之前,請先替換以下項目:
- project-id:專案 ID
- region:專案區域
- connection-profile-id:連線設定檔 ID
- connection-profile-display-name:連線設定檔顯示名稱
- cluster-id:要建立的 AlloyDB 叢集 ID
- user:要提供給初始使用者的使用者名稱
- password:要提供給初始使用者的密碼
- vpc-network:AlloyDB 叢集要連線的 VPC 網路
- instance-id:要建立的 AlloyDB 執行個體 ID
- cpu-count:用於設定執行個體的 CPU 數量
所有儲存在 Google Cloud 的靜態資料,都會透過強化版金鑰管理系統進行加密。這個系統與 Google 加密自家資料時使用的系統相同,這些金鑰管理系統提供嚴格的金鑰存取權控管和稽核機制,並使用 AES-256 加密標準加密靜態使用者資料。不需要設定、調整或管理。如果使用者對加密編譯資料的遵循規定或位置沒有特定要求, Google Cloud的預設靜態加密機制就是最佳選擇。
HTTP 方法和網址:
POST https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles?connectionProfileId=connection-profile-id
JSON 要求主體:
{
"displayName": "connection-profile-display-name",
"alloydb": {
"cluster_id": "cluster-id"
"settings": {
"initial_user": {
"user": "user",
"password": "password",
}
"vpc_network": "vpc-network",
"primary_instance_settings": {
"id": "instance-id",
"machine_config": {
"cpu_count": cpu-count
}
}
}
}
}
如要傳送要求,請展開以下其中一個選項:
您應該會收到如下的 JSON 回應:
{
"name": "projects/project-id/locations/region/operations/operation-1591975557292-5a7e4b195623c-e350e3da-713dee7d",
"metadata": {
"@type": "type.googleapis.com/google.cloud.clouddms.v1.OperationMetadata",
"createTime": "2020-06-12T15:25:57.430715421Z",
"target": "projects/project-id/locations/region/connectionProfiles/connection-profile-id",
"verb": "create",
"requestedCancellation": false,
"apiVersion": "v1"
},
"done": false
}
gcloud
如要查看使用 gcloud 建立資料庫遷移服務連線設定檔的概略資訊,請按這裡。
取得連線設定檔相關資訊
REST
使用任何要求資料之前,請先替換以下項目:
- project-id:專案 ID
- region:專案區域
- connection-profile-id:連線設定檔 ID
HTTP 方法和網址:
GET https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id
如要傳送要求,請展開以下其中一個選項:
您應該會收到如下的 JSON 回應:
gcloud
如要進一步瞭解如何使用 gcloud 擷取連結設定檔的相關資訊,請按這裡。
列出連線設定檔
以下是擷取所有連線設定檔資訊的要求。
REST
使用任何要求資料之前,請先替換以下項目:
- project-id:專案 ID
- region:專案區域
orderBy:使用這個篩選器,即可依字母順序擷取特定地區的所有連線設定檔清單。舉例來說,orderBy=name篩選器會依名稱依序傳回所有連線設定檔。-
pageSize:使用這個篩選器,指定資料庫遷移服務在頁面上擷取及顯示的連線設定檔上限。舉例來說,設定pageSize=10後,資料庫遷移服務會針對一個網頁傳回最多 10 個連線設定檔。
如果連線設定檔超過 10 個,則會顯示在其他頁面。每個頁面的結尾都會顯示 nextPageToken 參數和不重複 ID。使用 ID 擷取下列頁面的連線設定檔清單。
HTTP 方法和網址:
GET https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles
如要傳送要求,請展開以下其中一個選項:
您應該會收到如下的 JSON 回應:
gcloud
如要進一步瞭解如何使用 gcloud 擷取所有連結設定檔的相關資訊,請按這裡。
更新連線設定檔
以下是要求更新現有連線設定檔的使用者名稱和密碼欄位。在要求中使用 updateMask 參數後,要求主體中只需包含這些欄位即可。
REST
使用任何要求資料之前,請先替換以下項目:
- project-id:專案 ID
- region:專案區域
- connection-profile-id:連線設定檔 ID
- username:資料庫使用者名稱
- password:資料庫使用者密碼
HTTP 方法和網址:
PATCH
JSON 要求主體:
如要傳送要求,請展開以下其中一個選項:
您應該會收到如下的 JSON 回應:
{
"name": "projects/project-id/locations/region/operations/operation-1591973161667-5a7e422cb0ba4-3004980d-2ae97165",
"metadata": {
"@type": "type.googleapis.com/google.cloud.clouddms.v1.OperationMetadata",
"createTime": "2020-06-12T14:46:01.744267779Z",
"target": "projects/project-id/locations/region/connectionProfiles/connection-profile-id",
"verb": "update",
"requestedCancellation": false,
"apiVersion": "v1"
},
"done": false
}
gcloud
如要進一步瞭解如何使用 gcloud 更新連線設定檔,請按這裡。
刪除連線設定檔
REST
使用任何要求資料之前,請先替換以下項目:
- project-id:專案 ID
- region:專案區域
- connection-profile-id:連線設定檔 ID
HTTP 方法和網址:
DELETE https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id
如要傳送要求,請展開以下其中一個選項:
您應該會收到如下的 JSON 回應:
{
"name": "projects/project-id/locations/region/operations/operation-1591973161667-5a7e422cb0ba4-3004980d-2ae97165",
"metadata": {
"@type": "type.googleapis.com/google.cloud.clouddms.v1.OperationMetadata",
"createTime": "2020-06-12T14:46:01.744267779Z",
"target": "projects/project-id/locations/region/connectionProfiles/connection-profile-id",
"verb": "delete",
"requestedCancellation": false,
"apiVersion": "v1"
},
"done": false
}
gcloud
如要進一步瞭解如何使用 gcloud 刪除連線設定檔,請按這裡。
刪除連線設定檔和相關聯的 AlloyDB 例項
以下是刪除目的地連線設定檔的請求,以及連帶刪除相關的 AlloyDB 執行個體。
REST
使用任何要求資料之前,請先替換以下項目:
- project-id:專案 ID
- region:專案區域
- connection-profile-id:連線設定檔 ID
HTTP 方法和網址:
DELETE https://datamigration.googleapis.com/v1/projects/project-id/locations/region/connectionProfiles/connection-profile-id?force=true
如要傳送要求,請展開以下其中一個選項:
您應該會收到如下的 JSON 回應:
{
"name": "projects/project-id/locations/region/operations/operation-1591973161667-5a7e422cb0ba4-3004980d-2ae97165",
"metadata": {
"@type": "type.googleapis.com/google.cloud.clouddms.v1.OperationMetadata",
"createTime": "2020-06-12T14:46:01.744267779Z",
"target": "projects/project-id/locations/region/connectionProfiles/connection-profile-id",
"verb": "create",
"requestedCancellation": false,
"apiVersion": "v1"
},
"done": false
}
gcloud
如要進一步瞭解如何使用 gcloud 刪除連線設定檔和相關聯的 AlloyDB 執行個體,請按這裡。