MCP Tools Reference: cloud-sql

Ferramenta: get_instance

Receba os detalhes de uma instância do Cloud SQL.

O exemplo a seguir demonstra como usar curl para invocar a ferramenta get_instance MCP.

Solicitação 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
}'

Esquema de entrada

Solicitação de recebimento de instância.

SqlInstancesGetRequest

Representação JSON 
{
  "instance": string,
  "project": string
}
Campos
instance

string

Obrigatório. ID da instância do banco de dados. Isso não inclui o ID do projeto.
project

string

Obrigatório. ID do projeto com a instância.

Esquema de saída

Um recurso de instância do Cloud SQL.

DatabaseInstance

Representação 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.
}
Campos
kind

string

Esse valor é sempre sql#instance.
state

enum (SqlInstanceState)

O estado de veiculação atual da instância do Cloud SQL.
databaseVersion

enum (SqlDatabaseVersion)

O tipo e a versão do mecanismo de banco de dados. O campo databaseVersion não pode ser alterado após a criação da instância.
settings

object (Settings)

As configurações do usuário.
etag

string

Este campo está obsoleto e será removido da versão futura da API. Em vez disso, use o campo settings.settingsVersion.
failoverReplica

object (SqlFailoverReplica)

O nome e o status da réplica de failover.
masterInstanceName

string

O nome da instância que atuará como principal na configuração da replicação.
replicaNames[]

string

As réplicas da instância.
maxDiskSize
(deprecated)

string (Int64Value format)

O tamanho máximo do disco da instância em bytes.
currentDiskSize
(deprecated)

string (Int64Value format)

O uso atual do disco da instância em bytes. O uso dessa propriedade foi suspenso. Em vez disso, use a métrica "cloudsql.googleapis.com/database/disk/bytes_used" na API Cloud Monitoring. Consulte este anúncio para mais detalhes.
ipAddresses[]

object (IpMapping)

Os endereços IP atribuídos à instância.
serverCaCert

object (SslCert)

Configuração SSL
instanceType

enum (SqlInstanceType)

O tipo de instância.
project

string

O ID do projeto com a instância do Cloud SQL. O domínio do Google Apps tem o prefixo, se aplicável.
ipv6Address
(deprecated)

string

O endereço IPv6 atribuído à instância. (Obsoleto) Esta propriedade era aplicável apenas a instâncias de primeira geração.
serviceAccountEmailAddress

string

O endereço de e-mail da conta de serviço atribuído à instância.\Essa propriedade é somente leitura.
onPremisesConfiguration

object (OnPremisesConfiguration)

Configuração específica para instâncias locais.
replicaConfiguration

object (ReplicaConfiguration)

Configuração específica para réplicas de failover e réplicas de leitura.
backendType

enum (SqlBackendType)

O tipo de back-end. SECOND_GEN: instância de banco de dados do Cloud SQL. EXTERNAL: um servidor de banco de dados que não é gerenciado pelo Google.

Essa propriedade é somente leitura. Use a propriedade tier no objeto settings para determinar o tipo de banco de dados.
selfLink

string

O URI desse recurso.
suspensionReason[]

enum (SqlSuspensionReason)

Se o estado da instância for SUSPENSO, o motivo da suspensão.
connectionName

string

Nome da conexão da instância do Cloud SQL usada nas strings de conexão.
name

string

Nome da instância do Cloud SQL. Isso não inclui o ID do projeto.
region

string

A região geográfica da instância do Cloud SQL.

Ela pode ser uma das regiões em que o Cloud SQL opera:

Por exemplo, asia-east1, europe-west1 e us-central1. O valor padrão é us-central1.
gceZone

string

A zona do Compute Engine de onde a instância está sendo veiculada. Esse valor pode ser diferente da zona especificada quando a instância foi criada se a instância falhou na zona secundária. AVISO: mudar isso pode reiniciar a instância.
secondaryGceZone

string

A zona do Compute Engine de onde a instância de failover está sendo veiculada para uma instância regional. Esse valor pode ser diferente da zona especificada quando a instância foi criada se a instância falhou na zona secundária/de failover.
diskEncryptionConfiguration

object (DiskEncryptionConfiguration)

Configuração de criptografia de disco específica de uma instância.
diskEncryptionStatus

object (DiskEncryptionStatus)

Status de criptografia de disco específico de uma instância.
rootPassword

string

Senha raiz inicial. Use somente na criação. É necessário definir senhas de root antes de se conectar às instâncias do PostgreSQL.
scheduledMaintenance

object (SqlScheduledMaintenance)

O horário de início de qualquer manutenção agendada futura dessa instância.
satisfiesPzs

boolean

Esse status indica se a instância atende ao PZS.

O status está reservado para uso futuro.
databaseInstalledVersion

string

Apenas saída. Armazena a versão atual do banco de dados em execução na instância, incluindo a versão secundária, como MYSQL_8_0_18.
createTime

string (Timestamp format)

Apenas saída. A hora em que a instância foi criada no formato RFC 3339, por exemplo, 2012-11-15T16:19:00.094Z.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
availableMaintenanceVersions[]

string

Apenas saída. Listar todas as versões de manutenção aplicáveis à instância
maintenanceVersion

string

A versão atual do software na instância.
upgradableDatabaseVersions[]

object (AvailableDatabaseVersion)

Apenas saída. Todas as versões de banco de dados disponíveis para upgrade.
replicationCluster

object (ReplicationCluster)

Opcional. Um par de instância principal e réplica de recuperação de desastres (DR). Uma réplica de DR é uma réplica entre regiões designada para failover caso a instância principal tenha uma falha regional. Aplicável ao MySQL e ao PostgreSQL.
satisfiesPzi

boolean

Apenas saída. Esse status indica se a instância atende ao PZI.

O status está reservado para uso futuro.
tags

map (key: string, value: string)

Opcional. Somente entrada. Imutável. Chaves e valores de tag vinculados a esta instância. É preciso representar cada item no mapa como: "<tag-key-namespaced-name>" : "<tag-value-short-name>".

Por exemplo, um único recurso pode ter as seguintes tags:

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

Para mais informações sobre a criação e o gerenciamento de tags, consulte https://cloud.google.com/resource-manager/docs/tags/tags-overview.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
nodes[]

object (PoolNodeConfig)

Apenas saída. Entradas com informações sobre cada nó do pool de leitura.
dnsNames[]

object (DnsNameMapping)

Apenas saída. A lista de nomes DNS usados por esta instância.

Campo de união _out_of_disk_report.

_out_of_disk_report pode ser apenas de um dos tipos a seguir:
outOfDiskReport

object (SqlOutOfDiskReport)

Esse campo representa o relatório gerado pelo job proativo de integridade do banco de dados para problemas de falta de espaço em disco. * Gravadores: * o job proativo de integridade do banco de dados para OOD. * Leitores: o job proativo de integridade do banco de dados

Campo de união _sql_network_architecture.

_sql_network_architecture pode ser apenas de um dos tipos a seguir:
sqlNetworkArchitecture

enum (SqlNetworkArchitecture)

Campo de união _psc_service_attachment_link.

_psc_service_attachment_link pode ser apenas de um dos tipos a seguir:
pscServiceAttachmentLink

string

Apenas saída. O link para o anexo de serviço da instância do PSC.

Campo de união _dns_name.

_dns_name pode ser apenas de um dos tipos a seguir:
dnsName

string

Apenas saída. O nome DNS da instância.

Campo de união _primary_dns_name.

_primary_dns_name pode ser apenas de um dos tipos a seguir:
primaryDnsName
(deprecated)

string

Apenas saída. OBSOLETO: use write_endpoint.

Campo de união _write_endpoint.

_write_endpoint pode ser apenas de um dos tipos a seguir:
writeEndpoint

string

Apenas saída. O nome DNS da instância principal em um grupo de replicação.

Campo de união _gemini_config.

_gemini_config pode ser apenas de um dos tipos a seguir:
geminiConfig

object (GeminiInstanceConfig)

Configuração da instância do Gemini.

Campo de união _switch_transaction_logs_to_cloud_storage_enabled.

_switch_transaction_logs_to_cloud_storage_enabled pode ser apenas de um dos tipos a seguir:
switchTransactionLogsToCloudStorageEnabled

boolean

Somente entrada. Se o Cloud SQL está ativado para alternar o armazenamento de arquivos de registro de recuperação pontual de um disco de dados para o Cloud Storage.

Campo de união _include_replicas_for_major_version_upgrade.

_include_replicas_for_major_version_upgrade pode ser apenas de um dos tipos a seguir:
includeReplicasForMajorVersionUpgrade

boolean

Somente entrada. Determina se um upgrade de versão principal no local de réplicas acontece quando um upgrade de versão principal no local de uma instância principal é iniciado.

Campo de união _node_count.

_node_count pode ser apenas de um dos tipos a seguir:
nodeCount

integer

O número de nós em um pool de leitura.

Configurações

Representação 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.
}
Campos
settingsVersion

string (Int64Value format)

A versão das configurações da instância. Este é um campo obrigatório para o método de atualização para garantir que as atualizações simultâneas sejam tratadas corretamente. Durante a atualização, use o valor settingsVersion mais recente para essa instância e não tente atualizar esse valor.
authorizedGaeApplications[]
(deprecated)

string

Os IDs do aplicativo do App Engine que podem acessar essa instância. (Obsoleto) Aplicado apenas a instâncias de primeira geração.
tier

string

O nível (ou tipo de máquina) dessa instância, por exemplo, db-custom-1-3840. AVISO: mudar isso reinicia a instância.
kind

string

Esse valor é sempre sql#settings.
userLabels

map (key: string, value: string)

Rótulos fornecidos pelo usuário, representados como um dicionário em que cada rótulo é um único par de chave-valor.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
availabilityType

enum (SqlAvailabilityType)

Tipo de disponibilidade. Valores possíveis: * ZONAL: a instância veicula dados de apenas uma zona. As interrupções nessa zona afetam a acessibilidade dos dados. * REGIONAL: a instância pode veicular dados de mais de uma zona em uma região (ela é altamente disponível).

Para mais informações, consulte Visão geral da configuração de alta disponibilidade.
pricingPlan

enum (SqlPricingPlan)

O plano de preços da instância. Pode ser PER_USE ou PACKAGE. Somente PER_USE é compatível com instâncias de segunda geração.
replicationType
(deprecated)

enum (SqlReplicationType)

O tipo de replicação que esta instância usa. Pode ser ASYNCHRONOUS ou SYNCHRONOUS. (Obsoleto) Essa propriedade era aplicável apenas a instâncias de primeira geração.
storageAutoResizeLimit

string (Int64Value format)

O tamanho máximo da capacidade de armazenamento que pode ser aumentada automaticamente. O valor padrão é 0 (zero), que especifica que não há limite.
activationPolicy

enum (SqlActivationPolicy)

A política de ativação especifica quando a instância é ativada. É aplicável somente quando o estado da instância é RUNNABLE. Valores válidos: * ALWAYS: a instância está ativada e permanece assim mesmo na ausência de solicitações de conexão. * NEVER: a instância está desativada. Não será ativada mesmo que uma solicitação de conexão chegue.
ipConfiguration

object (IpConfiguration)

As configurações do Gerenciamento de IP. Isso permite ativar ou desativar o IP da instância e gerenciar quais redes externas podem se conectar à instância. O endereço IPv4 não pode ser desativado em instâncias de segunda geração.
storageAutoResize

boolean

Configuração para aumentar o tamanho do armazenamento automaticamente. O valor padrão é true.
locationPreference

object (LocationPreference)

As configurações de preferência de local. Isso permite que a instância esteja localizada o mais próximo possível de um aplicativo do App Engine ou de uma zona do Compute Engine para melhorar o desempenho. O co-local do App Engine era aplicável apenas a instâncias de primeira geração.
databaseFlags[]

object (DatabaseFlags)

As sinalizações do banco de dados transmitidas para a instância na inicialização.
dataDiskType

enum (SqlDataDiskType)

O tipo de disco de dados: PD_SSD (padrão) ou PD_HDD. Não é usado em instâncias de primeira geração.
maintenanceWindow

object (MaintenanceWindow)

A janela de manutenção dessa instância. Isso especifica quando a instância pode ser reiniciada para fins de manutenção.
backupConfiguration

object (BackupConfiguration)

A configuração de backup diário da instância.
databaseReplicationEnabled

boolean

Configuração específica para ler instâncias de réplica. Indica se a replicação está ativada ou não. AVISO: mudar isso reinicia a instância.
crashSafeReplicationEnabled
(deprecated)

boolean

Configuração específica para ler instâncias de réplica. Indica se as sinalizações do banco de dados para replicação de segurança contra falhas estão ativadas. Essa propriedade era aplicável apenas a instâncias de primeira geração.
dataDiskSizeGb

string (Int64Value format)

O tamanho do disco de dados, em GB. O tamanho mínimo do disco de dados é de 10 GB.
activeDirectoryConfig

object (SqlActiveDirectoryConfig)

Configuração do Active Directory, relevante apenas para o Cloud SQL para SQL Server.
collation

string

O nome do agrupamento de instâncias do servidor.
denyMaintenancePeriods[]

object (DenyMaintenancePeriod)

Períodos de bloqueio de manutenção
insightsConfig

object (InsightsConfig)

Configuração de insights, por enquanto relevante apenas para o Postgres.
passwordValidationPolicy

object (PasswordValidationPolicy)

A política de validação de senha do usuário local da instância.
sqlServerAuditConfig

object (SqlServerAuditConfig)

Configuração de auditoria específica do SQL Server.
edition

enum (Edition)

Opcional. A edição da instância.
connectorEnforcement

enum (ConnectorEnforcement)

Especifica se as conexões precisam usar conectores do Cloud SQL. Os valores de opção incluem o seguinte: NOT_REQUIRED (as instâncias do Cloud SQL podem ser conectadas sem os conectores do Cloud SQL) e REQUIRED (permite apenas conexões que usam os conectores do Cloud SQL).

O uso de REQUIRED desativa todas as redes autorizadas atuais. Se esse campo não for especificado ao criar uma instância, NOT_REQUIRED será usado. Se esse campo não for especificado ao adicionar um patch ou atualizar uma instância, ele vai permanecer inalterado.
deletionProtectionEnabled

boolean

Configuração para proteção contra exclusão acidental de instâncias.
timeZone

string

Fuso horário do servidor, relevante apenas para o Cloud SQL para SQL Server.
advancedMachineFeatures

object (AdvancedMachineFeatures)

Especifica a configuração avançada da máquina para as instâncias relevantes apenas para o SQL Server.
dataCacheConfig

object (DataCacheConfig)

Configuração para cache de dados.
replicationLagMaxSeconds

integer

Opcional. Valor de configuração para recriação da réplica após determinado atraso de replicação
enableGoogleMlIntegration

boolean

Opcional. Quando esse parâmetro é definido como "true", as instâncias do Cloud SQL podem se conectar à Vertex AI para transmitir solicitações de previsões em tempo real e insights para a IA. O valor padrão é falso. Isso se aplica apenas às instâncias do Cloud SQL para MySQL e do Cloud SQL para PostgreSQL.
enableDataplexIntegration

boolean

Opcional. Por padrão, as instâncias do Cloud SQL têm a extração de esquema desativada para o Dataplex. Quando esse parâmetro é definido como "true", a extração de esquema para o Dataplex em instâncias do Cloud SQL é ativada.
retainBackupsOnDelete

boolean

Opcional. Quando esse parâmetro é definido como "true", o Cloud SQL retém backups da instância mesmo depois que ela é excluída. O backup ON_DEMAND será mantido até que o cliente o exclua ou exclua o projeto. O backup AUTOMATED será retido com base na configuração de retenção de backups.
entraidConfig

object (SqlServerEntraIdConfig)

Opcional. A configuração do Microsoft Entra ID para a instância do SQL Server.
performanceCaptureConfig

object (PerformanceCaptureConfig)

Opcional. Configuração para captura de performance, que fornece métricas de diagnóstico em situações de alta carga.

Campo de união _data_disk_provisioned_iops.

_data_disk_provisioned_iops pode ser apenas de um dos tipos a seguir:
dataDiskProvisionedIops

string (int64 format)

Opcional. Número provisionado de operações de E/S por segundo para o disco de dados. Esse campo só é usado para tipos de disco balanceados de hiperdisco.

Campo de união _data_disk_provisioned_throughput.

_data_disk_provisioned_throughput pode ser apenas de um dos tipos a seguir:
dataDiskProvisionedThroughput

string (int64 format)

Opcional. Capacidade de processamento provisionada medida em MiB por segundo para o disco de dados. Esse campo só é usado para tipos de disco balanceados de hiperdisco.

Campo de união _connection_pool_config.

_connection_pool_config pode ser apenas de um dos tipos a seguir:
connectionPoolConfig

object (ConnectionPoolConfig)

Opcional. A configuração de pooling de conexões gerenciado para a instância.

Campo de união _final_backup_config.

_final_backup_config pode ser apenas de um dos tipos a seguir:
finalBackupConfig

object (FinalBackupConfig)

Opcional. A configuração final de backup da instância.

Campo de união _read_pool_auto_scale_config.

_read_pool_auto_scale_config pode ser apenas de um dos tipos a seguir:
readPoolAutoScaleConfig

object (ReadPoolAutoScaleConfig)

Opcional. A configuração de escalonamento automático do pool de leitura para a instância.

Campo de união _auto_upgrade_enabled.

_auto_upgrade_enabled pode ser apenas de um dos tipos a seguir:
autoUpgradeEnabled

boolean

Opcional. Configuração de upgrade automático do Cloud SQL para MySQL. Quando esse parâmetro é definido como "true", o upgrade automático é ativado para versões secundárias do MySQL 8.0. A versão do MySQL precisa ser 8.0.35 ou mais recente.

Campo de união _data_api_access.

_data_api_access pode ser apenas de um dos tipos a seguir:
dataApiAccess

enum (DataApiAccess)

Esse parâmetro controla se o uso da API ExecuteSql para se conectar à instância é permitido. Não permitido por padrão.

Int64Value

Representação JSON 
{
  "value": string
}
Campos
value

string (int64 format)

O valor int64.

UserLabelsEntry

Representação JSON 
{
  "key": string,
  "value": string
}
Campos
key

string
value

string

IpConfiguration

Representação 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.
}
Campos
ipv4Enabled

boolean

Se a instância recebe um endereço IP público ou não.
privateNetwork

string

O link do recurso para a rede VPC a partir da qual a instância do Cloud SQL pode ser acessada para IP particular. Por exemplo, /projects/myProject/global/networks/default Essa configuração pode ser atualizada, mas não pode ser removida após ser definida.
requireSsl

boolean

Use ssl_mode.

Se as conexões SSL/TLS por IP são aplicadas. Se definido como "false", permite conexões não SSL/não TLS e SSL/TLS. Para conexões SSL/TLS, o certificado do cliente não será verificado. Se definido como "true", só permite conexões criptografadas com SSL/TLS e com certificados de cliente válidos. Se você quiser aplicar o SSL/TLS sem exigir certificados de cliente válidos, use a flag ssl_mode em vez de require_ssl.
authorizedNetworks[]

object (AclEntry)

A lista de redes externas que têm permissão para se conectar à instância usando o IP. Na notação "CIDR", também conhecida como "barra" (por exemplo, 157.197.200.0/24).
allocatedIpRange

string

O nome do intervalo de IP alocado para a instância do Cloud SQL de IP privado. Por exemplo: "google-managed-services-default". Se definido, o IP da instância será criado no intervalo alocado. O nome do intervalo precisa estar em conformidade com a RFC 1035. O nome precisa ter de 1 a 63 caracteres e corresponder à expressão regular [a-z]([-a-z0-9]*[a-z0-9])?.
enablePrivatePathForGoogleCloudServices

boolean

Controla a conectividade com instâncias de IP particular dos serviços do Google, como o BigQuery.
sslMode

enum (SslMode)

Especifique como o SSL/TLS é aplicado nas conexões de banco de dados. Se você precisar usar a flag require_ssl para compatibilidade com versões anteriores, apenas os seguintes pares de valores serão válidos:

Para PostgreSQL e MySQL:

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

Para o SQL Server:

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

O valor de ssl_mode tem prioridade sobre o valor de require_ssl.

Por exemplo, para o par ssl_mode=ENCRYPTED_ONLY e require_ssl=false, ssl_mode=ENCRYPTED_ONLY significa aceitar apenas conexões SSL, enquanto require_ssl=false significa aceitar conexões não SSL e SSL. Nesse caso, os bancos de dados MySQL e PostgreSQL respeitam ssl_mode e aceitam apenas conexões SSL.
customSubjectAlternativeNames[]

string

Opcional. Nomes alternativos do assunto(SANs) personalizados para uma instância do Cloud SQL.

Campo de união _psc_config.

_psc_config pode ser apenas de um dos tipos a seguir:
pscConfig

object (PscConfig)

Configurações do PSC para esta instância.

Campo de união _server_ca_mode.

_server_ca_mode pode ser apenas de um dos tipos a seguir:
serverCaMode

enum (CaMode)

Especifique o tipo de CA usado para o certificado do servidor.

Campo de união _server_ca_pool.

_server_ca_pool pode ser apenas de um dos tipos a seguir:
serverCaPool

string

Opcional. O nome do recurso do pool de CA do servidor para uma instância com CUSTOMER_MANAGED_CAS_CA como server_ca_mode. Formato: projects/{PROJECT}/locations/{REGION}/caPools/{CA_POOL_ID}

Campo de união _server_certificate_rotation_mode.

_server_certificate_rotation_mode pode ser apenas de um dos tipos a seguir:
serverCertificateRotationMode

enum (ServerCertificateRotationMode)

Opcional. Controla o recurso de rotação automática de certificados do servidor. Esse recurso é desativado por padrão. Quando ativado, o certificado do servidor é alternado automaticamente durante a manutenção programada do Cloud SQL ou as atualizações de manutenção de autoatendimento até seis meses antes da expiração. Essa configuração só pode ser definida se server_ca_mode for GOOGLE_MANAGED_CAS_CA ou CUSTOMER_MANAGED_CAS_CA.

BoolValue

Representação JSON 
{
  "value": boolean
}
Campos
value

boolean

O valor booleano.

AclEntry

Representação JSON 
{
  "value": string,
  "expirationTime": string,
  "name": string,
  "kind": string
}
Campos
value

string

O valor permitido para a lista de controle de acesso.
expirationTime

string (Timestamp format)

A hora em que essa entrada de controle de acesso expira no formato RFC 3339. Por exemplo, 2012-11-15T16:19:00.094Z.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
name

string

Opcional. Um rótulo para identificar essa entrada.
kind

string

Esse valor é sempre sql#aclEntry.

Carimbo de data/hora

Representação JSON 
{
  "seconds": string,
  "nanos": integer
}
Campos
seconds

string (int64 format)

Representa os segundos do horário UTC desde a época Unix 1970-01-01T00:00:00Z. Precisa estar entre -62135596800 e 253402300799 (o que corresponde a 0001-01-01T00:00:00Z a 9999-12-31T23:59:59Z).
nanos

integer

Frações não negativas de um segundo com resolução de nanossegundos. Esse campo é a parte de nanossegundos da duração, não uma alternativa aos segundos. Os valores de segundos negativos com frações ainda precisam ter valores em nanossegundos não negativos que representam períodos posteriores. O valor precisa estar entre 0 e 999.999.999 (inclusive).

PscConfig

Representação 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.
}
Campos
allowedConsumerProjects[]

string

Opcional. A lista de projetos consumidores que estão na lista de permissões para conexões do PSC com essa instância. Essa instância pode ser conectada com o PSC de qualquer rede nesses projetos.

Cada projeto do consumidor nessa lista pode ser representado por um número (numérico) ou um ID (alfanumérico).
pscAutoConnections[]

object (PscAutoConnectionConfig)

Opcional. A lista de configurações para endpoints do consumidor do Private Service Connect solicitados que podem ser usados para se conectar a esta instância do Cloud SQL.
networkAttachmentUri

string

Opcional. O anexo de rede da rede do consumidor que a instância do Cloud SQL ativada para Private Service Connect está autorizada a se conectar pela interface do PSC. Formato: projects/PROJECT/regions/REGION/networkAttachments/ID

Campo de união _psc_enabled.

_psc_enabled pode ser apenas de um dos tipos a seguir:
pscEnabled

boolean

Indica se a conectividade do PSC está ativada para esta instância.

PscAutoConnectionConfig

Representação 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.
}
Campos
consumerProject

string

Opcional. É o ID do projeto de serviço do consumidor deste endpoint.

Opcional. Isso só é aplicável se "consumer_network" for uma rede VPC compartilhada.
consumerNetwork

string

Opcional. A rede do consumidor deste endpoint do consumidor. Precisa ser um caminho de recurso que inclua o projeto host e o nome da rede.

Por exemplo, projects/project1/global/networks/network1

O projeto host do consumidor dessa rede pode ser diferente do projeto de serviço do consumidor.

Campo de união _ip_address.

_ip_address pode ser apenas de um dos tipos a seguir:
ipAddress

string

O endereço IP do endpoint do consumidor.

Campo de união _status.

_status pode ser apenas de um dos tipos a seguir:
status

string

O status da conexão do endpoint do consumidor.

Campo de união _consumer_network_status.

_consumer_network_status pode ser apenas de um dos tipos a seguir:
consumerNetworkStatus

string

O status da política de conexão da rede do consumidor.

LocationPreference

Representação JSON 
{
  "followGaeApplication": string,
  "zone": string,
  "secondaryZone": string,
  "kind": string
}
Campos
followGaeApplication
(deprecated)

string

O aplicativo do App Engine a seguir, precisa estar na mesma região da instância do Cloud SQL. AVISO: mudar isso pode reiniciar a instância.
zone

string

A zona preferida do Compute Engine (por exemplo, us-central1-a, us-central1-b etc.). AVISO: mudar isso pode reiniciar a instância.
secondaryZone

string

A zona preferida do Compute Engine para o secundário/failover (por exemplo, us-central1-a, us-central1-b etc.). Para desativar esse campo, defina-o como "no_secondary_zone".
kind

string

Esse valor é sempre sql#locationPreference.

DatabaseFlags

Representação JSON 
{
  "name": string,
  "value": string
}
Campos
name

string

O nome da sinalização. Essas flags são transmitidas na inicialização da instância. Portanto, inclua as opções do servidor e as variáveis do sistema. As flags são especificadas com sublinhados, não hifens. Para mais informações, consulte Como configurar sinalizações de banco de dados na documentação do Cloud SQL.
value

string

O valor da sinalização. As flags booleanas são definidas como on para verdadeiro e off para falso. Esse campo precisa ser omitido se a sinalização não aceitar um valor.

MaintenanceWindow

Representação JSON 
{
  "hour": integer,
  "day": integer,
  "updateTrack": enum (SqlUpdateTrack),
  "kind": string
}
Campos
hour

integer

Hora do dia: 0 a 23. Especifique no fuso horário UTC.
day

integer

Dia da semana: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY ou SUNDAY. Especifique no fuso horário UTC. Retornado na saída como um número inteiro, de 1 a 7, em que 1 é igual a segunda-feira.
updateTrack

enum (SqlUpdateTrack)

Configurações de dia/hora da manutenção: canary, stable ou week5. Para mais informações, consulte Sobre a manutenção em instâncias do Cloud SQL.
kind

string

Esse valor é sempre sql#maintenanceWindow.

Int32Value

Representação JSON 
{
  "value": integer
}
Campos
value

integer

O valor int32.

BackupConfiguration

Representação 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.
}
Campos
startTime

string

Hora de início da configuração de backup diário no fuso horário UTC no formato de 24 horas: HH:MM.
enabled

boolean

Se essa configuração está ativada.
kind

string

Esse valor é sempre sql#backupConfiguration.
binaryLogEnabled

boolean

(Somente MySQL) Se o registro binário está ativado. Se a configuração de backup estiver desativada, o binarylog também deverá ser desativado.
replicationLogArchivingEnabled

boolean

Reservado para uso futuro.
location

string

Local do backup
pointInTimeRecoveryEnabled

boolean

Se a recuperação pontual está ativada.
backupRetentionSettings

object (BackupRetentionSettings)

Configurações de retenção de backup.
transactionLogRetentionDays

integer

O número de dias de registros de transações que retemos para restauração pontual, de 1 a 7.

Campo de união _transactional_log_storage_state.

_transactional_log_storage_state pode ser apenas de um dos tipos a seguir:
transactionalLogStorageState

enum (TransactionalLogStorageState)

Apenas saída. Esse valor contém o local de armazenamento dos registros de transações usados para realizar a recuperação pontual (PITR) do banco de dados.

Campo de união _backup_tier.

_backup_tier pode ser apenas de um dos tipos a seguir:
backupTier

enum (BackupTier)

Apenas saída. Nível de backup que gerencia os backups da instância.

BackupRetentionSettings

Representação JSON 
{
  "retentionUnit": enum (RetentionUnit),
  "retainedBackups": integer
}
Campos
retentionUnit

enum (RetentionUnit)

A unidade que "retained_backups" representa.
retainedBackups

integer

Dependendo do valor de "retention_unit", isso é usado para determinar se um backup precisa ser excluído. Se retention_unit for "COUNT", vamos manter esse número de backups.

SqlActiveDirectoryConfig

Representação JSON 
{
  "kind": string,
  "domain": string,
  "mode": enum (ActiveDirectoryMode),
  "dnsServers": [
    string
  ],
  "adminCredentialSecretName": string,
  "organizationalUnit": string
}
Campos
kind

string

É sempre sql#activeDirectoryConfig.
domain

string

O nome do domínio (por exemplo, meudominio.com).
mode

enum (ActiveDirectoryMode)

Opcional. O modo da configuração do Active Directory.
dnsServers[]

string

Opcional. Endereços IPv4 do controlador de domínio usados para inicializar o Active Directory.
adminCredentialSecretName

string

Opcional. A chave do gerenciador de secrets que armazena a credencial do administrador. Por exemplo, projects/{project}/secrets/{secret}.
organizationalUnit

string

Opcional. O nome distinto da unidade organizacional. Esse é o caminho hierárquico completo para a unidade organizacional.

DenyMaintenancePeriod

Representação JSON 
{
  "startDate": string,
  "endDate": string,
  "time": string
}
Campos
startDate

string

Data de início do "período de bloqueio de manutenção". Se o ano da data de início estiver em branco, o ano da data de término também precisará estar. Nesse caso, o período de bloqueio de manutenção se repete todos os anos. A data está no formato aaaa-mm-dd, ou seja, 2020-11-01 ou mm-dd, ou seja, 11-01
endDate

string

Data de término do "período de bloqueio de manutenção". Se o ano da data de término estiver em branco, o ano da data de início também precisará estar. Nesse caso, significa que o intervalo sem manutenção se repete todos os anos. A data está no formato aaaa-mm-dd, ou seja, 2020-11-01 ou mm-dd, ou seja, 11-01
time

string

Horário em UTC em que o "período de bloqueio de manutenção" começa em start_date e termina em end_date. O horário está no formato HH:mm:SS, ou seja, 00:00:00

InsightsConfig

Representação JSON 
{
  "queryInsightsEnabled": boolean,
  "recordClientAddress": boolean,
  "recordApplicationTags": boolean,
  "queryStringLength": integer,
  "queryPlansPerMinute": integer,
  "enhancedQueryInsightsEnabled": boolean
}
Campos
queryInsightsEnabled

boolean

Se o recurso Query Insights está ativado.
recordClientAddress

boolean

Indica se o Query Insights vai registrar o endereço do cliente quando ativado.
recordApplicationTags

boolean

Se o Query Insights vai gravar tags de aplicativo da consulta quando ativado.
queryStringLength

integer

Tamanho máximo da consulta armazenada em bytes. Valor padrão: 1.024 bytes. Intervalo: 256 a 4.500 bytes. Consultas com comprimento maior que o valor desse campo serão truncadas para esse valor. Quando não definido, o comprimento da consulta será o valor padrão. Mudar o tamanho da consulta vai reiniciar o banco de dados.
queryPlansPerMinute

integer

Número de planos de execução de consultas capturados por insights por minuto de todas as consultas combinadas. O padrão é 5.
enhancedQueryInsightsEnabled

boolean

Opcional. Se o recurso de Query Insights aprimorados está ativado.

PasswordValidationPolicy

Representação JSON 
{
  "minLength": integer,
  "complexity": enum (Complexity),
  "reuseInterval": integer,
  "disallowUsernameSubstring": boolean,
  "passwordChangeInterval": string,
  "enablePasswordPolicy": boolean,
  "disallowCompromisedCredentials": boolean
}
Campos
minLength

integer

Número mínimo de caracteres permitidos.
complexity

enum (Complexity)

A complexidade da senha.
reuseInterval

integer

Número de senhas anteriores que não podem ser reutilizadas.
disallowUsernameSubstring

boolean

Não permitir nome de usuário como parte da senha.
passwordChangeInterval

string (Duration format)

Intervalo mínimo após o qual a senha pode ser alterada. Essa flag só é compatível com o PostgreSQL.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
enablePasswordPolicy

boolean

Define se a política de senha será ativada ou não. Quando ativadas, as senhas precisam atender aos requisitos de complexidade. Mantenha essa política ativada para evitar acessos não autorizados. Se essa política for desativada, senhas fracas serão permitidas.
disallowCompromisedCredentials
(deprecated)

boolean

Este campo está descontinuado e será removido em uma versão futura da API.

Duração

Representação JSON 
{
  "seconds": string,
  "nanos": integer
}
Campos
seconds

string (int64 format)

Segundos assinados do período. Precisa estar entre -315.576.000.000 e +315.576.000.000 (inclusive). Observação: esses limites são calculados da seguinte forma: 60 s/min * 60 min/h * 24 h/dia * 365,25 dias/ano * 10.000 anos
nanos

integer

Frações assinadas de um segundo com resolução de nanossegundos do período. Durações menores que um segundo são representadas com um campo seconds 0 e um campo nanos positivo ou negativo. Para durações de um segundo ou mais, um valor diferente de zero para o campo nanos precisa ter o mesmo sinal do campo seconds. Precisa estar entre -999.999.999 e +999.999.999 (inclusive).

SqlServerAuditConfig

Representação JSON 
{
  "kind": string,
  "bucket": string,
  "retentionInterval": string,
  "uploadInterval": string
}
Campos
kind

string

É sempre sql#sqlServerAuditConfig
bucket

string

O nome do bucket de destino (por exemplo, gs://mybucket).
retentionInterval

string (Duration format)

Por quanto tempo os arquivos de auditoria gerados serão mantidos.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
uploadInterval

string (Duration format)

Frequência do upload dos arquivos de auditoria gerados.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

AdvancedMachineFeatures

Representação JSON 
{
  "threadsPerCore": integer
}
Campos
threadsPerCore

integer

O número de linhas de execução por núcleo físico.

DataCacheConfig

Representação JSON 
{
  "dataCacheEnabled": boolean
}
Campos
dataCacheEnabled

boolean

Indica se o cache de dados está ativado para a instância.

ConnectionPoolConfig

Representação 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.
}
Campos
flags[]

object (ConnectionPoolFlags)

Opcional. Lista de flags de configuração do pool de conexões.

Campo de união _connection_pooling_enabled.

_connection_pooling_enabled pode ser apenas de um dos tipos a seguir:
connectionPoolingEnabled

boolean

Indica se o pool de conexões gerenciado está ativado.

Campo de união _pooler_count.

_pooler_count pode ser apenas de um dos tipos a seguir:
poolerCount

integer

Apenas saída. Número de poolers de conexão.

ConnectionPoolFlags

Representação JSON 
{
  "name": string,
  "value": string
}
Campos
name

string

Obrigatório. O nome da sinalização.
value

string

Obrigatório. O valor da sinalização. As flags booleanas são definidas como on para verdadeiro e off para falso. Esse campo precisa ser omitido se a sinalização não aceitar um valor.

FinalBackupConfig

Representação 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.
}
Campos

Campo de união _enabled.

_enabled pode ser apenas de um dos tipos a seguir:
enabled

boolean

Indica se o backup final está ativado para a instância.

Campo de união _retention_days.

_retention_days pode ser apenas de um dos tipos a seguir:
retentionDays

integer

O número de dias para reter o backup final após a exclusão da instância. O backup final será removido em (time_of_instance_deletion + retention_days).

ReadPoolAutoScaleConfig

Representação 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.
}
Campos
targetMetrics[]

object (TargetMetric)

Opcional. Métricas de destino para escalonamento automático do pool de leitura.

Campo de união _enabled.

_enabled pode ser apenas de um dos tipos a seguir:
enabled

boolean

Indica se o escalonamento automático do pool de leitura está ativado.

Campo de união _min_node_count.

_min_node_count pode ser apenas de um dos tipos a seguir:
minNodeCount

integer

Número mínimo de nós do pool de leitura a serem mantidos.

Campo de união _max_node_count.

_max_node_count pode ser apenas de um dos tipos a seguir:
maxNodeCount

integer

Número máximo de nós do pool de leitura a serem mantidos.

Campo de união _disable_scale_in.

_disable_scale_in pode ser apenas de um dos tipos a seguir:
disableScaleIn

boolean

Indica se o escalonamento automático do pool de leitura é compatível com operações reduzir escalonamento horizontal (remoção de nós).

Campo de união _scale_in_cooldown_seconds.

_scale_in_cooldown_seconds pode ser apenas de um dos tipos a seguir:
scaleInCooldownSeconds

integer

O período de espera para operações de redução de escala.

Campo de união _scale_out_cooldown_seconds.

_scale_out_cooldown_seconds pode ser apenas de um dos tipos a seguir:
scaleOutCooldownSeconds

integer

O período de espera para operações de escalonamento horizontal.

TargetMetric

Representação 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.
}
Campos

Campo de união _metric.

_metric pode ser apenas de um dos tipos a seguir:
metric

string

O nome da métrica a ser usada para o escalonamento automático.

Campo de união _target_value.

_target_value pode ser apenas de um dos tipos a seguir:
targetValue

number

O valor desejado da métrica.

SqlServerEntraIdConfig

Representação JSON 
{
  "kind": string,
  "tenantId": string,
  "applicationId": string
}
Campos
kind

string

Apenas saída. É sempre sql#sqlServerEntraIdConfig
tenantId

string

Opcional. O ID do locatário para a configuração do Entra ID.
applicationId

string

Opcional. O ID do aplicativo para a configuração do Entra ID.

PerformanceCaptureConfig

Representação 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.
}
Campos

Campo de união _enabled.

_enabled pode ser apenas de um dos tipos a seguir:
enabled

boolean

Opcional. Ative ou desative o recurso de captura de performance.

Campo de união _probing_interval_seconds.

_probing_interval_seconds pode ser apenas de um dos tipos a seguir:
probingIntervalSeconds

integer

Opcional. O intervalo de tempo em segundos entre duas sondagens.

Campo de união _probe_threshold.

_probe_threshold pode ser apenas de um dos tipos a seguir:
probeThreshold

integer

Opcional. O número mínimo de leituras consecutivas acima do limite que aciona a captura do estado da instância.

Campo de união _running_threads_threshold.

_running_threads_threshold pode ser apenas de um dos tipos a seguir:
runningThreadsThreshold

integer

Opcional. O número mínimo de linhas de execução do servidor em execução para acionar a captura no servidor principal.

Campo de união _seconds_behind_source_threshold.

_seconds_behind_source_threshold pode ser apenas de um dos tipos a seguir:
secondsBehindSourceThreshold

integer

Opcional. O número mínimo de segundos que a réplica precisa estar atrasada em relação à principal para acionar a captura na réplica.

Campo de união _transaction_duration_threshold.

_transaction_duration_threshold pode ser apenas de um dos tipos a seguir:
transactionDurationThreshold

integer

Opcional. O tempo em segundos que uma transação precisa estar aberta antes de o observador começar a gravar.

SqlFailoverReplica

Representação JSON 
{
  "name": string,
  "available": boolean
}
Campos
name

string

O nome da réplica de failover. Se especificado na criação da instância, uma réplica de failover é criada para a instância. O nome não inclui o ID do projeto.
available

boolean

O status de disponibilidade da réplica de failover. Um status falso indica que a réplica de failover está fora de sincronia. A instância principal só pode fazer failover para a réplica de failover quando o status for verdadeiro.

IpMapping

Representação JSON 
{
  "type": enum (SqlIpAddressType),
  "ipAddress": string,
  "timeToRetire": string
}
Campos
type

enum (SqlIpAddressType)

O tipo desse endereço IP. Um endereço PRIMARY é um endereço público que pode aceitar conexões de entrada. Um endereço PRIVATE é um endereço particular que pode aceitar conexões de entrada. Um endereço OUTGOING é o endereço de origem das conexões originadas da instância, se compatível.
ipAddress

string

O endereço IP atribuído.
timeToRetire

string (Timestamp format)

O prazo para a remoção desse IP no formato RFC 3339, por exemplo, 2012-11-15T16:19:00.094Z. Este campo só está disponível quando o IP está programado para ser desativado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

SslCert

Representação JSON 
{
  "kind": string,
  "certSerialNumber": string,
  "cert": string,
  "createTime": string,
  "commonName": string,
  "expirationTime": string,
  "sha1Fingerprint": string,
  "instance": string,
  "selfLink": string
}
Campos
kind

string

Esse valor é sempre sql#sslCert.
certSerialNumber

string

Número de série, conforme extraído do certificado.
cert

string

Representação PEM
createTime

string (Timestamp format)

A hora em que o certificado foi criado no formato RFC 3339, por exemplo, 2012-11-15T16:19:00.094Z

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
commonName

string

Nome fornecido pelo usuário. Restrito a [a-zA-Z.-_ ]+.
expirationTime

string (Timestamp format)

A hora em que o certificado expira no formato RFC 3339, por exemplo, 2012-11-15T16:19:00.094Z.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
sha1Fingerprint

string

Impressão digital Sha1.
instance

string

Nome da instância do banco de dados.
selfLink

string

O URI desse recurso.

OnPremisesConfiguration

Representação 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)
}
Campos
hostPort

string

O host e a porta da instância local no formato host:port
kind

string

Esse valor é sempre sql#onPremisesConfiguration.
username

string

O nome de usuário para se conectar à instância local.
password

string

A senha para se conectar à instância local.
caCertificate

string

Representação PEM do certificado x509 da CA confiável.
clientCertificate

string

Representação PEM do certificado x509 da réplica.
clientKey

string

Representação PEM da chave privada da réplica. A chave pública correspondente é codificada no certificado do cliente.
dumpFilePath

string

O arquivo dump para criar a réplica do Cloud SQL.
sourceInstance

object (InstanceReference)

A referência à instância do Cloud SQL se a origem for o Cloud SQL.
selectedObjects[]

object (SelectedObjects)

Opcional. Uma lista de objetos que o usuário seleciona para replicação de uma instância de origem externa.
sslOption

enum (SslOption)

Opcional. Opção de SSL para conexão de réplica com a origem local.

InstanceReference

Representação JSON 
{
  "name": string,
  "region": string,
  "project": string
}
Campos
name

string

O nome da instância do Cloud SQL a que se faz referência. Isso não inclui o ID do projeto.
region

string

A região da instância do Cloud SQL referenciada.
project

string

O ID do projeto da instância do Cloud SQL referenciada. O padrão é o mesmo ID do projeto que a instância referencia.

SelectedObjects

Representação JSON 
{
  "database": string
}
Campos
database

string

Obrigatório. O nome do banco de dados a ser migrado.

ReplicaConfiguration

Representação JSON 
{
  "kind": string,
  "mysqlReplicaConfiguration": {
    object (MySqlReplicaConfiguration)
  },
  "failoverTarget": boolean,
  "cascadableReplica": boolean
}
Campos
kind

string

Esse valor é sempre sql#replicaConfiguration.
mysqlReplicaConfiguration

object (MySqlReplicaConfiguration)

Configuração específica do MySQL ao replicar de uma instância principal local do MySQL. As informações de configuração de replicação, como nome de usuário, senha, certificados e chaves não são armazenados nos metadados da instância. As informações de configuração são usadas apenas para configurar a conexão de replicação e são armazenadas pelo MySQL em um arquivo chamado master.info no diretório de dados.
failoverTarget

boolean

Especifica se a réplica é o destino de failover. Se o campo estiver definido como true, a réplica será designada como uma réplica de failover. Caso a instância principal falhe, a réplica será promovida como a nova instância principal. Somente uma réplica pode ser especificada como destino de failover, e a réplica precisa estar em uma zona diferente da instância principal.
cascadableReplica

boolean

Opcional. Especifica se uma réplica do SQL Server é uma réplica em cascata. Uma réplica em cascata é uma réplica entre regiões do SQL Server que oferece suporte a réplicas abaixo dela.

MySqlReplicaConfiguration

Representação JSON 
{
  "dumpFilePath": string,
  "username": string,
  "password": string,
  "connectRetryInterval": integer,
  "masterHeartbeatPeriod": string,
  "caCertificate": string,
  "clientCertificate": string,
  "clientKey": string,
  "sslCipher": string,
  "verifyServerCertificate": boolean,
  "kind": string
}
Campos
dumpFilePath

string

Caminho para um arquivo dump SQL no Google Cloud Storage a partir do qual a instância de réplica será criada. O URI está no formato gs://bucketName/fileName. Arquivos gzip compactados (.gz) também são compatíveis. Os dumps têm as coordenadas binlog a partir das quais a replicação começa. Isso pode ser feito definindo --master-data como 1 ao usar mysqldump.
username

string

O nome de usuário da conexão de replicação.
password

string

A senha da conexão de replicação.
connectRetryInterval

integer

Segundos para aguardar entre novas tentativas de conexão. O padrão do MySQL é 60 segundos.
masterHeartbeatPeriod

string (Int64Value format)

Intervalo em milissegundos entre os sinais de funcionamento da replicação.
caCertificate

string

Representação PEM do certificado x509 da CA confiável.
clientCertificate

string

Representação PEM do certificado x509 da réplica.
clientKey

string

Representação PEM da chave privada da réplica. A chave pública correspondente é codificada no certificado do cliente.
sslCipher

string

Uma lista de criptografias permitidas para usar na criptografia SSL.
verifyServerCertificate

boolean

Indica se o valor "Nome comum" da instância principal deve ser verificado no certificado que ela envia durante o handshake de SSL.
kind

string

Esse valor é sempre sql#mysqlReplicaConfiguration.

DiskEncryptionConfiguration

Representação JSON 
{
  "kmsKeyName": string,
  "kind": string
}
Campos
kmsKeyName

string

Nome do recurso da chave KMS para criptografia de disco
kind

string

Esse valor é sempre sql#diskEncryptionConfiguration.

DiskEncryptionStatus

Representação JSON 
{
  "kmsKeyVersionName": string,
  "kind": string
}
Campos
kmsKeyVersionName

string

Versão da chave do KMS usada para criptografar o recurso da instância do Cloud SQL.
kind

string

Esse valor é sempre sql#diskEncryptionStatus.

SqlScheduledMaintenance

Representação 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.
}
Campos
startTime

string (Timestamp format)

O horário de início de qualquer manutenção agendada futura dessa instância.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
canDefer
(deprecated)

boolean
canReschedule

boolean

Se a manutenção programada puder ser reprogramada.

Campo de união _schedule_deadline_time.

_schedule_deadline_time pode ser apenas de um dos tipos a seguir:
scheduleDeadlineTime

string (Timestamp format)

Não é possível reprogramar a manutenção para começar depois desse prazo.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

SqlOutOfDiskReport

Representação 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.
}
Campos

Campo de união _sql_out_of_disk_state.

_sql_out_of_disk_state pode ser apenas de um dos tipos a seguir:
sqlOutOfDiskState

enum (SqlOutOfDiskState)

Esse campo representa o estado gerado pelo job proativo de integridade do banco de dados para problemas de falta de espaço em disco. * Gravadores: * o job proativo de integridade do banco de dados para OOD. * Leitores: o job proativo de integridade do banco de dados

Campo de união _sql_min_recommended_increase_size_gb.

_sql_min_recommended_increase_size_gb pode ser apenas de um dos tipos a seguir:
sqlMinRecommendedIncreaseSizeGb

integer

O tamanho mínimo recomendado de aumento em gigabytes. Esse campo é usado pelo front-end * Writers: * o job proativo de integridade do banco de dados para OOD. * Leitores:

AvailableDatabaseVersion

Representação 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.
}
Campos

Campo de união _major_version.

_major_version pode ser apenas de um dos tipos a seguir:
majorVersion

string

O nome da versão principal.

Campo de união _name.

_name pode ser apenas de um dos tipos a seguir:
name

string

O nome da versão do banco de dados. Para o MySQL 8.0, essa string fornece a versão principal e secundária do banco de dados.

Campo de união _display_name.

_display_name pode ser apenas de um dos tipos a seguir:
displayName

string

O nome de exibição da versão do banco de dados.

ReplicationCluster

Representação JSON 
{
  "psaWriteEndpoint": string,
  "failoverDrReplicaName": string,
  "drReplica": boolean
}
Campos
psaWriteEndpoint

string

Apenas saída. Se definido, esse campo indica que a instância tem um endpoint DNS de acesso a serviços particulares (PSA) que aponta para a instância principal do cluster. Se essa instância for a principal, o endpoint DNS vai apontar para ela. Após uma operação de alternância ou failover de réplica, esse endpoint DNS aponta para a instância promovida. Este é um campo somente leitura, retornado ao usuário como informação. Esse campo pode existir mesmo que uma instância independente ainda não tenha uma réplica de DR ou que a réplica de DR tenha sido excluída.
failoverDrReplicaName

string

Opcional. Se a instância for uma instância principal, esse campo vai identificar a réplica de recuperação de desastres (DR). Uma réplica de DR é uma configuração opcional para instâncias da edição Enterprise Plus. Se a instância for uma réplica de leitura, o campo não será definido. Defina este campo como um nome de réplica para designar uma réplica de DR para uma instância principal. Remova o nome da réplica para remover a designação de réplica de DR.
drReplica

boolean

Apenas saída. Campo somente leitura que indica se a réplica é de DR. Esse campo não é definido se a instância for primária.

GeminiInstanceConfig

Representação 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.
}
Campos

Campo de união _entitled.

_entitled pode ser apenas de um dos tipos a seguir:
entitled

boolean

Apenas saída. Indica se o Gemini está ativado.

Campo de união _google_vacuum_mgmt_enabled.

_google_vacuum_mgmt_enabled pode ser apenas de um dos tipos a seguir:
googleVacuumMgmtEnabled

boolean

Apenas saída. Se o gerenciamento do aspirador de pó está ativado.

Campo de união _oom_session_cancel_enabled.

_oom_session_cancel_enabled pode ser apenas de um dos tipos a seguir:
oomSessionCancelEnabled

boolean

Apenas saída. Indica se o cancelamento da sessão de falta de memória (OOM) está ativado.

Campo de união _active_query_enabled.

_active_query_enabled pode ser apenas de um dos tipos a seguir:
activeQueryEnabled

boolean

Apenas saída. Indica se a consulta ativa está ativada.

Campo de união _index_advisor_enabled.

_index_advisor_enabled pode ser apenas de um dos tipos a seguir:
indexAdvisorEnabled

boolean

Apenas saída. Indica se o consultor de índice está ativado.

Campo de união _flag_recommender_enabled.

_flag_recommender_enabled pode ser apenas de um dos tipos a seguir:
flagRecommenderEnabled

boolean

Apenas saída. Indica se o recomendador de flags está ativado.

TagsEntry

Representação JSON 
{
  "key": string,
  "value": string
}
Campos
key

string
value

string

PoolNodeConfig

Representação 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.
}
Campos
ipAddresses[]

object (IpMapping)

Apenas saída. Mapeamentos que contêm endereços IP que podem ser usados para se conectar ao nó do pool de leitura.
dnsNames[]

object (DnsNameMapping)

Apenas saída. A lista de nomes DNS usados por este nó do pool de leitura.
pscAutoConnections[]

object (PscAutoConnectionConfig)

Apenas saída. A lista de configurações para endpoints do consumidor do Private Service Connect (PSC) configurados automaticamente que podem ser usados para se conectar a este nó do pool de leitura.

Campo de união _name.

_name pode ser apenas de um dos tipos a seguir:
name

string

Apenas saída. O nome do nó do pool de leitura, que será usado para recuperar métricas e registros.

Campo de união _gce_zone.

_gce_zone pode ser apenas de um dos tipos a seguir:
gceZone

string

Apenas saída. A zona do nó do pool de leitura.

Campo de união _dns_name.

_dns_name pode ser apenas de um dos tipos a seguir:
dnsName

string

Apenas saída. O nome DNS do nó do pool de leitura.

Campo de união _state.

_state pode ser apenas de um dos tipos a seguir:
state

enum (SqlInstanceState)

Apenas saída. O estado atual do nó do pool de leitura.

Campo de união _psc_service_attachment_link.

_psc_service_attachment_link pode ser apenas de um dos tipos a seguir:
pscServiceAttachmentLink

string

Apenas saída. O anexo de serviço do Private Service Connect (PSC) do nó do pool de leitura.

DnsNameMapping

Representação JSON 
{
  "name": string,
  "connectionType": enum (ConnectionType),
  "dnsScope": enum (DnsScope),
  "recordManager": enum (RecordManager)
}
Campos
name

string

Apenas saída. O nome DNS.
connectionType

enum (ConnectionType)

Apenas saída. O tipo de conexão do nome DNS.
dnsScope

enum (DnsScope)

Apenas saída. O escopo a que o nome DNS se aplica.
recordManager

enum (RecordManager)

Apenas saída. O gerenciador desse registro DNS.

Anotações de ferramentas

Dica destrutiva: ❌ | Dica idempotente: ❌ | Dica somente leitura: ✅ | Dica de mundo aberto: ❌