MCP Tools Reference: redis.googleapis.com

工具：backup_cluster

备份 Memorystore for Redis Cluster 中的集群。

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

Curl 请求 
                  
curl --location 'https://redis.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "backup_cluster",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

输入架构

对 BackupCluster 的请求。

BackupClusterRequest

JSON 表示法 
{
  "name": string,
  "ttl": string,

  // Union field _backup_id can be only one of the following:
  "backupId": string
  // End of list of possible types for union field _backup_id.
}
字段
name

string

必需。Redis 集群资源名称，格式为 projects/{project_id}/locations/{location_id}/clusters/{cluster_id}，其中 location_id 表示 Google Cloud 区域。
ttl

string (Duration format)

可选。备份的 TTL 过期时间。值范围为 1 天到 100 年。如果未指定，则默认值为 100 年。

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

联合字段 _backup_id。

_backup_id 只能是下列其中一项：
backupId

string

可选。要创建的备份的 ID。如果未指定，则使用默认值 ([YYYYMMDDHHMMSS]_[缩短的集群 UID])。

时长

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 之间（含边界值）。

输出架构

此资源表示由网络 API 调用引发的长时间运行的操作。

操作

JSON 表示法 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
字段
name

string

由服务器分配的名称，该名称仅在最初返回它的那项服务中是唯一的。如果您使用默认 HTTP 映射，则 name 应是以 operations/{unique_id} 结尾的资源名称。
metadata

object

{

createTime：操作的创建时间。

endTime：操作完成运行的时间。

target：由服务器定义的操作目标的资源路径。

verb：操作执行的谓词的名称。

statusDetail：人类可读的操作状态（如果有）。

cancelRequested：标识用户是否已请求取消操作。已成功取消的操作具有 Operation.error 值，且 google.rpc.Status.code 为 1（对应于 Code.CANCELLED）。

apiVersion：用于启动操作的 API 版本。

}

此对象可以包含任意类型的字段。附加字段 "@type" 包含用于标示相应类型的 URI。示例：{ "id": 1234, "@type": "types.example.com/standard/id" }。
done

boolean

如果值为 false，则表示操作仍在进行中。如果为 true，则表示操作已完成，其结果不是 error 就是 response。
联合字段 result。操作结果，可以是 error，也可以是有效的 response。如果 done == false，则既不会设置 error，也不会设置 response。如果 done == true，则只能设置 error 或 response 中的一项。部分服务可能不会提供结果。result 只能是下列其中一项：
error

object (Status)

操作失败或被取消时表示有错误发生的结果。
response

object

操作的常规成功响应。如果原始方法在成功时不返回任何数据（如 Delete），则响应为 google.protobuf.Empty。如果原始方法为标准 Get/Create/Update 方法，则响应应该为资源。对于其他方法，响应类型应为 XxxResponse，其中 Xxx 是原始方法的名称。例如，如果原始方法名称为 TakeSnapshot()，则推断的响应类型为 TakeSnapshotResponse。

此对象可以包含任意类型的字段。附加字段 "@type" 包含用于标示相应类型的 URI。示例：{ "id": 1234, "@type": "types.example.com/standard/id" }。

不限

JSON 表示法 
{
  "typeUrl": string,
  "value": string
}
字段
typeUrl

string

通过 URI 引用（包含以斜杠结尾的前缀和完全限定的类型名称）来标识序列化 Protobuf 消息的类型。

示例：type.googleapis.com/google.protobuf.StringValue

此字符串必须包含至少一个 / 字符，并且最后一个 / 之后的内容必须是规范形式的完全限定名，不含前导点。请勿在这些 URI 引用中写入方案，以免客户端尝试联系它们。

前缀是任意的，Protobuf 实现应仅剥离最后一个 / 之前（包括最后一个 /）的所有内容，以标识类型。type.googleapis.com/ 是某些旧版实现所需的常见默认前缀。此前缀并不表示类型的来源，包含该前缀的 URI 不应响应任何请求。

所有类型网址字符串都必须是合法的 URI 引用，并且（对于文本格式）还必须满足以下额外限制：引用的内容只能包含字母数字字符、百分号编码的转义字符以及以下集合中的字符（不包括外侧的反引号）：/-.~_!$&()*+,;=。尽管我们允许使用百分比编码，但实现不应将其转义，以免与现有解析器混淆。例如，应拒绝 type.googleapis.com%2FFoo。

在 Any 的原始设计中，曾考虑过在这些类型网址上启动类型解析服务的可能性，但 Protobuf 从未实现过此类服务，并且认为联系这些网址存在问题，可能会导致安全问题。不尝试联系人类型网址。
value

string (bytes format)

包含由 type_url 描述的类型的 Protobuf 序列化。

使用 base64 编码的字符串。

状态

JSON 表示法 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
字段
code

integer

状态代码，应为 google.rpc.Code 的枚举值。
message

string

面向开发者的错误消息（应采用英语）。任何向用户显示的错误消息都应进行本地化并通过 google.rpc.Status.details 字段发送，或者由客户端进行本地化。
details[]

object

包含错误详细信息的消息列表。有一组通用的消息类型可供 API 使用。

可以包含任意类型字段的对象。附加字段 "@type" 包含用于标示相应类型的 URI。示例：{ "id": 1234, "@type": "types.example.com/standard/id" }。

工具注释

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