方法:projects.locations.instances.list

列出项目在指定位置(区域)或所有位置拥有的所有 Redis 实例。

位置应采用以下格式:* projects/{projectId}/locations/{locationId}

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

HTTP 请求

GET https://redis.googleapis.com/v1/{parent=projects/*/locations/*}/instances

网址使用 gRPC 转码语法。

路径参数

参数
parent

string

必需。实例位置的资源名称,采用以下形式:projects/{projectId}/locations/{locationId},其中 locationId 指的是 GCP 区域

查询参数

参数
pageSize

number

要返回的最大项目数。

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

pageToken

string

从上一个 List 请求返回的 nextPageToken 值(如果有)。

请求正文

请求正文必须为空。

响应正文

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

instances.list 的响应。

JSON 表示法

{
  "instances": [
    {
      object(Instance)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
字段
instances[]

object(Instance)

项目中指定位置或所有位置的 Redis 实例列表。

如果请求的父字段中的 locationId 为“-”,则查询项目可用的所有区域,并汇总结果。如果在这样的聚合查询中,位置不可用,则响应中包含虚拟 Redis 条目,其中“name”字段设置为具有 projects/{projectId}/locations/{locationId}/instances/- 形式的值,“status”字段设置为 ERROR,并且“statusMessage”字段设置为“location for available for instances.list”。

nextPageToken

string

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

unreachable[]

string

无法到达的位置。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅身份验证概览