Method: projects.locations.clusters.setResourceLabels

Sets labels on a cluster.

HTTP request

POST https://container.googleapis.com/v1beta1/{name=projects/*/locations/*/clusters/*}:setResourceLabels

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

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

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

  • container.clusters.update

Request body

The request body contains data with the following structure:

JSON representation 
{
  "projectId": string,
  "zone": string,
  "clusterId": string,
  "resourceLabels": {
    string: string,
    ...
  },
  "labelFingerprint": string
}
Fields
projectId
(deprecated)

string

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

string

Required. 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

Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
resourceLabels

map (key: string, value: string)

Required. The labels to set for that cluster.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
labelFingerprint

string

Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.

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.