MCP Tools Reference: cloud-sql

ツール: get_instance

Cloud SQL インスタンスの詳細を取得します。

次のサンプルは、curl を使用して get_instance MCP ツールを呼び出す方法を示しています。

Curl リクエスト 
                  
curl --location 'https://sqladmin.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "get_instance",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

入力スキーマ

インスタンスの取得リクエスト。

SqlInstancesGetRequest

JSON 表現 
{
  "instance": string,
  "project": string
}
フィールド
instance

string

必須。データベース インスタンス ID。プロジェクト ID は含みません。
project

string

必須。インスタンスを含むプロジェクトのプロジェクト ID。

出力スキーマ

Cloud SQL インスタンス リソース。

DatabaseInstance

JSON 表現 
{
  "kind": string,
  "state": enum (SqlInstanceState),
  "databaseVersion": enum (SqlDatabaseVersion),
  "settings": {
    object (Settings)
  },
  "etag": string,
  "failoverReplica": {
    object (SqlFailoverReplica)
  },
  "masterInstanceName": string,
  "replicaNames": [
    string
  ],
  "maxDiskSize": string,
  "currentDiskSize": string,
  "ipAddresses": [
    {
      object (IpMapping)
    }
  ],
  "serverCaCert": {
    object (SslCert)
  },
  "instanceType": enum (SqlInstanceType),
  "project": string,
  "ipv6Address": string,
  "serviceAccountEmailAddress": string,
  "onPremisesConfiguration": {
    object (OnPremisesConfiguration)
  },
  "replicaConfiguration": {
    object (ReplicaConfiguration)
  },
  "backendType": enum (SqlBackendType),
  "selfLink": string,
  "suspensionReason": [
    enum (SqlSuspensionReason)
  ],
  "connectionName": string,
  "name": string,
  "region": string,
  "gceZone": string,
  "secondaryGceZone": string,
  "diskEncryptionConfiguration": {
    object (DiskEncryptionConfiguration)
  },
  "diskEncryptionStatus": {
    object (DiskEncryptionStatus)
  },
  "rootPassword": string,
  "scheduledMaintenance": {
    object (SqlScheduledMaintenance)
  },
  "satisfiesPzs": boolean,
  "databaseInstalledVersion": string,
  "createTime": string,
  "availableMaintenanceVersions": [
    string
  ],
  "maintenanceVersion": string,
  "upgradableDatabaseVersions": [
    {
      object (AvailableDatabaseVersion)
    }
  ],
  "replicationCluster": {
    object (ReplicationCluster)
  },
  "satisfiesPzi": boolean,
  "tags": {
    string: string,
    ...
  },
  "nodes": [
    {
      object (PoolNodeConfig)
    }
  ],
  "dnsNames": [
    {
      object (DnsNameMapping)
    }
  ],

  // Union field _out_of_disk_report can be only one of the following:
  "outOfDiskReport": {
    object (SqlOutOfDiskReport)
  }
  // End of list of possible types for union field _out_of_disk_report.

  // Union field _sql_network_architecture can be only one of the following:
  "sqlNetworkArchitecture": enum (SqlNetworkArchitecture)
  // End of list of possible types for union field _sql_network_architecture.

  // Union field _psc_service_attachment_link can be only one of the following:
  "pscServiceAttachmentLink": string
  // End of list of possible types for union field _psc_service_attachment_link.

  // Union field _dns_name can be only one of the following:
  "dnsName": string
  // End of list of possible types for union field _dns_name.

  // Union field _primary_dns_name can be only one of the following:
  "primaryDnsName": string
  // End of list of possible types for union field _primary_dns_name.

  // Union field _write_endpoint can be only one of the following:
  "writeEndpoint": string
  // End of list of possible types for union field _write_endpoint.

  // Union field _gemini_config can be only one of the following:
  "geminiConfig": {
    object (GeminiInstanceConfig)
  }
  // End of list of possible types for union field _gemini_config.

  // Union field _switch_transaction_logs_to_cloud_storage_enabled can be only
  // one of the following:
  "switchTransactionLogsToCloudStorageEnabled": boolean
  // End of list of possible types for union field
  // _switch_transaction_logs_to_cloud_storage_enabled.

  // Union field _include_replicas_for_major_version_upgrade can be only one of
  // the following:
  "includeReplicasForMajorVersionUpgrade": boolean
  // End of list of possible types for union field
  // _include_replicas_for_major_version_upgrade.

  // Union field _node_count can be only one of the following:
  "nodeCount": integer
  // End of list of possible types for union field _node_count.
}
フィールド
kind

string

これは常に sql#instance です。
state

enum (SqlInstanceState)

Cloud SQL インスタンスの現在のサービス状態。
databaseVersion

enum (SqlDatabaseVersion)

データベース エンジンの種類とバージョン。databaseVersion フィールドは、インスタンスの作成後に変更できません。
settings

object (Settings)

ユーザー設定。
etag

string

このフィールドはサポートが終了しており、API の将来のバージョンで削除されます。代わりに settings.settingsVersion フィールドを使用してください。
failoverReplica

object (SqlFailoverReplica)

フェイルオーバー レプリカの名前とステータス。
masterInstanceName

string

レプリケーション設定でプライマリとして機能するインスタンスの名前。
replicaNames[]

string

インスタンスのレプリカ。
maxDiskSize
(deprecated)

string (Int64Value format)

インスタンスの最大ディスクサイズ（バイト単位）。
currentDiskSize
(deprecated)

string (Int64Value format)

インスタンスの現在のディスク使用量（バイト単位）。このプロパティはサポート終了されました。代わりに、Cloud Monitoring API で「cloudsql.googleapis.com/database/disk/bytes_used」指標を使用してください。詳しくは、こちらのお知らせをご覧ください。
ipAddresses[]

object (IpMapping)

インスタンスに割り当てられた IP アドレス。
serverCaCert

object (SslCert)

SSL 設定。
instanceType

enum (SqlInstanceType)

インスタンスのタイプ。
project

string

Cloud SQL インスタンスを含むプロジェクトのプロジェクト ID。該当する場合、Google apps ドメインが先頭に追加されます。
ipv6Address
(deprecated)

string

インスタンスに割り当てられた IPv6 アドレス。（非推奨）このプロパティは第 1 世代のインスタンスにのみ適用されていました。
serviceAccountEmailAddress

string

インスタンスに割り当てられたサービス アカウントのメールアドレス。このプロパティは読み取り専用です。
onPremisesConfiguration

object (OnPremisesConfiguration)

オンプレミス インスタンス固有の設定。
replicaConfiguration

object (ReplicaConfiguration)

フェイルオーバー レプリカと読み取りレプリカ固有の設定。
backendType

enum (SqlBackendType)

バックエンド タイプ。SECOND_GEN: Cloud SQL データベース インスタンス。EXTERNAL: Google によって管理されていないデータベース サーバー。

このプロパティは読み取り専用です。settings オブジェクトの tier プロパティを使用して、データベース タイプを決定します。
selfLink

string

このリソースの URI。
suspensionReason[]

enum (SqlSuspensionReason)

インスタンスの状態が SUSPENDED の場合の停止理由。
connectionName

string

接続文字列で使用される Cloud SQL インスタンスの接続名。
name

string

Cloud SQL インスタンスの名前。プロジェクト ID は含みません。
region

string

Cloud SQL インスタンスの地理的リージョン。

Cloud SQL が動作するリージョンのいずれかになります。

たとえば、asia-east1、europe-west1、us-central1 などです。デフォルト値は us-central1 です。
gceZone

string

インスタンスが現在サービスを提供している Compute Engine のゾーン。インスタンスがセカンダリ ゾーンにフェイルオーバーした場合、この値はインスタンスの作成時に指定されたゾーンとは異なる可能性があります。警告: これを変更すると、インスタンスが再起動する可能性があります。
secondaryGceZone

string

リージョン インスタンスのフェイルオーバー インスタンスが現在サービスを提供している Compute Engine のゾーン。インスタンスがセカンダリ ゾーンまたはフェイルオーバー ゾーンにフェイルオーバーした場合、この値はインスタンスの作成時に指定されたゾーンとは異なる可能性があります。
diskEncryptionConfiguration

object (DiskEncryptionConfiguration)

インスタンス固有のディスク暗号化構成。
diskEncryptionStatus

object (DiskEncryptionStatus)

インスタンスに固有のディスクの暗号化ステータス。
rootPassword

string

初期 root パスワード。作成時にのみ使用します。PostgreSQL インスタンスに接続する前に、ルートパスワードを設定する必要があります。
scheduledMaintenance

object (SqlScheduledMaintenance)

このインスタンスに対する次回の定期メンテナンスの開始時刻。
satisfiesPzs

boolean

このステータスは、インスタンスが PZS を満たしているかどうかを示します。

このステータスは将来の使用のために予約されています。
databaseInstalledVersion

string

出力専用。インスタンスで実行されている現在のデータベース バージョン（MYSQL_8_0_18 などのマイナー バージョンを含む）を保存します。
createTime

string (Timestamp format)

出力専用。インスタンスが作成された時刻（RFC 3339 形式）。例: 2012-11-15T16:19:00.094Z。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
availableMaintenanceVersions[]

string

出力専用。インスタンスに適用可能なすべてのメンテナンス バージョンを一覧表示する
maintenanceVersion

string

インスタンスの現在のソフトウェア バージョン。
upgradableDatabaseVersions[]

object (AvailableDatabaseVersion)

出力専用。アップグレードに使用できるすべてのデータベース バージョン。
replicationCluster

object (ReplicationCluster)

省略可。プライマリ インスタンスと障害復旧（DR）レプリカのペア。DR レプリカは、プライマリ インスタンスでリージョン障害が発生した場合にフェイルオーバー用に指定するクロスリージョン レプリカです。MySQL と PostgreSQL に適用されます。
satisfiesPzi

boolean

出力専用。このステータスは、インスタンスが PZI を満たしているかどうかを示します。

このステータスは将来の使用のために予約されています。
tags

map (key: string, value: string)

省略可。入力専用。変更不可。このインスタンスにバインドされているタグキーとタグ値。マップ内の各アイテムは "<tag-key-namespaced-name>" : "<tag-value-short-name>" として表す必要があります。

たとえば、単一のリソースに次のタグを設定できます。

  "123/environment": "production",
  "123/costCenter": "marketing",

タグの作成と管理の詳細については、https://cloud.google.com/resource-manager/docs/tags/tags-overview をご覧ください。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
nodes[]

object (PoolNodeConfig)

出力専用。読み取りプールの各読み取りプール ノードに関する情報を含むエントリ。
dnsNames[]

object (DnsNameMapping)

出力専用。このインスタンスで使用される DNS 名のリスト。

共用体フィールド _out_of_disk_report。

_out_of_disk_report は次のいずれかになります。
outOfDiskReport

object (SqlOutOfDiskReport)

このフィールドは、OutOfDisk の問題について、事前対応型のデータベース健全性ジョブによって生成されたレポートを表します。* ライター: * OOD の事前対応型データベース健全性ジョブ。* 読み取り: * 事前対応型データベース ウェルネス ジョブ

共用体フィールド _sql_network_architecture。

_sql_network_architecture は次のいずれかになります。
sqlNetworkArchitecture

enum (SqlNetworkArchitecture)

共用体フィールド _psc_service_attachment_link。

_psc_service_attachment_link は次のいずれかになります。
pscServiceAttachmentLink

string

出力専用。PSC インスタンスのサービス アタッチメントへのリンク。

共用体フィールド _dns_name。

_dns_name は次のいずれかになります。
dnsName

string

出力専用。インスタンスの DNS 名。

共用体フィールド _primary_dns_name。

_primary_dns_name は次のいずれかになります。
primaryDnsName
(deprecated)

string

出力専用。非推奨: 代わりに write_endpoint を使用してください。

共用体フィールド _write_endpoint。

_write_endpoint は次のいずれかになります。
writeEndpoint

string

出力専用。レプリケーション グループのプライマリ インスタンスの DNS 名。

共用体フィールド _gemini_config。

_gemini_config は次のいずれかになります。
geminiConfig

object (GeminiInstanceConfig)

Gemini インスタンスの構成。

共用体フィールド _switch_transaction_logs_to_cloud_storage_enabled。

_switch_transaction_logs_to_cloud_storage_enabled は次のいずれかになります。
switchTransactionLogsToCloudStorageEnabled

boolean

入力専用。Cloud SQL で、ポイントインタイム リカバリ ログファイルの保存先をデータディスクから Cloud Storage に切り替えることができるかどうか。

共用体フィールド _include_replicas_for_major_version_upgrade。

_include_replicas_for_major_version_upgrade は次のいずれかになります。
includeReplicasForMajorVersionUpgrade

boolean

入力専用。プライマリ インスタンスのメジャー バージョンのインプレース アップグレードが開始されたときに、レプリカのメジャー バージョンのインプレース アップグレードが行われるかどうかを決定します。

共用体フィールド _node_count。

_node_count は次のいずれかになります。
nodeCount

integer

読み取りプール内の読み取りプールノードの数。

設定

JSON 表現 
{
  "settingsVersion": string,
  "authorizedGaeApplications": [
    string
  ],
  "tier": string,
  "kind": string,
  "userLabels": {
    string: string,
    ...
  },
  "availabilityType": enum (SqlAvailabilityType),
  "pricingPlan": enum (SqlPricingPlan),
  "replicationType": enum (SqlReplicationType),
  "storageAutoResizeLimit": string,
  "activationPolicy": enum (SqlActivationPolicy),
  "ipConfiguration": {
    object (IpConfiguration)
  },
  "storageAutoResize": boolean,
  "locationPreference": {
    object (LocationPreference)
  },
  "databaseFlags": [
    {
      object (DatabaseFlags)
    }
  ],
  "dataDiskType": enum (SqlDataDiskType),
  "maintenanceWindow": {
    object (MaintenanceWindow)
  },
  "backupConfiguration": {
    object (BackupConfiguration)
  },
  "databaseReplicationEnabled": boolean,
  "crashSafeReplicationEnabled": boolean,
  "dataDiskSizeGb": string,
  "activeDirectoryConfig": {
    object (SqlActiveDirectoryConfig)
  },
  "collation": string,
  "denyMaintenancePeriods": [
    {
      object (DenyMaintenancePeriod)
    }
  ],
  "insightsConfig": {
    object (InsightsConfig)
  },
  "passwordValidationPolicy": {
    object (PasswordValidationPolicy)
  },
  "sqlServerAuditConfig": {
    object (SqlServerAuditConfig)
  },
  "edition": enum (Edition),
  "connectorEnforcement": enum (ConnectorEnforcement),
  "deletionProtectionEnabled": boolean,
  "timeZone": string,
  "advancedMachineFeatures": {
    object (AdvancedMachineFeatures)
  },
  "dataCacheConfig": {
    object (DataCacheConfig)
  },
  "replicationLagMaxSeconds": integer,
  "enableGoogleMlIntegration": boolean,
  "enableDataplexIntegration": boolean,
  "retainBackupsOnDelete": boolean,
  "entraidConfig": {
    object (SqlServerEntraIdConfig)
  },
  "performanceCaptureConfig": {
    object (PerformanceCaptureConfig)
  },

  // Union field _data_disk_provisioned_iops can be only one of the following:
  "dataDiskProvisionedIops": string
  // End of list of possible types for union field _data_disk_provisioned_iops.

  // Union field _data_disk_provisioned_throughput can be only one of the
  // following:
  "dataDiskProvisionedThroughput": string
  // End of list of possible types for union field
  // _data_disk_provisioned_throughput.

  // Union field _connection_pool_config can be only one of the following:
  "connectionPoolConfig": {
    object (ConnectionPoolConfig)
  }
  // End of list of possible types for union field _connection_pool_config.

  // Union field _final_backup_config can be only one of the following:
  "finalBackupConfig": {
    object (FinalBackupConfig)
  }
  // End of list of possible types for union field _final_backup_config.

  // Union field _read_pool_auto_scale_config can be only one of the following:
  "readPoolAutoScaleConfig": {
    object (ReadPoolAutoScaleConfig)
  }
  // End of list of possible types for union field _read_pool_auto_scale_config.

  // Union field _auto_upgrade_enabled can be only one of the following:
  "autoUpgradeEnabled": boolean
  // End of list of possible types for union field _auto_upgrade_enabled.

  // Union field _data_api_access can be only one of the following:
  "dataApiAccess": enum (DataApiAccess)
  // End of list of possible types for union field _data_api_access.
}
項目
settingsVersion

string (Int64Value format)

インスタンス設定のバージョン。これは、update メソッドで同時更新が適切に処理されるようにするための必須フィールドです。更新中は、このインスタンスの最新の settingsVersion 値を使用し、この値を更新しようとしないでください。
authorizedGaeApplications[]
(deprecated)

string

このインスタンスにアクセスできる App Engine のアプリケーション ID。（非推奨）第 1 世代インスタンスにのみ適用されます。
tier

string

このインスタンスの階層（またはマシンタイプ）。例: db-custom-1-3840。警告: これを変更すると、インスタンスが再起動します。
kind

string

これは常に sql#settings です。
userLabels

map (key: string, value: string)

ユーザーが指定したラベル。各ラベルが単一の Key-Value ペアである辞書として表されます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
availabilityType

enum (SqlAvailabilityType)

可用性タイプ。可能な値: * ZONAL: インスタンスは 1 つのゾーンからのみデータを提供します。そのゾーンが停止するとデータにアクセスできなくなる可能性があります。* REGIONAL: インスタンスはリージョン内の複数のゾーンからデータを提供できます（可用性が高い）。

詳細については、高可用性構成の概要をご覧ください。
pricingPlan

enum (SqlPricingPlan)

このインスタンスの料金プラン。PER_USE または PACKAGE のいずれかを指定できます。第 2 世代インスタンスでは PER_USE のみがサポートされます。
replicationType
(deprecated)

enum (SqlReplicationType)

このインスタンスが使用するレプリケーションの種類。ASYNCHRONOUS または SYNCHRONOUS のいずれかを指定できます。（非推奨）このプロパティは第 1 世代のインスタンスにのみ適用されていました。
storageAutoResizeLimit

string (Int64Value format)

ストレージ容量を自動的に増加できる最大サイズ。デフォルト値は 0 で、この場合制限はありません。
activationPolicy

enum (SqlActivationPolicy)

アクティベーション ポリシーは、インスタンスがいつアクティブになるかを指定します。インスタンスの状態が RUNNABLE の場合にのみ適用されます。有効な値: * ALWAYS: インスタンスはオンで、接続リクエストがない場合でもオンのままです。* NEVER: インスタンスはオフで、接続リクエストが届いてもアクティブになりません。
ipConfiguration

object (IpConfiguration)

IP 管理用の設定。インスタンス IP を有効または無効にしたり、インスタンスに接続できる外部ネットワークを管理することができます。第 2 世代のインスタンスでは、IPv4 アドレスを無効にできません。
storageAutoResize

boolean

ストレージ サイズを自動的に拡大するための設定。デフォルト値は true です。
locationPreference

object (LocationPreference)

望ましい場所の設定。これにより、インスタンスを App Engine アプリまたは Compute Engine ゾーンの近くに配置して、パフォーマンスを向上させることができます。App Engine のコロケーションは、第 1 世代のインスタンスにのみ適用されていました。
databaseFlags[]

object (DatabaseFlags)

起動時にインスタンスに渡されるデータベース フラグ。
dataDiskType

enum (SqlDataDiskType)

データディスクのタイプ: PD_SSD（デフォルト）または PD_HDD。第 1 世代のインスタンスには使用されません。
maintenanceWindow

object (MaintenanceWindow)

このインスタンスのメンテナンス時間枠。メンテナンスのためにインスタンスを再起動できるタイミングを指定します。
backupConfiguration

object (BackupConfiguration)

インスタンスの日次バックアップ設定。
databaseReplicationEnabled

boolean

読み取りレプリカ インスタンス専用の設定。レプリケーションが有効かどうかを示します。警告: これを変更すると、インスタンスが再起動します。
crashSafeReplicationEnabled
(deprecated)

boolean

読み取りレプリカ インスタンス専用の設定。クラッシュセーフ レプリケーションのデータベース フラグが有効化どうかを示します。このプロパティは第 1 世代のインスタンスにのみ適用されていました。
dataDiskSizeGb

string (Int64Value format)

データディスクのサイズ（GB）。データディスクの最小サイズは 10 GB です。
activeDirectoryConfig

object (SqlActiveDirectoryConfig)

Active Directory の構成。Cloud SQL for SQL Server にのみ関連します。
collation

string

サーバー インスタンスの照合順序の名前。
denyMaintenancePeriods[]

object (DenyMaintenancePeriod)

メンテナンス期間を拒否する
insightsConfig

object (InsightsConfig)

分析情報の構成。現時点では Postgres にのみ関連します。
passwordValidationPolicy

object (PasswordValidationPolicy)

インスタンスのローカル ユーザーのパスワード検証ポリシー。
sqlServerAuditConfig

object (SqlServerAuditConfig)

SQL Server 固有の監査構成。
edition

enum (Edition)

省略可。インスタンスのエディション。
connectorEnforcement

enum (ConnectorEnforcement)

接続で Cloud SQL コネクタを使用する必要があるかどうかを指定します。オプション値には、NOT_REQUIRED（Cloud SQL コネクタなしで Cloud SQL インスタンスを接続できる）と REQUIRED（Cloud SQL コネクタを使用する接続のみを許可する）があります。

REQUIRED を使用すると、既存のすべての承認済みネットワークが無効になります。新しいインスタンスの作成時にこのフィールドが指定されていない場合は、NOT_REQUIRED が使用されます。既存のインスタンスにパッチを適用または更新するときにこのフィールドが指定されていない場合、インスタンスでは変更されません。
deletionProtectionEnabled

boolean

インスタンスが誤って削除されないように保護する構成。
timeZone

string

サーバーのタイムゾーン。Cloud SQL for SQL Server にのみ関連します。
advancedMachineFeatures

object (AdvancedMachineFeatures)

SQL Server にのみ関連するインスタンスの詳細なマシン構成を指定します。
dataCacheConfig

object (DataCacheConfig)

データ キャッシュの構成。
replicationLagMaxSeconds

integer

省略可。特定のレプリケーション ラグの後にレプリカを再作成するための構成値
enableGoogleMlIntegration

boolean

省略可。このパラメータを true に設定すると、Cloud SQL インスタンスを Vertex AI に接続して、リアルタイム予測と分析情報のリクエストを AI に渡すことができます。デフォルト値は false です。これは、Cloud SQL for MySQL インスタンスと Cloud SQL for PostgreSQL インスタンスにのみ適用されます。
enableDataplexIntegration

boolean

省略可。デフォルトでは、Cloud SQL インスタンスでは Dataplex のスキーマ抽出が無効になっています。このパラメータを true に設定すると、Cloud SQL インスタンスの Dataplex のスキーマ抽出が有効になります。
retainBackupsOnDelete

boolean

省略可。このパラメータが true に設定されている場合、Cloud SQL はインスタンスが削除された後もインスタンスのバックアップを保持します。ON_DEMAND バックアップは、お客様がバックアップまたはプロジェクトを削除するまで保持されます。自動バックアップは、バックアップの保持設定に基づいて保持されます。
entraidConfig

object (SqlServerEntraIdConfig)

省略可。SQL Server インスタンスの Microsoft Entra ID 構成。
performanceCaptureConfig

object (PerformanceCaptureConfig)

省略可。パフォーマンス キャプチャの構成。高負荷時の診断指標を提供します。

共用体フィールド _data_disk_provisioned_iops。

_data_disk_provisioned_iops は次のいずれかになります。
dataDiskProvisionedIops

string (int64 format)

省略可。データディスクにプロビジョニングされた 1 秒あたりの I/O オペレーション数。このフィールドは、hyperdisk-balanced ディスクタイプでのみ使用されます。

共用体フィールド _data_disk_provisioned_throughput。

_data_disk_provisioned_throughput は次のいずれかになります。
dataDiskProvisionedThroughput

string (int64 format)

省略可。データディスクのプロビジョニングされたスループット（MiB/秒）。このフィールドは、hyperdisk-balanced ディスクタイプでのみ使用されます。

共用体フィールド _connection_pool_config。

_connection_pool_config は次のいずれかになります。
connectionPoolConfig

object (ConnectionPoolConfig)

省略可。インスタンスのマネージド接続プーリング構成。

共用体フィールド _final_backup_config。

_final_backup_config は次のいずれかになります。
finalBackupConfig

object (FinalBackupConfig)

省略可。インスタンスの最終バックアップ構成。

共用体フィールド _read_pool_auto_scale_config。

_read_pool_auto_scale_config は次のいずれかになります。
readPoolAutoScaleConfig

object (ReadPoolAutoScaleConfig)

省略可。インスタンスの読み取りプールの自動スケーリング構成。

共用体フィールド _auto_upgrade_enabled。

_auto_upgrade_enabled は次のいずれかになります。
autoUpgradeEnabled

boolean

省略可。Cloud SQL for MySQL の自動アップグレード構成。このパラメータを true に設定すると、MySQL 8.0 マイナー バージョンで自動アップグレードが有効になります。MySQL のバージョンは 8.0.35 以降である必要があります。

共用体フィールド _data_api_access。

_data_api_access は次のいずれかになります。
dataApiAccess

enum (DataApiAccess)

このパラメータは、ExecuteSql API を使用してインスタンスに接続することを許可するかどうかを制御します。デフォルトでは許可されていません。

Int64Value

JSON 表現 
{
  "value": string
}
フィールド
value

string (int64 format)

int64 値。

UserLabelsEntry

JSON 表現 
{
  "key": string,
  "value": string
}
フィールド
key

string
value

string

IpConfiguration

JSON 表現 
{
  "ipv4Enabled": boolean,
  "privateNetwork": string,
  "requireSsl": boolean,
  "authorizedNetworks": [
    {
      object (AclEntry)
    }
  ],
  "allocatedIpRange": string,
  "enablePrivatePathForGoogleCloudServices": boolean,
  "sslMode": enum (SslMode),
  "customSubjectAlternativeNames": [
    string
  ],

  // Union field _psc_config can be only one of the following:
  "pscConfig": {
    object (PscConfig)
  }
  // End of list of possible types for union field _psc_config.

  // Union field _server_ca_mode can be only one of the following:
  "serverCaMode": enum (CaMode)
  // End of list of possible types for union field _server_ca_mode.

  // Union field _server_ca_pool can be only one of the following:
  "serverCaPool": string
  // End of list of possible types for union field _server_ca_pool.

  // Union field _server_certificate_rotation_mode can be only one of the
  // following:
  "serverCertificateRotationMode": enum (ServerCertificateRotationMode)
  // End of list of possible types for union field
  // _server_certificate_rotation_mode.
}
フィールド
ipv4Enabled

boolean

インスタンスにパブリック IP アドレスが割り当てられているかどうか。
privateNetwork

string

プライベート IP で Cloud SQL インスタンスにアクセス可能な VPC ネットワークのリソースリンク。（例: /projects/myProject/global/networks/default）。この設定は変更できますが、設定後に削除することはできません。
requireSsl

boolean

ssl_mode を代わりに使用してください。

IP 経由の SSL/TLS 接続を適用するかどうか。false に設定すると、非 SSL/非 TLS 接続と SSL/TLS 接続の両方が許可されます。SSL/TLS 接続の場合、クライアント証明書は検証されません。true に設定すると、SSL/TLS で暗号化され、有効なクライアント証明書を有する接続のみが許可されます。有効なクライアント証明書の要件を適用せずに SSL/TLS を適用する場合は、require_ssl フラグではなく ssl_mode フラグを使用します。
authorizedNetworks[]

object (AclEntry)

IP を使用したインスタンスへの接続を許可する外部ネットワークのリスト。CIDR 表記（「スラッシュ」表記とも呼びます。例: 157.197.200.0/24）。
allocatedIpRange

string

プライベート IP Cloud SQL インスタンスに割り振られた IP 範囲の名前。（「google-managed-services-default」など）。設定されている場合、インスタンス IP は割り当てられた範囲で作成されます。範囲名は RFC 1035 に準拠している必要があります。具体的には、名前は長さが 1 ～ 63 文字で、正規表現 [a-z]([-a-z0-9]*[a-z0-9])?. に一致している必要があります。
enablePrivatePathForGoogleCloudServices

boolean

BigQuery などの Google サービスからプライベート IP インスタンスへの接続を制御します。
sslMode

enum (SslMode)

データベース接続で SSL/TLS を適用する方法を指定します。下位互換性のために require_ssl フラグを使用する必要がある場合は、次の値のペアのみが有効です。

PostgreSQL と MySQL の場合:

  • ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED と require_ssl=false
  • ssl_mode=ENCRYPTED_ONLY と require_ssl=false
  • ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED と require_ssl=true

SQL Server の場合:

  • ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED と require_ssl=false
  • ssl_mode=ENCRYPTED_ONLY と require_ssl=true

ssl_mode の値は require_ssl の値よりも優先されます。

たとえば、ペア ssl_mode=ENCRYPTED_ONLY と require_ssl=false の場合、ssl_mode=ENCRYPTED_ONLY は SSL 接続のみを受け入れることを意味し、require_ssl=false は非 SSL 接続と SSL 接続の両方を受け入れることを意味します。この場合、MySQL データベースと PostgreSQL データベースは ssl_mode を尊重し、SSL 接続のみを受け入れます。
customSubjectAlternativeNames[]

string

省略可。Cloud SQL インスタンスのカスタム サブジェクト代替名（SAN）。

共用体フィールド _psc_config。

_psc_config は次のいずれかになります。
pscConfig

object (PscConfig)

このインスタンスの PSC 設定。

共用体フィールド _server_ca_mode。

_server_ca_mode は次のいずれかになります。
serverCaMode

enum (CaMode)

サーバー証明書に使用する CA のタイプを指定します。

共用体フィールド _server_ca_pool。

_server_ca_pool は次のいずれかになります。
serverCaPool

string

省略可。server_ca_mode が CUSTOMER_MANAGED_CAS_CA のインスタンスのサーバー CA プールのリソース名。形式: projects/{PROJECT}/locations/{REGION}/caPools/{CA_POOL_ID}

共用体フィールド _server_certificate_rotation_mode。

_server_certificate_rotation_mode は次のいずれかになります。
serverCertificateRotationMode

enum (ServerCertificateRotationMode)

省略可。サーバー証明書の自動ローテーション機能を制御します。この機能はデフォルトでは無効になっています。有効にすると、サーバー証明書は、有効期限が切れる最大 6 か月前の Cloud SQL の定期メンテナンスまたはセルフサービス メンテナンスの更新中に自動的にローテーションされます。この設定は、server_ca_mode が GOOGLE_MANAGED_CAS_CA または CUSTOMER_MANAGED_CAS_CA のいずれかの場合にのみ設定できます。

BoolValue

JSON 表現 
{
  "value": boolean
}
フィールド
value

boolean

ブール値。

AclEntry

JSON 表現 
{
  "value": string,
  "expirationTime": string,
  "name": string,
  "kind": string
}
フィールド
value

string

アクセス制御リストの許可リスト値。
expirationTime

string (Timestamp format)

このアクセス制御エントリが期限切れになる時刻を、RFC 3339 形式で表したもの。例: 2012-11-15T16:19:00.094Z。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
name

string

省略可。このエントリを識別するラベル。
kind

string

これは常に sql#aclEntry です。

タイムスタンプ

JSON 表現 
{
  "seconds": string,
  "nanos": integer
}
フィールド
seconds

string (int64 format)

UNIX エポック 1970-01-01T00:00:00Z からの UTC 時刻の秒数を表します。-62135596800～253402300799 の範囲（両端を含む）にする必要があります（これは 0001-01-01T00:00:00Z～9999-12-31T23:59:59Z に対応します）。
nanos

integer

ナノ秒分解能による、秒の負ではない小数以下部分。このフィールドは、秒の代替ではなく、期間のナノ秒部分です。小数以下を含む負の秒の値は、時間を前方にカウントする負ではない nanos 値を持つ必要があります。0～999,999,999 にする必要があります（両端を含む）。

PscConfig

JSON 表現 
{
  "allowedConsumerProjects": [
    string
  ],
  "pscAutoConnections": [
    {
      object (PscAutoConnectionConfig)
    }
  ],
  "networkAttachmentUri": string,

  // Union field _psc_enabled can be only one of the following:
  "pscEnabled": boolean
  // End of list of possible types for union field _psc_enabled.
}
フィールド
allowedConsumerProjects[]

string

省略可。このインスタンスへの PSC 接続が許可リストに登録されているコンシューマー プロジェクトのリスト。このインスタンスには、これらのプロジェクトの任意のネットワークから PSC で接続できます。

このリストの各コンシューマー プロジェクトは、プロジェクト番号（数値）またはプロジェクト ID（英数字）で表されます。
pscAutoConnections[]

object (PscAutoConnectionConfig)

省略可。この Cloud SQL インスタンスへの接続に使用できる、リクエストされた Private Service Connect コンシューマー エンドポイントの設定のリスト。
networkAttachmentUri

string

省略可。Private Service Connect 対応の Cloud SQL インスタンスが PSC インターフェース経由で接続することを承認されているコンシューマー ネットワークのネットワーク アタッチメント。形式: projects/PROJECT/regions/REGION/networkAttachments/ID

共用体フィールド _psc_enabled。

_psc_enabled は次のいずれかになります。
pscEnabled

boolean

このインスタンスで PSC 接続が有効になっているかどうか。

PscAutoConnectionConfig

JSON 表現 
{
  "consumerProject": string,
  "consumerNetwork": string,

  // Union field _ip_address can be only one of the following:
  "ipAddress": string
  // End of list of possible types for union field _ip_address.

  // Union field _status can be only one of the following:
  "status": string
  // End of list of possible types for union field _status.

  // Union field _consumer_network_status can be only one of the following:
  "consumerNetworkStatus": string
  // End of list of possible types for union field _consumer_network_status.
}
フィールド
consumerProject

string

省略可。これは、このコンシューマー エンドポイントのコンシューマー サービス プロジェクトのプロジェクト ID です。

省略可。これは、consumer_network が共有 VPC ネットワークの場合にのみ適用されます。
consumerNetwork

string

省略可。このコンシューマー エンドポイントのコンシューマー ネットワーク。これは、ホスト プロジェクトとネットワーク名の両方を含むリソースパスである必要があります。

例: projects/project1/global/networks/network1

このネットワークのコンシューマー ホスト プロジェクトは、コンシューマー サービス プロジェクトとは異なる場合があります。

共用体フィールド _ip_address。

_ip_address は次のいずれかになります。
ipAddress

string

コンシューマー エンドポイントの IP アドレス。

共用体フィールド _status。

_status は次のいずれかになります。
status

string

コンシューマー エンドポイントの接続ステータス。

共用体フィールド _consumer_network_status。

_consumer_network_status は次のいずれかになります。
consumerNetworkStatus

string

コンシューマー ネットワークの接続ポリシーのステータス。

LocationPreference

JSON 表現 
{
  "followGaeApplication": string,
  "zone": string,
  "secondaryZone": string,
  "kind": string
}
フィールド
followGaeApplication
(deprecated)

string

どの App Engine アプリケーションの近くに配置するかを示します。Cloud SQL インスタンスと同じリージョンにあることが必要です。警告: これを変更すると、インスタンスが再起動する可能性があります。
zone

string

優先する Compute Engine ゾーン（us-central1-a、us-central1-b など）。警告: これを変更すると、インスタンスが再起動する可能性があります。
secondaryZone

string

セカンダリ/フェイルオーバー用の優先 Compute Engine ゾーン（us-central1-a、us-central1-b など）。このフィールドを無効にするには、「no_secondary_zone」に設定します。
kind

string

これは常に sql#locationPreference です。

DatabaseFlags

JSON 表現 
{
  "name": string,
  "value": string
}
フィールド
name

string

フラグの名前。これらのフラグはインスタンスの起動時に渡されるため、サーバー オプションとシステム変数の両方が含まれます。フラグは、ハイフンではなくアンダースコアで指定します。詳細については、Cloud SQL ドキュメントのデータベース フラグの構成をご覧ください。
value

string

フラグの値。ブール値フラグは、true の場合は on、false の場合は off に設定されます。フラグが値をとらない場合は、このフィールドを省略する必要があります。

MaintenanceWindow

JSON 表現 
{
  "hour": integer,
  "day": integer,
  "updateTrack": enum (SqlUpdateTrack),
  "kind": string
}
フィールド
hour

integer

時間（0 ～ 23）。UTC タイムゾーンで指定します。
day

integer

曜日 - MONDAY、TUESDAY、WEDNESDAY、THURSDAY、FRIDAY、SATURDAY、SUNDAY。UTC タイムゾーンで指定します。出力で 1 ～ 7 の整数として返されます。1 は月曜日です。
updateTrack

enum (SqlUpdateTrack)

メンテナンスのタイミング設定: canary、stable、または week5。詳細については、Cloud SQL インスタンスでのメンテナンスについてをご覧ください。
kind

string

これは常に sql#maintenanceWindow です。

Int32Value

JSON 表現 
{
  "value": integer
}
フィールド
value

integer

int32 値。

BackupConfiguration

JSON 表現 
{
  "startTime": string,
  "enabled": boolean,
  "kind": string,
  "binaryLogEnabled": boolean,
  "replicationLogArchivingEnabled": boolean,
  "location": string,
  "pointInTimeRecoveryEnabled": boolean,
  "backupRetentionSettings": {
    object (BackupRetentionSettings)
  },
  "transactionLogRetentionDays": integer,

  // Union field _transactional_log_storage_state can be only one of the
  // following:
  "transactionalLogStorageState": enum (TransactionalLogStorageState)
  // End of list of possible types for union field
  // _transactional_log_storage_state.

  // Union field _backup_tier can be only one of the following:
  "backupTier": enum (BackupTier)
  // End of list of possible types for union field _backup_tier.
}
フィールド
startTime

string

日次バックアップ設定の開始時刻を、UTC タイムゾーンの 24 時間形式（HH:MM）で表したもの。
enabled

boolean

この設定が有効かどうか。
kind

string

これは常に sql#backupConfiguration です。
binaryLogEnabled

boolean

（MySQL のみ）バイナリログが有効かどうか。バックアップ構成が無効になっている場合は、バイナリログも無効にする必要があります。
replicationLogArchivingEnabled

boolean

将来の使用のために予約。
location

string

バックアップのロケーション
pointInTimeRecoveryEnabled

boolean

ポイントインタイム リカバリが有効かどうか。
backupRetentionSettings

object (BackupRetentionSettings)

バックアップ保持設定。
transactionLogRetentionDays

integer

ポイントインタイム リストアのために保持するトランザクション ログの日数（1 ～ 7）。

共用体フィールド _transactional_log_storage_state。

_transactional_log_storage_state は次のいずれかになります。
transactionalLogStorageState

enum (TransactionalLogStorageState)

出力専用。この値には、データベースのポイントインタイム リカバリ（PITR）の実行に使用されるトランザクション ログの保存場所が含まれます。

共用体フィールド _backup_tier。

_backup_tier は次のいずれかになります。
backupTier

enum (BackupTier)

出力専用。インスタンスのバックアップを管理するバックアップ ティア。

BackupRetentionSettings

JSON 表現 
{
  "retentionUnit": enum (RetentionUnit),
  "retainedBackups": integer
}
フィールド
retentionUnit

enum (RetentionUnit)

retained_backups が表す単位。
retainedBackups

integer

これは、retention_unit の値に応じて、バックアップを削除する必要があるかどうかを判断するために使用されます。retention_unit が「COUNT」の場合、この数のバックアップが保持されます。

SqlActiveDirectoryConfig

JSON 表現 
{
  "kind": string,
  "domain": string,
  "mode": enum (ActiveDirectoryMode),
  "dnsServers": [
    string
  ],
  "adminCredentialSecretName": string,
  "organizationalUnit": string
}
フィールド
kind

string

常に sql#activeDirectoryConfig になります。
domain

string

ドメインの名前（例: mydomain.com）。
mode

enum (ActiveDirectoryMode)

省略可。Active Directory 構成のモード。
dnsServers[]

string

省略可。Active Directory のブートストラップに使用されるドメイン コントローラの IPv4 アドレス。
adminCredentialSecretName

string

省略可。管理者認証情報を保存するシークレット マネージャー キー。（例: projects/{project}/secrets/{secret}）。
organizationalUnit

string

省略可。組織部門の識別名。これは、組織部門への完全な階層パスです。

DenyMaintenancePeriod

JSON 表現 
{
  "startDate": string,
  "endDate": string,
  "time": string
}
フィールド
startDate

string

「メンテナンス拒否期間」の開始日。開始日の年が空の場合、終了日の年も空にする必要があります。この場合、メンテナンス拒否期間が毎年繰り返されることを意味します。日付は yyyy-mm-dd 形式（2020-11-01、または mm-dd（例: 11-01
endDate

string

「メンテナンス拒否期間」の終了日。終了日の年が空の場合、開始日の年も空にする必要があります。この場合、メンテナンスなしの間隔が毎年繰り返されることを意味します。日付は yyyy-mm-dd 形式（2020-11-01、または mm-dd（例: 11-01
time

string

start_date にメンテナンス拒否期間が開始し、end_date に終了する UTC 時間。時刻は HH:mm:SS 形式です。00:00:00

InsightsConfig

JSON 表現 
{
  "queryInsightsEnabled": boolean,
  "recordClientAddress": boolean,
  "recordApplicationTags": boolean,
  "queryStringLength": integer,
  "queryPlansPerMinute": integer,
  "enhancedQueryInsightsEnabled": boolean
}
フィールド
queryInsightsEnabled

boolean

Query Insights 機能が有効かどうか。
recordClientAddress

boolean

有効にしたときに Query Insights がクライアント アドレスを記録するかどうか。
recordApplicationTags

boolean

Query Insights を有効にした際にクエリのアプリケーション タグを記録するかどうか。
queryStringLength

integer

保存されるクエリの最大長（バイト単位）。デフォルト値: 1,024 バイト。範囲: 256 ～ 4,500 バイト。このフィールドの値を超えるクエリの長さは、この値に切り捨てられます。設定されていない場合、クエリ長はデフォルト値になります。クエリの長さを変更すると、データベースが再起動します。
queryPlansPerMinute

integer

すべてのクエリを合計した 1 分間に Insights によってキャプチャされたクエリ実行プランの数。デフォルトは 5 です。
enhancedQueryInsightsEnabled

boolean

省略可。強化された Query Insights 機能が有効かどうか。

PasswordValidationPolicy

JSON 表現 
{
  "minLength": integer,
  "complexity": enum (Complexity),
  "reuseInterval": integer,
  "disallowUsernameSubstring": boolean,
  "passwordChangeInterval": string,
  "enablePasswordPolicy": boolean,
  "disallowCompromisedCredentials": boolean
}
フィールド
minLength

integer

使用できる最小文字数。
complexity

enum (Complexity)

パスワードの複雑さ。
reuseInterval

integer

再利用できない以前のパスワードの数。
disallowUsernameSubstring

boolean

パスワードの一部としてユーザー名を許可しない。
passwordChangeInterval

string (Duration format)

パスワードを変更できる最小間隔。このフラグは PostgreSQL でのみサポートされています。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
enablePasswordPolicy

boolean

パスワード ポリシーを有効にするかどうか。有効にすると、パスワードは複雑さの要件を満たす必要があります。不正アクセスを防ぐため、このポリシーは有効にしておくことをおすすめします。このポリシーを無効にすると、強度の低いパスワードが許可されます。
disallowCompromisedCredentials
(deprecated)

boolean

このフィールドは非推奨であり、API の将来のバージョンで削除されます。

所要時間

JSON 表現 
{
  "seconds": string,
  "nanos": integer
}
フィールド
seconds

string (int64 format)

期間の符号付き秒数。-315,576,000,000 ～+315,576,000,000 の範囲（両端を含む）にする必要があります。注: これらの境界は、60 秒/分 * 60 分/時間 * 24 時間/日 * 365.25 日/年 * 10,000 年から計算されます。
nanos

integer

期間のナノ秒分解能による、秒の符号付き小数以下部分。1 秒未満の期間は、0 の seconds フィールドと正または負の nanos フィールドで表されます。1 秒以上の期間の場合、nanos フィールドのゼロ以外の値は、seconds フィールドと同じ符号である必要があります。-999,999,999～+999,999,999 の範囲内（境界含む）である必要があります。

SqlServerAuditConfig

JSON 表現 
{
  "kind": string,
  "bucket": string,
  "retentionInterval": string,
  "uploadInterval": string
}
フィールド
kind

string

常に sql#sqlServerAuditConfig になります。
bucket

string

転送先バケットの名前（例: gs://mybucket）。
retentionInterval

string (Duration format)

生成された監査ファイルの保持期間。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
uploadInterval

string (Duration format)

生成された監査ファイルをアップロードする頻度。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

AdvancedMachineFeatures

JSON 表現 
{
  "threadsPerCore": integer
}
フィールド
threadsPerCore

integer

物理コアあたりのスレッド数。

DataCacheConfig

JSON 表現 
{
  "dataCacheEnabled": boolean
}
フィールド
dataCacheEnabled

boolean

インスタンスでデータ キャッシュが有効になっているかどうか。

ConnectionPoolConfig

JSON 表現 
{
  "flags": [
    {
      object (ConnectionPoolFlags)
    }
  ],

  // Union field _connection_pooling_enabled can be only one of the following:
  "connectionPoolingEnabled": boolean
  // End of list of possible types for union field _connection_pooling_enabled.

  // Union field _pooler_count can be only one of the following:
  "poolerCount": integer
  // End of list of possible types for union field _pooler_count.
}
フィールド
flags[]

object (ConnectionPoolFlags)

省略可。接続プール構成フラグのリスト。

共用体フィールド _connection_pooling_enabled。

_connection_pooling_enabled は次のいずれかになります。
connectionPoolingEnabled

boolean

マネージド接続プーリングが有効かどうか。

共用体フィールド _pooler_count。

_pooler_count は次のいずれかになります。
poolerCount

integer

出力専用。接続プーラーの数。

ConnectionPoolFlags

JSON 表現 
{
  "name": string,
  "value": string
}
フィールド
name

string

必須。フラグの名前。
value

string

必須。フラグの値。ブール値フラグは、true の場合は on、false の場合は off に設定されます。フラグが値をとらない場合は、このフィールドを省略する必要があります。

FinalBackupConfig

JSON 表現 
{

  // Union field _enabled can be only one of the following:
  "enabled": boolean
  // End of list of possible types for union field _enabled.

  // Union field _retention_days can be only one of the following:
  "retentionDays": integer
  // End of list of possible types for union field _retention_days.
}
フィールド

共用体フィールド _enabled。

_enabled は次のいずれかになります。
enabled

boolean

インスタンスで最終バックアップが有効になっているかどうか。

共用体フィールド _retention_days。

_retention_days は次のいずれかになります。
retentionDays

integer

インスタンスの削除後に最終バックアップを保持する日数。最終バックアップは、（インスタンス削除時刻 + 保持日数）に削除されます。

ReadPoolAutoScaleConfig

JSON 表現 
{
  "targetMetrics": [
    {
      object (TargetMetric)
    }
  ],

  // Union field _enabled can be only one of the following:
  "enabled": boolean
  // End of list of possible types for union field _enabled.

  // Union field _min_node_count can be only one of the following:
  "minNodeCount": integer
  // End of list of possible types for union field _min_node_count.

  // Union field _max_node_count can be only one of the following:
  "maxNodeCount": integer
  // End of list of possible types for union field _max_node_count.

  // Union field _disable_scale_in can be only one of the following:
  "disableScaleIn": boolean
  // End of list of possible types for union field _disable_scale_in.

  // Union field _scale_in_cooldown_seconds can be only one of the following:
  "scaleInCooldownSeconds": integer
  // End of list of possible types for union field _scale_in_cooldown_seconds.

  // Union field _scale_out_cooldown_seconds can be only one of the following:
  "scaleOutCooldownSeconds": integer
  // End of list of possible types for union field _scale_out_cooldown_seconds.
}
フィールド
targetMetrics[]

object (TargetMetric)

省略可。読み取りプールの自動スケーリングのターゲット指標。

共用体フィールド _enabled。

_enabled は次のいずれかになります。
enabled

boolean

読み取りプールの自動スケーリングが有効かどうかを示します。

共用体フィールド _min_node_count。

_min_node_count は次のいずれかになります。
minNodeCount

integer

維持する読み取りプールノードの最小数。

共用体フィールド _max_node_count。

_max_node_count は次のいずれかになります。
maxNodeCount

integer

維持する読み取りプールノードの最大数。

共用体フィールド _disable_scale_in。

_disable_scale_in は次のいずれかになります。
disableScaleIn

boolean

読み取りプールの自動スケーリングがスケールイン オペレーション（ノードの削除）をサポートしているかどうかを示します。

共用体フィールド _scale_in_cooldown_seconds。

_scale_in_cooldown_seconds は次のいずれかになります。
scaleInCooldownSeconds

integer

スケールイン オペレーションのクールダウン期間。

共用体フィールド _scale_out_cooldown_seconds。

_scale_out_cooldown_seconds は次のいずれかになります。
scaleOutCooldownSeconds

integer

スケールアウト オペレーションのクールダウン期間。

TargetMetric

JSON 表現 
{

  // Union field _metric can be only one of the following:
  "metric": string
  // End of list of possible types for union field _metric.

  // Union field _target_value can be only one of the following:
  "targetValue": number
  // End of list of possible types for union field _target_value.
}
フィールド

共用体フィールド _metric。

_metric は次のいずれかになります。
metric

string

自動スケーリングに使用する指標名。

共用体フィールド _target_value。

_target_value は次のいずれかになります。
targetValue

number

指標の目標値。

SqlServerEntraIdConfig

JSON 表現 
{
  "kind": string,
  "tenantId": string,
  "applicationId": string
}
フィールド
kind

string

出力専用。常に sql#sqlServerEntraIdConfig になります。
tenantId

string

省略可。Entra ID 構成のテナント ID。
applicationId

string

省略可。Entra ID 構成のアプリケーション ID。

PerformanceCaptureConfig

JSON 表現 
{

  // Union field _enabled can be only one of the following:
  "enabled": boolean
  // End of list of possible types for union field _enabled.

  // Union field _probing_interval_seconds can be only one of the following:
  "probingIntervalSeconds": integer
  // End of list of possible types for union field _probing_interval_seconds.

  // Union field _probe_threshold can be only one of the following:
  "probeThreshold": integer
  // End of list of possible types for union field _probe_threshold.

  // Union field _running_threads_threshold can be only one of the following:
  "runningThreadsThreshold": integer
  // End of list of possible types for union field _running_threads_threshold.

  // Union field _seconds_behind_source_threshold can be only one of the
  // following:
  "secondsBehindSourceThreshold": integer
  // End of list of possible types for union field
  // _seconds_behind_source_threshold.

  // Union field _transaction_duration_threshold can be only one of the
  // following:
  "transactionDurationThreshold": integer
  // End of list of possible types for union field
  // _transaction_duration_threshold.
}
フィールド

共用体フィールド _enabled。

_enabled は次のいずれかになります。
enabled

boolean

省略可。パフォーマンス キャプチャ機能を有効または無効にします。

共用体フィールド _probing_interval_seconds。

_probing_interval_seconds は次のいずれかになります。
probingIntervalSeconds

integer

省略可。2 つのプローブ間の時間間隔（秒単位）。

共用体フィールド _probe_threshold。

_probe_threshold は次のいずれかになります。
probeThreshold

integer

省略可。インスタンスの状態キャプチャをトリガーするしきい値を超える連続した読み取りの最小数。

共用体フィールド _running_threads_threshold。

_running_threads_threshold は次のいずれかになります。
runningThreadsThreshold

integer

省略可。プライマリでキャプチャをトリガーするために実行されるサーバー スレッドの最小数。

共用体フィールド _seconds_behind_source_threshold。

_seconds_behind_source_threshold は次のいずれかになります。
secondsBehindSourceThreshold

integer

省略可。レプリカでキャプチャをトリガーするために、レプリカがプライマリよりも遅れている必要がある最小秒数。

共用体フィールド _transaction_duration_threshold。

_transaction_duration_threshold は次のいずれかになります。
transactionDurationThreshold

integer

省略可。ウォッチャーがトランザクションの記録を開始するまでにトランザクションが開いている必要がある時間（秒単位）。

SqlFailoverReplica

JSON 表現 
{
  "name": string,
  "available": boolean
}
フィールド
name

string

フェイルオーバー レプリカの名前。インスタンス作成時に指定された場合、インスタンスのフェイルオーバー レプリカが作成されます。名前にはプロジェクト ID は含まれません。
available

boolean

フェイルオーバー レプリカの可用性ステータス。false ステータスは、フェイルオーバー レプリカが同期されていないことを示します。プライマリ インスタンスは、ステータスが true の場合のみフェイルオーバー レプリカにフェイルオーバーできます。

IpMapping

JSON 表現 
{
  "type": enum (SqlIpAddressType),
  "ipAddress": string,
  "timeToRetire": string
}
フィールド
type

enum (SqlIpAddressType)

この IP アドレスの種類。PRIMARY アドレスは、受信接続を受け入れることができる一般公開アドレスです。PRIVATE アドレスは、受信接続を受け入れることができるプライベート アドレスです。OUTGOING アドレスは、インスタンスから送信される接続の送信元アドレスです（サポートされている場合）。
ipAddress

string

割り当てられた IP アドレス。
timeToRetire

string (Timestamp format)

この IP の使用を中止する期限（RFC 3339 形式）。例: 2012-11-15T16:19:00.094Z。このフィールドは、IP の廃止がスケジュールされている場合にのみ使用できます。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

SslCert

JSON 表現 
{
  "kind": string,
  "certSerialNumber": string,
  "cert": string,
  "createTime": string,
  "commonName": string,
  "expirationTime": string,
  "sha1Fingerprint": string,
  "instance": string,
  "selfLink": string
}
フィールド
kind

string

これは常に sql#sslCert です。
certSerialNumber

string

証明書から抽出されたシリアル番号。
cert

string

PEM 表現。
createTime

string (Timestamp format)

証明書が作成された時刻を、RFC 3339 形式で表します。例: 2012-11-15T16:19:00.094Z

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
commonName

string

ユーザー指定の名前。 a～z、A～Z、-、+ 以外は使用できません。
expirationTime

string (Timestamp format)

証明書の期限が切れる時刻を RFC 3339 形式で表します。例: 2012-11-15T16:19:00.094Z。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
sha1Fingerprint

string

Sha1 フィンガープリント
instance

string

データベース インスタンスの名前。
selfLink

string

このリソースの URI。

OnPremisesConfiguration

JSON 表現 
{
  "hostPort": string,
  "kind": string,
  "username": string,
  "password": string,
  "caCertificate": string,
  "clientCertificate": string,
  "clientKey": string,
  "dumpFilePath": string,
  "sourceInstance": {
    object (InstanceReference)
  },
  "selectedObjects": [
    {
      object (SelectedObjects)
    }
  ],
  "sslOption": enum (SslOption)
}
項目
hostPort

string

オンプレミス インスタンスのホストとポート（host:port 形式）。
kind

string

これは常に sql#onPremisesConfiguration です。
username

string

オンプレミス インスタンスに接続するためのユーザー名。
password

string

オンプレミス インスタンスに接続するためのパスワード。
caCertificate

string

信頼できる CA の x509 証明書の PEM 表現。
clientCertificate

string

レプリカの x509 証明書の PEM 表現。
clientKey

string

レプリカの秘密鍵の PEM 表現。対応する公開鍵は、クライアントの証明書でエンコードされます。
dumpFilePath

string

Cloud SQL レプリカを作成するダンプファイル。
sourceInstance

object (InstanceReference)

移行元が Cloud SQL の場合、Cloud SQL インスタンスへの参照。
selectedObjects[]

object (SelectedObjects)

省略可。ユーザーが外部ソース インスタンスからレプリケーション用に選択するオブジェクトのリスト。
sslOption

enum (SslOption)

省略可。オンプレミス ソースへのレプリカ接続の SSL オプション。

InstanceReference

JSON 表現 
{
  "name": string,
  "region": string,
  "project": string
}
フィールド
name

string

参照されている Cloud SQL インスタンスの名前。プロジェクト ID は含みません。
region

string

参照されている Cloud SQL インスタンスのリージョン。
project

string

参照されている Cloud SQL インスタンスのプロジェクト ID。デフォルトは、インスタンスが参照するプロジェクト ID と同じです。

SelectedObjects

JSON 表現 
{
  "database": string
}
フィールド
database

string

必須。移行するデータベースの名前。

ReplicaConfiguration

JSON 表現 
{
  "kind": string,
  "mysqlReplicaConfiguration": {
    object (MySqlReplicaConfiguration)
  },
  "failoverTarget": boolean,
  "cascadableReplica": boolean
}
フィールド
kind

string

これは常に sql#replicaConfiguration です。
mysqlReplicaConfiguration

object (MySqlReplicaConfiguration)

MySQL オンプレミス プライマリ インスタンスから複製する場合の MySQL 固有の設定。ユーザー名、パスワード、証明書、鍵などのレプリケーション設定情報は、インスタンスのメタデータに保存されません。構成情報は、レプリケーション接続をセットアップするためにだけに使われ、MySQL によりデータ ディレクトリの master.info という名前のファイルに保存されます。
failoverTarget

boolean

レプリカがフェイルオーバー ターゲットかどうかを指定します。このフィールドに true が設定されている場合、レプリカはフェイルオーバー レプリカとして指定されます。プライマリ インスタンスが障害になった場合、レプリカ インスタンスが新しいプライマリ インスタンスに昇格します。フェイルオーバー ターゲットに指定できるレプリカは 1 つだけで、レプリカはプライマリ インスタンスと違うゾーンにあることが必要です。
cascadableReplica

boolean

省略可。SQL Server レプリカがカスケード可能なレプリカかどうかを指定します。カスケード可能なレプリカは、その下のレプリカをサポートする SQL Server クロス リージョン レプリカです。

MySqlReplicaConfiguration

JSON 表現 
{
  "dumpFilePath": string,
  "username": string,
  "password": string,
  "connectRetryInterval": integer,
  "masterHeartbeatPeriod": string,
  "caCertificate": string,
  "clientCertificate": string,
  "clientKey": string,
  "sslCipher": string,
  "verifyServerCertificate": boolean,
  "kind": string
}
フィールド
dumpFilePath

string

レプリカ インスタンスの作成元となる、Google Cloud Storage 内の SQL ダンプファイルのパス。URI の形式は gs://bucketName/fileName です。圧縮された gzip ファイル（.gz）もサポートされます。ダンプには、レプリケーションを開始するバイナリログ座標が含まれています。これを実現するには、mysqldump を使用するときに、--master-data に 1 を設定します。
username

string

レプリケーション接続のユーザー名。
password

string

レプリケーション接続のパスワード。
connectRetryInterval

integer

接続再試行までの待ち時間（秒単位）。MySQL のデフォルトは 60 秒です。
masterHeartbeatPeriod

string (Int64Value format)

レプリケーション ハートビートの間隔（ミリ秒単位）。
caCertificate

string

信頼できる CA の x509 証明書の PEM 表現。
clientCertificate

string

レプリカの x509 証明書の PEM 表現。
clientKey

string

レプリカの秘密鍵の PEM 表現。対応する公開鍵は、クライアントの証明書でエンコードされます。
sslCipher

string

SSL 暗号化で使用することが許容される暗号のリスト。
verifyServerCertificate

boolean

SSL ハンドシェイク中に送信する証明書の中の、プライマリ インスタンスの共通名の値を確認するかどうか。
kind

string

これは常に sql#mysqlReplicaConfiguration です。

DiskEncryptionConfiguration

JSON 表現 
{
  "kmsKeyName": string,
  "kind": string
}
フィールド
kmsKeyName

string

ディスクの暗号化用の KMS 鍵のリソース名
kind

string

これは常に sql#diskEncryptionConfiguration です。

DiskEncryptionStatus

JSON 表現 
{
  "kmsKeyVersionName": string,
  "kind": string
}
項目
kmsKeyVersionName

string

Cloud SQL インスタンス リソースを暗号化するために使用される KMS 鍵バージョン
kind

string

これは常に sql#diskEncryptionStatus です。

SqlScheduledMaintenance

JSON 表現 
{
  "startTime": string,
  "canDefer": boolean,
  "canReschedule": boolean,

  // Union field _schedule_deadline_time can be only one of the following:
  "scheduleDeadlineTime": string
  // End of list of possible types for union field _schedule_deadline_time.
}
フィールド
startTime

string (Timestamp format)

このインスタンスに対する次回の定期メンテナンスの開始時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
canDefer
(deprecated)

boolean
canReschedule

boolean

定期メンテナンスのスケジュールを変更可能かどうか。

共用体フィールド _schedule_deadline_time。

_schedule_deadline_time は次のいずれかになります。
scheduleDeadlineTime

string (Timestamp format)

この期限を過ぎてメンテナンスを開始するようにスケジュールを変更することはできません。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

SqlOutOfDiskReport

JSON 表現 
{

  // Union field _sql_out_of_disk_state can be only one of the following:
  "sqlOutOfDiskState": enum (SqlOutOfDiskState)
  // End of list of possible types for union field _sql_out_of_disk_state.

  // Union field _sql_min_recommended_increase_size_gb can be only one of the
  // following:
  "sqlMinRecommendedIncreaseSizeGb": integer
  // End of list of possible types for union field
  // _sql_min_recommended_increase_size_gb.
}
フィールド

共用体フィールド _sql_out_of_disk_state。

_sql_out_of_disk_state は次のいずれかになります。
sqlOutOfDiskState

enum (SqlOutOfDiskState)

このフィールドは、OutOfDisk 問題に対する事前対応型データベース健全性ジョブによって生成された状態を表します。* ライター: * OOD の事前対応型データベース健全性ジョブ。* 読み取り: * 事前対応型データベース ウェルネス ジョブ

共用体フィールド _sql_min_recommended_increase_size_gb。

_sql_min_recommended_increase_size_gb は次のいずれかになります。
sqlMinRecommendedIncreaseSizeGb

integer

推奨される最小増加サイズ（GB）。このフィールドは、フロントエンドと OOD の事前対応型データベース健全性ジョブによって使用されます。* 読者:

AvailableDatabaseVersion

JSON 表現 
{

  // Union field _major_version can be only one of the following:
  "majorVersion": string
  // End of list of possible types for union field _major_version.

  // Union field _name can be only one of the following:
  "name": string
  // End of list of possible types for union field _name.

  // Union field _display_name can be only one of the following:
  "displayName": string
  // End of list of possible types for union field _display_name.
}
フィールド

共用体フィールド _major_version。

_major_version は次のいずれかになります。
majorVersion

string

バージョンのメジャー バージョン名。

共用体フィールド _name。

_name は次のいずれかになります。
name

string

データベース バージョン名。MySQL 8.0 の場合、この文字列はデータベースのメジャー バージョンとマイナー バージョンを提供します。

共用体フィールド _display_name。

_display_name は次のいずれかになります。
displayName

string

データベース バージョンの表示名。

ReplicationCluster

JSON 表現 
{
  "psaWriteEndpoint": string,
  "failoverDrReplicaName": string,
  "drReplica": boolean
}
フィールド
psaWriteEndpoint

string

出力専用。設定されている場合、このフィールドは、このインスタンスにクラスタのプライマリ インスタンスを指すプライベート サービス アクセス（PSA）DNS エンドポイントがあることを示します。このインスタンスがプライマリの場合、DNS エンドポイントはこのインスタンスを指します。切り替えまたはレプリカのフェイルオーバー オペレーションの後、この DNS エンドポイントは昇格したインスタンスを指します。これは読み取り専用のフィールドで、情報としてユーザーに返されます。このフィールドは、スタンドアロン インスタンスにまだ DR レプリカがない場合や、DR レプリカが削除された場合でも存在します。
failoverDrReplicaName

string

省略可。インスタンスがプライマリ インスタンスの場合、このフィールドは障害復旧（DR）レプリカを識別します。DR レプリカは、Enterprise Plus エディションのインスタンスのオプション構成です。インスタンスがリードレプリカの場合、このフィールドは設定されません。このフィールドをレプリカ名に設定して、プライマリ インスタンスの DR レプリカを指定します。レプリカ名を削除して、DR レプリカの指定を削除します。
drReplica

boolean

出力専用。レプリカが DR レプリカかどうかを示す読み取り専用フィールド。インスタンスがプライマリ インスタンスの場合、このフィールドは設定されません。

GeminiInstanceConfig

JSON 表現 
{

  // Union field _entitled can be only one of the following:
  "entitled": boolean
  // End of list of possible types for union field _entitled.

  // Union field _google_vacuum_mgmt_enabled can be only one of the following:
  "googleVacuumMgmtEnabled": boolean
  // End of list of possible types for union field _google_vacuum_mgmt_enabled.

  // Union field _oom_session_cancel_enabled can be only one of the following:
  "oomSessionCancelEnabled": boolean
  // End of list of possible types for union field _oom_session_cancel_enabled.

  // Union field _active_query_enabled can be only one of the following:
  "activeQueryEnabled": boolean
  // End of list of possible types for union field _active_query_enabled.

  // Union field _index_advisor_enabled can be only one of the following:
  "indexAdvisorEnabled": boolean
  // End of list of possible types for union field _index_advisor_enabled.

  // Union field _flag_recommender_enabled can be only one of the following:
  "flagRecommenderEnabled": boolean
  // End of list of possible types for union field _flag_recommender_enabled.
}
フィールド

共用体フィールド _entitled。

_entitled は次のいずれかになります。
entitled

boolean

出力専用。Gemini が有効かどうか。

共用体フィールド _google_vacuum_mgmt_enabled。

_google_vacuum_mgmt_enabled は次のいずれかになります。
googleVacuumMgmtEnabled

boolean

出力専用。掃除機管理が有効かどうか。

共用体フィールド _oom_session_cancel_enabled。

_oom_session_cancel_enabled は次のいずれかになります。
oomSessionCancelEnabled

boolean

出力専用。メモリ不足（OOM）セッションのキャンセルが有効かどうか。

共用体フィールド _active_query_enabled。

_active_query_enabled は次のいずれかになります。
activeQueryEnabled

boolean

出力専用。アクティブ クエリが有効かどうか。

共用体フィールド _index_advisor_enabled。

_index_advisor_enabled は次のいずれかになります。
indexAdvisorEnabled

boolean

出力専用。インデックス アドバイザーが有効かどうか。

共用体フィールド _flag_recommender_enabled。

_flag_recommender_enabled は次のいずれかになります。
flagRecommenderEnabled

boolean

出力専用。フラグの推奨事項が有効かどうか。

TagsEntry

JSON 表現 
{
  "key": string,
  "value": string
}
フィールド
key

string
value

string

PoolNodeConfig

JSON 表現 
{
  "ipAddresses": [
    {
      object (IpMapping)
    }
  ],
  "dnsNames": [
    {
      object (DnsNameMapping)
    }
  ],
  "pscAutoConnections": [
    {
      object (PscAutoConnectionConfig)
    }
  ],

  // Union field _name can be only one of the following:
  "name": string
  // End of list of possible types for union field _name.

  // Union field _gce_zone can be only one of the following:
  "gceZone": string
  // End of list of possible types for union field _gce_zone.

  // Union field _dns_name can be only one of the following:
  "dnsName": string
  // End of list of possible types for union field _dns_name.

  // Union field _state can be only one of the following:
  "state": enum (SqlInstanceState)
  // End of list of possible types for union field _state.

  // Union field _psc_service_attachment_link can be only one of the following:
  "pscServiceAttachmentLink": string
  // End of list of possible types for union field _psc_service_attachment_link.
}
フィールド
ipAddresses[]

object (IpMapping)

出力専用。読み取りプールノードへの接続に使用できる IP アドレスを含むマッピング。
dnsNames[]

object (DnsNameMapping)

出力専用。この読み取りプールノードで使用される DNS 名のリスト。
pscAutoConnections[]

object (PscAutoConnectionConfig)

出力専用。この読み取りプールノードへの接続に使用できる、リクエストされた自動設定の Private Service Connect（PSC）コンシューマー エンドポイントの設定のリスト。

共用体フィールド _name。

_name は次のいずれかになります。
name

string

出力専用。指標とログの取得に使用される読み取りプールノードの名前。

共用体フィールド _gce_zone。

_gce_zone は次のいずれかになります。
gceZone

string

出力専用。読み取りプールノードのゾーン。

共用体フィールド _dns_name。

_dns_name は次のいずれかになります。
dnsName

string

出力専用。読み取りプールノードの DNS 名。

共用体フィールド _state。

_state は次のいずれかになります。
state

enum (SqlInstanceState)

出力専用。読み取りプールノードの現在の状態。

共用体フィールド _psc_service_attachment_link。

_psc_service_attachment_link は次のいずれかになります。
pscServiceAttachmentLink

string

出力専用。読み取りプールノードの Private Service Connect（PSC）サービス アタッチメント。

DnsNameMapping

JSON 表現 
{
  "name": string,
  "connectionType": enum (ConnectionType),
  "dnsScope": enum (DnsScope),
  "recordManager": enum (RecordManager)
}
フィールド
name

string

出力専用。DNS 名。
connectionType

enum (ConnectionType)

出力専用。DNS 名の接続タイプ。
dnsScope

enum (DnsScope)

出力専用。DNS 名が適用されるスコープ。
recordManager

enum (RecordManager)

出力専用。この DNS レコードのマネージャー。

ツールのアノテーション

破壊的ヒント: ❌ | べき等ヒント: ❌ | 読み取り専用ヒント: ✅ | オープン ワールド ヒント: ❌