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

必須。バックアップ コレクションのロケーションのリソース名。形式は 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 のリスト。

リクエストの parent フィールドの location_id が「-」の場合、プロジェクトで使用可能なすべてのリージョンがクエリ対象となり、結果が集計されます。このような集計クエリでロケーションが使用できない場合、プレースホルダの backupCollection エントリがレスポンスに含まれます。このエントリの 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

出力専用。システムによって割り当てられたバックアップ コレクションの一意の識別子。

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 からの UTC 時刻の秒数を表します。-62135596800~253402300799 の範囲(両端を含む)にする必要があります(これは 0001-01-01T00:00:00Z~9999-12-31T23:59:59Z に対応します)。

nanos

integer

ナノ秒分解能による、秒の負ではない小数以下部分。このフィールドは、秒の代替ではなく、期間のナノ秒部分です。小数以下を含む負の秒の値は、時間を前方にカウントする負ではない nanos 値を持つ必要があります。0 ~ 999,999,999 にする必要があります(両端を含む)。

ツールのアノテーション

破壊的ヒント: ❌ | べき等ヒント: ✅ | 読み取り専用ヒント: ✅ | オープン ワールド ヒント: ❌