プライベート接続構成の管理

概要

このセクションでは、Datastream API を使用してプライベート接続構成を作成、取得、削除する方法について説明します。

プライベート接続の構成には、Datastream がプライベートネットワーク（Google Cloud 内または VPN もしくは相互接続で接続される外部ソース）を介してデータソースと通信するために使用する情報が含まれています。この通信は、Virtual Private Cloud（VPC）とのピアリング接続を介して行われます。

Datastream API を使用する方法は 2 つあります。REST API 呼び出し、または Google Cloud CLI（CLI）を使用できます。

gcloud を使用した Datastream のプライベート接続構成の管理の概要については、こちらをご覧ください。

プライベート接続構成の作成

プライベート接続構成を作成する前に、次のことを確認してください。

Datastream のプライベートネットワークにピアリングする VPC ネットワークがあります。VPC ネットワークの作成の詳細については、VPC ネットワークピアリングの使用をご覧ください。
VPC ネットワーク上で使用可能な IP 範囲を割り振ります。Datastream は、この IP 範囲を使用して、指定された VPC との VPC ピアリングを作成するため、その VPC 内のサブネットと重複しないようにする必要があります。その結果、Datastream はソースと通信できるようになります。

プライベート接続構成の作成に関連するパラメータは 2 つあります。

vpcName: VPC ネットワークの名前とパスを指定します。
subnet: VPC ネットワーク上で使用可能な IP 範囲を指定します。

次のコードは、プライベート接続構成の作成リクエストを示し、接続方法に VPC ピアリング（vpcPeeringConfig）を指定しています。

REST

POST https://datastream.googleapis.com/v1/projects/[project-id]/locations/
[location]/privateConnections?privateConnectionId=[private-connectivity configuration-id]
{
  "displayName": "[private-connectivity-configuration-display-name]",
  "vpcPeeringConfig": {
      "vpcName": "[name-and-path-of-VPC-network]",
      "subnet": "[subnet]"
  }
}

次に例を示します。

POST https://datastream.googleapis.com/v1/projects/myProjectId/locations/
us-central1/privateConnections?privateConnectionId=myPrivateConnection
{
  "displayName": "my private connectivity configuration",
  "vpcPeeringConfig": {
    "vpcName": "projects/my-project/global/networks/my-vpc",
    "subnet": "10.11.12.13/29"
  }
}

プライベート接続構成の作成後、privateConnections/get メソッドを呼び出して構成に関する情報を表示できます。出力は次のように表示されます。

{
  "name": "projects/projectId/location/us-central1/privateConnections/myPrivateConnection",
  "createTime": "2019-12-22T16:17:37.159786963Z",
  "updateTime": "2019-12-22T16:17:37.159786963Z",
  "displayName": "my private connectivity configuration",
  "state": "CREATED",
  "vpcPeeringConfig": {
    "vpcName": "projects/my-project/global/networks/my-vpc",
    "subnet": "10.11.12.13/29"
  }
}

gcloud

gcloud を使用してプライベート接続構成を作成する方法については、こちらをクリックしてください。

プライベート接続構成に関する情報の取得

次のコードは、作成されたプライベート接続構成に関する情報を取得するリクエストを示しています。

REST

GET https://datastream.googleapis.com/v1/projects/[project-id]/locations/
[location]/privateConnections/[private-connectivity-configuration-id]

次に例を示します。

GET https://datastream.googleapis.com/v1/projects/myProjectId/locations/
us-central1/privateConnections/myPrivateConnection

gcloud

gcloud を使用してプライベート接続構成の情報を取得する方法については、こちらをクリックしてください。

プライベート接続構成の一覧表示

次のコードは、すべてのプライベート接続構成に関する情報を取得するリクエストを示しています。

REST

GET https://datastream.googleapis.com/v1/projects/[project-id]/locations/
[location]/privateConnections

gcloud

gcloud を使用してすべてのプライベート接続構成に関する情報を取得する方法については、こちらをクリックしてください。

プライベート接続構成の削除

次のコードは、プライベート接続構成の削除リクエストを示しています。構成を削除すると、その構成を使用する接続プロファイルは機能しなくなります。さらに、これらの接続プロファイルを使用するストリームは動作しません。

この問題を解決するには、接続プロファイルごとに異なるプライベート接続構成を割り当てます。詳細については、接続プロファイルを更新するをご覧ください。

REST

DELETE https://datastream.googleapis.com/v1/projects/[project-id]/locations/
[location]/privateConnections/[private-connectivity-configuration-id] {"force": true}

次に例を示します。

DELETE https://datastream.googleapis.com/v1/projects/myProjectId/locations/
us-central1/privateConnections/myPrivateConnection {"force": true}

{"force": true} 部分を追加して、プライベート接続の構成が適切に削除されていることを確認する必要があります。

gcloud

gcloud を使用してプライベート接続構成を削除する方法の詳細については、こちらをクリックしてください。

API を使用してタグを管理する

API を使用して接続プロファイルを管理する