# REST Resource: projects.locations.clusters

- [Resource: Cluster](https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#Cluster)
  - [JSON representation](https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#Cluster.SCHEMA_REPRESENTATION)
- [Fleet](https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#Fleet)
  - [JSON representation](https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#Fleet.SCHEMA_REPRESENTATION)
- [ClusterNetworking](https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#ClusterNetworking)
  - [JSON representation](https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#ClusterNetworking.SCHEMA_REPRESENTATION)
- [Authorization](https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#Authorization)
  - [JSON representation](https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#Authorization.SCHEMA_REPRESENTATION)
- [ClusterUser](https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#ClusterUser)
  - [JSON representation](https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#ClusterUser.SCHEMA_REPRESENTATION)
- [MaintenancePolicy](https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#MaintenancePolicy)
  - [JSON representation](https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#MaintenancePolicy.SCHEMA_REPRESENTATION)
- [MaintenanceWindow](https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#MaintenanceWindow)
  - [JSON representation](https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#MaintenanceWindow.SCHEMA_REPRESENTATION)
- [RecurringTimeWindow](https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#RecurringTimeWindow)
  - [JSON representation](https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#RecurringTimeWindow.SCHEMA_REPRESENTATION)
- [TimeWindow](https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#TimeWindow)
  - [JSON representation](https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#TimeWindow.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#METHODS_SUMMARY)

## Resource: Cluster

A Google Distributed Cloud Edge Kubernetes cluster.

| JSON representation |
|---|
| ``` { "name": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "fleet": { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#Fleet`) }, "networking": { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#ClusterNetworking`) }, "authorization": { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#Authorization`) }, "defaultMaxPodsPerNode": integer, "endpoint": string, "clusterCaCertificate": string, "maintenancePolicy": { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#MaintenancePolicy`) }, "controlPlaneVersion": string, "nodeVersion": string } ``` |

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the cluster. |
| `createTime` | ``string (`https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp` format)`` Output only. The time when the cluster was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`. |
| `updateTime` | ``string (`https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp` format)`` Output only. The time when the cluster was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`. |
| `labels` | `map (key: string, value: string)` Labels associated with this resource. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. |
| `fleet` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#Fleet`)`` Optional. Fleet configuration. |
| `networking` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#ClusterNetworking`)`` Required. Cluster-wide networking configuration. |
| `authorization` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#Authorization`)`` Required. Immutable. RBAC policy that will be applied and managed by GEC. |
| `defaultMaxPodsPerNode` | `integer` Optional. The default maximum number of pods per node used if a maximum value is not specified explicitly for a node pool in this cluster. If unspecified, the Kubernetes default value will be used. |
| `endpoint` | `string` Output only. The IP address of the Kubernetes API server. |
| `clusterCaCertificate` | `string` Output only. The PEM-encoded public certificate of the cluster's CA. |
| `maintenancePolicy` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#MaintenancePolicy`)`` Optional. Cluster-wide maintenance policy configuration. |
| `controlPlaneVersion` | `string` Output only. The control plane release version |
| `nodeVersion` | `string` Output only. The lowest release version among all worker nodes. This field can be empty if the cluster does not have any worker nodes. |

## Fleet

Fleet related configuration.

Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems.

| JSON representation |
|---|
| ``` { "project": string, "membership": string } ``` |

| Fields ||
|---|---|
| `project` | `string` Required. The name of the Fleet host project where this cluster will be registered. Project names are formatted as `projects/<project-number>`. |
| `membership` | `string` Output only. The name of the managed Hub Membership resource associated to this cluster. Membership names are formatted as `projects/<project-number>/locations/global/membership/<cluster-id>`. |

## ClusterNetworking

Cluster-wide networking configuration.

| JSON representation |
|---|
| ``` { "clusterIpv4CidrBlocks": [ string ], "servicesIpv4CidrBlocks": [ string ] } ``` |

| Fields ||
|---|---|
| `clusterIpv4CidrBlocks[]` | `string` Required. All pods in the cluster are assigned an RFC1918 IPv4 address from these blocks. Only a single block is supported. This field cannot be changed after creation. |
| `servicesIpv4CidrBlocks[]` | `string` Required. All services in the cluster are assigned an RFC1918 IPv4 address from these blocks. Only a single block is supported. This field cannot be changed after creation. |

## Authorization

RBAC policy that will be applied and managed by GEC.

| JSON representation |
|---|
| ``` { "adminUsers": { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#ClusterUser`) } } ``` |

| Fields ||
|---|---|
| `adminUsers` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#ClusterUser`)`` Required. User that will be granted the cluster-admin role on the cluster, providing full access to the cluster. Currently, this is a singular field, but will be expanded to allow multiple admins in the future. |

## ClusterUser

A user principal for an RBAC policy.

| JSON representation |
|---|
| ``` { "username": string } ``` |

| Fields ||
|---|---|
| `username` | `string` Required. An active Google username. |

## MaintenancePolicy

Maintenance policy configuration.

| JSON representation |
|---|
| ``` { "window": { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#MaintenanceWindow`) } } ``` |

| Fields ||
|---|---|
| `window` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#MaintenanceWindow`)`` Specifies the maintenance window in which maintenance may be performed. |

## MaintenanceWindow

Maintenance window configuration

| JSON representation |
|---|
| ``` { "recurringWindow": { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#RecurringTimeWindow`) } } ``` |

| Fields ||
|---|---|
| `recurringWindow` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#RecurringTimeWindow`)`` Configuration of a recurring maintenance window. |

## RecurringTimeWindow

Represents an arbitrary window of time that recurs.

| JSON representation |
|---|
| ``` { "window": { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#TimeWindow`) }, "recurrence": string } ``` |

| Fields ||
|---|---|
| `window` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters#TimeWindow`)`` The window of the first recurrence. |
| `recurrence` | `string` An RRULE (<https://tools.ietf.org/html/rfc5545#section-3.8.5.3>) for how this window recurs. They go on for the span of time between the start and end time. |

## TimeWindow

Represents an arbitrary window of time.

| JSON representation |
|---|
| ``` { "startTime": string, "endTime": string } ``` |

| Fields ||
|---|---|
| `startTime` | ``string (`https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp` format)`` The time that the window first starts. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`. |
| `endTime` | ``string (`https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp` format)`` The time that the window ends. The end time must take place after the start time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters/create` | Creates a new Cluster in a given project and location. |
| ### `https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters/delete` | Deletes a single Cluster. |
| ### `https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters/generateAccessToken` | Generates an access token for a Cluster. |
| ### `https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters/get` | Gets details of a single Cluster. |
| ### `https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters/list` | Lists Clusters in a given project and location. |
| ### `https://docs.cloud.google.com/distributed-cloud/connected/1.5.1/docs/reference/container/rest/v1/projects.locations.clusters/patch` | Updates the parameters of a single Cluster. |