Method: projects.zones.clusters.monitoring

Sets the monitoring service for a specific cluster.

HTTP request

POST https://container.googleapis.com/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
projectId
(deprecated)

string

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone
(deprecated)

string

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId
(deprecated)

string

Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Request body

The request body contains data with the following structure:

JSON representation
{
  "monitoringService": string,
  "name": string
}
Fields
monitoringService

string

Required. The monitoring service the cluster should use to write metrics. Currently available options:

  • monitoring.googleapis.com/kubernetes - The Cloud Monitoring service with a Kubernetes-native resource model
  • monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15).
  • none - No metrics will be exported from the cluster.

If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.

name

string

The name (project, location, cluster) of the cluster to set monitoring. Specified in the format projects/*/locations/*/clusters/*.

Authorization requires the following IAM permission on the specified resource name:

  • container.clusters.update

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.