Method: projects.locations.instances.list

列出给定项目和位置中的实例。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。要列出实例所在的父级。格式:projects/{project}/locations/{location}

查询参数

参数
pageSize

integer

可选。请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器将选择合适的默认值。

pageToken

string

可选。标识服务器应返回的结果页面的令牌。

filter

string

可选。用于过滤结果的表达式。

orderBy

string

可选。按定义的顺序对结果进行排序。支持的值:“name”“createTime”。

请求正文

请求正文必须为空。

响应正文

[instances.list][] 的响应消息。

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

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

object (Instance)

如果请求的 {location} 为“-”,则响应将包含所有位置的实例列表。系统会忽略无法访问的位置中的实例。

nextPageToken

string

可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

unreachable[]

string

无法到达的位置。

授权范围

需要以下 OAuth 范围:

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

IAM 权限

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

  • memorystore.instances.list

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