インスタンス

Cloud SQL インスタンスを表します。Cloud SQL インスタンスは、Google のクラウドでホストされている SQL データベースです。Instances リソースは、一般的な設定作業と管理作業のためのメソッドを備えています。詳細については、インスタンスを作成するインスタンスの設定をご覧ください。

このリソースのメソッドのリストについては、このページの末尾をご覧ください。

リソースの表記

Instance リソース。

{
  "kind": "sql#instance",
  "selfLink": string,
  "name": string,
  "connectionName": string,
  "etag": etag,
  "project": string,
  "state": string,
  "backendType": string,
  "databaseVersion": string,
  "region": string,
  "currentDiskSize": long,
  "maxDiskSize": long,
  "settings": {
    "kind": "sql#settings",
    "settingsVersion": long,
    "authorizedGaeApplications": [
      string
    ],
    "tier": string,
    "backupConfiguration": {
      "kind": "sql#backupConfiguration",
      "startTime": string,
      "enabled": boolean,
      "binaryLogEnabled": boolean
    },
    "pricingPlan": string,
    "replicationType": string,
    "activationPolicy": string,
    "ipConfiguration": {
      "ipv4Enabled": boolean,
      "authorizedNetworks": [
        {
          "kind": "sql#aclEntry",
          "value": string,
          "name": string,
          "expirationTime": datetime
        }
      ],
      "requireSsl": boolean
    },
    "locationPreference": {
      "kind": "sql#locationPreference",
      "followGaeApplication": string,
      "zone": string
    },
    "databaseFlags": [
      {
        "name": string,
        "value": string
      }
    ],
    "databaseReplicationEnabled": boolean,
    "crashSafeReplicationEnabled": boolean,
    "dataDiskSizeGb": long,
    "dataDiskType": string,
    "maintenanceWindow": {
      "kind": "sql#maintenanceWindow",
      "hour": integer,
      "day": integer,
      "updateTrack": string
    },
    "storageAutoResize": boolean,
    "storageAutoResizeLimit": long,
    "availabilityType": string,
    "labels": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "serverCaCert": sslCerts Resource,
  "ipAddresses": [
    {
      "ipAddress": string,
      "timeToRetire": datetime,
      "type": string
    }
  ],
  "instanceType": string,
  "masterInstanceName": string,
  "replicaNames": [
    string
  ],
  "failoverReplica": {
    "name": string,
    "available": boolean
  },
  "ipv6Address": string,
  "serviceAccountEmailAddress": string,
  "onPremisesConfiguration": {
    "kind": "sql#onPremisesConfiguration",
    "hostPort": string
  },
  "replicaConfiguration": {
    "kind": "sql#replicaConfiguration",
    "mysqlReplicaConfiguration": {
      "kind": "sql#mysqlReplicaConfiguration",
      "dumpFilePath": string,
      "username": string,
      "password": string,
      "connectRetryInterval": integer,
      "masterHeartbeatPeriod": long,
      "caCertificate": string,
      "clientCertificate": string,
      "clientKey": string,
      "sslCipher": string,
      "verifyServerCertificate": boolean
    },
    "failoverTarget": boolean
  },
  "suspensionReason": [
    string
  ]
}
プロパティ名 説明 メモ
backendType string
FIRST_GEN: 第 1 世代のインスタンス。MySQL のみです。
SECOND_GEN: 第 2 世代のインスタンスまたは PostgreSQL インスタンス。
EXTERNAL: Google で管理されていないデータベース サーバー。
connectionName string 接続文字列で使用される Cloud SQL インスタンスの接続名。
currentDiskSize long インスタンスの現在のディスク使用量(バイト単位)。このプロパティはサポート終了されました。代わりに、Cloud Monitoring API の「cloudsql.googleapis.com/database/disk/bytes_used」指標を使用してください。詳細は、https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ をご覧ください。
databaseVersion string データベース エンジンの種類とバージョン。第 1 世代のインスタンスの場合は、MYSQL_5_5MYSQL_5_6 になります。第 2 世代のインスタンスの場合は、MYSQL_5_6MYSQL_5_7 になります。デフォルトは MYSQL_5_6 です。
インスタンス作成後は databaseVersion プロパティを変更できません。
書き込み可能
etag etag リソースの HTTP 1.1 エンティティ タグ
failoverReplica object フェイルオーバー レプリカの名前とステータス。このプロパティは、第 2 世代のインスタンスのみに適用されます。 書き込み可能
failoverReplica.available boolean フェイルオーバー レプリカの可用性ステータス。false ステータスは、フェイルオーバー レプリカが同期されていないことを示します。マスターは、ステータスが true の場合のみフェイルオーバー レプリカにフェイルオーバーできます。
failoverReplica.name string フェイルオーバー レプリカの名前。インスタンス作成時に指定された場合、インスタンスのフェイルオーバー レプリカが作成されます。名前にはプロジェクト ID は含まれていません。このプロパティは、第 2 世代のインスタンスのみに適用されます。 書き込み可能
instanceType string インスタンスの種類。次のいずれかになります。
CLOUD_SQL_INSTANCE: マスターからのレプリケーションが行われていない Cloud SQL インスタンス。
ON_PREMISES_INSTANCE: 顧客の施設内で動作しているインスタンス。
READ_REPLICA_INSTANCE: 読み取りレプリカとして設定されている Cloud SQL インスタンス。
ipAddresses[] list インスタンスに割り当てられた IP アドレス。
ipAddresses[].ipAddress string 割り当てられた IP アドレス。
ipAddresses[].timeToRetire datetime この IP の使用を中止する期限(RFC 3339 形式)。例: 2012-11-15T16:19:00.094Z。このフィールドは、IP の使用中止がスケジュールされている場合のみ使用できます。
ipAddresses[].type string この IP アドレスの種類。PRIMARY アドレスは、受信接続を受け入れることができるアドレスです。OUTGOING アドレスは、インスタンスから送信される接続の送信元アドレス(サポートされている場合)です。
ipv6Address string インスタンスに割り当てられた IPv6 アドレス。このプロパティは、第 1 世代のインスタンスにのみ適用されます。
kind string 常に sql#instance になります。
masterInstanceName string レプリケーション設定でマスターとして振る舞うインスタンスの名前。 書き込み可能
maxDiskSize long インスタンスの最大ディスクサイズ(バイト単位)。
name string Cloud SQL インスタンスの名前。プロジェクト ID は含みません。
onPremisesConfiguration nested object オンプレミス インスタンス固有の設定。 書き込み可能
onPremisesConfiguration.hostPort string オンプレミス インスタンスのホストとポート(host:port 形式)。
onPremisesConfiguration.kind string 常に sql#onPremisesConfiguration になります。
project string Cloud SQL インスタンスを含むプロジェクトのプロジェクト ID。該当する場合、Google apps ドメインが先頭に追加されます。
region string 地理的なリージョン。デフォルトは us-central または us-central1 で、インスタンスのタイプ(第 1 世代または第 2 世代 / PostgreSQL)によって異なります。有効な値の完全なリストについては、インスタンスのロケーションをご覧ください。インスタンス作成後はリージョンを変更できません。 書き込み可能
replicaConfiguration nested object フェイルオーバー レプリカと読み取りレプリカ固有の設定。 書き込み可能
replicaConfiguration.failoverTarget boolean レプリカがフェイルオーバー ターゲットかどうかを指定します。このフィールドに true が設定されている場合、レプリカはフェイルオーバー レプリカとして指定されます。マスター インスタンスが障害になった場合、レプリカ インスタンスが新しいマスター インスタンスに昇格します。

フェイルオーバー ターゲットに指定できるレプリカは 1 つだけで、レプリカはマスター インスタンスと違うゾーンにあることが必要です。

書き込み可能
replicaConfiguration.kind string 常に sql#replicaConfiguration になります。
replicaConfiguration.mysqlReplicaConfiguration nested object MySQL オンプレミス マスターから複製する場合の MySQL 固有の設定。ユーザー名、パスワード、証明書、鍵などのレプリケーション設定情報は、インスタンスのメタデータに保存されません。設定情報は、レプリケーション接続をセットアップするためにだけに使われ、MySQL によりデータ ディレクトリの master.info という名前のファイルに保存されます。 書き込み可能
replicaConfiguration.mysqlReplicaConfiguration.caCertificate string 信頼できる CA の x509 証明書の PEM 表現。 書き込み可能
replicaConfiguration.mysqlReplicaConfiguration.clientCertificate string スレーブの x509 証明書の PEM 表現。 書き込み可能
replicaConfiguration.mysqlReplicaConfiguration.clientKey string スレーブの秘密鍵の PEM 表現。対応する公開鍵は、クライアントの証明書でエンコードされます。 書き込み可能
replicaConfiguration.mysqlReplicaConfiguration.connectRetryInterval integer 接続再試行までの待ち時間(秒単位)。MySQL のデフォルトは 60 秒です。 書き込み可能
replicaConfiguration.mysqlReplicaConfiguration.dumpFilePath string スレーブ インスタンスの作成元となる、Google Cloud Storage 内の SQL ダンプファイルのパス。URI の形式は gs://bucketName/fileName です。圧縮された gzip ファイル(.gz)もサポートされます。ダンプには、レプリケーションを開始するバイナリログ座標が含まれている必要があります。これを実現するには、mysqldump を使用するときに、--master-data に 1 を設定します。 書き込み可能
replicaConfiguration.mysqlReplicaConfiguration.kind string 常に sql#mysqlReplicaConfiguration になります。
replicaConfiguration.mysqlReplicaConfiguration.masterHeartbeatPeriod long レプリケーション ハートビートの間隔(ミリ秒単位)。 書き込み可能
replicaConfiguration.mysqlReplicaConfiguration.password string レプリケーション接続のパスワード。 書き込み可能
replicaConfiguration.mysqlReplicaConfiguration.sslCipher string SSL 暗号化で使用することが許容される暗号のリスト。 書き込み可能
replicaConfiguration.mysqlReplicaConfiguration.username string レプリケーション接続のユーザー名。 書き込み可能
replicaConfiguration.mysqlReplicaConfiguration.verifyServerCertificate boolean SSL ハンドシェイク中に送信する証明書の中の、マスターの共通名の値を確認するかどうか。 書き込み可能
replicaNames[] list インスタンスのレプリカ。
serverCaCert nested object SSL 設定。
serviceAccountEmailAddress string インスタンスに割り当てられたサービス アカウントのメールアドレス。このプロパティは、第 2 世代のインスタンスのみに適用されます。
settings nested object ユーザー設定。
settings.activationPolicy string アクティベーション ポリシーは、いつインスタンスをアクティブ化するかを指定します。インスタンスの状態が RUNNABLE の場合のみ適用されます。有効な値は以下のとおりです。
ALWAYS: インスタンスは機能している状態です。アクティベーション ポリシーにより、インスタンスが接続リクエストに応答するかどうかが決まります。
NEVER: インスタンスはオフ状態です。接続リクエストが到着してもアクティブ化されません。
ON_DEMAND: インスタンスは受信したリクエストに応答し、使用中でないときは自動的にオフになります。PER_USE 料金のインスタンスは、アクティブでない状態が 15 分続くとオフになります。PER_PACKAGE 料金のインスタンスは、アクティブでない状態が 12 時間続くとオフになります。
書き込み可能
settings.authorizedGaeApplications[] list このインスタンスにアクセスできる App Engine のアプリケーション ID。このプロパティは、第 1 世代のインスタンスのみに適用されます。 書き込み可能
settings.availabilityType string 将来の使用のために予約。
settings.backupConfiguration nested object インスタンスの日次バックアップ設定。 書き込み可能
settings.backupConfiguration.binaryLogEnabled boolean バイナリログが有効かどうか。バックアップ設定が無効になっている場合は、バイナリログも無効にする必要があります。 書き込み可能
settings.backupConfiguration.enabled boolean この設定が有効かどうか。 書き込み可能
settings.backupConfiguration.kind string 常に sql#backupConfiguration になります。
settings.backupConfiguration.startTime string 日次バックアップ設定の開始時刻を、UTC タイムゾーンの 24 時間形式(HH:MM)で表したもの。 書き込み可能
settings.crashSafeReplicationEnabled boolean 読み取りレプリカ インスタンス専用の設定。クラッシュセーフ レプリケーションのデータベース フラグが有効化どうかを示します。このプロパティは、第 1 世代のインスタンスのみに適用されます。 書き込み可能
settings.dataDiskSizeGb long データディスクのサイズ(GB 単位)。最小データディスク サイズは 10 GB です。第 2 世代のインスタンスのみに適用されます。 書き込み可能
settings.dataDiskType string データディスクの種類。PD_SSD(デフォルト)または PD_HDD。第 2 世代のインスタンスのみに適用されます。 書き込み可能
settings.databaseFlags[] list 起動時にインスタンスに渡されるデータベース フラグ。 書き込み可能
settings.databaseFlags[].name string フラグの名前。これらのフラグはインスタンスの起動時に渡されます。フラグは、ハイフンではなくアンダースコアで指定します。詳細は、Cloud SQL のドキュメントのCloud SQL フラグを設定するをご覧ください。また、サーバー オプションシステム変数については MySQL の公式ドキュメント、サーバー構成については PostgreSQL のドキュメントをご覧ください。
settings.databaseFlags[].value string フラグの値。ブール値には、true の場合は on、false の場合は off を設定します。フラグが値をとらない場合は、このフィールドを省略する必要があります。
settings.databaseReplicationEnabled boolean 読み取りレプリカ インスタンス専用の設定。レプリケーションが有効かどうかを示します。 書き込み可能
settings.ipConfiguration nested object IP 管理用の設定。インスタンス IP を有効または無効にしたり、インスタンスに接続できる外部ネットワークを管理することができます。第 2 世代のインスタンスでは、IPv4 アドレスを無効にできません。 書き込み可能
settings.ipConfiguration.authorizedNetworks[] list IP を使用したインスタンスへの接続を許可する外部ネットワークのリスト。CIDR 表記(「スラッシュ」表記とも呼びます。例: 192.168.100.0/24)で指定します。 書き込み可能
settings.ipConfiguration.authorizedNetworks[].expirationTime datetime このアクセス制御エントリが期限切れになる時刻を、RFC 3339 形式で表したもの。例: 2012-11-15T16:19:00.094Z 書き込み可能
settings.ipConfiguration.authorizedNetworks[].kind string 常に sql#aclEntry になります。
settings.ipConfiguration.authorizedNetworks[].name string このエントリを識別するためのオプションのラベル。 書き込み可能
settings.ipConfiguration.authorizedNetworks[].value string アクセス制御リストのホワイトリスト値。たとえば、外部 IP(IPv4 か IPv6)アドレスかサブネットからのクライアントにアクセスを許可するには、そのアドレスかサブネットをここで使用します。 書き込み可能
settings.ipConfiguration.ipv4Enabled boolean インスタンスに IP アドレスを割り当てるかどうか。 書き込み可能
settings.ipConfiguration.requireSsl boolean mysqld が、IP 経由で接続するユーザーにデフォルトで「REQUIRE X509」を指定するかどうか。 書き込み可能
settings.kind string 常に sql#settings になります。
settings.labels[] list 将来の使用のために予約。
settings.labels[].key string 将来の使用のために予約。
settings.labels[].value string 将来の使用のために予約。
settings.locationPreference nested object 希望するロケーションの設定。これにより、パフォーマンス向上のため、App Engine アプリケーションや Google Compute Engine ゾーンのできるだけ近くにインスタンスを配置できます。 書き込み可能
settings.locationPreference.followGaeApplication string どの App Engine アプリケーションの近くに配置するかを示します。Cloud SQL インスタンスと同じリージョンにあることが必要です。 書き込み可能
settings.locationPreference.kind string 常に sql#locationPreference になります。
settings.locationPreference.zone string 希望する Compute Engine ゾーン(例: us-centra1-a、us-central1-b)。 書き込み可能
settings.maintenanceWindow nested object このインスタンスのメンテナンス時間枠。メンテナンス目的でインスタンスを再起動しても構わない時間を指定します。第 2 世代のインスタンスのみに適用されます。 書き込み可能
settings.maintenanceWindow.day integer 月曜日から始まる曜日(1~7)。 書き込み可能
settings.maintenanceWindow.hour integer 時間(0~23)。 書き込み可能
settings.maintenanceWindow.kind string 常に sql#maintenanceWindow になります。
settings.maintenanceWindow.updateTrack string
settings.pricingPlan string このインスタンスの料金プラン。PER_USEPACKAGE になります。第 2 世代のインスタンスでは、PER_USE のみがサポートされています。 書き込み可能
settings.replicationType string このインスタンスが使用するレプリケーションの種類。ASYNCHRONOUS または SYNCHRONOUS になります。 書き込み可能
settings.settingsVersion long インスタンス設定のバージョン。これは、update メソッドで同時更新が適切に処理されるようにするための必須フィールドです。更新中は、このインスタンスの最新の settingsVersion 値を使用し、この値を更新しようとしないでください。
settings.storageAutoResize boolean ストレージ サイズを自動的に拡大するための設定。デフォルト値は false です。第 2 世代のインスタンスのみに適用されます。 書き込み可能
settings.storageAutoResizeLimit long ストレージ容量を自動的に増加できる最大サイズ。デフォルト値は 0 で、この場合制限はありません。第 2 世代のインスタンスのみに適用されます。 書き込み可能
settings.tier string このインスタンスの階層またはマシンタイプ。例: db-n1-standard-1。詳細は、料金をご覧ください。 書き込み可能
state string Cloud SQL インスタンスの現在のサービス状態。次のいずれかになります。
RUNNABLE: インスタンスは実行中か、アクセスしたときに稼働できる状態にあります。
SUSPENDED: 課金の問題などにより、インスタンスは利用できません。
PENDING_CREATE: インスタンスを作成しています。
MAINTENANCE: メンテナンスのためインスタンスは停止中です。
FAILED: インスタンスを作成できませんでした。
UNKNOWN_STATE: インスタンスの状態は不明です。
suspensionReason[] list インスタンスの状態が SUSPENDED の場合の停止理由。取り得る値は、BILLING_ISSUEINTERNAL_MAINTENANCEOPERATIONAL_ISSUE です。

メソッド

clone
Cloud SQL インスタンスを、ソース インスタンスのクローンとして作成します。
delete
Cloud SQL インスタンスを削除します。
export
Cloud SQL インスタンスから Google Cloud Storage バケットに、MySQL ダンプか CSV ファイルとしてデータをエクスポートします。
failover
インスタンスをそのフェイルオーバー レプリカ インスタンスにフェイルオーバーします。
get
Cloud SQL インスタンスに関する情報が格納されているリソースを取得します。
import
Google Cloud Storage バケット内の MySQL ダンプか CSV ファイルから Cloud SQL インスタンスにデータをインポートします。
insert
新しい Cloud SQL インスタンスを作成します。
list
特定のプロジェクトの下のインスタンスの一覧を、インスタンス名のアルファベット順に取得します。
patch
Cloud SQL インスタンスの設定を、パッチ セマンティクスを使って更新します。
promoteReplica
読み取りレプリカ インスタンスを、スタンドアロン Cloud SQL インスタンスに昇格します。
resetSslConfig
すべてのクライアント証明書を削除し、インスタンスに対する新たなサーバー SSL 証明書を生成します。
restart
Cloud SQL インスタンスを再起動します。
restoreBackup
Cloud SQL インスタンスのバックアップを復元します。
startReplica
読み取りレプリカ インスタンスのレプリケーションを開始します。
stopReplica
読み取りレプリカ インスタンスのレプリケーションを停止します。
truncateLog
MySQL の一般的なクエリと遅いクエリのログテーブルを切り捨てます。
更新
Cloud SQL インスタンスの設定を更新します。
このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...