Herramienta: get_instance
Obtén los detalles de una instancia de Cloud SQL.
En el siguiente ejemplo, se muestra cómo usar curl para invocar la herramienta de MCP get_instance.
| Solicitud de 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
Es una solicitud de obtención de instancias.
SqlInstancesGetRequest
| Representación JSON |
|---|
{ "instance": string, "project": string } |
| Campos | |
|---|---|
instance |
Obligatorio. El ID de instancia de la base de datos. Esto no incluye el ID del proyecto. |
project |
Obligatorio. El ID del proyecto que contiene la instancia. |
Esquema de salida
Es un recurso de instancia de Cloud SQL.
DatabaseInstance
| Representación JSON |
|---|
{ "kind": string, "state": enum ( |
| Campos | |
|---|---|
kind |
Siempre es |
state |
El estado de entrega actual de la instancia de Cloud SQL. |
databaseVersion |
El tipo y la versión del motor de base de datos. El campo |
settings |
Es la configuración del usuario. |
etag |
Este campo está obsoleto y se quitará en una versión futura de la API. En su lugar, usa el campo |
failoverReplica |
El nombre y el estado de la réplica de conmutación por error. |
masterInstanceName |
Es el nombre de la instancia que actuará como principal en la configuración de replicación. |
replicaNames[] |
Son las réplicas de la instancia. |
maxDiskSize |
Es el tamaño máximo del disco de la instancia en bytes. |
currentDiskSize |
Es el uso actual del disco de la instancia en bytes. Esta propiedad dejó de estar disponible. En su lugar, usa la métrica "cloudsql.googleapis.com/database/disk/bytes_used" en la API de Cloud Monitoring. Consulta este anuncio para obtener más información. |
ipAddresses[] |
Son las direcciones IP asignadas a la instancia. |
serverCaCert |
Configuración de SSL |
instanceType |
Es el tipo de instancia. |
project |
Es el ID del proyecto que contiene la instancia de Cloud SQL. El dominio de las apps de Google tiene un prefijo si corresponde. |
ipv6Address |
Es la dirección IPv6 asignada a la instancia. (Obsoleto) Esta propiedad solo se aplicaba a las instancias de primera generación. |
serviceAccountEmailAddress |
Es la dirección de correo electrónico de la cuenta de servicio asignada a la instancia.\nEsta propiedad es de solo lectura. |
onPremisesConfiguration |
Es la configuración específica para las instancias locales. |
replicaConfiguration |
Es la configuración específica de las réplicas de conmutación por error y las réplicas de lectura. |
backendType |
Es el tipo de backend. Esta propiedad es de solo lectura. Usa la propiedad |
selfLink |
Es el URI de este recurso. |
suspensionReason[] |
Si el estado de la instancia es SUSPENDED, se indica el motivo de la suspensión. |
connectionName |
Nombre de conexión de la instancia de Cloud SQL que se usa en las cadenas de conexión. |
name |
Es el nombre de la instancia de Cloud SQL. Esto no incluye el ID del proyecto. |
region |
Es la región geográfica de la instancia de Cloud SQL. Puede ser una de las regiones en las que opera Cloud SQL: Por ejemplo, |
gceZone |
Es la zona de Compute Engine desde la que se entrega la instancia actualmente. Este valor podría ser diferente de la zona que se especificó cuando se creó la instancia si esta realizó una conmutación por error a su zona secundaria. ADVERTENCIA: Si cambias este parámetro, es posible que se reinicie la instancia. |
secondaryGceZone |
Es la zona de Compute Engine desde la que actualmente se entrega la instancia de conmutación por error para una instancia regional. Este valor podría ser diferente de la zona que se especificó cuando se creó la instancia si esta conmutó por error a su zona secundaria o de conmutación por error. |
diskEncryptionConfiguration |
Es la configuración de encriptación de disco específica de una instancia. |
diskEncryptionStatus |
Es el estado de encriptación del disco específico de una instancia. |
rootPassword |
Es la contraseña raíz inicial. Solo se usa en la creación. Debes establecer contraseñas de raíz antes de poder conectarte a instancias de PostgreSQL. |
scheduledMaintenance |
Es la hora de inicio de cualquier mantenimiento programado próximo para esta instancia. |
satisfiesPzs |
Este estado indica si la instancia satisface la PZS. El estado está reservado para uso futuro. |
databaseInstalledVersion |
Solo salida. Almacena la versión actual de la base de datos que se ejecuta en la instancia, incluida la versión secundaria, como |
createTime |
Solo salida. Es la fecha y hora en que se creó la instancia, en formato RFC 3339, por ejemplo, Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
availableMaintenanceVersions[] |
Solo salida. Enumera todas las versiones de mantenimiento aplicables en la instancia |
maintenanceVersion |
Es la versión de software actual en la instancia. |
upgradableDatabaseVersions[] |
Solo salida. Son todas las versiones de la base de datos que están disponibles para la actualización. |
replicationCluster |
Es opcional. Un par de instancia principal y réplica de recuperación ante desastres (DR). Una réplica de DR es una réplica entre regiones que designas para la conmutación por error en caso de que la instancia principal experimente una falla regional. Se aplica a MySQL y PostgreSQL. |
satisfiesPzi |
Solo salida. Este estado indica si la instancia satisface la PZI. El estado está reservado para uso futuro. |
tags |
Es opcional. Solo entrada. Inmutable. Son las claves y los valores de las etiquetas que están vinculados a esta instancia. Debes representar cada elemento del mapa de la siguiente manera: Por ejemplo, un solo recurso puede tener las siguientes etiquetas: Para obtener más información sobre la creación y administración de etiquetas, consulta https://cloud.google.com/resource-manager/docs/tags/tags-overview. Un objeto que contiene una lista de pares |
nodes[] |
Solo salida. Son entradas que contienen información sobre cada nodo del grupo de lectura. |
dnsNames[] |
Solo salida. Es la lista de nombres de DNS que usa esta instancia. |
Campo de unión
|
|
outOfDiskReport |
Este campo representa el informe generado por el trabajo proactivo de estado de la base de datos para los problemas de OutOfDisk. * Escritores: * El trabajo proactivo de estado de la base de datos para OOD. * Lectores: * El trabajo proactivo de estado de la base de datos |
Campo de unión
|
|
sqlNetworkArchitecture |
|
Campo de unión
|
|
pscServiceAttachmentLink |
Solo salida. Es el vínculo al adjunto de servicio de la instancia de PSC. |
Campo de unión
|
|
dnsName |
Solo salida. Es el nombre de DNS de la instancia. |
Campo de unión
|
|
primaryDnsName |
Solo salida. OBSOLETO: En su lugar, usa write_endpoint. |
Campo de unión
|
|
writeEndpoint |
Solo salida. Es el nombre de DNS de la instancia principal en un grupo de replicación. |
Campo de unión
|
|
geminiConfig |
Es la configuración de la instancia de Gemini. |
Campo de unión
|
|
switchTransactionLogsToCloudStorageEnabled |
Solo entrada. Indica si Cloud SQL está habilitado para cambiar el almacenamiento de los archivos de registro de recuperación de un momento determinado de un disco de datos a Cloud Storage. |
Campo de unión
|
|
includeReplicasForMajorVersionUpgrade |
Solo entrada. Determina si se produce una actualización local de la versión principal de las réplicas cuando se inicia una actualización local de la versión principal de una instancia principal. |
Campo de unión
|
|
nodeCount |
Es la cantidad de nodos de grupo de lectura en un grupo de lectura. |
Configuración
| Representación JSON |
|---|
{ "settingsVersion": string, "authorizedGaeApplications": [ string ], "tier": string, "kind": string, "userLabels": { string: string, ... }, "availabilityType": enum ( |
| Campos | |
|---|---|
settingsVersion |
Es la versión de la configuración de la instancia. Este es un campo obligatorio para el método de actualización, ya que garantiza que las actualizaciones simultáneas se controlen correctamente. Durante la actualización, usa el valor de settingsVersion más reciente para esta instancia y no intentes actualizar este valor. |
authorizedGaeApplications[] |
Son los IDs de las apps de App Engine que pueden acceder a esta instancia. (Obsoleto) Se aplica solo a las instancias de primera generación. |
tier |
Es el nivel (o tipo de máquina) de esta instancia, por ejemplo, |
kind |
Siempre es |
userLabels |
Son las etiquetas proporcionadas por el usuario, representadas como un diccionario en el que cada etiqueta es un solo par clave-valor. Un objeto que contiene una lista de pares |
availabilityType |
Es el tipo de disponibilidad. Valores posibles: * Para obtener más información, consulta Descripción general de la configuración de alta disponibilidad. |
pricingPlan |
Es el plan de precios para esta instancia. Puede ser |
replicationType |
Es el tipo de replicación que usa esta instancia. Puede ser |
storageAutoResizeLimit |
Es el tamaño máximo al que se puede aumentar automáticamente la capacidad de almacenamiento. El valor predeterminado es 0, que especifica que no hay límite. |
activationPolicy |
La política de activación especifica cuándo se activa la instancia y solo se aplica cuando el estado de la instancia es RUNNABLE. Valores válidos: * |
ipConfiguration |
Es la configuración de la administración de IP. Esto permite habilitar o inhabilitar la IP de la instancia y administrar qué redes externas pueden conectarse a ella. La dirección IPv4 no se puede inhabilitar para las instancias de segunda generación. |
storageAutoResize |
Es la configuración para aumentar el tamaño de almacenamiento de forma automática. El valor predeterminado es verdadero. |
locationPreference |
Es la configuración de preferencias de ubicación. Esto permite que la instancia se ubique lo más cerca posible de una app de App Engine o de una zona de Compute Engine para obtener un mejor rendimiento. La colocación conjunta de App Engine solo se aplicaba a las instancias de primera generación. |
databaseFlags[] |
Son las marcas de base de datos que se pasan a la instancia durante el inicio. |
dataDiskType |
Tipo de disco de datos: |
maintenanceWindow |
Es el período de mantenimiento de esta instancia. Especifica cuándo se puede reiniciar la instancia por motivos de mantenimiento. |
backupConfiguration |
Es la configuración de copia de seguridad diaria para la instancia. |
databaseReplicationEnabled |
Es la configuración específica de las instancias de réplica de lectura. Indica si la replicación está habilitada o no. ADVERTENCIA: Si cambias este parámetro, se reiniciará la instancia. |
crashSafeReplicationEnabled |
Es la configuración específica de las instancias de réplica de lectura. Indica si las marcas de la base de datos para la replicación a prueba de fallas están habilitadas. Esta propiedad solo se aplicaba a las instancias de primera generación. |
dataDiskSizeGb |
Tamaño del disco de datos en GB. El tamaño mínimo del disco de datos es de 10 GB. |
activeDirectoryConfig |
Es la configuración de Active Directory, que solo es relevante para Cloud SQL para SQL Server. |
collation |
Es el nombre de la intercalación de la instancia del servidor. |
denyMaintenancePeriods[] |
Rechazo del período de mantenimiento |
insightsConfig |
Configuración de estadísticas, por ahora solo relevante para Postgres. |
passwordValidationPolicy |
Es la política de validación de contraseñas de usuario local de la instancia. |
sqlServerAuditConfig |
Es la configuración de auditoría específica de SQL Server. |
edition |
Es opcional. Es la edición de la instancia. |
connectorEnforcement |
Especifica si las conexiones deben usar conectores de Cloud SQL. Los valores de las opciones incluyen los siguientes: Ten en cuenta que, si usas REQUIRED, se inhabilitarán todas las redes autorizadas existentes. Si no se especifica este campo cuando se crea una instancia nueva, se usa NOT_REQUIRED. Si este campo no se especifica cuando se aplica un parche o se actualiza una instancia existente, se deja sin cambios en la instancia. |
deletionProtectionEnabled |
Es la configuración para proteger contra la eliminación accidental de instancias. |
timeZone |
Es la zona horaria del servidor, que solo es relevante para Cloud SQL para SQL Server. |
advancedMachineFeatures |
Especifica la configuración avanzada de la máquina para las instancias, solo relevante para SQL Server. |
dataCacheConfig |
Es la configuración de la caché de datos. |
replicationLagMaxSeconds |
Es opcional. Valor de configuración para la recreación de la réplica después de un cierto retraso de replicación |
enableGoogleMlIntegration |
Es opcional. Cuando este parámetro se establece en verdadero, las instancias de Cloud SQL pueden conectarse a Vertex AI para pasar solicitudes de predicciones y estadísticas en tiempo real a la IA. El valor predeterminado es falso. Esto solo se aplica a las instancias de Cloud SQL para MySQL y Cloud SQL para PostgreSQL. |
enableDataplexIntegration |
Es opcional. De forma predeterminada, las instancias de Cloud SQL tienen inhabilitada la extracción de esquemas para Dataplex. Cuando este parámetro se establece en verdadero, se activa la extracción de esquemas para Dataplex en instancias de Cloud SQL. |
retainBackupsOnDelete |
Es opcional. Cuando este parámetro se establece en verdadero, Cloud SQL retiene copias de seguridad de la instancia incluso después de que se borra. La copia de seguridad ON_DEMAND se conservará hasta que el cliente la borre o borre el proyecto. La copia de seguridad AUTOMÁTICA se conservará según el parámetro de configuración de retención de copias de seguridad. |
entraidConfig |
Es opcional. Es la configuración de Microsoft Entra ID para la instancia de SQL Server. |
performanceCaptureConfig |
Es opcional. Es la configuración de la captura de rendimiento, que proporciona métricas de diagnóstico en situaciones de carga alta. |
Campo de unión
|
|
dataDiskProvisionedIops |
Es opcional. Cantidad aprovisionada de operaciones de E/S por segundo para el disco de datos. Este campo solo se usa para los tipos de discos Hyperdisk Balanced. |
Campo de unión
|
|
dataDiskProvisionedThroughput |
Es opcional. Es la capacidad de procesamiento aprovisionada medida en MiB por segundo para el disco de datos. Este campo solo se usa para los tipos de discos Hyperdisk Balanced. |
Campo de unión
|
|
connectionPoolConfig |
Es opcional. Es la configuración de la agrupación de conexiones administrada para la instancia. |
Campo de unión
|
|
finalBackupConfig |
Es opcional. Es la configuración final de la copia de seguridad de la instancia. |
Campo de unión
|
|
readPoolAutoScaleConfig |
Es opcional. Es la configuración del ajuste de escala automático del grupo de lectura para la instancia. |
Campo de unión
|
|
autoUpgradeEnabled |
Es opcional. Es la configuración de actualización automática de Cloud SQL para MySQL. Cuando este parámetro se establece como verdadero, se habilita la actualización automática para las versiones secundarias de MySQL 8.0. La versión de MySQL debe ser 8.0.35 o posterior. |
Campo de unión
|
|
dataApiAccess |
Este parámetro controla si se permite usar la API de ExecuteSql para conectarse a la instancia. No se permite de forma predeterminada. |
Int64Value
| Representación JSON |
|---|
{ "value": string } |
| Campos | |
|---|---|
value |
Es el valor int64. |
UserLabelsEntry
| Representación JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
IpConfiguration
| Representación JSON |
|---|
{ "ipv4Enabled": boolean, "privateNetwork": string, "requireSsl": boolean, "authorizedNetworks": [ { object ( |
| Campos | |
|---|---|
ipv4Enabled |
Indica si se asigna una dirección IP pública a la instancia. |
privateNetwork |
Es el vínculo del recurso para la red de VPC desde la que se puede acceder a la instancia de Cloud SQL con una IP privada. Por ejemplo, |
requireSsl |
Utiliza Indica si se aplican las conexiones SSL/TLS a través de IP. Si se configura como falso, se permiten conexiones sin SSL/TLS y con SSL/TLS. Para las conexiones SSL/TLS, no se verificará el certificado de cliente. Si se establece como verdadero, solo se permiten conexiones encriptadas con SSL/TLS y con certificados de cliente válidos. Si deseas aplicar SSL/TLS sin aplicar el requisito de certificados de cliente válidos, usa la marca |
authorizedNetworks[] |
Es la lista de redes externas que pueden conectarse a la instancia con la IP. En notación CIDR, también conocida como notación de barra (por ejemplo, |
allocatedIpRange |
Es el nombre del rango de IP asignado para la instancia de Cloud SQL con IP privada. Por ejemplo, "google-managed-services-default". Si se configura, la IP de la instancia se creará en el rango asignado. El nombre del rango debe cumplir con RFC 1035. Específicamente, el nombre debe tener entre 1 y 63 caracteres, y coincidir con la expresión regular |
enablePrivatePathForGoogleCloudServices |
Controla la conectividad a instancias con IP privada desde los servicios de Google, como BigQuery. |
sslMode |
Especifica cómo se aplica SSL/TLS en las conexiones de bases de datos. Si debes usar la marca Para PostgreSQL y MySQL, haz lo siguiente:
Para SQL Server, haz lo siguiente:
El valor de Por ejemplo, para el par |
customSubjectAlternativeNames[] |
Es opcional. Son los nombres alternativos del sujeto(SAN) personalizados para una instancia de Cloud SQL. |
Campo de unión
|
|
pscConfig |
Es la configuración del PSC para esta instancia. |
Campo de unión
|
|
serverCaMode |
Especifica qué tipo de CA se usa para el certificado del servidor. |
Campo de unión
|
|
serverCaPool |
Es opcional. Es el nombre del recurso del grupo de CA del servidor para una instancia con |
Campo de unión
|
|
serverCertificateRotationMode |
Es opcional. Controla la función de rotación automática de certificados de servidor. Esta función está inhabilitada de forma predeterminada. Cuando se habilita, el certificado de servidor se rotará automáticamente durante el mantenimiento programado de Cloud SQL o las actualizaciones de mantenimiento de autoservicio hasta seis meses antes de su vencimiento. Este parámetro de configuración solo se puede establecer si server_ca_mode es GOOGLE_MANAGED_CAS_CA o CUSTOMER_MANAGED_CAS_CA. |
BoolValue
| Representación JSON |
|---|
{ "value": boolean } |
| Campos | |
|---|---|
value |
Es el valor booleano. |
AclEntry
| Representación JSON |
|---|
{ "value": string, "expirationTime": string, "name": string, "kind": string } |
| Campos | |
|---|---|
value |
Es el valor incluido en la lista de entidades permitidas para la lista de control de acceso. |
expirationTime |
Fecha y hora en que vence esta entrada de control de acceso, en formato RFC 3339, por ejemplo, Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
name |
Es opcional. Es una etiqueta para identificar esta entrada. |
kind |
Siempre es |
Marca de tiempo
| Representación JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Campos | |
|---|---|
seconds |
Representa los segundos de la hora UTC desde la época de Unix 1970-01-01T00:00:00Z. Debe estar entre -62135596800 y 253402300799 inclusive (lo que corresponde a 0001-01-01T00:00:00Z a 9999-12-31T23:59:59Z). |
nanos |
Fracciones no negativas de un segundo a una resolución de nanosegundos. Este campo es la parte de la duración en nanosegundos, no una alternativa a los segundos. Los valores de segundos negativos con fracciones deben tener valores nanos no negativos que se cuentan hacia adelante en el tiempo. Debe ser un valor entre 0 y 999,999,999, inclusive. |
PscConfig
| Representación JSON |
|---|
{ "allowedConsumerProjects": [ string ], "pscAutoConnections": [ { object ( |
| Campos | |
|---|---|
allowedConsumerProjects[] |
Es opcional. Es la lista de proyectos de consumidor incluidos en la lista de entidades permitidas para las conexiones de PSC a esta instancia. Se puede conectar a esta instancia con PSC desde cualquier red de estos proyectos. Cada proyecto del consumidor en esta lista puede estar representado por un número de proyecto (numérico) o por un ID de proyecto (alfanumérico). |
pscAutoConnections[] |
Es opcional. Es la lista de parámetros de configuración para los extremos de consumidor de Private Service Connect solicitados que se pueden usar para conectarse a esta instancia de Cloud SQL. |
networkAttachmentUri |
Es opcional. Es el adjunto de red de la red del consumidor a la que la instancia de Cloud SQL habilitada para Private Service Connect está autorizada a conectarse a través de la interfaz de PSC. El formato es projects/PROJECT/regions/REGION/networkAttachments/ID. |
Campo de unión
|
|
pscEnabled |
Indica si la conectividad de PSC está habilitada para esta instancia. |
PscAutoConnectionConfig
| Representación JSON |
|---|
{ "consumerProject": string, "consumerNetwork": string, // Union field |
| Campos | |
|---|---|
consumerProject |
Es opcional. Es el ID del proyecto de servicio del consumidor de este extremo del consumidor. Es opcional. Esto solo se aplica si consumer_network es una red de VPC compartida. |
consumerNetwork |
Es opcional. Es la red del consumidor de este extremo del consumidor. Debe ser una ruta de acceso al recurso que incluya el proyecto host y el nombre de la red. Por ejemplo, El proyecto host del consumidor de esta red puede ser diferente del proyecto de servicio del consumidor. |
Campo de unión
|
|
ipAddress |
Es la dirección IP del extremo del consumidor. |
Campo de unión
|
|
status |
Es el estado de conexión del extremo del consumidor. |
Campo de unión
|
|
consumerNetworkStatus |
Es el estado de la política de conexión de la red del consumidor. |
LocationPreference
| Representación JSON |
|---|
{ "followGaeApplication": string, "zone": string, "secondaryZone": string, "kind": string } |
| Campos | |
|---|---|
followGaeApplication |
La aplicación de App Engine que se debe seguir debe estar en la misma región que la instancia de Cloud SQL. ADVERTENCIA: Si cambias este parámetro, es posible que se reinicie la instancia. |
zone |
Zona de Compute Engine preferida (por ejemplo, us-central1-a, us-central1-b, etcétera) ADVERTENCIA: Si cambias este parámetro, es posible que se reinicie la instancia. |
secondaryZone |
Zona de Compute Engine preferida para la instancia secundaria o de conmutación por error (por ejemplo, us-central1-a, us-central1-b, etcétera). Para inhabilitar este campo, configúralo como "no_secondary_zone". |
kind |
Siempre es |
Marcas de bases de datos
| Representación JSON |
|---|
{ "name": string, "value": string } |
| Campos | |
|---|---|
name |
Es el nombre de la marca. Estas marcas se pasan al inicio de la instancia, por lo que incluyen tanto las opciones del servidor como las variables del sistema. Las marcas se especifican con guiones bajos, no con guiones. Para obtener más información, consulta Configura marcas de bases de datos en la documentación de Cloud SQL. |
value |
Es el valor de la marca. Las marcas booleanas se configuran en |
MaintenanceWindow
| Representación JSON |
|---|
{
"hour": integer,
"day": integer,
"updateTrack": enum ( |
| Campos | |
|---|---|
hour |
Hora del día: de 0 a 23. Especifica en la zona horaria UTC. |
day |
Día de la semana: |
updateTrack |
Configuración del horario de mantenimiento: |
kind |
Siempre es |
Int32Value
| Representación JSON |
|---|
{ "value": integer } |
| Campos | |
|---|---|
value |
Es el valor int32. |
BackupConfiguration
| Representación JSON |
|---|
{ "startTime": string, "enabled": boolean, "kind": string, "binaryLogEnabled": boolean, "replicationLogArchivingEnabled": boolean, "location": string, "pointInTimeRecoveryEnabled": boolean, "backupRetentionSettings": { object ( |
| Campos | |
|---|---|
startTime |
Hora de inicio para la configuración de la copia de seguridad diaria en la zona horaria UTC en formato de 24 horas: |
enabled |
Indica si esta configuración está habilitada. |
kind |
Siempre es |
binaryLogEnabled |
(Solo para MySQL) Indica si el registro binario está habilitado. Si la configuración de copia de seguridad está inhabilitada, también se debe inhabilitar el registro binario. |
replicationLogArchivingEnabled |
Se reserva para usarlo más adelante. |
location |
Ubicación de la copia de seguridad |
pointInTimeRecoveryEnabled |
Indica si la recuperación de un momento determinado está habilitada. |
backupRetentionSettings |
Configuración de retención de copias de seguridad |
transactionLogRetentionDays |
Cantidad de días de registros de transacciones que conservamos para la recuperación a un momento determinado, del 1 al 7. |
Campo de unión
|
|
transactionalLogStorageState |
Solo salida. Este valor contiene la ubicación de almacenamiento de los registros de transacciones que se usan para realizar la recuperación de un momento determinado (PITR) de la base de datos. |
Campo de unión
|
|
backupTier |
Solo salida. Es el nivel de copia de seguridad que administra las copias de seguridad de la instancia. |
BackupRetentionSettings
| Representación JSON |
|---|
{
"retentionUnit": enum ( |
| Campos | |
|---|---|
retentionUnit |
Unidad que representa "retained_backups". |
retainedBackups |
Según el valor de retention_unit, se usa para determinar si se debe borrar una copia de seguridad. Si retention_unit es "COUNT", conservaremos esta cantidad de copias de seguridad. |
SqlActiveDirectoryConfig
| Representación JSON |
|---|
{
"kind": string,
"domain": string,
"mode": enum ( |
| Campos | |
|---|---|
kind |
Siempre es sql#activeDirectoryConfig. |
domain |
Nombre del dominio (p. ej., mydomain.com) |
mode |
Es opcional. Es el modo de configuración de Active Directory. |
dnsServers[] |
Es opcional. Son las direcciones IPv4 del controlador de dominio que se usan para iniciar Active Directory. |
adminCredentialSecretName |
Es opcional. Es la clave de Secret Manager que almacena la credencial del administrador. (p.ej., projects/{project}/secrets/{secret}). |
organizationalUnit |
Es opcional. Nombre de la unidad organizativa. Es la ruta jerárquica completa a la unidad organizativa. |
DenyMaintenancePeriod
| Representación JSON |
|---|
{ "startDate": string, "endDate": string, "time": string } |
| Campos | |
|---|---|
startDate |
Fecha de inicio del "período de rechazo del mantenimiento". Si el año de la fecha de inicio está vacío, el año de la fecha de finalización también debe estar vacío. En este caso, significa que el rechazo del período de mantenimiento se repite cada año. La fecha está en formato aaaa-mm-dd, es decir: 2020-11-01 o mm-dd, es decir, 11-01 |
endDate |
Fecha de finalización del "período de rechazo del mantenimiento". Si el año de la fecha de finalización está vacío, el año de la fecha de inicio también debe estar vacío. En este caso, significa que el intervalo sin mantenimiento se repite cada año. La fecha está en formato aaaa-mm-dd, es decir: 2020-11-01 o mm-dd, es decir, 11-01 |
time |
Es la hora en UTC en la que comienza el "período de rechazo del mantenimiento" en start_date y finaliza en end_date. La hora está en formato HH: mm:SS, es decir: 00:00:00 |
InsightsConfig
| Representación JSON |
|---|
{ "queryInsightsEnabled": boolean, "recordClientAddress": boolean, "recordApplicationTags": boolean, "queryStringLength": integer, "queryPlansPerMinute": integer, "enhancedQueryInsightsEnabled": boolean } |
| Campos | |
|---|---|
queryInsightsEnabled |
Indica si la función de Estadísticas de consultas está habilitada. |
recordClientAddress |
Indica si las Estadísticas de consultas registrarán la dirección del cliente cuando estén habilitadas. |
recordApplicationTags |
Indica si las Estadísticas de consultas registrarán etiquetas de aplicaciones de la consulta cuando estén habilitadas. |
queryStringLength |
Es la longitud máxima de la búsqueda almacenada en bytes. El valor predeterminado es de 1,024 bytes. Rango: de 256 a 4,500 bytes. Las longitudes de búsqueda superiores al valor de este campo se truncarán a este valor. Cuando no se configura, la longitud de la búsqueda será el valor predeterminado. Si cambias la longitud de la consulta, se reiniciará la base de datos. |
queryPlansPerMinute |
Cantidad de planes de ejecución de consultas que captura Insights por minuto para todas las consultas combinadas. El valor predeterminado es 5. |
enhancedQueryInsightsEnabled |
Es opcional. Indica si la función de estadísticas de consultas mejoradas está habilitada. |
PasswordValidationPolicy
| Representación JSON |
|---|
{
"minLength": integer,
"complexity": enum ( |
| Campos | |
|---|---|
minLength |
Es la cantidad mínima de caracteres permitidos. |
complexity |
Es la complejidad de la contraseña. |
reuseInterval |
Cantidad de contraseñas anteriores que no se pueden volver a usar. |
disallowUsernameSubstring |
No permitir el nombre de usuario como parte de la contraseña |
passwordChangeInterval |
Es el intervalo mínimo después del cual se puede cambiar la contraseña. Esta marca solo es compatible con PostgreSQL. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “ |
enablePasswordPolicy |
Indica si se debe habilitar la política de contraseñas. Cuando se habilita, las contraseñas deben cumplir con los requisitos de complejidad. Mantén habilitada esta política para ayudar a evitar el acceso no autorizado. Si inhabilitas esta política, se permitirán las contraseñas débiles. |
disallowCompromisedCredentials |
Este campo dejó de estar disponible y se quitará en una versión futura de la API. |
Duración
| Representación JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Campos | |
|---|---|
seconds |
Son los segundos firmados del período. Debe estar entre -315,576,000,000 y +315,576,000,000, inclusive. Nota: Estos límites se calculan de la siguiente manera: 60 s/min * 60 min/h * 24 h/día * 365.25 días/año * 10,000 años. |
nanos |
Fracciones firmadas de un segundo con una resolución de nanosegundos del período. Las duraciones inferiores a un segundo se representan con un campo |
SqlServerAuditConfig
| Representación JSON |
|---|
{ "kind": string, "bucket": string, "retentionInterval": string, "uploadInterval": string } |
| Campos | |
|---|---|
kind |
Siempre es sql#sqlServerAuditConfig. |
bucket |
Nombre del bucket de destino (p.ej., gs://mybucket). |
retentionInterval |
Tiempo durante el que se conservan los archivos de auditoría generados. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “ |
uploadInterval |
Con qué frecuencia se deben subir los archivos de auditoría generados. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “ |
AdvancedMachineFeatures
| Representación JSON |
|---|
{ "threadsPerCore": integer } |
| Campos | |
|---|---|
threadsPerCore |
Es la cantidad de subprocesos por núcleo físico. |
DataCacheConfig
| Representación JSON |
|---|
{ "dataCacheEnabled": boolean } |
| Campos | |
|---|---|
dataCacheEnabled |
Indica si la caché de datos está habilitada para la instancia. |
ConnectionPoolConfig
| Representación JSON |
|---|
{ "flags": [ { object ( |
| Campos | |
|---|---|
flags[] |
Es opcional. Es una lista de marcas de configuración del grupo de conexiones. |
Campo de unión
|
|
connectionPoolingEnabled |
Indica si la agrupación de conexiones administradas está habilitada. |
Campo de unión
|
|
poolerCount |
Solo salida. Cantidad de agrupadores de conexiones. |
ConnectionPoolFlags
| Representación JSON |
|---|
{ "name": string, "value": string } |
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre de la marca. |
value |
Obligatorio. Es el valor de la marca. Las marcas booleanas se configuran en |
FinalBackupConfig
| Representación JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de unión
|
|
enabled |
Indica si la copia de seguridad final está habilitada para la instancia. |
Campo de unión
|
|
retentionDays |
Es la cantidad de días que se retendrá la copia de seguridad final después de la eliminación de la instancia. La copia de seguridad final se borrará en (time_of_instance_deletion + retention_days). |
ReadPoolAutoScaleConfig
| Representación JSON |
|---|
{ "targetMetrics": [ { object ( |
| Campos | |
|---|---|
targetMetrics[] |
Es opcional. Son las métricas objetivo para el ajuste de escala automático del grupo de lectura. |
Campo de unión
|
|
enabled |
Indica si está habilitado el ajuste de escala automático del grupo de lectura. |
Campo de unión
|
|
minNodeCount |
Es la cantidad mínima de nodos del grupo de lectura que se deben mantener. |
Campo de unión
|
|
maxNodeCount |
Es la cantidad máxima de nodos del grupo de lectura que se deben mantener. |
Campo de unión
|
|
disableScaleIn |
Indica si el ajuste de escala automático del grupo de lectura admite operaciones de reducción de escala (quitar nodos). |
Campo de unión
|
|
scaleInCooldownSeconds |
Es el período de inactividad para las operaciones de reducción. |
Campo de unión
|
|
scaleOutCooldownSeconds |
Es el período de inactividad para las operaciones de escalamiento horizontal. |
TargetMetric
| Representación JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de unión
|
|
metric |
Es el nombre de la métrica que se usará para el ajuste de escala automático. |
Campo de unión
|
|
targetValue |
Es el valor objetivo de la métrica. |
SqlServerEntraIdConfig
| Representación JSON |
|---|
{ "kind": string, "tenantId": string, "applicationId": string } |
| Campos | |
|---|---|
kind |
Solo salida. Siempre es sql#sqlServerEntraIdConfig |
tenantId |
Es opcional. Es el ID del arrendatario para la configuración de Entra ID. |
applicationId |
Es opcional. Es el ID de la aplicación para la configuración de Entra ID. |
PerformanceCaptureConfig
| Representación JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de unión
|
|
enabled |
Es opcional. Habilita o inhabilita la función de captura de rendimiento. |
Campo de unión
|
|
probingIntervalSeconds |
Es opcional. Es el intervalo de tiempo en segundos entre dos sondeos cualesquiera. |
Campo de unión
|
|
probeThreshold |
Es opcional. Es la cantidad mínima de lecturas consecutivas por encima del umbral que activan la captura del estado de la instancia. |
Campo de unión
|
|
runningThreadsThreshold |
Es opcional. Es la cantidad mínima de subprocesos del servidor que se ejecutan para activar la captura en el servidor principal. |
Campo de unión
|
|
secondsBehindSourceThreshold |
Es opcional. Es la cantidad mínima de segundos que la réplica debe retrasarse con respecto a la instancia principal para activar la captura en la réplica. |
Campo de unión
|
|
transactionDurationThreshold |
Es opcional. Es la cantidad de tiempo en segundos que debe haber estado abierta una transacción antes de que el observador comience a registrarla. |
SqlFailoverReplica
| Representación JSON |
|---|
{ "name": string, "available": boolean } |
| Campos | |
|---|---|
name |
Es el nombre de la réplica de conmutación por error. Si se especifica durante la creación de la instancia, se crea una réplica de conmutación por error para la instancia. El nombre no incluye el ID del proyecto. |
available |
Es el estado de disponibilidad de la réplica de conmutación por error. Un estado falso indica que la réplica de conmutación por error no está sincronizada. La instancia principal solo puede conmutar por error a la réplica de conmutación por error cuando el estado es verdadero. |
IpMapping
| Representación JSON |
|---|
{
"type": enum ( |
| Campos | |
|---|---|
type |
Es el tipo de esta dirección IP. Una dirección |
ipAddress |
Es la dirección IP asignada. |
timeToRetire |
Hora de vencimiento de esta IP en formato RFC 3339, por ejemplo, Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
SslCert
| Representación JSON |
|---|
{ "kind": string, "certSerialNumber": string, "cert": string, "createTime": string, "commonName": string, "expirationTime": string, "sha1Fingerprint": string, "instance": string, "selfLink": string } |
| Campos | |
|---|---|
kind |
Siempre es |
certSerialNumber |
Número de serie, tal como se extrajo del certificado. |
cert |
Representación PEM. |
createTime |
Fecha y hora en que se creó el certificado en formato RFC 3339, por ejemplo, Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
commonName |
Es el nombre proporcionado por el usuario. Se limita a [a-zA-Z.-_ ]+. |
expirationTime |
Fecha y hora de vencimiento del certificado en formato RFC 3339, por ejemplo, Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
sha1Fingerprint |
Huella digital Sha1. |
instance |
Es el nombre de la instancia de la base de datos. |
selfLink |
Es el URI de este recurso. |
OnPremisesConfiguration
| Representación JSON |
|---|
{ "hostPort": string, "kind": string, "username": string, "password": string, "caCertificate": string, "clientCertificate": string, "clientKey": string, "dumpFilePath": string, "sourceInstance": { object ( |
| Campos | |
|---|---|
hostPort |
El host y el puerto de la instancia local en formato host:port |
kind |
Siempre es |
username |
Nombre de usuario para conectarse a la instancia local. |
password |
Contraseña para conectarse a la instancia local. |
caCertificate |
Representación PEM del certificado x509 de CA de confianza. |
clientCertificate |
Representación PEM del certificado x509 de la réplica. |
clientKey |
Representación PEM de la clave privada de la réplica. La clave pública correspondiente está codificada en el certificado del cliente. |
dumpFilePath |
Es el archivo de volcado para crear la réplica de Cloud SQL. |
sourceInstance |
Es la referencia a la instancia de Cloud SQL si la fuente es Cloud SQL. |
selectedObjects[] |
Es opcional. Es una lista de objetos que el usuario selecciona para la replicación desde una instancia de fuente externa. |
sslOption |
Es opcional. Opción de SSL para la conexión de la réplica a la fuente local. |
InstanceReference
| Representación JSON |
|---|
{ "name": string, "region": string, "project": string } |
| Campos | |
|---|---|
name |
Es el nombre de la instancia de Cloud SQL a la que se hace referencia. Esto no incluye el ID del proyecto. |
region |
Es la región de la instancia de Cloud SQL a la que se hace referencia. |
project |
Es el ID del proyecto de la instancia de Cloud SQL a la que se hace referencia. El valor predeterminado es el mismo ID del proyecto al que hace referencia la instancia. |
SelectedObjects
| Representación JSON |
|---|
{ "database": string } |
| Campos | |
|---|---|
database |
Obligatorio. Es el nombre de la base de datos que se migrará. |
ReplicaConfiguration
| Representación JSON |
|---|
{
"kind": string,
"mysqlReplicaConfiguration": {
object ( |
| Campos | |
|---|---|
kind |
Siempre es |
mysqlReplicaConfiguration |
Es la configuración específica de MySQL cuando se replica desde una instancia principal local de MySQL. La información de configuración de la replicación, como el nombre de usuario, la contraseña, los certificados y las claves, no se almacena en los metadatos de la instancia. La información de configuración solo se usa para establecer la conexión de replicación y MySQL la almacena en un archivo llamado |
failoverTarget |
Especifica si la réplica es el destino de conmutación por error. Si el campo se establece en |
cascadableReplica |
Es opcional. Especifica si una réplica de SQL Server es una réplica que se puede aplicar en cascada. Una réplica que se puede aplicar en cascada es una réplica entre regiones de SQL Server que admite réplicas debajo de ella. |
MySqlReplicaConfiguration
| Representación 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 |
Es la ruta de acceso a un archivo de volcado de SQL en Google Cloud Storage desde el que se creará la instancia de réplica. El URI tiene el formato gs://bucketName/fileName. También se admiten archivos gzip comprimidos (.gz). Los volcados tienen las coordenadas del registro binario desde el que comienza la replicación. Para ello, configura --master-data en 1 cuando uses mysqldump. |
username |
Es el nombre de usuario para la conexión de replicación. |
password |
Es la contraseña de la conexión de replicación. |
connectRetryInterval |
Cantidad de segundos que se deben esperar entre los reintentos de conexión. El valor predeterminado de MySQL es de 60 segundos. |
masterHeartbeatPeriod |
Es el intervalo en milisegundos entre los latidos de replicación. |
caCertificate |
Representación PEM del certificado x509 de CA de confianza. |
clientCertificate |
Representación PEM del certificado x509 de la réplica. |
clientKey |
Representación PEM de la clave privada de la réplica. La clave pública correspondiente está codificada en el certificado del cliente. |
sslCipher |
Es una lista de algoritmos de cifrado permitidos para la encriptación SSL. |
verifyServerCertificate |
Indica si se debe verificar el valor del nombre común de la instancia principal en el certificado que envía durante el protocolo de enlace de SSL. |
kind |
Siempre es |
DiskEncryptionConfiguration
| Representación JSON |
|---|
{ "kmsKeyName": string, "kind": string } |
| Campos | |
|---|---|
kmsKeyName |
Nombre del recurso de la clave KMS para la encriptación del disco. |
kind |
Siempre es |
DiskEncryptionStatus
| Representación JSON |
|---|
{ "kmsKeyVersionName": string, "kind": string } |
| Campos | |
|---|---|
kmsKeyVersionName |
Versión de la clave de KMS que se usó para encriptar el recurso de la instancia de Cloud SQL |
kind |
Siempre es |
SqlScheduledMaintenance
| Representación JSON |
|---|
{ "startTime": string, "canDefer": boolean, "canReschedule": boolean, // Union field |
| Campos | |
|---|---|
startTime |
Es la hora de inicio de cualquier mantenimiento programado próximo para esta instancia. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
canDefer |
|
canReschedule |
Indica si se puede reprogramar el mantenimiento programado. |
Campo de unión
|
|
scheduleDeadlineTime |
El mantenimiento no se puede reprogramar para que comience después de esta fecha límite. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
SqlOutOfDiskReport
| Representación JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de unión
|
|
sqlOutOfDiskState |
Este campo representa el estado generado por el trabajo de mantenimiento proactivo de la base de datos para los problemas de OutOfDisk. * Escritores: * El trabajo proactivo de estado de la base de datos para OOD. * Lectores: * El trabajo proactivo de estado de la base de datos |
Campo de unión
|
|
sqlMinRecommendedIncreaseSizeGb |
Tamaño de aumento mínimo recomendado en gigabytes. El frontend y el trabajo proactivo de estado de la base de datos para OOD consumen este campo. * Lectores: |
AvailableDatabaseVersion
| Representación JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de unión
|
|
majorVersion |
Es el nombre de la versión principal de la versión. |
Campo de unión
|
|
name |
Es el nombre de la versión de la base de datos. Para MySQL 8.0, esta cadena proporciona la versión principal y secundaria de la base de datos. |
Campo de unión
|
|
displayName |
Es el nombre visible de la versión de la base de datos. |
ReplicationCluster
| Representación JSON |
|---|
{ "psaWriteEndpoint": string, "failoverDrReplicaName": string, "drReplica": boolean } |
| Campos | |
|---|---|
psaWriteEndpoint |
Solo salida. Si se configura, este campo indica que esta instancia tiene un extremo de DNS de acceso a servicios privados (PSA) que apunta a la instancia principal del clúster. Si esta instancia es la principal, el extremo de DNS apunta a ella. Después de una operación de cambio o conmutación por error de réplica, este extremo de DNS apunta a la instancia promovida. Este es un campo de solo lectura que se devuelve al usuario como información. Este campo puede existir incluso si una instancia independiente aún no tiene una réplica de DR o si se borró la réplica de DR. |
failoverDrReplicaName |
Es opcional. Si la instancia es principal, este campo identifica la réplica de recuperación ante desastres (DR). Una réplica de DR es una configuración opcional para las instancias de la edición Enterprise Plus. Si la instancia es una réplica de lectura, el campo no se establece. Establece este campo en un nombre de réplica para designar una réplica de DR para una instancia principal. Quita el nombre de la réplica para quitar la designación de réplica de DR. |
drReplica |
Solo salida. Es un campo de solo lectura que indica si la réplica es una réplica de DR. Este campo no se establece si la instancia es principal. |
GeminiInstanceConfig
| Representación JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de unión
|
|
entitled |
Solo salida. Indica si Gemini está habilitado. |
Campo de unión
|
|
googleVacuumMgmtEnabled |
Solo salida. Indica si la administración de la aspiradora está habilitada. |
Campo de unión
|
|
oomSessionCancelEnabled |
Solo salida. Indica si está habilitada la cancelación de la sesión de memoria insuficiente (OOM). |
Campo de unión
|
|
activeQueryEnabled |
Solo salida. Indica si la búsqueda activa está habilitada. |
Campo de unión
|
|
indexAdvisorEnabled |
Solo salida. Indica si el asesor de índices está habilitado. |
Campo de unión
|
|
flagRecommenderEnabled |
Solo salida. Indica si el recomendador de marcas está habilitado. |
TagsEntry
| Representación JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
PoolNodeConfig
| Representación JSON |
|---|
{ "ipAddresses": [ { object ( |
| Campos | |
|---|---|
ipAddresses[] |
Solo salida. Son asignaciones que contienen direcciones IP que se pueden usar para conectarse al nodo del grupo de lectura. |
dnsNames[] |
Solo salida. Es la lista de nombres de DNS que usa este nodo del grupo de lectura. |
pscAutoConnections[] |
Solo salida. Es la lista de parámetros de configuración para los extremos de consumidor de Private Service Connect (PSC) solicitados y configurados automáticamente que se pueden usar para conectarse a este nodo de grupo de lectura. |
Campo de unión
|
|
name |
Solo salida. Nombre del nodo del grupo de lectura, que se usará para recuperar métricas y registros. |
Campo de unión
|
|
gceZone |
Solo salida. Es la zona del nodo del grupo de lectura. |
Campo de unión
|
|
dnsName |
Solo salida. Es el nombre de DNS del nodo del grupo de lectura. |
Campo de unión
|
|
state |
Solo salida. Es el estado actual del nodo del grupo de lectura. |
Campo de unión
|
|
pscServiceAttachmentLink |
Solo salida. Es el adjunto del servicio de Private Service Connect (PSC) del nodo del grupo de lectura. |
DnsNameMapping
| Representación JSON |
|---|
{ "name": string, "connectionType": enum ( |
| Campos | |
|---|---|
name |
Solo salida. Es el nombre de DNS. |
connectionType |
Solo salida. Es el tipo de conexión del nombre de DNS. |
dnsScope |
Solo salida. Es el alcance al que se aplica el nombre de DNS. |
recordManager |
Solo salida. Es el administrador de este registro DNS. |
Anotaciones de herramientas
Sugerencia destructiva: ❌ | Sugerencia idempotente: ❌ | Sugerencia de solo lectura: ✅ | Sugerencia de mundo abierto: ❌