Method: projects.locations.backupCollections.list

列出使用方项目在指定位置(区域)或所有位置拥有的所有备份集合。

如果将 locationId 指定为 -(通配符),则会查询项目可用的所有区域,并汇总结果。

HTTP 请求

GET https://memorystore.googleapis.com/v1beta/{parent=projects/*/locations/*}/backupCollections

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。backupCollection 位置的资源名称,格式为 projects/{projectId}/locations/{locationId},其中 locationId 表示 Google Cloud 区域。

查询参数

参数
pageSize

integer

可选。需要返回的最大项数。

如果未指定,则服务将使用默认值 1000。无论 pageSize 值如何,响应都可能包含部分列表,调用方应该只依赖于响应的 nextPageToken 确定是否还有更多集群需要查询。

pageToken

string

可选。从上一个 [backupCollections.list] 请求返回的 nextPageToken 值(如果有)。

请求正文

请求正文必须为空。

响应正文

对 [backupCollections.list] 的响应。

如果成功,响应正文将包含结构如下的数据:

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

object (BackupCollection)

项目中的 backupCollection 列表。

如果请求的父字段中的 locationId 为“-”,则查询项目可用的所有区域,并汇总结果。如果在这种汇总查询中某个位置不可用,响应中会包含一个占位符 backupCollection 条目,其中 name 字段设置为 projects/{projectId}/locations/{locationId}/backupCollections/- 格式的值,status 字段设置为 ERROR,statusMessage 字段设置为“location not available for backupCollections.list”。

nextPageToken

string

用于检索下一页结果的令牌。如果列表中没有更多结果,则为空。

unreachable[]

string

无法到达的位置。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

IAM 权限

需要拥有 parent 资源的以下 IAM 权限:

  • memorystore.backupCollections.list

如需了解详情,请参阅 IAM 文档