プライベート IP を構成する

Console

1. Google Cloud コンソールで Cloud SQL の [インスタンス] ページに移動します。

   Cloud SQL の [インスタンス] に移動

2. [インスタンスを作成] をクリックします。
3. [設定オプションを表示] を展開します。
4. [接続] を開きます。
5. [プライベート IP] を選択します。

   プルダウン リストに、プロジェクトで使用可能な VPC ネットワークが表示されます。プロジェクトが共有 VPC のサービス プロジェクトである場合、ホスト プロジェクトの VPC ネットワークも表示されます。

6. 使用する VPC ネットワークを選択します。

プライベート サービス接続を設定する必要があることを示すメッセージが表示された場合は、次の手順を行います。

1. [接続の設定] をクリックします。
2. [IP 範囲を割り振る] セクションで、次のいずれかのオプションを選択します。
   • 既存の IP 範囲を 1 つ以上選択するか、プルダウンから新しい IP 範囲を作成します。プルダウンには、以前に割り振られた範囲があればそれが含まれます。または、[新しい IP 範囲の割り振り] を選択して、新しい範囲と名前を入力することもできます。
   • ネットワークで自動的に割り振られた IP 範囲を使用します。
3. [続行] をクリックします。
4. [接続の作成] をクリックします。
5. 「Private service connection for network VPC_NETWORK_NAME has been successfully created」というメッセージが表示されていることを確認します。
7. 必要に応じて、接続に使用するインスタンスに割り振る IP 範囲を指定できます。
   1. [割り振られた IP 範囲のオプションを表示] を展開します。
   2. プルダウン メニューから IP 範囲を選択します。
8. 省略可。他の Google Cloud サービス（たとえば BigQuery）から、プライベート IP 接続を介して Cloud SQL 内のデータにアクセスして、このデータに対してクエリを実行できるようにする場合は、[プライベート パスを有効にする] を選択します。
9. インスタンスの構成を完了します。
10. [インスタンスを作成] をクリックします。

gcloud

プライベート IP アドレスを使用してインスタンスを作成する前に、プロジェクトがプライベート サービス アクセス用に構成されていることを確認してください。

リクエストのデータを使用する前に、次のように置き換えます。

• INSTANCE_ID: インスタンス ID
• PROJECT_ID: プロジェクト ID

• NETWORK_PROJECT_ID: VPC ネットワークのプロジェクト ID

• VPC_NETWORK_NAME: VPC ネットワークの名前
• RANGE_NAME: 省略可。 指定すると、IP 範囲が割り振られる範囲名が設定されます。範囲名は RFC-1035 に準拠し、1～63 文字にする必要があります。
• REGION_NAME: リージョン名

また、必要に応じて --enable-google-private-path パラメータを使用して、BigQuery などの他の Google Cloud サービスが Cloud SQL 内のデータにアクセスし、プライベート IP 接続でこのデータに対するクエリを実行できるようにします。このパラメータは次の場合にのみ有効です。

• --no-assign-ip パラメータを使用する。
• --network パラメータを使用して、プライベート接続の作成に使用する VPC ネットワークの名前を指定する。

gcloud beta sql instances create INSTANCE_ID \
--project=PROJECT_ID \
--network=projects/NETWORK_PROJECT_ID/global/networks/VPC_NETWORK_NAME \
--no-assign-ip \
--allocated-ip-range-name=RANGE_NAME \
--enable-google-private-path

Terraform

新しいインスタンスにプライベート IP を構成するには、次の Terraform リソースを使用します。

• google_compute_network
• google_compute_global_address
• google_service_networking_connection
• google_sql_database_instance

resource "google_compute_network" "peering_network" {
  name                    = "private-network"
  auto_create_subnetworks = "false"
}

resource "google_compute_global_address" "private_ip_address" {
  name          = "private-ip-address"
  purpose       = "VPC_PEERING"
  address_type  = "INTERNAL"
  prefix_length = 16
  network       = google_compute_network.peering_network.id
}

resource "google_service_networking_connection" "default" {
  network                 = google_compute_network.peering_network.id
  service                 = "servicenetworking.googleapis.com"
  reserved_peering_ranges = [google_compute_global_address.private_ip_address.name]
}

resource "google_sql_database_instance" "instance" {
  name             = "private-ip-sql-instance"
  region           = "us-central1"
  database_version = "MYSQL_8_0"

  depends_on = [google_service_networking_connection.default]

  settings {
    tier = "db-f1-micro"
    ip_configuration {
      ipv4_enabled    = "false"
      private_network = google_compute_network.peering_network.id
    }
  }
  # set `deletion_protection` to true, will ensure that one cannot accidentally delete this instance by
  # use of Terraform whereas `deletion_protection_enabled` flag protects this instance at the GCP level.
  deletion_protection = false
}

resource "google_compute_network_peering_routes_config" "peering_routes" {
  peering              = google_service_networking_connection.default.peering
  network              = google_compute_network.peering_network.name
  import_custom_routes = true
  export_custom_routes = true
}


## Uncomment this block after adding a valid DNS suffix

# resource "google_service_networking_peered_dns_domain" "default" {
#   name       = "example-com"
#   network    = google_compute_network.peering_network.name
#   dns_suffix = "example.com."
#   service    = "servicenetworking.googleapis.com"
# }

変更を適用する

Google Cloud プロジェクトで Terraform 構成を適用するには、次のセクションの手順を完了します。

Cloud Shell を準備する

1. Cloud Shell を起動します。

2. Terraform 構成を適用するデフォルトの Google Cloud プロジェクトを設定します。

   このコマンドは、プロジェクトごとに 1 回だけ実行する必要があります。これは任意のディレクトリで実行できます。

   export GOOGLE_CLOUD_PROJECT=PROJECT_ID

   Terraform 構成ファイルに明示的な値を設定すると、環境変数がオーバーライドされます。

ディレクトリを準備する

Terraform 構成ファイルには独自のディレクトリ（ルート モジュールとも呼ばれます）が必要です。

1. Cloud Shell で、ディレクトリを作成し、そのディレクトリ内に新しいファイルを作成します。ファイルの拡張子は .tf にする必要があります（例: main.tf）。このチュートリアルでは、このファイルを main.tf とします。

   mkdir DIRECTORY && cd DIRECTORY && touch main.tf

2. チュートリアルを使用している場合は、各セクションまたはステップのサンプルコードをコピーできます。

   新しく作成した main.tf にサンプルコードをコピーします。

   必要に応じて、GitHub からコードをコピーします。Terraform スニペットがエンドツーエンドのソリューションの一部である場合は、この方法をおすすめします。

3. 環境に適用するサンプル パラメータを確認し、変更します。
4. 変更を保存します。
5. Terraform を初期化します。これは、ディレクトリごとに 1 回だけ行う必要があります。

   terraform init

   必要に応じて、最新バージョンの Google プロバイダを使用する場合は、-upgrade オプションを使用します。

   terraform init -upgrade

変更を適用する

1. 構成を確認して、Terraform が作成または更新するリソースが想定どおりであることを確認します。

   terraform plan

   必要に応じて構成を修正します。

2. 次のコマンドを実行し、プロンプトで「yes」と入力して、Terraform 構成を適用します。

   terraform apply

   Terraform に「Apply complete!」のメッセージが表示されるまで待ちます。

3. Google Cloud プロジェクトを開いて結果を表示します。Google Cloud コンソールの UI でリソースに移動して、Terraform によって作成または更新されたことを確認します。

変更を削除する

変更を削除するには、次の手順を行います。

1. 削除の保護を無効にするには、Terraform 構成ファイルで deletion_protection 引数を false に設定します。

   deletion_protection =  "false"

2. 次のコマンドを実行し、プロンプトで「yes」と入力して、更新された Terraform 構成を適用します。

   terraform apply

3. 以前に Terraform 構成で適用されたリソースを削除するには、次のコマンドを実行して、プロンプトに「yes」と入力します。

   terraform destroy

REST v1

プライベート IP アドレスを持つ新しいインスタンスを作成します。

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID:: プロジェクト ID
• INSTANCE_ID:: インスタンス ID
• VPC_NETWORK_NAME:: このインスタンスに使用する Virtual Private Cloud（VPC）ネットワークの名前を指定します。このネットワークに対して、プライベート サービス アクセスがすでに構成されている必要があります。
• RANGE_NAME:: 省略可。指定すると、IP 範囲が割り当てられる範囲名が設定されます。範囲名は RFC-1035 に準拠し、1～63 文字にする必要があります。
• AUTHORIZED_NETWORKS: パブリック IP 接続の場合は、インスタンスに接続できる承認済みネットワークからの接続を指定します。

ipv4Enabled パラメータには、インスタンスにパブリック IP アドレスを使用する場合は true を設定し、インスタンスにプライベート IP アドレスを使用する場合は false を設定します。

enablePrivatePathForGoogleCloudServices パラメータを true に設定すると、BigQuery などの他の Google Cloud サービスに、Cloud SQL 内のデータに対するアクセスが許可され、プライベート IP 接続を介してこのデータに対してクエリを実行できるようになります。このパラメータを false に設定すると、他の Google Cloud サービスは、プライベート IP 接続を介した Cloud SQL 内のデータへのアクセスができなくなります。

HTTP メソッドと URL:

POST https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances

リクエストの本文（JSON）:

{
  "name": "INSTANCE_ID",
  "region": "region",
  "databaseVersion": "database-version",
  "settings": {
    "tier": "machine-type",
    "ipConfiguration": {
      "ipv4Enabled": false,
      "privateNetwork": "projects/PROJECT_ID/global/networks/VPC_NETWORK_NAME",
      "allocatedIpRange": "RANGE_NAME"
      "authorizedNetworks": [AUTHORIZED_NETWORKS],
      
      "enablePrivatePathForGoogleCloudServices": true
      
    }
  }
}

リクエストを送信するには、次のいずれかのオプションを展開します。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances"

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_ID",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2020-01-21T22:43:37.981Z",
  "operationType": "CREATE",
  "name": "OPERATION_ID",
  "targetId": "INSTANCE_ID",
  "selfLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

REST v1beta4

プライベート IP アドレスを持つ新しいインスタンスを作成します。

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID:: プロジェクト ID
• INSTANCE_ID:: インスタンス ID
• VPC_NETWORK_NAME:: このインスタンスに使用する Virtual Private Cloud（VPC）ネットワークの名前を指定します。このネットワークに対して、プライベート サービス アクセスがすでに構成されている必要があります。
• RANGE_NAME:: 省略可。指定すると、IP 範囲が割り当てられる範囲名が設定されます。範囲名は RFC-1035 に準拠し、1～63 文字にする必要があります。
• AUTHORIZED_NETWORKS: パブリック IP 接続の場合は、インスタンスに接続できる承認済みネットワークからの接続を指定します。

ipv4Enabled パラメータには、インスタンスにパブリック IP アドレスを使用する場合は true を設定し、インスタンスにプライベート IP アドレスを使用する場合は false を設定します。

enablePrivatePathForGoogleCloudServices パラメータを true に設定すると、BigQuery などの他の Google Cloud サービスに、Cloud SQL 内のデータに対するアクセスが許可され、プライベート IP 接続を介してこのデータに対してクエリを実行できるようになります。このパラメータを false に設定すると、他の Google Cloud サービスは、プライベート IP 接続を介した Cloud SQL 内のデータへのアクセスができなくなります。

HTTP メソッドと URL:

POST https://sqladmin.googleapis.com/v1beta4/projects/PROJECT_ID/instances

リクエストの本文（JSON）:

{
  "name": "INSTANCE_ID",
  "region": "region",
  "databaseVersion": "database-version",
  "settings": {
    "tier": "machine-type",
    "ipConfiguration": {
      "ipv4Enabled": false,
      "privateNetwork": "projects/PROJECT_ID/global/networks/VPC_NETWORK_NAME",
      "allocatedIpRange": "RANGE_NAME"
      "authorizedNetworks": [AUTHORIZED_NETWORKS],
      
      "enablePrivatePathForGoogleCloudServices": true
      
    }
  }
}

リクエストを送信するには、次のいずれかのオプションを展開します。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://sqladmin.googleapis.com/v1beta4/projects/PROJECT_ID/instances"

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://sqladmin.googleapis.com/v1beta4/projects/PROJECT_ID/instances" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_ID",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2020-01-21T22:43:37.981Z",
  "operationType": "CREATE",
  "name": "OPERATION_ID",
  "targetId": "INSTANCE_ID",
  "selfLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

Console

1. Google Cloud コンソールで Cloud SQL の [インスタンス] ページに移動します。

   Cloud SQL の [インスタンス] に移動

2. インスタンスの [概要] ページを開くには、インスタンス名をクリックします。
3. Cloud SQL ナビゲーション メニューから [接続] を選択します。
4. [ネットワーキング] タブの [プライベート IP] チェックボックスをオンにします。

   プロジェクトで使用可能なネットワークがプルダウン リストに表示されます。

5. 使用する VPC ネットワークを選択します。

[プライベート サービス接続が必要] と表示された場合:

1. [接続の設定] をクリックします。
2. [IP 範囲を割り当てる] セクションで、次のいずれかのオプションを選択します。
   • 既存の IP 範囲を 1 つ以上選択するか、プルダウンから新しい IP 範囲を作成します。プルダウンには、以前に割り振られた範囲があればそれが含まれます。または、[新しい IP 範囲の割り振り] を選択して、新しい範囲と名前を入力することもできます。
   • ネットワークで自動的に割り振られた IP 範囲を使用します。
3. [続行] をクリックします。
4. [接続の作成] をクリックします。
5. ステータスを確認し、ネットワーク VPC_NETWORK_NAME のプライベート サービス接続が正常に作成されたことを確認します。
6. 省略可。他の Google Cloud サービス（たとえば BigQuery）から、プライベート IP 接続を介して Cloud SQL 内のデータにアクセスして、このデータに対してクエリを実行できるようにする場合は、[プライベート パスを有効にする] チェックボックスをオンにします。
7. [保存] をクリックします。

gcloud

プロジェクトがプライベート サービス アクセス用に構成されていることを確認してください。

--network パラメータを使用して、選択した VPC ネットワークの名前を指定し、Cloud SQL インスタンスを更新します。

gcloud beta sql instances patch INSTANCE_ID \
--project=PROJECT_ID \
--network=projects/NETWORK_PROJECT_ID/global/networks/VPC_NETWORK_NAME \
--no-assign-ip \
--enable-google-private-path

REST v1

プライベート IP アドレスを持つ新しいインスタンスを作成します。

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID:: プロジェクト ID
• INSTANCE_ID:: インスタンス ID
• VPC_NETWORK_NAME:: このインスタンスに使用する Virtual Private Cloud（VPC）ネットワークの名前を指定します。このネットワークに対して、プライベート サービス アクセスがすでに構成されている必要があります。
• RANGE_NAME:: 省略可。指定すると、IP 範囲が割り当てられる範囲名が設定されます。範囲名は RFC-1035 に準拠し、1～63 文字にする必要があります。
• AUTHORIZED_NETWORKS: パブリック IP 接続の場合は、インスタンスに接続できる承認済みネットワークからの接続を指定します。

ipv4Enabled パラメータには、インスタンスにパブリック IP アドレスを使用する場合は true を設定し、インスタンスにプライベート IP アドレスを使用する場合は false を設定します。

enablePrivatePathForGoogleCloudServices パラメータを true に設定すると、BigQuery などの他の Google Cloud サービスに、Cloud SQL 内のデータに対するアクセスが許可され、プライベート IP 接続を介してこのデータに対してクエリを実行できるようになります。このパラメータを false に設定すると、他の Google Cloud サービスは、プライベート IP 接続を介した Cloud SQL 内のデータへのアクセスができなくなります。

HTTP メソッドと URL:

PATCH https://sqladmin.googleapis.com/sql/v1/projects/PROJECT_ID/instances/INSTANCE_ID

リクエストの本文（JSON）:

{
  "settings":
  {
    "ipConfiguration": {
      "ipv4Enabled": false,
      "privateNetwork": "projects/PROJECT_ID/global/networks/VPC_NETWORK_NAME",
      "allocatedIpRange": "RANGE_NAME"
      "authorizedNetworks": [AUTHORIZED_NETWORKS],
      
      "enablePrivatePathForGoogleCloudServices": true
      
    }
  }
}

リクエストを送信するには、次のいずれかのオプションを展開します。

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://sqladmin.googleapis.com/sql/v1/projects/PROJECT_ID/instances/INSTANCE_ID"

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://sqladmin.googleapis.com/sql/v1/projects/PROJECT_ID/instances/INSTANCE_ID" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2020-01-21T22:43:37.981Z",
  "operationType": "UPDATE",
  "name": "OPERATION_ID",
  "targetId": "INSTANCE_ID",
  "selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

REST v1beta4

プライベート IP アドレスを持つ新しいインスタンスを作成します。

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID:: プロジェクト ID
• INSTANCE_ID:: インスタンス ID
• VPC_NETWORK_NAME:: このインスタンスに使用する Virtual Private Cloud（VPC）ネットワークの名前を指定します。このネットワークに対して、プライベート サービス アクセスがすでに構成されている必要があります。
• RANGE_NAME:: 省略可。指定すると、IP 範囲が割り当てられる範囲名が設定されます。範囲名は RFC-1035 に準拠し、1～63 文字にする必要があります。
• AUTHORIZED_NETWORKS パブリック IP 接続の場合は、インスタンスに接続できる承認済みネットワークからの接続を指定します。

ipv4Enabled パラメータには、インスタンスにパブリック IP アドレスを使用する場合は true を設定し、インスタンスにプライベート IP アドレスを使用する場合は false を設定します。

enablePrivatePathForGoogleCloudServices パラメータを true に設定すると、BigQuery などの他の Google Cloud サービスに、Cloud SQL 内のデータに対するアクセスが許可され、プライベート IP 接続を介してこのデータに対してクエリを実行できるようになります。このパラメータを false に設定すると、他の Google Cloud サービスは、プライベート IP 接続を介した Cloud SQL 内のデータへのアクセスができなくなります。

HTTP メソッドと URL:

PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID

リクエストの本文（JSON）:

{
  "settings":
  {
    "ipConfiguration": {
      "ipv4Enabled": false,
      "privateNetwork": "projects/PROJECT_ID/global/networks/VPC_NETWORK_NAME",
      "allocatedIpRange": "RANGE_NAME"
      "authorizedNetworks": [AUTHORIZED_NETWORKS],
      
      "enablePrivatePathForGoogleCloudServices": true
      
    }
  }
}

リクエストを送信するには、次のいずれかのオプションを展開します。

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID"

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2020-01-21T22:43:37.981Z",
  "operationType": "UPDATE",
  "name": "OPERATION_ID",
  "targetId": "INSTANCE_ID",
  "selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}