Alat: get_instance
Mendapatkan detail instance Cloud SQL.
Contoh berikut menunjukkan cara menggunakan curl untuk memanggil alat MCP get_instance.
| Permintaan 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 }' |
Skema Input
Permintaan pengambilan instance.
SqlInstancesGetRequest
| Representasi JSON |
|---|
{ "instance": string, "project": string } |
| Kolom | |
|---|---|
instance |
Wajib. ID instance database. Ini tidak menyertakan project ID. |
project |
Wajib. Project ID project yang berisi instance. |
Skema Output
Resource instance Cloud SQL.
DatabaseInstance
| Representasi JSON |
|---|
{ "kind": string, "state": enum ( |
| Kolom | |
|---|---|
kind |
Nilai ini selalu |
state |
Status penayangan instance Cloud SQL saat ini. |
databaseVersion |
Jenis dan versi mesin database. Kolom |
settings |
Setelan pengguna. |
etag |
Kolom ini tidak digunakan lagi dan akan dihapus dari versi mendatang API. Gunakan kolom |
failoverReplica |
Nama dan status replika failover. |
masterInstanceName |
Nama instance yang akan bertindak sebagai instance utama dalam penyiapan replikasi. |
replicaNames[] |
Replika instance. |
maxDiskSize |
Ukuran disk maksimum instance dalam byte. |
currentDiskSize |
Penggunaan disk instance saat ini dalam byte. Properti ini sudah tidak digunakan lagi. Gunakan metrik "cloudsql.googleapis.com/database/disk/bytes_used" di Cloud Monitoring API. Lihat pengumuman ini untuk mengetahui detailnya. |
ipAddresses[] |
Alamat IP yang ditetapkan untuk instance. |
serverCaCert |
Konfigurasi SSL. |
instanceType |
Jenis instance. |
project |
ID project yang berisi instance Cloud SQL. Domain aplikasi Google diberi awalan jika berlaku. |
ipv6Address |
Alamat IPv6 yang ditetapkan ke instance. (Tidak digunakan lagi) Properti ini hanya berlaku untuk instance Generasi Pertama. |
serviceAccountEmailAddress |
Alamat email akun layanan yang ditetapkan ke instance.\Properti ini bersifat hanya baca. |
onPremisesConfiguration |
Konfigurasi khusus untuk instance lokal. |
replicaConfiguration |
Konfigurasi khusus untuk replika failover dan replika baca. |
backendType |
Jenis backend. Properti ini bersifat hanya baca; gunakan properti |
selfLink |
URI resource ini. |
suspensionReason[] |
Jika status instance adalah DITANGGUHKAN, alasan penangguhan. |
connectionName |
Nama koneksi instance Cloud SQL yang digunakan dalam string koneksi. |
name |
Nama instance Cloud SQL. Ini tidak menyertakan project ID. |
region |
Region geografis instance Cloud SQL. Dapat berupa salah satu region tempat Cloud SQL beroperasi: Misalnya, |
gceZone |
Zona Compute Engine tempat instance saat ini melayani. Nilai ini dapat berbeda dari zona yang ditentukan saat instance dibuat jika instance telah melakukan failover ke zona sekundernya. PERINGATAN: Mengubah setelan ini dapat memulai ulang instance. |
secondaryGceZone |
Zona Compute Engine tempat instance failover saat ini melayani instance regional. Nilai ini dapat berbeda dari zona yang ditentukan saat instance dibuat jika instance telah di-failover ke zona sekunder/failover-nya. |
diskEncryptionConfiguration |
Konfigurasi enkripsi disk khusus untuk instance. |
diskEncryptionStatus |
Status enkripsi disk khusus untuk instance. |
rootPassword |
Sandi root awal. Hanya digunakan saat pembuatan. Anda harus menetapkan sandi root sebelum dapat terhubung ke instance PostgreSQL. |
scheduledMaintenance |
Waktu mulai pemeliharaan terjadwal yang akan datang untuk instance ini. |
satisfiesPzs |
Status ini menunjukkan apakah instance memenuhi PZS. Status ini dicadangkan untuk penggunaan di masa mendatang. |
databaseInstalledVersion |
Hanya output. Menyimpan versi database saat ini yang berjalan di instance, termasuk versi minor seperti |
createTime |
Hanya output. Waktu saat instance dibuat dalam format RFC 3339, misalnya Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
availableMaintenanceVersions[] |
Hanya output. Mencantumkan semua versi pemeliharaan yang berlaku pada instance |
maintenanceVersion |
Versi software saat ini di instance. |
upgradableDatabaseVersions[] |
Hanya output. Semua versi database yang tersedia untuk diupgrade. |
replicationCluster |
Opsional. Pasangan instance utama dan replika pemulihan dari bencana (DR). Replika DR adalah replika lintas region yang Anda tetapkan untuk failover jika instance utama mengalami kegagalan regional. Berlaku untuk MySQL dan PostgreSQL. |
satisfiesPzi |
Hanya output. Status ini menunjukkan apakah instance memenuhi PZI. Status ini dicadangkan untuk penggunaan di masa mendatang. |
tags |
Opsional. Hanya input. Tidak dapat diubah. Kunci tag dan nilai tag yang terikat ke instance ini. Anda harus merepresentasikan setiap item dalam peta sebagai: Misalnya, satu resource dapat memiliki tag berikut: Untuk mengetahui informasi selengkapnya tentang pembuatan dan pengelolaan tag, lihat https://cloud.google.com/resource-manager/docs/tags/tags-overview. Objek yang berisi daftar pasangan |
nodes[] |
Hanya output. Entri yang berisi informasi tentang setiap node pool baca dari pool baca. |
dnsNames[] |
Hanya output. Daftar nama DNS yang digunakan oleh instance ini. |
Kolom union
|
|
outOfDiskReport |
Kolom ini menampilkan laporan yang dibuat oleh tugas kesehatan database proaktif untuk masalah OutOfDisk. * Penulis: * tugas pemeliharaan database proaktif untuk OOD. * Pembaca: * tugas pemeliharaan database proaktif |
Kolom union
|
|
sqlNetworkArchitecture |
|
Kolom union
|
|
pscServiceAttachmentLink |
Hanya output. Link ke lampiran layanan instance PSC. |
Kolom union
|
|
dnsName |
Hanya output. Nama DNS instance. |
Kolom union
|
|
primaryDnsName |
Hanya output. TIDAK DIGUNAKAN LAGI: sebagai gantinya gunakan write_endpoint. |
Kolom union
|
|
writeEndpoint |
Hanya output. Nama DNS instance utama dalam grup replikasi. |
Kolom union
|
|
geminiConfig |
Konfigurasi instance Gemini. |
Kolom union
|
|
switchTransactionLogsToCloudStorageEnabled |
Hanya input. Apakah Cloud SQL diaktifkan untuk beralih menyimpan file log pemulihan point-in-time dari disk data ke Cloud Storage. |
Kolom union
|
|
includeReplicasForMajorVersionUpgrade |
Hanya input. Menentukan apakah upgrade versi utama di tempat replika terjadi saat upgrade versi utama di tempat instance utama dimulai. |
Kolom union
|
|
nodeCount |
Jumlah node kumpulan baca dalam kumpulan baca. |
Setelan
| Representasi JSON |
|---|
{ "settingsVersion": string, "authorizedGaeApplications": [ string ], "tier": string, "kind": string, "userLabels": { string: string, ... }, "availabilityType": enum ( |
| Kolom | |
|---|---|
settingsVersion |
Versi setelan instance. Kolom ini wajib diisi untuk metode update guna memastikan update serentak ditangani dengan benar. Selama update, gunakan nilai settingsVersion terbaru untuk instance ini dan jangan mencoba memperbarui nilai ini. |
authorizedGaeApplications[] |
ID aplikasi App Engine yang dapat mengakses instance ini. (Tidak digunakan lagi) Hanya diterapkan pada instance Generasi Pertama. |
tier |
Tingkatan (atau jenis mesin) untuk instance ini, misalnya |
kind |
Nilai ini selalu |
userLabels |
Label yang disediakan pengguna, direpresentasikan sebagai kamus dengan setiap label adalah pasangan nilai kunci tunggal. Objek yang berisi daftar pasangan |
availabilityType |
Jenis ketersediaan. Nilai yang mungkin: * Untuk mengetahui informasi selengkapnya, lihat Ringkasan Konfigurasi Ketersediaan Tinggi. |
pricingPlan |
Paket harga untuk instance ini. Ini dapat berupa |
replicationType |
Jenis replikasi yang digunakan instance ini. Ini dapat berupa |
storageAutoResizeLimit |
Ukuran maksimum kapasitas penyimpanan yang dapat ditingkatkan secara otomatis. Nilai defaultnya adalah 0, yang menentukan bahwa tidak ada batas. |
activationPolicy |
Kebijakan aktivasi menentukan kapan instance diaktifkan; kebijakan ini hanya berlaku saat status instance adalah DAPAT DIJALANKAN. Nilai yang valid: * |
ipConfiguration |
Setelan untuk Pengelolaan IP. Hal ini memungkinkan untuk mengaktifkan atau menonaktifkan IP instance dan mengelola jaringan eksternal mana yang dapat terhubung ke instance. Alamat IPv4 tidak dapat dinonaktifkan untuk instance Generasi Kedua. |
storageAutoResize |
Konfigurasi untuk meningkatkan ukuran penyimpanan secara otomatis. Nilai defaultnya adalah benar (true). |
locationPreference |
Setelan preferensi lokasi. Hal ini memungkinkan instance ditempatkan sedekat mungkin dengan aplikasi App Engine atau zona Compute Engine untuk performa yang lebih baik. Kolokasi App Engine hanya berlaku untuk instance Generasi Pertama. |
databaseFlags[] |
Tanda database yang diteruskan ke instance saat startup. |
dataDiskType |
Jenis disk data: |
maintenanceWindow |
Masa pemeliharaan untuk instance ini. Fungsi ini menentukan kapan instance dapat dimulai ulang untuk tujuan pemeliharaan. |
backupConfiguration |
Konfigurasi pencadangan harian untuk instance. |
databaseReplicationEnabled |
Konfigurasi khusus untuk instance replika baca. Menunjukkan apakah replikasi diaktifkan atau tidak. PERINGATAN: Mengubah setelan ini akan memulai ulang instance. |
crashSafeReplicationEnabled |
Konfigurasi khusus untuk instance replika baca. Menunjukkan apakah tanda database untuk replikasi yang aman dari error diaktifkan atau tidak. Properti ini hanya berlaku untuk instance Generasi Pertama. |
dataDiskSizeGb |
Ukuran disk data, dalam GB. Ukuran minimum disk data adalah 10 GB. |
activeDirectoryConfig |
Konfigurasi Active Directory, hanya relevan untuk Cloud SQL untuk SQL Server. |
collation |
Nama kolasi Instance server. |
denyMaintenancePeriods[] |
Periode penolakan pemeliharaan |
insightsConfig |
Konfigurasi insight, untuk saat ini hanya relevan untuk Postgres. |
passwordValidationPolicy |
Kebijakan validasi sandi pengguna lokal instance. |
sqlServerAuditConfig |
Konfigurasi audit khusus SQL Server. |
edition |
Opsional. Edisi instance. |
connectorEnforcement |
Menentukan apakah koneksi harus menggunakan konektor Cloud SQL. Nilai opsi mencakup berikut ini: Perhatikan bahwa penggunaan REQUIRED akan menonaktifkan semua jaringan resmi yang ada. Jika kolom ini tidak ditentukan saat membuat instance baru, NOT_REQUIRED akan digunakan. Jika kolom ini tidak ditentukan saat melakukan patch atau mengupdate instance yang ada, kolom ini tidak akan berubah di instance. |
deletionProtectionEnabled |
Konfigurasi untuk melindungi dari penghapusan instance yang tidak disengaja. |
timeZone |
Zona waktu server, hanya relevan untuk Cloud SQL untuk SQL Server. |
advancedMachineFeatures |
Menentukan konfigurasi mesin lanjutan untuk instance yang hanya relevan untuk SQL Server. |
dataCacheConfig |
Konfigurasi untuk cache data. |
replicationLagMaxSeconds |
Opsional. Nilai konfigurasi untuk pembuatan ulang replika setelah jeda replikasi tertentu |
enableGoogleMlIntegration |
Opsional. Jika parameter ini disetel ke benar (true), instance Cloud SQL dapat terhubung ke Vertex AI untuk meneruskan permintaan prediksi dan insight real-time ke AI. Nilai defaultnya adalah false. Hal ini hanya berlaku untuk instance Cloud SQL untuk MySQL dan Cloud SQL untuk PostgreSQL. |
enableDataplexIntegration |
Opsional. Secara default, instance Cloud SQL menonaktifkan ekstraksi skema untuk Dataplex. Jika parameter ini disetel ke benar (true), ekstraksi skema untuk Dataplex di instance Cloud SQL akan diaktifkan. |
retainBackupsOnDelete |
Opsional. Jika parameter ini disetel ke benar (true), Cloud SQL akan menyimpan cadangan instance meskipun setelah instance dihapus. Cadangan ON_DEMAND akan dipertahankan hingga pelanggan menghapus cadangan atau project. Cadangan OTOMATIS akan dipertahankan berdasarkan setelan retensi cadangan. |
entraidConfig |
Opsional. Konfigurasi Microsoft Entra ID untuk instance SQL Server. |
performanceCaptureConfig |
Opsional. Konfigurasi untuk Perekaman Performa, memberikan metrik diagnostik selama situasi beban tinggi. |
Kolom union
|
|
dataDiskProvisionedIops |
Opsional. Jumlah operasi I/O per detik yang disediakan untuk disk data. Kolom ini hanya digunakan untuk jenis disk hyperdisk-balanced. |
Kolom union
|
|
dataDiskProvisionedThroughput |
Opsional. Throughput yang disediakan diukur dalam MiB per detik untuk disk data. Kolom ini hanya digunakan untuk jenis disk hyperdisk-balanced. |
Kolom union
|
|
connectionPoolConfig |
Opsional. Konfigurasi penggabungan koneksi terkelola untuk instance. |
Kolom union
|
|
finalBackupConfig |
Opsional. Konfigurasi cadangan akhir untuk instance. |
Kolom union
|
|
readPoolAutoScaleConfig |
Opsional. Konfigurasi penskalaan otomatis kumpulan baca untuk instance. |
Kolom union
|
|
autoUpgradeEnabled |
Opsional. Konfigurasi upgrade otomatis Cloud SQL untuk MySQL. Jika parameter ini disetel ke benar (true), upgrade otomatis akan diaktifkan untuk versi minor MySQL 8.0. Versi MySQL harus 8.0.35 atau yang lebih tinggi. |
Kolom union
|
|
dataApiAccess |
Parameter ini mengontrol apakah akan mengizinkan penggunaan ExecuteSql API untuk terhubung ke instance. Tidak diizinkan secara default. |
Int64Value
| Representasi JSON |
|---|
{ "value": string } |
| Kolom | |
|---|---|
value |
Nilai int64. |
UserLabelsEntry
| Representasi JSON |
|---|
{ "key": string, "value": string } |
| Kolom | |
|---|---|
key |
|
value |
|
IpConfiguration
| Representasi JSON |
|---|
{ "ipv4Enabled": boolean, "privateNetwork": string, "requireSsl": boolean, "authorizedNetworks": [ { object ( |
| Kolom | |
|---|---|
ipv4Enabled |
Apakah instance diberi alamat IP publik atau tidak. |
privateNetwork |
Link resource untuk jaringan VPC tempat instance Cloud SQL dapat diakses untuk IP pribadi. Misalnya, |
requireSsl |
Sebagai gantinya, gunakan Apakah koneksi SSL/TLS melalui IP diterapkan. Jika disetel ke false, izinkan koneksi non-SSL/non-TLS dan SSL/TLS. Untuk koneksi SSL/TLS, sertifikat klien tidak akan diverifikasi. Jika disetel ke benar (true), maka hanya izinkan koneksi yang dienkripsi dengan SSL/TLS dan dengan sertifikat klien yang valid. Jika Anda ingin menerapkan SSL/TLS tanpa menerapkan persyaratan untuk sertifikat klien yang valid, gunakan tanda |
authorizedNetworks[] |
Daftar jaringan eksternal yang diizinkan untuk terhubung ke instance menggunakan IP. Dalam notasi 'CIDR', juga dikenal sebagai notasi 'garis miring' (misalnya: |
allocatedIpRange |
Nama rentang IP yang dialokasikan untuk instance Cloud SQL IP pribadi. Misalnya: "google-managed-services-default". Jika disetel, IP instance akan dibuat dalam rentang yang dialokasikan. Nama rentang harus mematuhi RFC 1035. Secara khusus, nama harus terdiri dari 1-63 karakter dan cocok dengan ekspresi reguler |
enablePrivatePathForGoogleCloudServices |
Mengontrol konektivitas ke instance IP pribadi dari layanan Google, seperti BigQuery. |
sslMode |
Menentukan cara penerapan SSL/TLS dalam koneksi database. Jika Anda harus menggunakan tanda Untuk PostgreSQL dan MySQL:
Untuk SQL Server:
Nilai Misalnya, untuk pasangan |
customSubjectAlternativeNames[] |
Opsional. Nama Alternatif Subjek(SAN) kustom untuk instance Cloud SQL. |
Kolom union
|
|
pscConfig |
Setelan PSC untuk instance ini. |
Kolom union
|
|
serverCaMode |
Tentukan jenis CA yang digunakan untuk sertifikat server. |
Kolom union
|
|
serverCaPool |
Opsional. Nama resource kumpulan CA server untuk instance dengan |
Kolom union
|
|
serverCertificateRotationMode |
Opsional. Mengontrol fitur rotasi sertifikat server otomatis. Fitur ini dinonaktifkan secara default. Jika diaktifkan, sertifikat server akan dirotasi secara otomatis selama update pemeliharaan mandiri atau pemeliharaan terjadwal Cloud SQL hingga enam bulan sebelum masa berlakunya berakhir. Setelan ini hanya dapat disetel jika server_ca_mode adalah GOOGLE_MANAGED_CAS_CA atau CUSTOMER_MANAGED_CAS_CA. |
BoolValue
| Representasi JSON |
|---|
{ "value": boolean } |
| Kolom | |
|---|---|
value |
Nilai bool. |
AclEntry
| Representasi JSON |
|---|
{ "value": string, "expirationTime": string, "name": string, "kind": string } |
| Kolom | |
|---|---|
value |
Nilai yang masuk daftar yang diizinkan untuk daftar kontrol akses. |
expirationTime |
Waktu saat entri kontrol akses ini berakhir dalam format RFC 3339, misalnya Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
name |
Opsional. Label untuk mengidentifikasi entri ini. |
kind |
Nilai ini selalu |
Stempel waktu
| Representasi JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Kolom | |
|---|---|
seconds |
Mewakili detik waktu UTC sejak epoch Unix 1970-01-01T00:00:00Z. Harus antara -62135596800 dan 253402300799 inklusif (yang sesuai dengan 0001-01-01T00:00:00Z hingga 9999-12-31T23:59:59Z). |
nanos |
Pecahan detik non-negatif pada resolusi nanodetik. Kolom ini adalah bagian nanodetik dari durasi, bukan alternatif untuk detik. Nilai detik negatif dengan pecahan harus tetap memiliki nilai nanos non-negatif yang dihitung maju dalam waktu. Harus antara 0 dan 999.999.999 inklusif. |
PscConfig
| Representasi JSON |
|---|
{ "allowedConsumerProjects": [ string ], "pscAutoConnections": [ { object ( |
| Kolom | |
|---|---|
allowedConsumerProjects[] |
Opsional. Daftar project konsumen yang masuk daftar yang diizinkan untuk koneksi PSC ke instance ini. Instance ini dapat terhubung dengan PSC dari jaringan mana pun dalam project ini. Setiap project konsumen dalam daftar ini dapat diwakili oleh nomor project (numerik) atau oleh project ID (alfanumerik). |
pscAutoConnections[] |
Opsional. Daftar setelan untuk endpoint konsumen Private Service Connect yang diminta yang dapat digunakan untuk terhubung ke instance Cloud SQL ini. |
networkAttachmentUri |
Opsional. Lampiran jaringan dari jaringan konsumen yang instance Cloud SQL yang mendukung Private Service Connect diizinkan untuk terhubung melalui antarmuka PSC. Format: projects/PROJECT/regions/REGION/networkAttachments/ID |
Kolom union
|
|
pscEnabled |
Apakah konektivitas PSC diaktifkan untuk instance ini. |
PscAutoConnectionConfig
| Representasi JSON |
|---|
{ "consumerProject": string, "consumerNetwork": string, // Union field |
| Kolom | |
|---|---|
consumerProject |
Opsional. Ini adalah project ID project layanan konsumen dari endpoint konsumen ini. Opsional. Hal ini hanya berlaku jika consumer_network adalah jaringan VPC bersama. |
consumerNetwork |
Opsional. Jaringan konsumen dari endpoint konsumen ini. Ini harus berupa jalur resource yang mencakup project host dan nama jaringan. Misalnya, Project host konsumen dari jaringan ini mungkin berbeda dengan project layanan konsumen. |
Kolom union
|
|
ipAddress |
Alamat IP endpoint konsumen. |
Kolom union
|
|
status |
Status koneksi endpoint konsumen. |
Kolom union
|
|
consumerNetworkStatus |
Status kebijakan koneksi jaringan konsumen. |
LocationPreference
| Representasi JSON |
|---|
{ "followGaeApplication": string, "zone": string, "secondaryZone": string, "kind": string } |
| Kolom | |
|---|---|
followGaeApplication |
Aplikasi App Engine yang akan diikuti, harus berada di region yang sama dengan instance Cloud SQL. PERINGATAN: Mengubah setelan ini dapat memulai ulang instance. |
zone |
Zona Compute Engine pilihan (misalnya: us-central1-a, us-central1-b, dll.). PERINGATAN: Mengubah setelan ini dapat memulai ulang instance. |
secondaryZone |
Zona Compute Engine pilihan untuk sekunder/failover (misalnya: us-central1-a, us-central1-b, dll.). Untuk menonaktifkan kolom ini, tetapkan ke 'no_secondary_zone'. |
kind |
Nilai ini selalu |
DatabaseFlags
| Representasi JSON |
|---|
{ "name": string, "value": string } |
| Kolom | |
|---|---|
name |
Nama tanda. Flag ini diteruskan saat startup instance, jadi sertakan opsi server dan variabel sistem. Flag ditentukan dengan garis bawah, bukan tanda hubung. Untuk mengetahui informasi selengkapnya, lihat Mengonfigurasi Flag Database dalam dokumentasi Cloud SQL. |
value |
Nilai tanda. Flag Boolean ditetapkan ke |
MaintenanceWindow
| Representasi JSON |
|---|
{
"hour": integer,
"day": integer,
"updateTrack": enum ( |
| Kolom | |
|---|---|
hour |
Jam dalam sehari - 0 hingga 23. Tentukan di zona waktu UTC. |
day |
Hari dalam seminggu - |
updateTrack |
Setelan waktu pemeliharaan: |
kind |
Nilai ini selalu |
Int32Value
| Representasi JSON |
|---|
{ "value": integer } |
| Kolom | |
|---|---|
value |
Nilai int32. |
BackupConfiguration
| Representasi JSON |
|---|
{ "startTime": string, "enabled": boolean, "kind": string, "binaryLogEnabled": boolean, "replicationLogArchivingEnabled": boolean, "location": string, "pointInTimeRecoveryEnabled": boolean, "backupRetentionSettings": { object ( |
| Kolom | |
|---|---|
startTime |
Waktu mulai untuk konfigurasi pencadangan harian dalam zona waktu UTC dalam format 24 jam - |
enabled |
Apakah konfigurasi ini diaktifkan. |
kind |
Nilai ini selalu |
binaryLogEnabled |
(Khusus MySQL) Apakah log biner diaktifkan. Jika konfigurasi pencadangan dinonaktifkan, binarylog juga harus dinonaktifkan. |
replicationLogArchivingEnabled |
Dipesan untuk penggunaan di masa mendatang. |
location |
Lokasi cadangan |
pointInTimeRecoveryEnabled |
Apakah pemulihan point-in-time diaktifkan. |
backupRetentionSettings |
Setelan retensi cadangan. |
transactionLogRetentionDays |
Jumlah hari log transaksi yang kami simpan untuk pemulihan point-in-time, dari 1-7. |
Kolom union
|
|
transactionalLogStorageState |
Hanya output. Nilai ini berisi lokasi penyimpanan log transaksional yang digunakan untuk melakukan pemulihan point-in-time (PITR) untuk database. |
Kolom union
|
|
backupTier |
Hanya output. Tingkat cadangan yang mengelola cadangan untuk instance. |
BackupRetentionSettings
| Representasi JSON |
|---|
{
"retentionUnit": enum ( |
| Kolom | |
|---|---|
retentionUnit |
Unit yang diwakili oleh 'retained_backups'. |
retainedBackups |
Bergantung pada nilai retention_unit, ini digunakan untuk menentukan apakah cadangan perlu dihapus. Jika retention_unit adalah 'COUNT', kami akan menyimpan cadangan sebanyak ini. |
SqlActiveDirectoryConfig
| Representasi JSON |
|---|
{
"kind": string,
"domain": string,
"mode": enum ( |
| Kolom | |
|---|---|
kind |
Ini selalu sql#activeDirectoryConfig. |
domain |
Nama domain (misalnya, mydomain.com). |
mode |
Opsional. Mode konfigurasi Active Directory. |
dnsServers[] |
Opsional. Alamat IPv4 pengontrol domain yang digunakan untuk mem-bootstrap Active Directory. |
adminCredentialSecretName |
Opsional. Kunci secret manager yang menyimpan kredensial administrator. (misalnya, projects/{project}/secrets/{secret}). |
organizationalUnit |
Opsional. Nama khusus unit organisasi. Ini adalah jalur hierarki lengkap ke unit organisasi. |
DenyMaintenancePeriod
| Representasi JSON |
|---|
{ "startDate": string, "endDate": string, "time": string } |
| Kolom | |
|---|---|
startDate |
Tanggal mulai "periode penolakan pemeliharaan". Jika tahun tanggal mulai kosong, tahun tanggal akhir juga harus kosong. Dalam hal ini, berarti periode tolak pemeliharaan berulang setiap tahun. Tanggal dalam format yyyy-mm-dd, yaitu 2020-11-01, atau bb-hh, yaitu, 11-01 |
endDate |
Tanggal akhir "periode tolak pemeliharaan". Jika tahun tanggal akhir kosong, tahun tanggal mulai juga harus kosong. Dalam hal ini, artinya interval tanpa pemeliharaan berulang setiap tahun. Tanggal dalam format yyyy-mm-dd, yaitu 2020-11-01, atau bb-hh, yaitu, 11-01 |
time |
Waktu dalam UTC saat "periode penolakan pemeliharaan" dimulai pada start_date dan berakhir pada end_date. Waktu dalam format: HH:mm:SS, yaitu, 00:00:00 |
InsightsConfig
| Representasi JSON |
|---|
{ "queryInsightsEnabled": boolean, "recordClientAddress": boolean, "recordApplicationTags": boolean, "queryStringLength": integer, "queryPlansPerMinute": integer, "enhancedQueryInsightsEnabled": boolean } |
| Kolom | |
|---|---|
queryInsightsEnabled |
Apakah fitur Insight Kueri diaktifkan. |
recordClientAddress |
Apakah Insight Kueri akan merekam alamat klien saat diaktifkan. |
recordApplicationTags |
Apakah Query Insight akan merekam tag aplikasi dari kueri saat diaktifkan. |
queryStringLength |
Panjang kueri maksimum yang disimpan dalam byte. Nilai default: 1024 byte. Rentang: 256-4.500 byte. Panjang kueri yang lebih besar dari nilai kolom ini akan dipangkas menjadi nilai ini. Jika tidak ditetapkan, panjang kueri akan menjadi nilai default. Mengubah panjang kueri akan memulai ulang database. |
queryPlansPerMinute |
Jumlah rencana eksekusi kueri yang diambil oleh Insight per menit untuk semua kueri yang digabungkan. Defaultnya adalah 5. |
enhancedQueryInsightsEnabled |
Opsional. Apakah fitur insight kueri yang ditingkatkan diaktifkan. |
PasswordValidationPolicy
| Representasi JSON |
|---|
{
"minLength": integer,
"complexity": enum ( |
| Kolom | |
|---|---|
minLength |
Jumlah karakter minimum yang diizinkan. |
complexity |
Kerumitan sandi. |
reuseInterval |
Jumlah sandi sebelumnya yang tidak dapat digunakan kembali. |
disallowUsernameSubstring |
Melarang nama pengguna sebagai bagian dari sandi. |
passwordChangeInterval |
Interval minimum setelah sandi dapat diubah. Flag ini hanya didukung untuk PostgreSQL. Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan ' |
enablePasswordPolicy |
Apakah akan mengaktifkan kebijakan sandi atau tidak. Jika diaktifkan, sandi harus memenuhi persyaratan kompleksitas. Aktifkan kebijakan ini untuk membantu mencegah akses tidak sah. Menonaktifkan kebijakan ini akan mengizinkan sandi yang lemah. |
disallowCompromisedCredentials |
Kolom ini tidak digunakan lagi dan akan dihapus di versi API mendatang. |
Durasi
| Representasi JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Kolom | |
|---|---|
seconds |
Detik bertanda dari rentang waktu. Harus dari -315.576.000.000 hingga +315.576.000.000 inklusif. Catatan: batas ini dihitung dari: 60 dtk/mnt * 60 mnt/j * 24 j/h * 365,25 h/thn * 10.000 thn |
nanos |
Pecahan detik bertanda pada resolusi nanodetik rentang waktu. Durasi kurang dari satu detik ditampilkan dengan kolom |
SqlServerAuditConfig
| Representasi JSON |
|---|
{ "kind": string, "bucket": string, "retentionInterval": string, "uploadInterval": string } |
| Kolom | |
|---|---|
kind |
Ini selalu sql#sqlServerAuditConfig |
bucket |
Nama bucket tujuan (misalnya, gs://mybucket). |
retentionInterval |
Durasi file audit yang dibuat akan dipertahankan. Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan ' |
uploadInterval |
Seberapa sering mengupload file audit yang dibuat. Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan ' |
AdvancedMachineFeatures
| Representasi JSON |
|---|
{ "threadsPerCore": integer } |
| Kolom | |
|---|---|
threadsPerCore |
Jumlah thread per inti fisik. |
DataCacheConfig
| Representasi JSON |
|---|
{ "dataCacheEnabled": boolean } |
| Kolom | |
|---|---|
dataCacheEnabled |
Apakah cache data diaktifkan untuk instance. |
ConnectionPoolConfig
| Representasi JSON |
|---|
{ "flags": [ { object ( |
| Kolom | |
|---|---|
flags[] |
Opsional. Daftar tanda konfigurasi kumpulan koneksi. |
Kolom union
|
|
connectionPoolingEnabled |
Apakah penggabungan koneksi terkelola diaktifkan atau tidak. |
Kolom union
|
|
poolerCount |
Hanya output. Jumlah penggabung koneksi. |
ConnectionPoolFlags
| Representasi JSON |
|---|
{ "name": string, "value": string } |
| Kolom | |
|---|---|
name |
Wajib. Nama tanda. |
value |
Wajib. Nilai tanda. Flag Boolean ditetapkan ke |
FinalBackupConfig
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union
|
|
enabled |
Apakah pencadangan akhir diaktifkan untuk instance. |
Kolom union
|
|
retentionDays |
Jumlah hari untuk mempertahankan cadangan akhir setelah penghapusan instance. Cadangan terakhir akan dihapus permanen pada (time_of_instance_deletion + retention_days). |
ReadPoolAutoScaleConfig
| Representasi JSON |
|---|
{ "targetMetrics": [ { object ( |
| Kolom | |
|---|---|
targetMetrics[] |
Opsional. Metrik target untuk penskalaan otomatis kumpulan baca. |
Kolom union
|
|
enabled |
Menunjukkan apakah penskalaan otomatis pool baca diaktifkan. |
Kolom union
|
|
minNodeCount |
Jumlah minimum node kumpulan baca yang akan dipertahankan. |
Kolom union
|
|
maxNodeCount |
Jumlah maksimum node kumpulan baca yang akan dipertahankan. |
Kolom union
|
|
disableScaleIn |
Menunjukkan apakah penskalaan otomatis kumpulan baca mendukung operasi penurunan skala (menghapus node). |
Kolom union
|
|
scaleInCooldownSeconds |
Periode tunggu untuk operasi pengecilan. |
Kolom union
|
|
scaleOutCooldownSeconds |
Periode tunggu untuk operasi penskalaan. |
TargetMetric
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union
|
|
metric |
Nama metrik yang akan digunakan untuk penskalaan otomatis. |
Kolom union
|
|
targetValue |
Nilai target untuk metrik. |
SqlServerEntraIdConfig
| Representasi JSON |
|---|
{ "kind": string, "tenantId": string, "applicationId": string } |
| Kolom | |
|---|---|
kind |
Hanya output. Ini selalu sql#sqlServerEntraIdConfig |
tenantId |
Opsional. ID tenant untuk konfigurasi Entra ID. |
applicationId |
Opsional. ID aplikasi untuk konfigurasi Entra ID. |
PerformanceCaptureConfig
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union
|
|
enabled |
Opsional. Mengaktifkan atau menonaktifkan fitur Perekaman Performa. |
Kolom union
|
|
probingIntervalSeconds |
Opsional. Interval waktu dalam detik antara dua pemeriksaan. |
Kolom union
|
|
probeThreshold |
Opsional. Jumlah minimum pembacaan berturut-turut di atas nilai minimum yang memicu pengambilan status instance. |
Kolom union
|
|
runningThreadsThreshold |
Opsional. Jumlah minimum thread server yang berjalan untuk memicu pengambilan di server utama. |
Kolom union
|
|
secondsBehindSourceThreshold |
Opsional. Jumlah minimum detik replika harus tertinggal dari yang utama untuk memicu pengambilan di replika. |
Kolom union
|
|
transactionDurationThreshold |
Opsional. Durasi waktu dalam detik yang diperlukan agar transaksi tetap terbuka sebelum pengamat mulai merekamnya. |
SqlFailoverReplica
| Representasi JSON |
|---|
{ "name": string, "available": boolean } |
| Kolom | |
|---|---|
name |
Nama replika failover. Jika ditentukan saat pembuatan instance, replika failover akan dibuat untuk instance tersebut. Nama tidak menyertakan project ID. |
available |
Status ketersediaan replika failover. Status salah menunjukkan bahwa replika failover tidak disinkronkan. Instance utama hanya dapat melakukan failover ke replika failover jika statusnya benar. |
IpMapping
| Representasi JSON |
|---|
{
"type": enum ( |
| Kolom | |
|---|---|
type |
Jenis alamat IP ini. Alamat |
ipAddress |
Alamat IP yang ditetapkan. |
timeToRetire |
Waktu jatuh tempo agar IP ini dihentikan dalam format RFC 3339, misalnya Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
SslCert
| Representasi JSON |
|---|
{ "kind": string, "certSerialNumber": string, "cert": string, "createTime": string, "commonName": string, "expirationTime": string, "sha1Fingerprint": string, "instance": string, "selfLink": string } |
| Kolom | |
|---|---|
kind |
Nilai ini selalu |
certSerialNumber |
Nomor seri, seperti yang diekstrak dari sertifikat. |
cert |
Representasi PEM. |
createTime |
Waktu saat sertifikat dibuat dalam format RFC 3339, misalnya Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
commonName |
Nama yang diberikan pengguna. Dibatasi ke [a-zA-Z.-_ ]+. |
expirationTime |
Waktu saat sertifikat berakhir dalam format RFC 3339, misalnya Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
sha1Fingerprint |
Sidik Jari Sha1. |
instance |
Nama instance database. |
selfLink |
URI resource ini. |
OnPremisesConfiguration
| Representasi JSON |
|---|
{ "hostPort": string, "kind": string, "username": string, "password": string, "caCertificate": string, "clientCertificate": string, "clientKey": string, "dumpFilePath": string, "sourceInstance": { object ( |
| Kolom | |
|---|---|
hostPort |
Host dan port instance lokal dalam format host:port |
kind |
Nilai ini selalu |
username |
Nama pengguna untuk terhubung ke instance lokal. |
password |
Sandi untuk terhubung ke instance lokal. |
caCertificate |
Representasi PEM dari sertifikat x509 CA tepercaya. |
clientCertificate |
Representasi PEM dari sertifikat x509 replika. |
clientKey |
Representasi PEM dari kunci pribadi replika. Kunci publik yang sesuai dienkode dalam sertifikat klien. |
dumpFilePath |
File dump untuk membuat replika Cloud SQL. |
sourceInstance |
Referensi ke instance Cloud SQL jika sumbernya adalah Cloud SQL. |
selectedObjects[] |
Opsional. Daftar objek yang dipilih pengguna untuk direplikasi dari instance sumber eksternal. |
sslOption |
Opsional. Opsi SSL untuk koneksi replika ke sumber lokal. |
InstanceReference
| Representasi JSON |
|---|
{ "name": string, "region": string, "project": string } |
| Kolom | |
|---|---|
name |
Nama instance Cloud SQL yang dirujuk. Ini tidak menyertakan project ID. |
region |
Region instance Cloud SQL yang dirujuk. |
project |
ID project instance Cloud SQL yang dirujuk. Nilai defaultnya adalah project ID yang sama dengan yang dirujuk instance. |
SelectedObjects
| Representasi JSON |
|---|
{ "database": string } |
| Kolom | |
|---|---|
database |
Wajib. Nama database yang akan dimigrasikan. |
ReplicaConfiguration
| Representasi JSON |
|---|
{
"kind": string,
"mysqlReplicaConfiguration": {
object ( |
| Kolom | |
|---|---|
kind |
Nilai ini selalu |
mysqlReplicaConfiguration |
Konfigurasi khusus MySQL saat mereplikasi dari instance utama MySQL lokal. Informasi konfigurasi replikasi seperti nama pengguna, sandi, sertifikat, dan kunci tidak disimpan dalam metadata instance. Informasi konfigurasi hanya digunakan untuk menyiapkan koneksi replikasi dan disimpan oleh MySQL dalam file bernama |
failoverTarget |
Menentukan apakah replika adalah target failover. Jika kolom disetel ke |
cascadableReplica |
Opsional. Menentukan apakah replika SQL Server adalah replika yang dapat dikaskade. Replika yang dapat dikaskade adalah replika lintas region SQL Server yang mendukung replika di bawahnya. |
MySqlReplicaConfiguration
| Representasi JSON |
|---|
{ "dumpFilePath": string, "username": string, "password": string, "connectRetryInterval": integer, "masterHeartbeatPeriod": string, "caCertificate": string, "clientCertificate": string, "clientKey": string, "sslCipher": string, "verifyServerCertificate": boolean, "kind": string } |
| Kolom | |
|---|---|
dumpFilePath |
Jalur ke file dump SQL di Google Cloud Storage yang akan digunakan untuk membuat instance replika. URI dalam bentuk gs://bucketName/fileName. File gzip terkompresi (.gz) juga didukung. Dump memiliki koordinat binlog yang menjadi titik awal replikasi. Hal ini dapat dilakukan dengan menyetel --master-data ke 1 saat menggunakan mysqldump. |
username |
Nama pengguna untuk koneksi replikasi. |
password |
Sandi untuk koneksi replikasi. |
connectRetryInterval |
Detik untuk menunggu di antara percobaan ulang koneksi. Default MySQL adalah 60 detik. |
masterHeartbeatPeriod |
Interval dalam milidetik antara detak jantung replikasi. |
caCertificate |
Representasi PEM dari sertifikat x509 CA tepercaya. |
clientCertificate |
Representasi PEM dari sertifikat x509 replika. |
clientKey |
Representasi PEM dari kunci pribadi replika. Kunci publik yang sesuai dienkode dalam sertifikat klien. |
sslCipher |
Daftar cipher yang diizinkan untuk digunakan dalam enkripsi SSL. |
verifyServerCertificate |
Apakah akan memeriksa nilai Nama Umum instance utama dalam sertifikat yang dikirim selama handshake SSL atau tidak. |
kind |
Nilai ini selalu |
DiskEncryptionConfiguration
| Representasi JSON |
|---|
{ "kmsKeyName": string, "kind": string } |
| Kolom | |
|---|---|
kmsKeyName |
Nama resource kunci KMS untuk enkripsi disk |
kind |
Nilai ini selalu |
DiskEncryptionStatus
| Representasi JSON |
|---|
{ "kmsKeyVersionName": string, "kind": string } |
| Kolom | |
|---|---|
kmsKeyVersionName |
Versi kunci KMS yang digunakan untuk mengenkripsi resource instance Cloud SQL |
kind |
Nilai ini selalu |
SqlScheduledMaintenance
| Representasi JSON |
|---|
{ "startTime": string, "canDefer": boolean, "canReschedule": boolean, // Union field |
| Kolom | |
|---|---|
startTime |
Waktu mulai pemeliharaan terjadwal yang akan datang untuk instance ini. Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
canDefer |
|
canReschedule |
Jika pemeliharaan terjadwal dapat dijadwalkan ulang. |
Kolom union
|
|
scheduleDeadlineTime |
Pemeliharaan tidak dapat dijadwalkan ulang untuk dimulai setelah batas waktu ini. Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
SqlOutOfDiskReport
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union
|
|
sqlOutOfDiskState |
Kolom ini menunjukkan status yang dihasilkan oleh tugas kesehatan database proaktif untuk masalah OutOfDisk. * Penulis: * tugas pemeliharaan database proaktif untuk OOD. * Pembaca: * tugas pemeliharaan database proaktif |
Kolom union
|
|
sqlMinRecommendedIncreaseSizeGb |
Ukuran peningkatan minimum yang direkomendasikan dalam GigaByte. Kolom ini digunakan oleh frontend * Penulis: * tugas pemeliharaan database proaktif untuk OOD. * Pembaca: |
AvailableDatabaseVersion
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union
|
|
majorVersion |
Nama versi utama versi. |
Kolom union
|
|
name |
Nama versi database. Untuk MySQL 8.0, string ini memberikan versi utama dan minor database. |
Kolom union
|
|
displayName |
Nama tampilan versi database. |
ReplicationCluster
| Representasi JSON |
|---|
{ "psaWriteEndpoint": string, "failoverDrReplicaName": string, "drReplica": boolean } |
| Kolom | |
|---|---|
psaWriteEndpoint |
Hanya output. Jika disetel, kolom ini menunjukkan bahwa instance ini memiliki endpoint DNS akses layanan pribadi (PSA) yang mengarah ke instance utama cluster. Jika instance ini adalah instance utama, maka endpoint DNS mengarah ke instance ini. Setelah operasi failover replika atau switchover, endpoint DNS ini mengarah ke instance yang dipromosikan. Ini adalah kolom hanya baca, yang ditampilkan kepada pengguna sebagai informasi. Kolom ini dapat ada meskipun instance mandiri belum memiliki replika DR atau replika DR dihapus. |
failoverDrReplicaName |
Opsional. Jika instance adalah instance utama, kolom ini mengidentifikasi replika pemulihan dari bencana (DR). Replika DR adalah konfigurasi opsional untuk instance edisi Enterprise Plus. Jika instance adalah replika baca, kolom ini tidak ditetapkan. Tetapkan kolom ini ke nama replika untuk menetapkan replika DR untuk instance utama. Hapus nama replika untuk menghapus penetapan replika DR. |
drReplica |
Hanya output. Kolom hanya baca yang menunjukkan apakah replika adalah replika DR. Kolom ini tidak ditetapkan jika instance adalah instance utama. |
GeminiInstanceConfig
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union
|
|
entitled |
Hanya output. Apakah Gemini diaktifkan. |
Kolom union
|
|
googleVacuumMgmtEnabled |
Hanya output. Apakah pengelolaan robot vakum diaktifkan. |
Kolom union
|
|
oomSessionCancelEnabled |
Hanya output. Apakah pembatalan sesi kehabisan memori (OOM) diaktifkan. |
Kolom union
|
|
activeQueryEnabled |
Hanya output. Apakah kueri aktif diaktifkan. |
Kolom union
|
|
indexAdvisorEnabled |
Hanya output. Apakah penasihat indeks diaktifkan atau tidak. |
Kolom union
|
|
flagRecommenderEnabled |
Hanya output. Apakah pemberi rekomendasi tanda diaktifkan atau tidak. |
TagsEntry
| Representasi JSON |
|---|
{ "key": string, "value": string } |
| Kolom | |
|---|---|
key |
|
value |
|
PoolNodeConfig
| Representasi JSON |
|---|
{ "ipAddresses": [ { object ( |
| Kolom | |
|---|---|
ipAddresses[] |
Hanya output. Pemetaan yang berisi alamat IP yang dapat digunakan untuk terhubung ke node kumpulan baca. |
dnsNames[] |
Hanya output. Daftar nama DNS yang digunakan oleh node kumpulan baca ini. |
pscAutoConnections[] |
Hanya output. Daftar setelan untuk endpoint konsumen Private Service Connect (PSC) yang disiapkan secara otomatis dan diminta yang dapat digunakan untuk terhubung ke node kumpulan baca ini. |
Kolom union
|
|
name |
Hanya output. Nama node kumpulan baca, yang akan digunakan untuk mengambil metrik dan log. |
Kolom union
|
|
gceZone |
Hanya output. Zona node kumpulan baca. |
Kolom union
|
|
dnsName |
Hanya output. Nama DNS node kumpulan baca. |
Kolom union
|
|
state |
Hanya output. Status node pool baca saat ini. |
Kolom union
|
|
pscServiceAttachmentLink |
Hanya output. Lampiran layanan Private Service Connect (PSC) dari node kumpulan baca. |
DnsNameMapping
| Representasi JSON |
|---|
{ "name": string, "connectionType": enum ( |
| Kolom | |
|---|---|
name |
Hanya output. Nama DNS. |
connectionType |
Hanya output. Jenis koneksi nama DNS. |
dnsScope |
Hanya output. Cakupan yang diterapkan nama DNS. |
recordManager |
Hanya output. Pengelola untuk data DNS ini. |
Anotasi Alat
Petunjuk Destruktif: ❌ | Petunjuk Idempoten: ❌ | Petunjuk Hanya Baca: ✅ | Petunjuk Dunia Terbuka: ❌