MCP Tools Reference: redis.googleapis.com

工具:list_backup_collections

列出所有 Memorystore for Redis Cluster 備份集合。

以下範例示範如何使用 curl 叫用 list_backup_collections 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": "list_backup_collections",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'
                

輸入內容的結構定義

請求 ListBackupCollections

ListBackupCollectionsRequest

JSON 表示法
{
  "parent": string,
  "pageSize": integer,
  "pageToken": string
}
欄位
parent

string

這是必要旗標,backupCollection 位置的資源名稱,格式為 projects/{project_id}/locations/{location_id},其中 location_id 是指 Google Cloud 區域。

pageSize

integer

選用。傳回的項目數量上限。

如未指定,服務會使用預設值 1000。無論 page_size 值為何,回應都可能包含部分清單,呼叫端應只依據回應的 next_page_token 判斷是否還有更多叢集待查詢。

pageToken

string

選用。先前的 [ListBackupCollections] 要求傳回的 next_page_token 值 (如有)。

輸出內容的結構定義

ListBackupCollections 的回應。

ListBackupCollectionsResponse

JSON 表示法
{
  "backupCollections": [
    {
      object (BackupCollection)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
欄位
backupCollections[]

object (BackupCollection)

專案中的 backupCollections 清單。

如果要求父項欄位中的 location_id 為「-」,系統會查詢專案可用的所有區域,並彙整結果。如果這類匯總查詢無法提供位置資訊,回應中就會包含預留位置的備份集合項目,且 name 欄位會設為 projects/{project_id}/locations/{location_id}/backupCollections/- 形式的值,status 欄位會設為 ERROR,status_message 欄位則會設為「location not available for ListBackupCollections」。

nextPageToken

string

用來擷取下一頁結果的符記;如果清單中沒有其他結果,這個欄位會留空。

unreachable[]

string

無法連線的位置。

BackupCollection

JSON 表示法
{
  "name": string,
  "clusterUid": string,
  "cluster": string,
  "kmsKey": string,
  "uid": string,
  "createTime": string,
  "totalBackupSizeBytes": string,
  "totalBackupCount": string,
  "lastBackupTime": string
}
欄位
name

string

ID。備份集合的完整資源路徑。

clusterUid

string

僅供輸出。備份集合的叢集 UID。

cluster

string

僅供輸出。備份集合所屬叢集的完整資源路徑。範例:projects/{project}/locations/{location}/clusters/{cluster}

kmsKey

string

僅供輸出。用於加密這個備份集合中備份的 KMS 金鑰。

uid

string

僅供輸出。系統指派的備份集合專屬 ID。

createTime

string (Timestamp format)

僅供輸出。備份集合的建立時間。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

totalBackupSizeBytes

string (int64 format)

僅供輸出。備份集合中所有備份的大小總計。

totalBackupCount

string (int64 format)

僅供輸出。備份集合中的備份總數。

lastBackupTime

string (Timestamp format)

僅供輸出。備份集合上次建立備份的時間。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

時間戳記

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

string (int64 format)

代表自 Unix 紀元 1970-01-01T00:00:00Z 起算的世界標準時間秒數。必須介於 -62135596800 和 253402300799 之間 (含),對應至 0001-01-01T00:00:00Z 至 9999-12-31T23:59:59Z。

nanos

integer

以奈秒為單位的非負秒數小數。這個欄位是時間長度的奈秒部分,並非秒數的替代值。如果秒數值為負數,且包含小數,奈秒值仍須為非負數,且會向前計時。必須介於 0 至 999,999,999 之間 (含)。

工具註解

破壞性提示:❌ | 等冪提示:✅ | 唯讀提示:✅ | 開放世界提示:❌