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

をご覧ください。

概要

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

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

Datastream API を使用する方法は 2 つあります。REST API 呼び出しを行うか、gcloud コマンドライン ツール(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"
  }
}

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

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

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}

gcloud

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