インスタンスの情報を表示する

MySQL | PostgreSQL | SQL Server

このページでは、Cloud SQL インスタンスに関する情報を表示する方法について説明します。

インスタンスの概要情報を表示する

Cloud SQL インスタンスの概要情報を確認するには、Google Cloud コンソール、gcloud CLI、または API を使用します。

コンソール

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

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

Private Service Connect が有効化されている Cloud SQL インスタンスに関する、次の情報が表示されます。
- 内部接続方式: インスタンスへの接続に Private Service Connect とプライベートサービスアクセスのどちらを使用するか
- プライベート IP アドレス: インスタンスのサービスアタッチメントに接続する VPC ネットワーク内の Private Service Connect エンドポイントの IP アドレス
- DNS 名: インスタンスの DNS 名
現在のインスタンスの状態を確認するには、インスタンス名の横にあるステータスアイコンの上にポインタを置きます。

インスタンスの状態が FAILED または MAINTENANCE の場合は、過去の時点を選択してその時点の状態にインスタンスを復元することで、インスタンスを復元できます。
インスタンスの [概要] ページを開くには、インスタンス名をクリックします。

[このインスタンスに接続] カードには、Private Service Connect が有効化されている Cloud SQL インスタンスに関する、次の追加情報が表示されます。
- プライベート IP 接続: インスタンスに内部 IP アドレスが必要なため、ステータスが [有効] になっています
- 許可されているプロジェクト: これらのプロジェクトでは、Private Service Connect エンドポイントからこのインスタンスへの接続が許可されます
- サービスアタッチメント: インスタンスのサービスアタッチメント
- パブリック IP 接続: 外部 IP 接続はサポートされていないため、ステータスは [無効] になります
内部 IP アドレスまたは外部 IP アドレスがインスタンスに追加されているかどうか、インスタンスに関連付けられた承認済みネットワークがあるかどうか、BigQuery などの他の Google Cloud サービスが Cloud SQL のデータにアクセスでき、内部接続を介してこのデータに対するクエリを実施できるかどうかなど、インスタンスに関する接続情報を確認するには、[接続] タブをクリックします。

このタブの詳細については、接続オプションについてをご覧ください。
[ネットワーキング] タブをクリックします。Private Service Connect が有効化されているインスタンスに関する、次の情報が表示されます。
- [プライベート IP] チェックボックスは選択されていますが、操作不可となっています。このインスタンスには内部 IP アドレスが必要であり、この設定は変更できません。
- このインスタンスに対して許可されているプロジェクト。
- [パブリック IP] チェックボックスは選択されていますが、操作不可となっています。
- [承認済みネットワーク] フィールドは操作不可となっています。このインスタンスでは Private Service Connect が使用されていますが、この接続方法ではこの機能がサポートされていないからです。

gcloud

gcloud CLI のインストールと使用開始については、gcloud CLI をインストールするをご覧ください。Cloud Shell の起動については、Cloud Shell を使用するをご覧ください。

インスタンスの概要情報を表示するには、gcloud sql instances describe コマンドを使用します。
```
gcloud sql instances describe INSTANCE_NAME \
--project=PROJECT_ID
```
次のように置き換えます。
- INSTANCE_NAME: Cloud SQL インスタンスの名前。このインスタンスで Private Service Connect が有効になっている場合、VPC ネットワーク内の Private Service Connect エンドポイントからの接続が可能です。
- PROJECT_ID: インスタンスが含まれている Google Cloud プロジェクトの ID またはプロジェクト番号。
このコマンドを実行した場合の出力例を次に示します。
```
gcloud sql instances describe myinstance 

--project=12345
...
dnsName: mydnsname
...
pscServiceAttachmentLink: projects/myproject/regions/myregion/serviceAttachments/myserviceattachment
...
 settings:
  ...
  ipConfiguration:
  ipv4Enabled: false
  pscConfig:
    allowedConsumerProjects:
      - projects/23456
      - projects/34567
    pscEnabled: true
```

Private Service Connect が有効になっているインスタンスの詳細情報を表示するには、次のパラメータを追加します。

設定	パラメータ	備考
DNS 名	`dnsName`	インスタンスの DNS 名。この名前で DNS レコードを作成し、Private Service Connect エンドポイントの IP アドレスを指すようにすることをおすすめします。また、インスタンスへの接続にはこの名前を使用することをおすすめします。
サービスアタッチメント	`pscServiceAttachmentLink`	インスタンスのサービスアタッチメントを指す URI。この URI は、Private Service Connect エンドポイントを作成するときに使用します。
許可されたコンシューマープロジェクト	`allowedConsumerProjects`	このインスタンスに対して許可されているプロジェクトのリスト。これらのプロジェクトの任意の VPC ネットワークからインスタンスのサービスアタッチメントへの Private Service Connect エンドポイントを作成できます。
Private Service Connect を有効にする	`pscEnabled`	インスタンスに対して Private Service Connect が有効になっているかどうか。

Terraform

インスタンスを作成するには、Terraform リソースを使用します。

resource "google_sql_database_instance" "postgres_pvp_instance_name" {
  name             = "postgres-pvp-instance-name"
  region           = "asia-northeast1"
  database_version = "POSTGRES_14"
  root_password    = "abcABC123!"
  settings {
    tier = "db-custom-2-7680"
    password_validation_policy {
      min_length                  = 6
      reuse_interval              = 2
      complexity                  = "COMPLEXITY_DEFAULT"
      disallow_username_substring = true
      password_change_interval    = "30s"
      enable_password_policy      = true
    }
  }
  # 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
}

変更を適用する

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

Cloud Shell を準備する

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

このコマンドは、プロジェクトごとに 1 回だけ実行する必要があります。これは任意のディレクトリで実行できます。
```
export GOOGLE_CLOUD_PROJECT=PROJECT_ID
```
Terraform 構成ファイルに明示的な値を設定すると、環境変数がオーバーライドされます。

ディレクトリを準備する

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

Cloud Shell で、ディレクトリを作成し、そのディレクトリ内に新しいファイルを作成します。ファイルの拡張子は .tf にする必要があります（例: main.tf）。このチュートリアルでは、このファイルを main.tf とします。
```
mkdir DIRECTORY && cd DIRECTORY && touch main.tf
```
チュートリアルを使用している場合は、各セクションまたはステップのサンプルコードをコピーできます。

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

必要に応じて、GitHub からコードをコピーします。Terraform スニペットがエンドツーエンドのソリューションの一部である場合は、この方法をおすすめします。
環境に適用するサンプルパラメータを確認し、変更します。
変更を保存します。
Terraform を初期化します。これは、ディレクトリごとに 1 回だけ行います。
```
terraform init
```
最新バージョンの Google プロバイダを使用する場合は、-upgrade オプションを使用します。
```
terraform init -upgrade
```

変更を適用する

構成を確認して、Terraform が作成または更新するリソースが想定どおりであることを確認します。
```
terraform plan
```
必要に応じて構成を修正します。
次のコマンドを実行します。プロンプトで「yes」と入力して、Terraform 構成を適用します。
```
terraform apply
```
Terraform に「Apply complete!」というメッセージが表示されるまで待ちます。
Google Cloud プロジェクトを開いて結果を表示します。Google Cloud コンソールの UI でリソースに移動して、Terraform によって作成または更新されたことを確認します。

変更を削除する

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

削除の保護を無効にするには、Terraform 構成ファイルで deletion_protection 引数を false に設定します。
```
deletion_protection =  "false"
```
次のコマンドを実行します。プロンプトで「yes」と入力して、更新された Terraform 構成を適用します。
```
terraform apply
```

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

REST v1

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

PROJECT_ID: インスタンスが含まれている Google Cloud プロジェクトの ID またはプロジェクト番号。
INSTANCE_NAME: Cloud SQL インスタンスの名前。このインスタンスで Private Service Connect が有効になっている場合、VPC ネットワーク内の Private Service Connect エンドポイントからの接続が可能です。

HTTP メソッドと URL:

GET https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME

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

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザーアカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザーアカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

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

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME" | Select-Object -Expand Content

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

{
  "kind": "sql#instance",
  "state": "RUNNABLE",
  "databaseVersion": "POSTGRES_13",
  "settings": {
    "authorizedGaeApplications": [],
    "tier": "db-custom-2-7680",
    "kind": "sql#settings",
    "availabilityType": "REGIONAL",
    "pricingPlan": "PER_USE",
    "replicationType": "SYNCHRONOUS",
    "activationPolicy": "ALWAYS",
    "ipConfiguration": {
      "authorizedNetworks": [],
      "pscConfig": {
        "allowedConsumerProjects": [
          "ALLOWED_PROJECTS"
        ],
        "pscEnabled": true
      },
      "ipv4Enabled": false
    },
  ...
  "createTime": "2023-06-14T18:48:34.975Z",
  "sqlNetworkArchitecture": "NEW_NETWORK_ARCHITECTURE",
  "pscServiceAttachmentLink": "projects/PROJECT_ID/regions/REGION_NAME/serviceAttachments/SERVICE_ATTACHMENT_ID",
  "dnsName": "DNS_NAME"
}

Private Service Connect が有効になっているインスタンスには、次のフィールドがあります。

allowedConsumerProjects: このインスタンスに対して許可されているプロジェクトのリスト。これらのプロジェクトの任意の VPC ネットワークからインスタンスのサービスアタッチメントへの Private Service Connect エンドポイントを作成できます。
pscEnabled: インスタンスで Private Service Connect が有効になっているかどうか。
pscServiceAttachmentLink: インスタンスのサービスアタッチメントを指す URI。この URI は、Private Service Connect エンドポイントを作成するときに使用します。
dnsName: インスタンスの DNS 名。この名前で DNS レコードを作成し、Private Service Connect エンドポイントの IP アドレスを指すようにすることをおすすめします。また、インスタンスへの接続にはこの名前を使用することをおすすめします。

このタスクのための基盤となる REST API リクエストを作成する方法については、instances:get のページをご覧ください。

REST v1beta4

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

PROJECT_ID: インスタンスが含まれている Google Cloud プロジェクトの ID またはプロジェクト番号。
INSTANCE_NAME: Cloud SQL インスタンスの名前。このインスタンスで Private Service Connect が有効になっている場合、VPC ネットワーク内の Private Service Connect エンドポイントからの接続が可能です。

HTTP メソッドと URL:

GET https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME

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

curl（Linux、macOS、Cloud Shell）

次のコマンドを実行します。

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME"

PowerShell（Windows）

次のコマンドを実行します。

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

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME" | Select-Object -Expand Content

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

{
  "kind": "sql#instance",
  "state": "RUNNABLE",
  "databaseVersion": "POSTGRES_13",
  "settings": {
    "authorizedGaeApplications": [],
    "tier": "db-custom-2-7680",
    "kind": "sql#settings",
    "availabilityType": "REGIONAL",
    "pricingPlan": "PER_USE",
    "replicationType": "SYNCHRONOUS",
    "activationPolicy": "ALWAYS",
    "ipConfiguration": {
      "authorizedNetworks": [],
      "pscConfig": {
        "allowedConsumerProjects": [
          "ALLOWED_PROJECTS"
        ],
        "pscEnabled": true
      },
      "ipv4Enabled": false
    },
  ...
  "createTime": "2023-06-14T18:48:34.975Z",
  "sqlNetworkArchitecture": "NEW_NETWORK_ARCHITECTURE",
  "pscServiceAttachmentLink": "projects/PROJECT_ID/regions/REGION_NAME/serviceAttachments/SERVICE_ATTACHMENT_ID",
  "dnsName": "DNS_NAME"
}

Private Service Connect が有効になっているインスタンスには、次のフィールドがあります。

allowedConsumerProjects: このインスタンスに対して許可されているプロジェクトのリスト。これらのプロジェクトの任意の VPC ネットワークからインスタンスのサービスアタッチメントへの Private Service Connect エンドポイントを作成できます。
pscEnabled: インスタンスで Private Service Connect が有効になっているかどうか。
pscServiceAttachmentLink: インスタンスのサービスアタッチメントを指す URI。この URI は、Private Service Connect エンドポイントを作成するときに使用します。
dnsName: インスタンスの DNS 名。この名前で DNS レコードを作成し、Private Service Connect エンドポイントの IP アドレスを指すようにすることをおすすめします。また、インスタンスへの接続にはこの名前を使用することをおすすめします。

このタスクのための基盤となる REST API リクエストを作成する方法については、instances:get のページをご覧ください。

おすすめのアクションがバナー上部に表示されることがあります。

指標

このセクションでは、インスタンスのモニタリングに使用できる重要なインスタンス指標の使用状況のグラフを示します。指標データを使用するときは、次の点に注意してください。

指標のデータポイントは、インスタンスによってホストされているすべてのデータベースを集計したものです。
データは現地時間で表示されます。
表示されたグラフは自動的には更新されません。新しいデータを表示するには、ページを更新する必要があります。
指標データが記録されてから、それが使用状況グラフに表示されるまでに、数分間の遅延があります。

グラフに表示される指標の詳細については、Cloud SQL インスタンスのモニタリングをご覧ください。

Cloud Monitoring が提供する Cloud SQL 指標の詳細については、Cloud SQL 指標リストをご覧ください。

Google Cloud で Cloud Monitoring を使用する方法については、Cloud Monitoring のドキュメントをご覧ください。

このインスタンスとの接続

[このインスタンスとの接続] セクションで、インスタンスの IP アドレス、VPC ネットワーク、接続名を見つけることができます。

ターミナルを開いてインスタンスに接続するには、[Connect using Cloud Shell] をクリックします。

右側のペインで関連するチュートリアルを開くには、[Connect from a Compute Engine VM instance] をクリックします。

[Connection options] に移動するには、[See all connection methods] をクリックします。

インスタンスへの接続の詳細については、接続の概要をご覧ください。

サービスアカウント

このセクションには、インスタンスのサービスアカウントのメールアドレスが表示されます。

詳細については、IAM のサービスアカウントのドキュメントをご覧ください。

構成

このセクションには、インスタンスの現在の構成の設定が表示されます。

構成を変更するには、[構成を編集] をクリックします。

インスタンス構成の編集の詳細については、インスタンスの編集をご覧ください。

オペレーションとログ

このセクションでは、バックアップの作成などの最近のインスタンスオペレーションをリストで示します。

最近のオペレーションを表示するには、[すべてのオペレーションを表示] をクリックします。

ロギング情報を表示するには、[View PostgreSQL Error Logs] をクリックします。

オペレーションと [ログエクスプローラ] ページの詳細については、Cloud SQL ロギングをご覧ください。

ロギングに関する一般的な情報については、ログの表示とログのエクスポートをご覧ください。

メンテナンス

このセクションでは、現在のメンテナンス更新の設定とスケジュールを示します。

設定を変更するには、[メンテナンスの設定を編集] をクリックします。

通知設定を変更するには、[通知設定を編集] をクリックします。

Cloud SQL のメンテナンスの詳細については、メンテナンスの概要をご覧ください。

次のステップ

Cloud SQL の Cloud Monitoring 指標について学習する。
インスタンスの設定について学習する。
インスタンスの編集について学習する。

インスタンスの情報を表示する

インスタンスの概要情報を表示する

コンソール

gcloud

Terraform

変更を適用する

Cloud Shell を準備する

ディレクトリを準備する

変更を適用する

変更を削除する

REST v1

curl（Linux、macOS、Cloud Shell）

PowerShell（Windows）

REST v1beta4

curl（Linux、macOS、Cloud Shell）

PowerShell（Windows）

指標

このインスタンスとの接続

サービス アカウント

構成

オペレーションとログ

メンテナンス

次のステップ

サービスアカウント