Method: projects.locations.privateClouds.clusters.list

列出给定私有云中的 Cluster 资源。

HTTP 请求

GET https://vmwareengine.googleapis.com/v1/{parent=projects/*/locations/*/privateClouds/*}/clusters

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。要查询集群的私有云的资源名称。资源名称是无方案 URI,遵循 https://cloud.google.com/apis/design/resource_names 中的惯例。例如 projects/my-project/locations/us-central1-a/privateClouds/my-cloud

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权:

  • vmwareengine.clusters.list

查询参数

参数
pageSize

integer

一页中返回的聚类数量上限。服务返回的值可能小于此值。最大值会被强制转换为 1,000。此字段的默认值为 500。

pageToken

string

从之前的 clusters.list 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 clusters.list 的所有其他参数必须与提供页面令牌的调用匹配。

filter

string

如需按多个表达式进行过滤,请在英文圆括号内分别提供每个表达式。例如:

(name = "example-cluster")
(nodeCount = "3")

默认情况下,每个表达式都是一个 AND 表达式。不过,您可以明确包含 ANDOR 表达式。例如:

(name = "example-cluster-1") AND
(createTime > "2021-04-12T08:15:10.40Z") OR
(name = "example-cluster-2")
orderBy

string

按特定顺序对列表结果进行排序。默认情况下,返回的结果按 name 升序排列。您还可以使用 orderBy="name desc" 根据 name 值按降序对结果进行排序。目前,仅支持按 name 排序。

请求正文

请求正文必须为空。

响应正文

VmwareEngine.ListClusters 的响应消息

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

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

object (Cluster)

私有云集群的列表。

nextPageToken

string

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

unreachable[]

string

使用通配符进行汇总查询时无法到达的位置。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅 Authentication Overview