- 重要な情報
- はじめに
- 用語集
- ガイド
- エージェント
- インテグレーション
- OpenTelemetry
- 開発者
- API
- CoScreen
- アプリ内
- Service Management
- インフラストラクチャー
- アプリケーションパフォーマンス
- 継続的インテグレーション
- ログ管理
- セキュリティ
- UX モニタリング
- 管理
ancestors
タイプ: UNORDERED_LIST_STRING
available_maintenance_versions
タイプ: UNORDERED_LIST_STRING
プロバイダー名: availableMaintenanceVersions
説明: 出力のみ。インスタンスに適用されるすべてのメンテナンスバージョンをリストアップします
backend_type
タイプ: STRING
プロバイダー名: backendType
説明: バックエンドのタイプ。SECOND_GEN
: クラウド SQL データベースのインスタンス。EXTERNAL
: Google が管理していないデータベースサーバー。このプロパティは読み取り専用です。データベースの種類を決定するには、settings
オブジェクトの tier
プロパティを使用します。
可能な値:
SQL_BACKEND_TYPE_UNSPECIFIED
- これは、例えば不明なバックエンドの種類です。FIRST_GEN
- V1 スペックルインスタンス。SECOND_GEN
- V2 スペックルインスタンス。EXTERNAL
- オンプレミスインスタンス。connection_name
タイプ: STRING
プロバイダー名: connectionName
説明: 接続文字列で使用されるクラウド SQL インスタンスの接続名。
create_time
タイプ: TIMESTAMP
Provider name: createTime
説明: 出力のみ。インスタンスが作成された時刻。RFC 3339 形式で、例えば 2012-11-15T16:19:00.094Z
のようになります。
current_disk_size
タイプ: INT64
プロバイダー名: currentDiskSize
説明: インスタンスの現在のディスク使用量 (バイト単位)。このプロパティは非推奨となりました。代わりに Cloud Monitoring API の “cloudsql.googleapis.com/database/disk/bytes_used” メトリクスを使用してください。詳しくはこの発表をご覧ください。
database_installed_version
タイプ: STRING
プロバイダー名: databaseInstalledVersion
説明: 出力のみ。MYSQL_8_0_18
のようなマイナーバージョンを含む、インスタンス上で動作している現在のデータベースバージョンを格納します。
database_version
タイプ: STRING
プロバイダー名: databaseVersion
説明: データベースエンジンの種類とバージョン。databaseVersion
フィールドはインスタンス作成後に変更することはできません。
可能な値:
SQL_DATABASE_VERSION_UNSPECIFIED
- これは、不明なデータベースのバージョンです。MYSQL_5_1
- データベースのバージョンは、MySQL 5.1 です。MYSQL_5_5
- データベースのバージョンは、MySQL 5.5 です。MYSQL_5_6
- データベースのバージョンは、MySQL 5.6 です。MYSQL_5_7
- データベースのバージョンは、MySQL 5.7 です。SQLSERVER_2017_STANDARD
- データベースのバージョンは、SQL Server 2017 Standard です。SQLSERVER_2017_ENTERPRISE
- データベースのバージョンは、SQL Server 2017 Enterprise です。SQLSERVER_2017_EXPRESS
- データベースのバージョンは、SQL Server 2017 Express です。SQLSERVER_2017_WEB
- データベースのバージョンは、SQL Server 2017 Web です。POSTGRES_9_6
- データベースのバージョンは、PostgreSQL 9.6 です。POSTGRES_10
- データベースのバージョンは、PostgreSQL 10 です。POSTGRES_11
- データベースのバージョンは、PostgreSQL 11 です。POSTGRES_12
- データベースのバージョンは、PostgreSQL 12 です。POSTGRES_13
- データベースのバージョンは、PostgreSQL 13 です。POSTGRES_14
- データベースのバージョンは、PostgreSQL 14 です。MYSQL_8_0
- データベースのバージョンは、MySQL 8 です。MYSQL_8_0_18
- データベースのメジャーバージョンは MySQL 8.0、マイナーバージョンは 18 です。MYSQL_8_0_26
- データベースのメジャーバージョンは MySQL 8.0、マイナーバージョンは 26 です。MYSQL_8_0_27
- データベースのメジャーバージョンは MySQL 8.0、マイナーバージョンは 27 です。MYSQL_8_0_28
- データベースのメジャーバージョンは MySQL 8.0、マイナーバージョンは 28 です。MYSQL_8_0_29
- データベースのメジャーバージョンは MySQL 8.0、マイナーバージョンは 29 です。MYSQL_8_0_30
- データベースのメジャーバージョンは MySQL 8.0、マイナーバージョンは 30 です。MYSQL_8_0_31
- データベースのメジャーバージョンは MySQL 8.0、マイナーバージョンは 31 です。MYSQL_8_0_32
- データベースのメジャーバージョンは MySQL 8.0、マイナーバージョンは 32 です。SQLSERVER_2019_STANDARD
- データベースのバージョンは、SQL Server 2019 Standard です。SQLSERVER_2019_ENTERPRISE
- データベースのバージョンは、SQL Server 2019 Enterprise です。SQLSERVER_2019_EXPRESS
- データベースのバージョンは、SQL Server 2019 Express です。SQLSERVER_2019_WEB
- データベースのバージョンは、SQL Server 2019 Web です。disk_encryption_configuration
タイプ: STRUCT
プロバイダー名: diskEncryptionConfiguration
説明: インスタンスに固有のディスク暗号化構成。
kind
STRING
kind
sql#diskEncryptionConfiguration
です。kms_key_name
STRING
kmsKeyName
disk_encryption_status
タイプ: STRUCT
プロバイダー名: diskEncryptionStatus
説明: インスタンスに固有のディスク暗号化ステータス。
kind
STRING
kind
sql#diskEncryptionStatus
です。kms_key_version_name
STRING
kmsKeyVersionName
etag
タイプ: STRING
プロバイダー名: etag
説明: このフィールドは非推奨で、API の将来のバージョンでは削除される予定です。代わりに settings.settingsVersion
フィールドを使用してください。
failover_replica
タイプ: STRUCT
プロバイダー名: failoverReplica
説明: フェイルオーバーレプリカの名前とステータス。
available
BOOLEAN
available
name
STRING
name
gce_zone
タイプ: STRING
プロバイダー名: gceZone
説明: インスタンスが現在サービスを提供している Compute Engine のゾーン。この値は、インスタンスがセカンダリゾーンにフェイルオーバーした場合、インスタンスの作成時に指定されたゾーンと異なる可能性があります。警告: これを変更すると、インスタンスが再起動する場合があります。
instance_type
タイプ: STRING
プロバイダー名: instanceType
説明: インスタンスタイプ。
可能な値:
SQL_INSTANCE_TYPE_UNSPECIFIED
- これは、不明な Cloud SQL インスタンスタイプです。CLOUD_SQL_INSTANCE
- プライマリインスタンスからレプリケートされていない通常の Cloud SQL インスタンス。ON_PREMISES_INSTANCE
- Cloud SQL で管理されていない、顧客構内で稼働しているインスタンス。READ_REPLICA_INSTANCE
- リードレプリカとして動作する Cloud SQL インスタンス。ip_addresses
タイプ: UNORDERED_LIST_STRUCT
プロバイダー名: ipAddresses
説明: インスタンスに割り当てられた IP アドレス。
ip_address
STRING
ipAddress
time_to_retire
TIMESTAMP
timeToRetire
2012-11-15T16:19:00.094Z
のように指定します。このフィールドは、IP がリタイアする予定のときにのみ利用可能です。type
STRING
type
PRIMARY
アドレスはパブリックアドレスで、着信接続を受け入れることができます。PRIVATE
アドレスは、着信接続を受け入れることができるプライベートなアドレスです。OUTGOING
アドレスは、サポートされている場合、インスタンスから発信される接続の発信元アドレスです。SQL_IP_ADDRESS_TYPE_UNSPECIFIED
- これは、不明な IP アドレスタイプです。PRIMARY
- 顧客が接続することになっている IP アドレス。通常、これはロードバランサーの IP アドレスです。OUTGOING
- リードレプリカがその外部プライマリインスタンスに確立する接続のソース IP アドレス。この IP アドレスは、構内のプライマリインスタンスへの着信接続をフィルターするファイアウォールがある場合、顧客が許可リストに入れることができます。PRIVATE
- プライベート IP やネットワークピアリングを利用する際に使用するプライベート IP。MIGRATED_1ST_GEN
- 移行したインスタンスの V1 IP。移行が完了したらすぐにこの IP を廃止してください。注: V1 IP アドレスを持つ V1 インスタンスは、PRIMARY としてカウントされます。ipv6_address
タイプ: STRING
プロバイダー名: ipv6Address
説明: インスタンスに割り当てられた IPv6 アドレス。(非推奨) このプロパティは、第一世代のインスタンスにのみ適用可能でした。
kind
タイプ: STRING
プロバイダー名: kind
説明: これは常に sql#instance
です。
labels
タイプ: UNORDERED_LIST_STRING
maintenance_version
タイプ: STRING
プロバイダー名: maintenanceVersion
説明: インスタンス上の現在のソフトウェアバージョン。
master_instance_name
タイプ: STRING
プロバイダー名: masterInstanceName
説明: レプリケーション設定においてプライマリとして動作するインスタンスの名前。
max_disk_size
タイプ: INT64
プロバイダー名: maxDiskSize
説明: インスタンスの最大ディスクサイズ (バイト単位)。
name
タイプ: STRING
プロバイダー名: name
説明: Cloud SQL インスタンスの名前。プロジェクト ID は含まれません。
on_premises_configuration
タイプ: STRUCT
プロバイダー名: onPremisesConfiguration
説明: オンプレミスインスタンスに特化した構成。
ca_certificate
STRING
caCertificate
client_certificate
STRING
clientCertificate
client_key
STRING
clientKey
dump_file_path
STRING
dumpFilePath
host_port
STRING
hostPort
kind
STRING
kind
sql#onPremisesConfiguration
です。password
STRING
password
source_instance
STRUCT
sourceInstance
name
STRING
name
project
STRING
project
region
STRING
region
username
STRING
username
organization_id
タイプ: STRING
out_of_disk_report
タイプ: STRUCT
プロバイダー名: outOfDiskReport
説明: このフィールドは、OutOfDisk 問題に対するプロアクティブデータベースウェルネスジョブが生成するレポートを表します。* ライター: * OOD のプロアクティブデータベースウェルネスジョブ。* リーダー: * プロアクティブデータベースウェルネスジョブ
sql_min_recommended_increase_size_gb
INT32
sqlMinRecommendedIncreaseSizeGb
sql_out_of_disk_state
STRING
sqlOutOfDiskState
SQL_OUT_OF_DISK_STATE_UNSPECIFIED
- 未指定の状態NORMAL
- インスタンスのデータディスクに十分な空き容量がありますSOFT_SHUTDOWN
- データディスクをほぼ使い切った状態です。データの破損を防ぐためにシャットダウンされます。parent
タイプ: STRING
project
タイプ: STRING
プロバイダー名: project
説明: Cloud SQL インスタンスを含むプロジェクトのプロジェクト ID。該当する場合は、Google アプリのドメインがプレフィックスとして付きます。
project_id
タイプ: STRING
project_number
タイプ: STRING
region
タイプ: STRING
プロバイダー名: region
説明: 地理的な地域。* us-central
(FIRST_GEN
インスタンスのみ) * us-central1
(SECOND_GEN
インスタンスのみ) * asia-east1
または europe-west1
が可能です。デフォルトは、インスタンスタイプに応じて us-central
または us-central1
です。インスタンス作成後に地域を変更することはできません。
replica_configuration
タイプ: STRUCT
プロバイダー名: replicaConfiguration
説明: フェイルオーバーレプリカとリードレプリカに特化した構成。
failover_target
BOOLEAN
failoverTarget
true
に設定すると、レプリカはフェイルオーバーレプリカとして指定されます。プライマリインスタンスに障害が発生した場合、そのレプリカインスタンスが新しいプライマリインスタンスとして昇格します。フェイルオーバーの対象として指定できるレプリカは 1 つだけで、そのレプリカはプライマリインスタンスと異なるゾーンにある必要があります。kind
STRING
kind
sql#replicaConfiguration
です。mysql_replica_configuration
STRUCT
mysqlReplicaConfiguration
master.info
というファイルに保存されます。ca_certificate
STRING
caCertificate
client_certificate
STRING
clientCertificate
client_key
STRING
clientKey
connect_retry_interval
INT32
connectRetryInterval
dump_file_path
STRING
dumpFilePath
kind
STRING
kind
sql#mysqlReplicaConfiguration
です。master_heartbeat_period
INT64
masterHeartbeatPeriod
password
STRING
password
ssl_cipher
STRING
sslCipher
username
STRING
username
verify_server_certificate
BOOLEAN
verifyServerCertificate
replica_names
タイプ: UNORDERED_LIST_STRING
プロバイダー名: replicaNames
説明: インスタンスのレプリカ。
resource_name
タイプ: STRING
root_password
タイプ: STRING
プロバイダー名: rootPassword
説明: ルートパスワードの初期値。作成時のみ使用します。PostgreSQL インスタンスに接続する前に、ルートパスワードを設定する必要があります。
satisfies_pzs
タイプ: BOOLEAN
プロバイダー名: satisfiesPzs
説明: インスタンスが Pzs を満たすかどうかを示すステータス。将来の使用のために予約されています。
scheduled_maintenance
タイプ: STRUCT
プロバイダー名: scheduledMaintenance
説明: このインスタンスに対して今後予定されているメンテナンスの開始時間。
can_defer
BOOLEAN
canDefer
can_reschedule
BOOLEAN
canReschedule
schedule_deadline_time
TIMESTAMP
scheduleDeadlineTime
start_time
TIMESTAMP
startTime
secondary_gce_zone
タイプ: STRING
プロバイダー名: secondaryGceZone
説明: リージョンインスタンスの場合、フェイルオーバーインスタンスが現在サービスを提供している Compute Engine のゾーン。この値は、インスタンスがセカンダリ/フェイルオーバーゾーンにフェイルオーバーした場合、インスタンスの作成時に指定されたゾーンと異なる可能性があります。
self_link
タイプ: STRING
プロバイダー名: selfLink
説明: このリソースの URI。
server_ca_cert
タイプ: STRUCT
プロバイダー名: serverCaCert
説明: SSL 構成。
cert
STRING
cert
cert_serial_number
STRING
certSerialNumber
common_name
STRING
commonName
create_time
TIMESTAMP
createTime
2012-11-15T16:19:00.094Z
のようになります。expiration_time
TIMESTAMP
expirationTime
2012-11-15T16:19:00.094Z
のようになります。instance
STRING
instance
kind
STRING
kind
sql#sslCert
です。self_link
STRING
selfLink
sha1_fingerprint
STRING
sha1Fingerprint
service_account_email_address
タイプ: STRING
プロバイダー名: serviceAccountEmailAddress
説明: インスタンスに割り当てられたサービスアカウントのメールアドレス。このプロパティは読み取り専用です。
settings
タイプ: STRUCT
プロバイダー名: settings
説明: ユーザー設定。
activation_policy
STRING
activationPolicy
ALWAYS
: インスタンスはオンになっており、接続リクエストがない場合でもそのままの状態を保ちます。* NEVER
: インスタンスはオフで、接続リクエストが来てもアクティブになりません。SQL_ACTIVATION_POLICY_UNSPECIFIED
- 不明なアクティブ化プラン。ALWAYS
- インスタンスは常に稼働しています。NEVER
- インスタンスが起動することはありません。ON_DEMAND
- インスタンスはリクエストを受けると起動します。active_directory_config
STRUCT
activeDirectoryConfig
domain
STRING
domain
kind
STRING
kind
advanced_machine_features
STRUCT
advancedMachineFeatures
threads_per_core
INT32
threadsPerCore
authorized_gae_applications
UNORDERED_LIST_STRING
authorizedGaeApplications
availability_type
STRING
availabilityType
ZONAL
: インスタンスは 1 つのゾーンのみからデータを提供します。そのゾーンで障害が発生した場合、データアクセスに影響があります。* REGIONAL
: インスタンスはリージョン内の複数のゾーンからデータを提供できます (高可用性です)。詳しくは、高可用性構成の概要を参照してください。SQL_AVAILABILITY_TYPE_UNSPECIFIED
- これは不明な可用性タイプです。ZONAL
- ゾーンで利用可能なインスタンス。REGIONAL
- リージョンで利用可能なインスタンス。backup_configuration
STRUCT
backupConfiguration
backup_retention_settings
STRUCT
backupRetentionSettings
retained_backups
INT32
retainedBackups
retention_unit
STRING
retentionUnit
RETENTION_UNIT_UNSPECIFIED
- バックアップの保持単位は未指定で、COUNT として扱われます。COUNT
- バックアップの保持は、「直近の 7 つのバックアップを保持する」のように、回数で指定します。binary_log_enabled
BOOLEAN
binaryLogEnabled
enabled
BOOLEAN
enabled
kind
STRING
kind
sql#backupConfiguration
です。location
STRING
location
point_in_time_recovery_enabled
BOOLEAN
pointInTimeRecoveryEnabled
replication_log_archiving_enabled
BOOLEAN
replicationLogArchivingEnabled
start_time
STRING
startTime
HH:MM
で指定します。transaction_log_retention_days
INT32
transactionLogRetentionDays
collation
STRING
collation
connector_enforcement
STRING
connectorEnforcement
NOT_REQUIRED
(Cloud SQL インスタンスは Cloud SQL Connectors なしで接続可能) と REQUIRED
(Cloud SQL Connectors を使用する接続のみ許可) REQUIRED を使用すると、既存のすべての認可されたネットワークが無効になることに注意してください。新規インスタンス作成時にこのフィールドを指定しない場合、NOT_REQUIRED が使用されます。既存のインスタンスにパッチを適用したり更新したりする際にこのフィールドが指定されない場合、そのインスタンスでは変更されずにそのまま残ります。CONNECTOR_ENFORCEMENT_UNSPECIFIED
- Cloud SQL コネクターの要件は不明です。NOT_REQUIRED
- Cloud SQL コネクターを要求しません。REQUIRED
- Cloud SQL Auth Proxy と Cloud SQL Java、Python、Go コネクターを含む、すべての接続に Cloud SQL コネクターを使用するよう要求します。注: これは、既存のすべての認可されたネットワークを無効にします。crash_safe_replication_enabled
BOOLEAN
crashSafeReplicationEnabled
data_disk_size_gb
INT64
dataDiskSizeGb
data_disk_type
STRING
dataDiskType
PD_SSD
(デフォルト) または PD_HDD
。 第一世代のインスタンスでは使用されません。SQL_DATA_DISK_TYPE_UNSPECIFIED
- これは不明なデータディスクタイプです。PD_SSD
- SSD データディスク。PD_HDD
- HDD データディスク。OBSOLETE_LOCAL_SSD
- このフィールドは非推奨で、API の将来のバージョンで削除される予定です。database_flags
UNORDERED_LIST_STRUCT
databaseFlags
name
STRING
name
value
STRING
value
on
に、false の場合は off
に設定されます。フラグが値をとらない場合は、このフィールドを省略しなければなりません。database_replication_enabled
BOOLEAN
databaseReplicationEnabled
deletion_protection_enabled
BOOLEAN
deletionProtectionEnabled
deny_maintenance_periods
UNORDERED_LIST_STRUCT
denyMaintenancePeriods
end_date
STRING
endDate
start_date
STRING
startDate
time
STRING
time
insights_config
STRUCT
insightsConfig
query_insights_enabled
BOOLEAN
queryInsightsEnabled
query_plans_per_minute
INT32
queryPlansPerMinute
query_string_length
INT32
queryStringLength
record_application_tags
BOOLEAN
recordApplicationTags
record_client_address
BOOLEAN
recordClientAddress
ip_configuration
STRUCT
ipConfiguration
allocated_ip_range
STRING
allocatedIpRange
[a-z]([-a-z0-9]*[a-z0-9])?.
にマッチする名前であることが必要です。authorized_networks
UNORDERED_LIST_STRUCT
authorizedNetworks
157.197.200.0/24
)。expiration_time
TIMESTAMP
expirationTime
2012-11-15T16:19:00.094Z
のようになります。kind
STRING
kind
sql#aclEntry
です。name
STRING
name
value
STRING
value
enable_private_path_for_google_cloud_services
BOOLEAN
enablePrivatePathForGoogleCloudServices
ipv4_enabled
BOOLEAN
ipv4Enabled
private_network
STRING
privateNetwork
/projects/myProject/global/networks/default
となります。この設定は更新することができますが、設定後に削除することはできません。require_ssl
BOOLEAN
requireSsl
kind
STRING
kind
sql#settings
です。location_preference
STRUCT
locationPreference
follow_gae_application
STRING
followGaeApplication
kind
STRING
kind
sql#locationPreference
です。secondary_zone
STRING
secondaryZone
zone
STRING
zone
maintenance_window
STRUCT
maintenanceWindow
day
INT32
day
hour
INT32
hour
kind
STRING
kind
sql#maintenanceWindow
です。update_track
STRING
updateTrack
canary
(初期) または stable
(後期)。詳しくはこちら。SQL_UPDATE_TRACK_UNSPECIFIED
- これは、不明なメンテナンスタイミングの優先です。canary
- 再起動が必要なインスタンス更新の場合、この更新追跡は、メンテナンスウィンドウの早い段階で新しいバージョンのために再起動することを好むインスタンスを示します。stable
- 再起動が必要なインスタンス更新の場合、この更新トラックは、Cloud SQL に再起動のタイミングを選択させることを希望するインスタンスを示します (該当する場合、そのメンテナンスウィンドウ内で)。password_validation_policy
STRUCT
passwordValidationPolicy
complexity
STRING
complexity
COMPLEXITY_UNSPECIFIED
- 複雑さのチェックは指定されていません。COMPLEXITY_DEFAULT
- 小文字、大文字、数字、非英数字の組み合わせ。disallow_username_substring
BOOLEAN
disallowUsernameSubstring
enable_password_policy
BOOLEAN
enablePasswordPolicy
min_length
INT32
minLength
password_change_interval
STRING
passwordChangeInterval
reuse_interval
INT32
reuseInterval
pricing_plan
STRING
pricingPlan
PER_USE
または PACKAGE
のいずれかになります。第二世代インスタンスでは PER_USE
のみがサポートされています。SQL_PRICING_PLAN_UNSPECIFIED
- これは、このインスタンスの不明な料金プランです。PACKAGE
- インスタンスは、月額定額制で請求されます。PER_USE
- インスタンスは使用量ごとに請求されます。replication_type
STRING
replicationType
ASYNCHRONOUS
または SYNCHRONOUS
のどちらかになります。(非推奨) このプロパティは、第一世代のインスタンスにのみ適用可能でした。SQL_REPLICATION_TYPE_UNSPECIFIED
- これは、Cloud SQL インスタンスの不明なレプリケーションタイプです。SYNCHRONOUS
- 第一世代インスタンスの同期レプリケーションモード。デフォルト値です。ASYNCHRONOUS
- 第一世代インスタンスの非同期レプリケーションモード。若干のパフォーマンス向上が期待できますが、このオプションを非同期に設定した状態で障害が発生した場合、最大で数秒間のデータ更新が失われる可能性があります。settings_version
INT64
settingsVersion
sql_server_audit_config
STRUCT
sqlServerAuditConfig
bucket
STRING
bucket
kind
STRING
kind
retention_interval
STRING
retentionInterval
upload_interval
STRING
uploadInterval
storage_auto_resize
BOOLEAN
storageAutoResize
storage_auto_resize_limit
INT64
storageAutoResizeLimit
tier
STRING
tier
db-custom-1-3840
です。警告: これを変更すると、インスタンスが再起動します。time_zone
STRING
timeZone
user_labels
UNORDERED_LIST_STRING
userLabels
state
タイプ: STRING
プロバイダー名: state
説明: Cloud SQL インスタンスの現在のサービス状態。
可能な値:
SQL_INSTANCE_STATE_UNSPECIFIED
- インスタンスの状態は不明です。RUNNABLE
- インスタンスは実行中、またはオーナーによって停止されています。SUSPENDED
- 請求の問題などで、インスタンスは利用できません。PENDING_DELETE
- インスタンスは削除中です。PENDING_CREATE
- インスタンスは作成中です。MAINTENANCE
- インスタンスはメンテナンスのため停止しています。FAILED
- インスタンスの作成に失敗したか、メンテナンス中に致命的なエラーが発生しました。ONLINE_MAINTENANCE
- 非推奨suspension_reason
タイプ: UNORDERED_LIST_STRING
プロバイダー名: suspensionReason
説明: インスタンス状態が SUSPENDED の場合、停止した理由。
tags
タイプ: UNORDERED_LIST_STRING