MCP Tools Reference: cloud-sql

工具：`clone_instance`

创建 Cloud SQL 实例作为源实例的克隆。

此工具会返回一个长时间运行的操作。使用 get_operation 工具轮询其状态，直到操作完成。
克隆操作可能需要几分钟时间。使用命令行工具暂停 30 秒，然后再重新检查状态。

以下示例演示了如何使用 curl 调用 clone_instance MCP 工具。

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": "clone_instance", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }'

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": "clone_instance",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

输入架构

实例克隆请求。

SqlInstancesCloneRequest

JSON 表示法
{ "instance": string, "project": string, "body": { object (`InstancesCloneRequest`) } }

字段

字段
`instance`	`string` 必需。要克隆的 Cloud SQL 实例的 ID（源）。不包括项目 ID。
`project`	`string` 必需。源实例以及克隆 Cloud SQL 实例的项目 ID。
`body`	`object (InstancesCloneRequest)`

instance

string

必需。要克隆的 Cloud SQL 实例的 ID（源）。不包括项目 ID。

project

string

必需。源实例以及克隆 Cloud SQL 实例的项目 ID。

body

object (InstancesCloneRequest)

InstancesCloneRequest

JSON 表示法
{ "cloneContext": { object (`CloneContext`) } }

字段

字段
`cloneContext`	`object (CloneContext)` 必需。包含有关克隆操作的详细信息。

cloneContext

object (CloneContext)

必需。包含有关克隆操作的详细信息。

CloneContext

JSON 表示法

JSON 表示法
{ "kind": string, "pitrTimestampMs": string, "destinationInstanceName": string, "binLogCoordinates": { object (`BinLogCoordinates`) }, "pointInTime": string, "allocatedIpRange": string, "databaseNames": [ string ], // Union field `_preferred_zone` can be only one of the following: "preferredZone": string // End of list of possible types for union field `_preferred_zone`. // Union field `_preferred_secondary_zone` can be only one of the following: "preferredSecondaryZone": string // End of list of possible types for union field `_preferred_secondary_zone`. // Union field `_source_instance_deletion_time` can be only one of the following: "sourceInstanceDeletionTime": string // End of list of possible types for union field // `_source_instance_deletion_time`. // Union field `_destination_project` can be only one of the following: "destinationProject": string // End of list of possible types for union field `_destination_project`. // Union field `_destination_network` can be only one of the following: "destinationNetwork": string // End of list of possible types for union field `_destination_network`. }

{
  "kind": string,
  "pitrTimestampMs": string,
  "destinationInstanceName": string,
  "binLogCoordinates": {
    object (BinLogCoordinates)
  },
  "pointInTime": string,
  "allocatedIpRange": string,
  "databaseNames": [
    string
  ],

  // Union field _preferred_zone can be only one of the following:
  "preferredZone": string
  // End of list of possible types for union field _preferred_zone.

  // Union field _preferred_secondary_zone can be only one of the following:
  "preferredSecondaryZone": string
  // End of list of possible types for union field _preferred_secondary_zone.

  // Union field _source_instance_deletion_time can be only one of the following:
  "sourceInstanceDeletionTime": string
  // End of list of possible types for union field
  // _source_instance_deletion_time.

  // Union field _destination_project can be only one of the following:
  "destinationProject": string
  // End of list of possible types for union field _destination_project.

  // Union field _destination_network can be only one of the following:
  "destinationNetwork": string
  // End of list of possible types for union field _destination_network.
}

字段

字段
`kind`	`string` 始终为 `sql#cloneContext`。
`pitrTimestampMs`	`string (int64 format)` 留待将来使用。
`destinationInstanceName`	`string` 必需。要创建为克隆的 Cloud SQL 实例的名称。
`binLogCoordinates`	`object (BinLogCoordinates)` 二进制日志坐标（如果已指定），用于标识源实例的克隆位置。如果未指定，则源实例会被克隆到最近的二进制日志坐标。
`pointInTime`	`string (Timestamp format)` 时间戳（如果已指定），用于标识源实例的克隆时间。采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例：`"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"` 或 `"2014-10-02T15:01:23+05:30"`。
`allocatedIpRange`	`string` 专用 IP Cloud SQL 实例的已分配 IP 范围的名称。例如：“google-managed-services-default”。如果设置，则克隆的实例 IP 将在分配的范围内创建。范围名称必须符合 RFC 1035 的要求。具体而言，名称的长度必须为 1-63 个字符，并且必须与正则表达式 a-z 匹配。留待将来使用。
`databaseNames[]`	`string` （仅限 SQL Server）仅克隆源实例中的指定数据库。如果为空，则克隆所有数据库。
联合字段 `_preferred_zone`。 `_preferred_zone` 只能是下列其中一项：
`preferredZone`	`string` 可选。将实例的克隆和时间点恢复克隆复制到指定可用区。如果未指定可用区，则克隆到与源实例相同的主可用区。此字段适用于所有数据库类型。
联合字段 `_preferred_secondary_zone`。 `_preferred_secondary_zone` 只能是下列其中一项：
`preferredSecondaryZone`	`string` 可选。复制指定可用区中区域级实例的克隆和时间点恢复克隆。如果未指定，则克隆到与源实例相同的次要可用区。此值不能与 preferred_zone 字段相同。此字段适用于所有数据库类型。
联合字段 `_source_instance_deletion_time`。 `_source_instance_deletion_time` 只能是下列其中一项：
`sourceInstanceDeletionTime`	`string (Timestamp format)` 用于标识源实例删除时间的相应时间戳。如果此实例被删除，则必须设置时间戳。采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例：`"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"` 或 `"2014-10-02T15:01:23+05:30"`。
联合字段 `_destination_project`。 `_destination_project` 只能是下列其中一项：
`destinationProject`	`string` 可选。克隆实例将创建到的目标项目的项目 ID。如需执行跨项目克隆，此字段为必填字段。如果未指定，则克隆将在源实例所在的同一项目中创建。
联合字段 `_destination_network`。 `_destination_network` 只能是下列其中一项：
`destinationNetwork`	`string` 可选。VPC 网络的完全限定 URI，克隆的实例将通过专用服务访问通道连接到该网络以获取专用 IP。例如：`projects/my-network-project/global/networks/my-network`。此字段仅在进行跨项目克隆时是必需的。

kind

string

始终为 sql#cloneContext。

pitrTimestampMs

string (int64 format)

留待将来使用。

destinationInstanceName

string

必需。要创建为克隆的 Cloud SQL 实例的名称。

binLogCoordinates

object (BinLogCoordinates)

二进制日志坐标（如果已指定），用于标识源实例的克隆位置。如果未指定，则源实例会被克隆到最近的二进制日志坐标。

pointInTime

string (Timestamp format)

时间戳（如果已指定），用于标识源实例的克隆时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

allocatedIpRange

string

专用 IP Cloud SQL 实例的已分配 IP 范围的名称。例如：“google-managed-services-default”。如果设置，则克隆的实例 IP 将在分配的范围内创建。范围名称必须符合 RFC 1035 的要求。具体而言，名称的长度必须为 1-63 个字符，并且必须与正则表达式 a-z 匹配。留待将来使用。

databaseNames[]

string

（仅限 SQL Server）仅克隆源实例中的指定数据库。如果为空，则克隆所有数据库。

联合字段 _preferred_zone。

_preferred_zone 只能是下列其中一项：

preferredZone

string

可选。将实例的克隆和时间点恢复克隆复制到指定可用区。如果未指定可用区，则克隆到与源实例相同的主可用区。此字段适用于所有数据库类型。

联合字段 _preferred_secondary_zone。

_preferred_secondary_zone 只能是下列其中一项：

preferredSecondaryZone

string

可选。复制指定可用区中区域级实例的克隆和时间点恢复克隆。如果未指定，则克隆到与源实例相同的次要可用区。此值不能与 preferred_zone 字段相同。此字段适用于所有数据库类型。

联合字段 _source_instance_deletion_time。

_source_instance_deletion_time 只能是下列其中一项：

sourceInstanceDeletionTime

string (Timestamp format)

用于标识源实例删除时间的相应时间戳。如果此实例被删除，则必须设置时间戳。

联合字段 _destination_project。

_destination_project 只能是下列其中一项：

destinationProject

string

可选。克隆实例将创建到的目标项目的项目 ID。如需执行跨项目克隆，此字段为必填字段。如果未指定，则克隆将在源实例所在的同一项目中创建。

联合字段 _destination_network。

_destination_network 只能是下列其中一项：

destinationNetwork

string

可选。VPC 网络的完全限定 URI，克隆的实例将通过专用服务访问通道连接到该网络以获取专用 IP。例如：projects/my-network-project/global/networks/my-network。此字段仅在进行跨项目克隆时是必需的。

BinLogCoordinates

JSON 表示法
{ "binLogFileName": string, "binLogPosition": string, "kind": string }

字段

字段
`binLogFileName`	`string` Cloud SQL 实例的二进制日志文件的名称。
`binLogPosition`	`string (int64 format)` 二进制日志文件中的位置（偏移）。
`kind`	`string` 始终为 `sql#binLogCoordinates`。

binLogFileName

string

Cloud SQL 实例的二进制日志文件的名称。

binLogPosition

string (int64 format)

二进制日志文件中的位置（偏移）。

kind

string

始终为 sql#binLogCoordinates。

时间戳

JSON 表示法
{ "seconds": string, "nanos": integer }

字段

字段
`seconds`	`string (int64 format)` 表示世界协调时间 (UTC) 的秒数（从 Unix 纪元 1970-01-01T00:00:00Z 开始算起）。必须介于 -62135596800 到 253402300799 之间（含边界值），对应于 0001-01-01T00:00:00Z 到 9999-12-31T23:59:59Z。
`nanos`	`integer` 秒数的非负小数部分（以纳秒为单位）。此字段是时长的纳秒部分，而不是秒的替代项。对于含小数部分的负秒数，仍必须包含按时间递升的非负纳秒值。必须在 0 到 999,999,999 之间（含边界值）。

seconds

string (int64 format)

表示世界协调时间 (UTC) 的秒数（从 Unix 纪元 1970-01-01T00:00:00Z 开始算起）。必须介于 -62135596800 到 253402300799 之间（含边界值），对应于 0001-01-01T00:00:00Z 到 9999-12-31T23:59:59Z。

nanos

integer

秒数的非负小数部分（以纳秒为单位）。此字段是时长的纳秒部分，而不是秒的替代项。对于含小数部分的负秒数，仍必须包含按时间递升的非负纳秒值。必须在 0 到 999,999,999 之间（含边界值）。

输出架构

Operation 资源。对于返回 Operation 资源的成功操作，仅会在资源中填充与操作相关的字段。

操作

JSON 表示法

JSON 表示法
{ "kind": string, "targetLink": string, "status": enum (`SqlOperationStatus`), "user": string, "insertTime": string, "startTime": string, "endTime": string, "error": { object (`OperationErrors`) }, "apiWarning": { object (`ApiWarning`) }, "operationType": enum (`SqlOperationType`), "importContext": { object (`ImportContext`) }, "exportContext": { object (`ExportContext`) }, "backupContext": { object (`BackupContext`) }, "preCheckMajorVersionUpgradeContext": { object (`PreCheckMajorVersionUpgradeContext`) }, "name": string, "targetId": string, "selfLink": string, "targetProject": string, "acquireSsrsLeaseContext": { object (`AcquireSsrsLeaseContext`) }, "subOperationType": { object (`SqlSubOperationType`) } }

{
  "kind": string,
  "targetLink": string,
  "status": enum (SqlOperationStatus),
  "user": string,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    object (OperationErrors)
  },
  "apiWarning": {
    object (ApiWarning)
  },
  "operationType": enum (SqlOperationType),
  "importContext": {
    object (ImportContext)
  },
  "exportContext": {
    object (ExportContext)
  },
  "backupContext": {
    object (BackupContext)
  },
  "preCheckMajorVersionUpgradeContext": {
    object (PreCheckMajorVersionUpgradeContext)
  },
  "name": string,
  "targetId": string,
  "selfLink": string,
  "targetProject": string,
  "acquireSsrsLeaseContext": {
    object (AcquireSsrsLeaseContext)
  },
  "subOperationType": {
    object (SqlSubOperationType)
  }
}

字段
`kind`	`string` 始终为 `sql#operation`。
`targetLink`	`string`
`status`	`enum (SqlOperationStatus)` 操作的状态。
`user`	`string` 启动此操作的用户的电子邮件地址。
`insertTime`	`string (Timestamp format)` 此操作已加入队列的时间，采用 UTC 时区，采用 RFC 3339 格式，例如 `2012-11-15T16:19:00.094Z`。采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例：`"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"` 或 `"2014-10-02T15:01:23+05:30"`。
`startTime`	`string (Timestamp format)` 此操作真正开始的时间，采用 UTC 时区，采用 RFC 3339 格式，例如 `2012-11-15T16:19:00.094Z`。采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例：`"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"` 或 `"2014-10-02T15:01:23+05:30"`。
`endTime`	`string (Timestamp format)` 此操作完成的时间，采用 UTC 时区，采用 RFC 3339 格式，例如 `2012-11-15T16:19:00.094Z`。采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例：`"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"` 或 `"2014-10-02T15:01:23+05:30"`。
`error`	`object (OperationErrors)` 如果在处理此操作期间发生错误，系统将填充此字段。
`apiWarning`	`object (ApiWarning)` Admin API 警告消息。
`operationType`	`enum (SqlOperationType)` 操作的类型。有效值为：* `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
`importContext`	`object (ImportContext)` 导入操作的上下文（如果适用）。
`exportContext`	`object (ExportContext)` 导出操作的上下文（如果适用）。
`backupContext`	`object (BackupContext)` 备份操作的上下文（如果适用）。
`preCheckMajorVersionUpgradeContext`	`object (PreCheckMajorVersionUpgradeContext)` 仅当 operation_type 为 PRE_CHECK_MAJOR_VERSION_UPGRADE 时，系统才会填充此字段。PreCheckMajorVersionUpgradeContext 消息本身包含相应预检查的详细信息，例如升级的目标数据库版本和检查结果（包括发现的任何警告或错误）。
`name`	`string` 唯一标识操作的标识符。您可以使用此标识符检索包含操作相关信息的操作资源。
`targetId`	`string` 运行相应操作的资源的名称。
`selfLink`	`string` 此资源的 URI。
`targetProject`	`string` 与此操作相关的目标实例的项目 ID。
`acquireSsrsLeaseContext`	`object (AcquireSsrsLeaseContext)` 获取 SSRS 租约操作的上下文（如果适用）。
`subOperationType`	`object (SqlSubOperationType)` 可选。基于操作类型的子操作。

时间戳

JSON 表示法
{ "seconds": string, "nanos": integer }

字段

字段
`seconds`	`string (int64 format)` 表示世界协调时间 (UTC) 的秒数（从 Unix 纪元 1970-01-01T00:00:00Z 开始算起）。必须介于 -62135596800 到 253402300799 之间（含边界值），对应于 0001-01-01T00:00:00Z 到 9999-12-31T23:59:59Z。
`nanos`	`integer` 秒数的非负小数部分（以纳秒为单位）。此字段是时长的纳秒部分，而不是秒的替代项。对于含小数部分的负秒数，仍必须包含按时间递升的非负纳秒值。必须在 0 到 999,999,999 之间（含边界值）。

seconds

string (int64 format)

nanos

integer

OperationErrors

JSON 表示法
{ "kind": string, "errors": [ { object (`OperationError`) } ] }

字段

字段
`kind`	`string` 始终为 `sql#operationErrors`。
`errors[]`	`object (OperationError)` 处理此操作时遇到的错误的列表。

kind

string

始终为 sql#operationErrors。

errors[]

object (OperationError)

处理此操作时遇到的错误的列表。

OperationError

JSON 表示法
{ "kind": string, "code": string, "message": string }

字段

字段
`kind`	`string` 始终为 `sql#operationError`。
`code`	`string` 确定发生的具体错误。
`message`	`string` 有关遇到的错误的其他信息。

kind

string

始终为 sql#operationError。

code

string

确定发生的具体错误。

message

string

有关遇到的错误的其他信息。

ApiWarning

JSON 表示法
{ "code": enum (`SqlApiWarningCode`), "message": string, "region": string }

字段

字段
`code`	`enum (SqlApiWarningCode)` 用于标识警告类型的唯一代码。
`message`	`string` 警告消息。
`region`	`string` REGION_UNREACHABLE 警告的区域名称。

code

enum (SqlApiWarningCode)

用于标识警告类型的唯一代码。

message

string

警告消息。

region

string

REGION_UNREACHABLE 警告的区域名称。

ImportContext

JSON 表示法

JSON 表示法
{ "uri": string, "database": string, "kind": string, "fileType": enum (`SqlFileType`), "csvImportOptions": { object (`SqlCsvImportOptions`) }, "importUser": string, "bakImportOptions": { object (`SqlBakImportOptions`) }, "sqlImportOptions": { object (`SqlImportOptions`) }, "tdeImportOptions": { object (`SqlTdeImportOptions`) } }

{
  "uri": string,
  "database": string,
  "kind": string,
  "fileType": enum (SqlFileType),
  "csvImportOptions": {
    object (SqlCsvImportOptions)
  },
  "importUser": string,
  "bakImportOptions": {
    object (SqlBakImportOptions)
  },
  "sqlImportOptions": {
    object (SqlImportOptions)
  },
  "tdeImportOptions": {
    object (SqlTdeImportOptions)
  }
}

字段
`uri`	`string` Cloud Storage 中导入文件的路径，格式为 `gs://bucketName/fileName`。如果 `fileType` 为 `SQL`，则支持压缩的 gzip 文件 (.gz)。实例必须对存储分区拥有写入权限，并拥有文件的读取权限。
`database`	`string` 导入的目标数据库。如果 `fileType` 为 `SQL`，则只有在导入文件未指定数据库且被导入文件中的任何数据库规范替换的情况下才需要此字段。对于整个实例并行导入操作，数据库会被存储在子目录名称中的数据库名称覆盖。如果 `fileType` 为 `CSV`，则必须指定一个数据库。
`kind`	`string` 始终为 `sql#importContext`。
`fileType`	`enum (SqlFileType)` 指定 URI 的文件类型。`SQL`: The file contains SQL statements. \`CSV`：文件包含 CSV 数据。
`csvImportOptions`	`object (SqlCsvImportOptions)` 用于以 CSV 格式导入数据的选项。
`importUser`	`string` 此导入操作的 PostgreSQL 用户。仅 PostgreSQL 实例。
`bakImportOptions`	`object (SqlBakImportOptions)` 特定于 SQL Server .BAK 文件的导入参数
`sqlImportOptions`	`object (SqlImportOptions)` 可选。用于从 SQL 语句导入数据的选项。
`tdeImportOptions`	`object (SqlTdeImportOptions)` 可选。特定于 SQL Server TDE 证书的导入参数

SqlCsvImportOptions

JSON 表示法
{ "table": string, "columns": [ string ], "escapeCharacter": string, "quoteCharacter": string, "fieldsTerminatedBy": string, "linesTerminatedBy": string }

字段
`table`	`string` 将导入 CSV 数据的表格。
`columns[]`	`string` 将导入 CSV 数据的列。如果未指定，则数据库表的所有列都将加载 CSV 数据。
`escapeCharacter`	`string` 指定应出现在需要转义的数据字符之前的字符。
`quoteCharacter`	`string` 指定在引用数据值时要使用的引用字符。
`fieldsTerminatedBy`	`string` 指定用于在文件的每行中分隔列的字符。
`linesTerminatedBy`	`string` 用于分隔行。如果某行不包含所有字段，则其余列会设置为默认值。

SqlBakImportOptions

JSON 表示法
{ "encryptionOptions": { object (`EncryptionOptions`) }, "striped": boolean, "noRecovery": boolean, "recoveryOnly": boolean, "bakType": enum (`BakType`), "stopAt": string, "stopAtMark": string }

字段
`encryptionOptions`	`object (EncryptionOptions)`
`striped`	`boolean` 正在恢复的备份集是否为条带化备份集。仅适用于 Cloud SQL for SQL Server。
`noRecovery`	`boolean` 备份导入是否会使用 NORECOVERY 选项恢复数据库。仅适用于 Cloud SQL for SQL Server。
`recoveryOnly`	`boolean` 备份导入请求是否只会使数据库联机，而不会下载 Bak 内容。只能将“no_recovery”和“recovery_only”中的一个设置为 true，否则将返回错误。仅适用于 Cloud SQL for SQL Server。
`bakType`	`enum (BakType)` bak 内容的类型，FULL 或 DIFF
`stopAt`	`string (Timestamp format)` 可选。导入应停止的时间戳。此时间戳采用 RFC 3339 格式（例如，`2023-10-01T16:19:00.094`）。此字段等效于 STOPAT 关键字，仅适用于 Cloud SQL for SQL Server。采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例：`"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"` 或 `"2014-10-02T15:01:23+05:30"`。
`stopAtMark`	`string` 可选。导入应停止的标记交易。此字段等同于 STOPATMARK 关键字，仅适用于 Cloud SQL for SQL Server。

EncryptionOptions

JSON 表示法
{ "certPath": string, "pvkPath": string, "pvkPassword": string, "keepEncrypted": boolean }

字段
`certPath`	`string` Cloud Storage 中证书 (.cer) 的路径，格式为 `gs://bucketName/fileName`。实例必须对存储分区拥有写入权限，并拥有文件的读取权限。
`pvkPath`	`string` Cloud Storage 中证书私钥 (.pvk) 的路径，格式为 `gs://bucketName/fileName`。实例必须对存储分区拥有写入权限，并拥有文件的读取权限。
`pvkPassword`	`string` 加密私钥的密码
`keepEncrypted`	`boolean` 可选。导入的文件是否保持加密状态。

BoolValue

JSON 表示法
{ "value": boolean }

字段

字段
`value`	`boolean` 布尔值。

value

boolean

布尔值。

SqlImportOptions

JSON 表示法
{ "threads": integer, "parallel": boolean, "postgresImportOptions": { object (`PostgresImportOptions`) } }

字段

字段
`threads`	`integer` 可选。用于并行导入的线程数。
`parallel`	`boolean` 可选。导入是否应并行进行。
`postgresImportOptions`	`object (PostgresImportOptions)` 可选。用于从 Cloud SQL for PostgreSQL 实例导入数据的选项。

threads

integer

可选。用于并行导入的线程数。

parallel

boolean

可选。导入是否应并行进行。

postgresImportOptions

object (PostgresImportOptions)

可选。用于从 Cloud SQL for PostgreSQL 实例导入数据的选项。

Int32Value

JSON 表示法
{ "value": integer }

字段

字段
`value`	`integer` int32 值。

value

integer

int32 值。

PostgresImportOptions

JSON 表示法
{ "clean": boolean, "ifExists": boolean }

字段

字段
`clean`	`boolean` 可选。pg_restore 实用程序的 --clean 标志。此标志仅在您启用 Cloud SQL 并行导入文件时适用。
`ifExists`	`boolean` 可选。pg_restore 实用程序的 --if-exists 标志。此标志仅在您启用 Cloud SQL 并行导入文件时适用。

clean

boolean

可选。pg_restore 实用程序的 --clean 标志。此标志仅在您启用 Cloud SQL 并行导入文件时适用。

ifExists

boolean

可选。pg_restore 实用程序的 --if-exists 标志。此标志仅在您启用 Cloud SQL 并行导入文件时适用。

SqlTdeImportOptions

JSON 表示法
{ "certificatePath": string, "privateKeyPath": string, "privateKeyPassword": string, "name": string }

字段
`certificatePath`	`string` 必需。TDE 证书公钥的路径，格式为 gs://bucketName/fileName。实例必须拥有文件的读取权限。仅适用于 SQL Server 实例。
`privateKeyPath`	`string` 必需。TDE 证书私钥的路径，格式为 gs://bucketName/fileName。实例必须拥有文件的读取权限。仅适用于 SQL Server 实例。
`privateKeyPassword`	`string` 必需。加密私钥的密码。
`name`	`string` 必需。证书名称。仅适用于 SQL Server 实例。

ExportContext

JSON 表示法

JSON 表示法
{ "uri": string, "databases": [ string ], "kind": string, "sqlExportOptions": { object (`SqlExportOptions`) }, "csvExportOptions": { object (`SqlCsvExportOptions`) }, "fileType": enum (`SqlFileType`), "offload": boolean, "bakExportOptions": { object (`SqlBakExportOptions`) }, "tdeExportOptions": { object (`SqlTdeExportOptions`) } }

{
  "uri": string,
  "databases": [
    string
  ],
  "kind": string,
  "sqlExportOptions": {
    object (SqlExportOptions)
  },
  "csvExportOptions": {
    object (SqlCsvExportOptions)
  },
  "fileType": enum (SqlFileType),
  "offload": boolean,
  "bakExportOptions": {
    object (SqlBakExportOptions)
  },
  "tdeExportOptions": {
    object (SqlTdeExportOptions)
  }
}

字段
`uri`	`string` Google Cloud Storage 中将存储导出的文件的路径。URI 的格式为 `gs://bucketName/fileName`。如果文件已存在，则请求成功，但操作失败。如果 `fileType` 为 `SQL` 且文件名以 .gz 结尾，则将压缩内容。
`databases[]`	`string` 要导出的数据库。 `MySQL instances:` 如果 `fileType` 为 `SQL` 且未指定数据库，则将导出所有数据库，但 `mysql` 系统数据库除外。如果 `fileType` 为 `CSV`，您可以使用此属性或使用 `csvExportOptions.selectQuery` 属性（优先于此属性）。 `PostgreSQL instances:` 如果您未按名称指定数据库，系统会导出实例中的所有用户数据库。这不包括系统数据库和用于管理内部操作的 Cloud SQL 数据库。导出所有用户数据库仅适用于目录格式的并行导出。如果 `fileType` 为 `CSV`，则此数据库必须与 `csvExportOptions.selectQuery` 属性中指定的值相匹配。 `SQL Server instances:` 您必须指定一个要导出的数据库，并且 `fileType` 必须为 `BAK`。
`kind`	`string` 始终为 `sql#exportContext`。
`sqlExportOptions`	`object (SqlExportOptions)` 用于将数据导出为 SQL 语句的选项。
`csvExportOptions`	`object (SqlCsvExportOptions)` 用于将数据导出为 CSV 的选项。仅限 `MySQL` 和 `PostgreSQL` 实例。
`fileType`	`enum (SqlFileType)` 指定 URI 的文件类型。
`offload`	`boolean` 是否执行无服务器导出。
`bakExportOptions`	`object (SqlBakExportOptions)` 用于将数据导出为 BAK 文件的选项。
`tdeExportOptions`	`object (SqlTdeExportOptions)` 可选。特定于 SQL Server TDE 证书的导出参数

SqlExportOptions

JSON 表示法

JSON 表示法
{ "tables": [ string ], "schemaOnly": boolean, "mysqlExportOptions": { object (`MysqlExportOptions`) }, "threads": integer, "parallel": boolean, "postgresExportOptions": { object (`PostgresExportOptions`) } }

{
  "tables": [
    string
  ],
  "schemaOnly": boolean,
  "mysqlExportOptions": {
    object (MysqlExportOptions)
  },
  "threads": integer,
  "parallel": boolean,
  "postgresExportOptions": {
    object (PostgresExportOptions)
  }
}

字段
`tables[]`	`string` 要从指定数据库导出或已导出的表。如果指定表，请指定一个且仅指定一个数据库。对于 PostgreSQL 实例，您只能指定一个表。
`schemaOnly`	`boolean` 仅导出架构。
`mysqlExportOptions`	`object (MysqlExportOptions)`
`threads`	`integer` 可选。用于并行导出的线程数。
`parallel`	`boolean` 可选。导出是否应并行进行。
`postgresExportOptions`	`object (PostgresExportOptions)` 可选。从 Cloud SQL for PostgreSQL 实例导出数据的选项。

MysqlExportOptions

JSON 表示法
{ "masterData": integer }

字段

字段
`masterData`	`integer` 包含设置复制所需的 SQL 语句的选项。如果设置为 `1`，则转储文件会包含带有二进制日志坐标的 CHANGE MASTER TO 语句，并且 --set-gtid-purged 设置为 ON。如果设置为 `2`，则 CHANGE MASTER TO 语句将编写为 SQL 注释，并且没有任何效果。如果设置为 `1` 以外的任何值，则 --set-gtid-purged 设置为 OFF。

masterData

integer

包含设置复制所需的 SQL 语句的选项。如果设置为 1，则转储文件会包含带有二进制日志坐标的 CHANGE MASTER TO 语句，并且 --set-gtid-purged 设置为 ON。如果设置为 2，则 CHANGE MASTER TO 语句将编写为 SQL 注释，并且没有任何效果。如果设置为 1 以外的任何值，则 --set-gtid-purged 设置为 OFF。

PostgresExportOptions

JSON 表示法
{ "clean": boolean, "ifExists": boolean }

字段

字段
`clean`	`boolean` 可选。使用此选项可包含 DROP `<object>` SQL 语句。在运行导入操作之前，请使用以下语句删除数据库对象。
`ifExists`	`boolean` 可选。用于在 clean 生成的每个 DROP 语句中添加 IF EXISTS SQL 语句的选项。

clean

boolean

可选。使用此选项可包含 DROP

<object>

SQL 语句。在运行导入操作之前，请使用以下语句删除数据库对象。

ifExists

boolean

可选。用于在 clean 生成的每个 DROP 语句中添加 IF EXISTS SQL 语句的选项。

SqlCsvExportOptions

JSON 表示法
{ "selectQuery": string, "escapeCharacter": string, "quoteCharacter": string, "fieldsTerminatedBy": string, "linesTerminatedBy": string }

字段
`selectQuery`	`string` 用于提取数据的 select 查询。
`escapeCharacter`	`string` 指定应出现在需要转义的数据字符之前的字符。
`quoteCharacter`	`string` 指定在引用数据值时要使用的引用字符。
`fieldsTerminatedBy`	`string` 指定用于在文件的每行中分隔列的字符。
`linesTerminatedBy`	`string` 用于分隔行。如果某行不包含所有字段，则其余列会设置为默认值。

SqlBakExportOptions

JSON 表示法
{ "striped": boolean, "stripeCount": integer, "bakType": enum (`BakType`), "copyOnly": boolean, "differentialBase": boolean, "exportLogStartTime": string, "exportLogEndTime": string }

字段
`striped`	`boolean` 导出是否应条带化。
`stripeCount`	`integer` 用于指定导出时要使用的条带数量的选项。如果留空，且条带化字段的值为 true，则系统会自动选择条带数。
`bakType`	`enum (BakType)` 相应 BAK 文件的类型，可以是 export、FULL 或 DIFF，仅限 SQL Server
`copyOnly (deprecated)`	`boolean` 此项已弃用！已弃用：copy_only 已弃用。请改用 differential_base
`differentialBase`	`boolean` 备份是否可用作差分库 copy_only 备份不能用作差分库
`exportLogStartTime`	`string (Timestamp format)` 可选。导出操作中将包含交易日志的开始时间戳。采用 RFC 3339 格式（例如 `2023-10-01T16:19:00.094`），以 UTC 表示。如果省略，则会包含自保留期限开始以来的所有可用日志。仅适用于 Cloud SQL for SQL Server。采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例：`"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"` 或 `"2014-10-02T15:01:23+05:30"`。
`exportLogEndTime`	`string (Timestamp format)` 可选。导出操作中将包含交易日志的结束时间戳。采用 RFC 3339 格式（例如 `2023-10-01T16:19:00.094`），以 UTC 表示。如果省略，则会包含当前时间之前的所有可用日志。仅适用于 Cloud SQL for SQL Server。采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例：`"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"` 或 `"2014-10-02T15:01:23+05:30"`。

SqlTdeExportOptions

JSON 表示法
{ "certificatePath": string, "privateKeyPath": string, "privateKeyPassword": string, "name": string }

字段
`certificatePath`	`string` 必需。TDE 证书公钥的路径，格式为 gs://bucketName/fileName。实例必须拥有存储桶的写入权限。仅适用于 SQL Server 实例。
`privateKeyPath`	`string` 必需。TDE 证书私钥的路径，格式为 gs://bucketName/fileName。实例必须对该位置具有写入权限。仅适用于 SQL Server 实例。
`privateKeyPassword`	`string` 必需。加密私钥的密码。
`name`	`string` 必需。证书名称。仅适用于 SQL Server 实例。

BackupContext

JSON 表示法
{ "backupId": string, "kind": string, "name": string }

字段

backupId

string (int64 format)

备份的标识符。

kind

string

始终为 sql#backupContext。

name

string

备份的名称。格式：projects/{project}/backups/{backup}

PreCheckMajorVersionUpgradeContext

JSON 表示法
{ "targetDatabaseVersion": enum (`SqlDatabaseVersion`), "preCheckResponse": [ { object (`PreCheckResponse`) } ], "kind": string }

字段

targetDatabaseVersion

enum (SqlDatabaseVersion)

必需。要升级到的目标数据库版本。

preCheckResponse[]

object (PreCheckResponse)

仅限输出。预检操作的响应。

kind

string

可选。始终为 sql#preCheckMajorVersionUpgradeContext。

PreCheckResponse

JSON 表示法

{
  "actionsRequired": [
    string
  ],

  // Union field _message can be only one of the following:
  "message": string
  // End of list of possible types for union field _message.

  // Union field _message_type can be only one of the following:
  "messageType": enum (MessageType)
  // End of list of possible types for union field _message_type.
}

字段

actionsRequired[]

string

用户需要采取的操作。使用 repeated 属性表示多个操作。

联合字段 _message。

_message 只能是下列其中一项：

message

string

要向用户显示的消息。

联合字段 _message_type。

_message_type 只能是下列其中一项：

messageType

enum (MessageType)

消息类型，是信息、警告还是错误。

AcquireSsrsLeaseContext

JSON 表示法

{

  // Union field _setup_login can be only one of the following:
  "setupLogin": string
  // End of list of possible types for union field _setup_login.

  // Union field _service_login can be only one of the following:
  "serviceLogin": string
  // End of list of possible types for union field _service_login.

  // Union field _report_database can be only one of the following:
  "reportDatabase": string
  // End of list of possible types for union field _report_database.

  // Union field _duration can be only one of the following:
  "duration": string
  // End of list of possible types for union field _duration.
}

字段

联合字段 _setup_login。

_setup_login 只能是下列其中一项：

setupLogin

string

用作设置登录名以连接到数据库服务器进行 SSRS 设置的用户名。

联合字段 _service_login。

_service_login 只能是下列其中一项：

serviceLogin

string

在 SSRS 设置期间用作服务登录名以连接到报告数据库的用户名。

联合字段 _report_database。

_report_database 只能是下列其中一项：

reportDatabase

string

用于 SSRS 设置的报告数据库。

联合字段 _duration。

_duration 只能是下列其中一项：

duration

string (Duration format)

设置 SSRS 所需的租约时长。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。

时长

JSON 表示法
{ "seconds": string, "nanos": integer }

字段

seconds

string (int64 format)

时间段的带符号秒数。必须介于 -315,576,000,000 到 +315,576,000,000 之间（含边界值）。注意：这些界限是通过以下计算得出的：60 秒/分钟 * 60 分钟/小时 * 24 小时/天 * 365.25 天/年 * 10000 年

nanos

integer

时间跨度的有符号秒数小数部分（以纳秒为单位）。小于 1 秒的时长用 0 seconds 字段和正或负 nanos 字段表示。对于时长为 1 秒或更长时间的情况，nanos 字段的非零值必须与 seconds 字段的符号相同。必须介于 -999,999,999 到 +999,999,999 之间（含边界值）。

SqlSubOperationType

JSON 表示法
{ // Union field `sub_operation_details` can be only one of the following: "maintenanceType": enum (`SqlMaintenanceType`) // End of list of possible types for union field `sub_operation_details`. }

字段

联合字段 sub_operation_details。与操作类型对应的子操作详细信息。sub_operation_details 只能是下列其中一项：

maintenanceType

enum (SqlMaintenanceType)

要对实例执行的维护类型。

工具注释

破坏性提示：❌ | 等幂性提示：❌ | 只读提示：❌ | 开放世界提示：❌

MCP Tools Reference: cloud-sql 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

工具：clone_instance

输入架构

SqlInstancesCloneRequest

InstancesCloneRequest

CloneContext

BinLogCoordinates

时间戳

输出架构

操作

时间戳

OperationErrors

OperationError

ApiWarning

ImportContext

SqlCsvImportOptions

SqlBakImportOptions

EncryptionOptions

BoolValue

SqlImportOptions

Int32Value

PostgresImportOptions

SqlTdeImportOptions

ExportContext

SqlExportOptions

MysqlExportOptions

PostgresExportOptions

SqlCsvExportOptions

SqlBakExportOptions

SqlTdeExportOptions

BackupContext

PreCheckMajorVersionUpgradeContext

PreCheckResponse

AcquireSsrsLeaseContext

时长

SqlSubOperationType

工具注释

MCP Tools Reference: cloud-sql

工具：`clone_instance`