GCP Kubernetes Engine (version v2.*.*)

cancel_operation_for_cluster

Cancels the specified operation.

Parameters

locationsId (required)

Type: string

operationsId (required)

Type: string

projectsId (required)

Type: string

$body

CancelOperationRequest cancels a single operation.

Type: object

{
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.\nThis field has been deprecated and replaced by the name field.",
"name" : "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
"operationId" : "Required. Deprecated. The server-assigned `name` of the operation.\nThis field has been deprecated and replaced by the name field.",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

complete_ip_rotation

Completes master IP rotation.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

projectsId (required)

Type: string

$body

CompleteIPRotationRequest moves the cluster master back into single-IP mode.

Type: object

{
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.",
"name" : "The name (project, location, cluster id) of the cluster to complete IP\nrotation. Specified in the format 'projects/*/locations/*/clusters/*'.",
"clusterId" : "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the name field.",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the name field."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

create_cluster

Creates a cluster, consisting of the specified number and type of Google
Compute Engine instances.

By default, the cluster is created in the project's
default network.

One firewall is added for the cluster. After cluster creation,
the Kubelet creates routes for each node to allow the containers
on that node to communicate with all other instances in the
cluster.

Finally, an entry is added to the project's global metadata indicating
which CIDR range the cluster is using.

Parameters

locationsId (required)

Type: string

projectsId (required)

Type: string

$body

CreateClusterRequest creates a cluster.

Type: object

{
"parent" : "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.",
"cluster" : {
"addonsConfig" : {
"kubernetesDashboard" : {
"disabled" : "Whether the Kubernetes Dashboard is enabled for this cluster."
},
"httpLoadBalancing" : {
"disabled" : "Whether the HTTP Load Balancing controller is enabled in the cluster.\nWhen enabled, it runs a small pod in the cluster that manages the load\nbalancers."
},
"cloudRunConfig" : {
"disabled" : "Whether Cloud Run addon is enabled for this cluster."
},
"networkPolicyConfig" : {
"disabled" : "Whether NetworkPolicy is enabled for this cluster."
},
"horizontalPodAutoscaling" : {
"disabled" : "Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.\nWhen enabled, it ensures that metrics are collected into Stackdriver\nMonitoring."
}
},
"resourceUsageExportConfig" : {
"consumptionMeteringConfig" : {
"enabled" : "Whether to enable consumption metering for this cluster. If enabled, a\nsecond BigQuery table will be created to hold resource consumption\nrecords."
},
"bigqueryDestination" : {
"datasetId" : "The ID of a BigQuery Dataset."
},
"enableNetworkEgressMetering" : "Whether to enable network egress metering for this cluster. If enabled, a\ndaemonset will be created in the cluster to meter network egress traffic."
},
"masterAuthorizedNetworksConfig" : {
"cidrBlocks" : [ {
"displayName" : "display_name is an optional field for users to identify CIDR blocks.",
"cidrBlock" : "cidr_block must be specified in CIDR notation."
} ],
"enabled" : "Whether or not master authorized networks is enabled."
},
"databaseEncryption" : {
"keyName" : "Name of CloudKMS key to use for the encryption of secrets in etcd.\nEx. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key",
"state" : "Denotes the state of etcd encryption."
},
"currentMasterVersion" : "[Output only] The current software version of the master endpoint.",
"zone" : "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use location instead.",
"enableKubernetesAlpha" : "Kubernetes alpha features are enabled on this cluster. This includes alpha\nAPI groups (e.g. v1alpha1) and features that may not be production ready in\nthe kubernetes version of the master and nodes.\nThe cluster has no SLA for uptime and master/node upgrades are disabled.\nAlpha enabled clusters are automatically deleted thirty days after\ncreation.",
"nodePools" : [ {
"podIpv4CidrSize" : "[Output only] The pod CIDR block size per node in this node pool.",
"maxPodsConstraint" : {
"maxPodsPerNode" : "Constraint enforced on the max num of pods per node."
},
"upgradeSettings" : {
"maxSurge" : "The maximum number of nodes that can be created beyond the current size\nof the node pool during the upgrade process.",
"maxUnavailable" : "The maximum number of nodes that can be simultaneously unavailable during\nthe upgrade process. A node is considered available if its status is\nReady."
},
"version" : "The version of the Kubernetes of this node.",
"statusMessage" : "[Output only] Additional information about the current status of this\nnode pool instance, if available.",
"selfLink" : "[Output only] Server-defined URL for the resource.",
"initialNodeCount" : "The initial node count for the pool. You must ensure that your\nCompute Engine resource quota\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.",
"instanceGroupUrls" : [ "string" ],
"management" : {
"autoUpgrade" : "A flag that specifies whether node auto-upgrade is enabled for the node\npool. If enabled, node auto-upgrade helps keep the nodes in your node pool\nup to date with the latest release version of Kubernetes.",
"upgradeOptions" : {
"description" : "[Output only] This field is set when upgrades are about to commence\nwith the description of the upgrade.",
"autoUpgradeStartTime" : "[Output only] This field is set when upgrades are about to commence\nwith the approximate start time for the upgrades, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format."
},
"autoRepair" : "A flag that specifies whether the node auto-repair is enabled for the node\npool. If enabled, the nodes in this node pool will be monitored and, if\nthey fail health checks too many times, an automatic repair action will be\ntriggered."
},
"name" : "The name of the node pool.",
"locations" : [ "string" ],
"autoscaling" : {
"minNodeCount" : "Minimum number of nodes in the NodePool. Must be >= 1 and <=\nmax_node_count.",
"autoprovisioned" : "Can this node pool be deleted automatically.",
"maxNodeCount" : "Maximum number of nodes in the NodePool. Must be >= min_node_count. There\nhas to enough quota to scale up the cluster.",
"enabled" : "Is autoscaling enabled for this node pool."
},
"conditions" : [ {
"code" : "Machine-friendly representation of the condition",
"message" : "Human-friendly representation of the condition"
} ],
"config" : {
"metadata" : "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the reserved keys:\n \"cluster-location\"\n \"cluster-name\"\n \"cluster-uid\"\n \"configure-sh\"\n \"containerd-configure-sh\"\n \"enable-os-login\"\n \"gci-ensure-gke-docker\"\n \"gci-metrics-enabled\"\n \"gci-update-strategy\"\n \"instance-template\"\n \"kube-env\"\n \"startup-script\"\n \"user-data\"\n \"disable-address-manager\"\n \"windows-startup-script-ps1\"\n \"common-psm1\"\n \"k8s-node-setup-psm1\"\n \"install-ssh-psm1\"\n \"user-profile-psm1\"\n \"serial-port-logging-enable\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.",
"shieldedInstanceConfig" : {
"enableSecureBoot" : "Defines whether the instance has Secure Boot enabled.\n\nSecure Boot helps ensure that the system only runs authentic software by\nverifying the digital signature of all boot components, and halting the\nboot process if signature verification fails.",
"enableIntegrityMonitoring" : "Defines whether the instance has integrity monitoring enabled.\n\nEnables monitoring and attestation of the boot integrity of the instance.\nThe attestation is performed against the integrity policy baseline. This\nbaseline is initially derived from the implicitly trusted boot image when\nthe instance is created."
},
"reservationAffinity" : {
"consumeReservationType" : "Corresponds to the type of reservation consumption.",
"values" : [ "string" ],
"key" : "Corresponds to the label key of reservation resource."
},
"serviceAccount" : "The Google Cloud Platform Service Account to be used by the node VMs.\nSpecify the email address of the Service Account; otherwise, if no Service\nAccount is specified, the \"default\" service account is used.",
"oauthScopes" : [ "string" ],
"taints" : [ {
"effect" : "Effect for taint.",
"value" : "Value for taint.",
"key" : "Key for taint."
} ],
"sandboxConfig" : {
"type" : "Type of the sandbox to use for the node."
},
"tags" : [ "string" ],
"labels" : "The map of Kubernetes labels (key/value pairs) to be applied to each node.\nThese will added in addition to any default label(s) that\nKubernetes may apply to the node.\nIn case of conflict in label keys, the applied set may differ depending on\nthe Kubernetes version -- it's best to assume the behavior is undefined\nand conflicts should be avoided.\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/",
"preemptible" : "Whether the nodes are created as preemptible VM instances. See:\nhttps://cloud.google.com/compute/docs/instances/preemptible for more\ninformation about preemptible VM instances.",
"minCpuPlatform" : "Minimum CPU platform to be used by this instance. The instance may be\nscheduled on the specified or newer CPU platform. Applicable values are the\nfriendly names of CPU platforms, such as\nminCpuPlatform: \"Intel Haswell\" or\nminCpuPlatform: \"Intel Sandy Bridge\". For more\ninformation, read [how to specify min CPU\nplatform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)",
"accelerators" : [ {
"acceleratorType" : "The accelerator type resource name. List of supported accelerators\n[here](/compute/docs/gpus)",
"acceleratorCount" : "The number of the accelerator cards exposed to an instance."
} ],
"diskType" : "Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')\n\nIf unspecified, the default disk type is 'pd-standard'",
"imageType" : "The image type to use for this node. Note that for a given image type,\nthe latest version of it will be used.",
"machineType" : "The name of a Google Compute Engine [machine\ntype](/compute/docs/machine-types) (e.g.\n`n1-standard-1`).\n\nIf unspecified, the default machine type is\n`n1-standard-1`.",
"localSsdCount" : "The number of local SSD disks to be attached to the node.\n\nThe limit for this value is dependent upon the maximum number of\ndisks available on a machine per zone. See:\nhttps://cloud.google.com/compute/docs/disks/local-ssd\nfor more information.",
"diskSizeGb" : "Size of the disk attached to each node, specified in GB.\nThe smallest allowed disk size is 10GB.\n\nIf unspecified, the default disk size is 100GB."
},
"status" : "[Output only] The status of the nodes in this pool instance."
} ],
"binaryAuthorization" : {
"enabled" : "Enable Binary Authorization for this cluster. If enabled, all container\nimages will be validated by Binary Authorization."
},
"networkPolicy" : {
"provider" : "The selected network policy provider.",
"enabled" : "Whether network policy is enabled on the cluster."
},
"currentNodeCount" : "[Output only] The number of nodes currently in the cluster. Deprecated.\nCall Kubernetes API directly to retrieve node information.",
"loggingService" : "The logging service the cluster should use to write logs.\nCurrently available options:\n\n* \"logging.googleapis.com/kubernetes\" - the Google Cloud Logging\nservice with Kubernetes-native resource model\n* `logging.googleapis.com` - the Google Cloud Logging service.\n* `none` - no logs will be exported from the cluster.\n* if left as an empty string,`logging.googleapis.com` will be used.",
"enableTpu" : "Enable the ability to use Cloud TPUs in this cluster.",
"maintenancePolicy" : {
"resourceVersion" : "A hash identifying the version of this policy, so that updates to fields of\nthe policy won't accidentally undo intermediate changes (and so that users\nof the API unaware of some fields won't accidentally remove other fields).\nMake a get() request to the cluster to get the current\nresource version and include it with requests to set the policy.",
"window" : {
"dailyMaintenanceWindow" : {
"duration" : "[Output only] Duration of the time window, automatically chosen to be\nsmallest possible in the given scenario.\nDuration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\nformat \"PTnHnMnS\".",
"startTime" : "Time within the maintenance window to start the maintenance operations.\nTime format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\nformat \"HH:MM\", where HH : [00-23] and MM : [00-59] GMT."
},
"recurringWindow" : {
"recurrence" : "An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how\nthis window reccurs. They go on for the span of time between the start and\nend time.\n\nFor example, to have something repeat every weekday, you'd use:\n FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\nTo repeat some window daily (equivalent to the DailyMaintenanceWindow):\n FREQ=DAILY\nFor the first weekend of every month:\n FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU\nThis specifies how frequently the window starts. Eg, if you wanted to have\na 9-5 UTC-4 window every weekday, you'd use something like:\n\n start time = 2019-01-01T09:00:00-0400\n end time = 2019-01-01T17:00:00-0400\n recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\n\nWindows can span multiple days. Eg, to make the window encompass every\nweekend from midnight Saturday till the last minute of Sunday UTC:\n\n start time = 2019-01-05T00:00:00Z\n end time = 2019-01-07T23:59:00Z\n recurrence = FREQ=WEEKLY;BYDAY=SA\n\nNote the start and end time's specific dates are largely arbitrary except\nto specify duration of the window and when it first starts.\nThe FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.",
"window" : {
"startTime" : "The time that the window first starts.",
"endTime" : "The time that the window ends. The end time should take place after the\nstart time."
}
},
"maintenanceExclusions" : "Exceptions to maintenance window. Non-emergency maintenance should not\noccur in these windows."
}
},
"instanceGroupUrls" : [ "string" ],
"expireTime" : "[Output only] The time the cluster will be automatically\ndeleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"subnetwork" : "The name of the Google Compute Engine\n[subnetwork](/compute/docs/subnetworks) to which the\ncluster is connected.",
"nodeIpv4CidrSize" : "[Output only] The size of the address space on each node for hosting\ncontainers. This is provisioned from within the `container_ipv4_cidr`\nrange. This field will only be set when cluster is in route-based network\nmode.",
"resourceLabels" : "The resource labels for the cluster to use to annotate any related\nGoogle Compute Engine resources.",
"name" : "The name of this cluster. The name must be unique within this project\nand location (e.g. zone or region), and can be up to 40 characters with\nthe following restrictions:\n\n* Lowercase letters, numbers, and hyphens only.\n* Must start with a letter.\n* Must end with a number or a letter.",
"authenticatorGroupsConfig" : {
"securityGroup" : "The name of the security group-of-groups to be used. Only relevant\nif enabled = true.",
"enabled" : "Whether this cluster should return group membership lookups\nduring authentication using a group of security groups."
},
"autoscaling" : {
"autoprovisioningLocations" : [ "string" ],
"resourceLimits" : [ {
"maximum" : "Maximum amount of the resource in the cluster.",
"minimum" : "Minimum amount of the resource in the cluster.",
"resourceType" : "Resource name \"cpu\", \"memory\" or gpu-specific string."
} ],
"autoprovisioningNodePoolDefaults" : {
"management" : {
"autoUpgrade" : "A flag that specifies whether node auto-upgrade is enabled for the node\npool. If enabled, node auto-upgrade helps keep the nodes in your node pool\nup to date with the latest release version of Kubernetes.",
"upgradeOptions" : {
"description" : "[Output only] This field is set when upgrades are about to commence\nwith the description of the upgrade.",
"autoUpgradeStartTime" : "[Output only] This field is set when upgrades are about to commence\nwith the approximate start time for the upgrades, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format."
},
"autoRepair" : "A flag that specifies whether the node auto-repair is enabled for the node\npool. If enabled, the nodes in this node pool will be monitored and, if\nthey fail health checks too many times, an automatic repair action will be\ntriggered."
},
"upgradeSettings" : {
"maxSurge" : "The maximum number of nodes that can be created beyond the current size\nof the node pool during the upgrade process.",
"maxUnavailable" : "The maximum number of nodes that can be simultaneously unavailable during\nthe upgrade process. A node is considered available if its status is\nReady."
},
"serviceAccount" : "The Google Cloud Platform Service Account to be used by the node VMs. If\nservice_account is specified, scopes should be empty.",
"oauthScopes" : [ "string" ]
},
"enableNodeAutoprovisioning" : "Enables automatic node pool creation and deletion."
},
"conditions" : [ {
"code" : "Machine-friendly representation of the condition",
"message" : "Human-friendly representation of the condition"
} ],
"status" : "[Output only] The current status of this cluster.",
"defaultMaxPodsConstraint" : {
"maxPodsPerNode" : "Constraint enforced on the max num of pods per node."
},
"verticalPodAutoscaling" : {
"enabled" : "Enables vertical pod autoscaling."
},
"masterAuth" : {
"clientCertificateConfig" : {
"issueClientCertificate" : "Issue a client certificate."
},
"clientCertificate" : "[Output only] Base64-encoded public certificate used by clients to\nauthenticate to the cluster endpoint.",
"password" : "The password to use for HTTP basic authentication to the master endpoint.\nBecause the master endpoint is open to the Internet, you should create a\nstrong password. If a password is provided for cluster creation, username\nmust be non-empty.",
"clientKey" : "[Output only] Base64-encoded private key used by clients to authenticate\nto the cluster endpoint.",
"clusterCaCertificate" : "[Output only] Base64-encoded public certificate that is the root of\ntrust for the cluster.",
"username" : "The username to use for HTTP basic authentication to the master endpoint.\nFor clusters v1.6.0 and later, basic authentication can be disabled by\nleaving username unspecified (or setting it to the empty string)."
},
"description" : "An optional description of this cluster.",
"labelFingerprint" : "The fingerprint of the set of labels for this cluster.",
"ipAllocationPolicy" : {
"clusterIpv4CidrBlock" : "The IP address range for the cluster pod IPs. If this field is set, then\n`cluster.cluster_ipv4_cidr` must be left blank.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
"createSubnetwork" : "Whether a new subnetwork will be created automatically for the cluster.\n\nThis field is only applicable when `use_ip_aliases` is true.",
"useIpAliases" : "Whether alias IPs will be used for pod IPs in the cluster.",
"tpuIpv4CidrBlock" : "The IP address range of the Cloud TPUs in this cluster. If unspecified, a\nrange will be automatically chosen with the default size.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nIf unspecified, the range will use the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
"clusterIpv4Cidr" : "This field is deprecated, use cluster_ipv4_cidr_block.",
"servicesIpv4CidrBlock" : "The IP address range of the services IPs in this cluster. If blank, a range\nwill be automatically chosen with the default size.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
"servicesIpv4Cidr" : "This field is deprecated, use services_ipv4_cidr_block.",
"clusterSecondaryRangeName" : "The name of the secondary range to be used for the cluster CIDR\nblock. The secondary range will be used for pod IP\naddresses. This must be an existing secondary range associated\nwith the cluster subnetwork.\n\nThis field is only applicable with use_ip_aliases is true and\ncreate_subnetwork is false.",
"servicesSecondaryRangeName" : "The name of the secondary range to be used as for the services\nCIDR block. The secondary range will be used for service\nClusterIPs. This must be an existing secondary range associated\nwith the cluster subnetwork.\n\nThis field is only applicable with use_ip_aliases is true and\ncreate_subnetwork is false.",
"nodeIpv4CidrBlock" : "The IP address range of the instance IPs in this cluster.\n\nThis is applicable only if `create_subnetwork` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
"nodeIpv4Cidr" : "This field is deprecated, use node_ipv4_cidr_block.",
"subnetworkName" : "A custom subnetwork name to be used if `create_subnetwork` is true. If\nthis field is empty, then an automatic name will be chosen for the new\nsubnetwork."
},
"nodeConfig" : {
"metadata" : "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the reserved keys:\n \"cluster-location\"\n \"cluster-name\"\n \"cluster-uid\"\n \"configure-sh\"\n \"containerd-configure-sh\"\n \"enable-os-login\"\n \"gci-ensure-gke-docker\"\n \"gci-metrics-enabled\"\n \"gci-update-strategy\"\n \"instance-template\"\n \"kube-env\"\n \"startup-script\"\n \"user-data\"\n \"disable-address-manager\"\n \"windows-startup-script-ps1\"\n \"common-psm1\"\n \"k8s-node-setup-psm1\"\n \"install-ssh-psm1\"\n \"user-profile-psm1\"\n \"serial-port-logging-enable\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.",
"shieldedInstanceConfig" : {
"enableSecureBoot" : "Defines whether the instance has Secure Boot enabled.\n\nSecure Boot helps ensure that the system only runs authentic software by\nverifying the digital signature of all boot components, and halting the\nboot process if signature verification fails.",
"enableIntegrityMonitoring" : "Defines whether the instance has integrity monitoring enabled.\n\nEnables monitoring and attestation of the boot integrity of the instance.\nThe attestation is performed against the integrity policy baseline. This\nbaseline is initially derived from the implicitly trusted boot image when\nthe instance is created."
},
"reservationAffinity" : {
"consumeReservationType" : "Corresponds to the type of reservation consumption.",
"values" : [ "string" ],
"key" : "Corresponds to the label key of reservation resource."
},
"serviceAccount" : "The Google Cloud Platform Service Account to be used by the node VMs.\nSpecify the email address of the Service Account; otherwise, if no Service\nAccount is specified, the \"default\" service account is used.",
"oauthScopes" : [ "string" ],
"taints" : [ {
"effect" : "Effect for taint.",
"value" : "Value for taint.",
"key" : "Key for taint."
} ],
"sandboxConfig" : {
"type" : "Type of the sandbox to use for the node."
},
"tags" : [ "string" ],
"labels" : "The map of Kubernetes labels (key/value pairs) to be applied to each node.\nThese will added in addition to any default label(s) that\nKubernetes may apply to the node.\nIn case of conflict in label keys, the applied set may differ depending on\nthe Kubernetes version -- it's best to assume the behavior is undefined\nand conflicts should be avoided.\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/",
"preemptible" : "Whether the nodes are created as preemptible VM instances. See:\nhttps://cloud.google.com/compute/docs/instances/preemptible for more\ninformation about preemptible VM instances.",
"minCpuPlatform" : "Minimum CPU platform to be used by this instance. The instance may be\nscheduled on the specified or newer CPU platform. Applicable values are the\nfriendly names of CPU platforms, such as\nminCpuPlatform: \"Intel Haswell\" or\nminCpuPlatform: \"Intel Sandy Bridge\". For more\ninformation, read [how to specify min CPU\nplatform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)",
"accelerators" : [ {
"acceleratorType" : "The accelerator type resource name. List of supported accelerators\n[here](/compute/docs/gpus)",
"acceleratorCount" : "The number of the accelerator cards exposed to an instance."
} ],
"diskType" : "Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')\n\nIf unspecified, the default disk type is 'pd-standard'",
"imageType" : "The image type to use for this node. Note that for a given image type,\nthe latest version of it will be used.",
"machineType" : "The name of a Google Compute Engine [machine\ntype](/compute/docs/machine-types) (e.g.\n`n1-standard-1`).\n\nIf unspecified, the default machine type is\n`n1-standard-1`.",
"localSsdCount" : "The number of local SSD disks to be attached to the node.\n\nThe limit for this value is dependent upon the maximum number of\ndisks available on a machine per zone. See:\nhttps://cloud.google.com/compute/docs/disks/local-ssd\nfor more information.",
"diskSizeGb" : "Size of the disk attached to each node, specified in GB.\nThe smallest allowed disk size is 10GB.\n\nIf unspecified, the default disk size is 100GB."
},
"network" : "The name of the Google Compute Engine\n[network](/compute/docs/networks-and-firewalls#networks) to which the\ncluster is connected. If left unspecified, the `default` network\nwill be used.",
"endpoint" : "[Output only] The IP address of this cluster's master endpoint.\nThe endpoint can be accessed from the internet at\n`https://username:password@endpoint/`.\n\nSee the `masterAuth` property of this resource for username and\npassword information.",
"initialNodeCount" : "The number of nodes to create in this cluster. You must ensure that your\nCompute Engine resource quota\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"node_config\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\n\nThis field is deprecated, use node_pool.initial_node_count instead.",
"shieldedNodes" : {
"enabled" : "Whether Shielded Nodes features are enabled on all nodes in this cluster."
},
"initialClusterVersion" : "The initial Kubernetes version for this cluster. Valid versions are those\nfound in validMasterVersions returned by getServerConfig. The version can\nbe upgraded over time; such upgrades are reflected in\ncurrentMasterVersion and currentNodeVersion.\n\nUsers may specify either explicit versions offered by\nKubernetes Engine or version aliases, which have the following behavior:\n\n- \"latest\": picks the highest valid Kubernetes version\n- \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version\n- \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version\n- \"1.X.Y-gke.N\": picks an explicit Kubernetes version\n- \"\",\"-\": picks the default Kubernetes version",
"privateClusterConfig" : {
"enablePrivateEndpoint" : "Whether the master's internal IP address is used as the cluster endpoint.",
"publicEndpoint" : "Output only. The external IP address of this cluster's master endpoint.",
"enablePrivateNodes" : "Whether nodes have internal IP addresses only. If enabled, all nodes are\ngiven only RFC 1918 private addresses and communicate with the master via\nprivate networking.",
"privateEndpoint" : "Output only. The internal IP address of this cluster's master endpoint.",
"peeringName" : "Output only. The peering name in the customer VPC used by this cluster.",
"masterIpv4CidrBlock" : "The IP range in CIDR notation to use for the hosted master network. This\nrange will be used for assigning internal IP addresses to the master or\nset of masters, as well as the ILB VIP. This range must not overlap with\nany other ranges in use within the cluster's network."
},
"legacyAbac" : {
"enabled" : "Whether the ABAC authorizer is enabled for this cluster. When enabled,\nidentities in the system, including service accounts, nodes, and\ncontrollers, will have statically granted permissions beyond those\nprovided by the RBAC configuration or IAM."
},
"clusterIpv4Cidr" : "The IP address range of the container pods in this cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`). Leave blank to have\none automatically chosen or specify a `/14` block in `10.0.0.0/8`.",
"monitoringService" : "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* `monitoring.googleapis.com` - the Google Cloud Monitoring service.\n* `none` - no metrics will be exported from the cluster.\n* if left as an empty string, `monitoring.googleapis.com` will be used.",
"networkConfig" : {
"subnetwork" : "Output only. The relative name of the Google Compute Engine\n[subnetwork](/compute/docs/vpc) to which the cluster is connected.\nExample: projects/my-project/regions/us-central1/subnetworks/my-subnet",
"enableIntraNodeVisibility" : "Whether Intra-node visibility is enabled for this cluster.\nThis makes same node pod to pod traffic visible for VPC network.",
"network" : "Output only. The relative name of the Google Compute Engine\nnetwork(/compute/docs/networks-and-firewalls#networks) to which\nthe cluster is connected.\nExample: projects/my-project/global/networks/my-network"
},
"statusMessage" : "[Output only] Additional information about the current status of this\ncluster, if available.",
"selfLink" : "[Output only] Server-defined URL for the resource.",
"currentNodeVersion" : "[Output only] Deprecated, use\n[NodePools.version](/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools)\ninstead. The current version of the node software components. If they are\ncurrently at multiple versions because they're in the process of being\nupgraded, this reflects the minimum version of all nodes.",
"tpuIpv4CidrBlock" : "[Output only] The IP address range of the Cloud TPUs in this cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `1.2.3.4/29`).",
"createTime" : "[Output only] The time the cluster was created, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"servicesIpv4Cidr" : "[Output only] The IP address range of the Kubernetes services in\nthis cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `1.2.3.4/29`). Service addresses are\ntypically put in the last `/16` from the container CIDR.",
"locations" : [ "string" ],
"location" : "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/regions-zones/regions-zones#available) or\n[region](/compute/docs/regions-zones/regions-zones#available) in which\nthe cluster resides."
},
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the parent field.",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the parent field."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

create_node_pool_for_cluster

Creates a node pool for a cluster.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

projectsId (required)

Type: string

$body

CreateNodePoolRequest creates a node pool for a cluster.

Type: object

{
"nodePool" : {
"podIpv4CidrSize" : "[Output only] The pod CIDR block size per node in this node pool.",
"maxPodsConstraint" : {
"maxPodsPerNode" : "Constraint enforced on the max num of pods per node."
},
"upgradeSettings" : {
"maxSurge" : "The maximum number of nodes that can be created beyond the current size\nof the node pool during the upgrade process.",
"maxUnavailable" : "The maximum number of nodes that can be simultaneously unavailable during\nthe upgrade process. A node is considered available if its status is\nReady."
},
"version" : "The version of the Kubernetes of this node.",
"statusMessage" : "[Output only] Additional information about the current status of this\nnode pool instance, if available.",
"selfLink" : "[Output only] Server-defined URL for the resource.",
"initialNodeCount" : "The initial node count for the pool. You must ensure that your\nCompute Engine resource quota\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.",
"instanceGroupUrls" : [ "string" ],
"management" : {
"autoUpgrade" : "A flag that specifies whether node auto-upgrade is enabled for the node\npool. If enabled, node auto-upgrade helps keep the nodes in your node pool\nup to date with the latest release version of Kubernetes.",
"upgradeOptions" : {
"description" : "[Output only] This field is set when upgrades are about to commence\nwith the description of the upgrade.",
"autoUpgradeStartTime" : "[Output only] This field is set when upgrades are about to commence\nwith the approximate start time for the upgrades, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format."
},
"autoRepair" : "A flag that specifies whether the node auto-repair is enabled for the node\npool. If enabled, the nodes in this node pool will be monitored and, if\nthey fail health checks too many times, an automatic repair action will be\ntriggered."
},
"name" : "The name of the node pool.",
"locations" : [ "string" ],
"autoscaling" : {
"minNodeCount" : "Minimum number of nodes in the NodePool. Must be >= 1 and <=\nmax_node_count.",
"autoprovisioned" : "Can this node pool be deleted automatically.",
"maxNodeCount" : "Maximum number of nodes in the NodePool. Must be >= min_node_count. There\nhas to enough quota to scale up the cluster.",
"enabled" : "Is autoscaling enabled for this node pool."
},
"conditions" : [ {
"code" : "Machine-friendly representation of the condition",
"message" : "Human-friendly representation of the condition"
} ],
"config" : {
"metadata" : "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the reserved keys:\n \"cluster-location\"\n \"cluster-name\"\n \"cluster-uid\"\n \"configure-sh\"\n \"containerd-configure-sh\"\n \"enable-os-login\"\n \"gci-ensure-gke-docker\"\n \"gci-metrics-enabled\"\n \"gci-update-strategy\"\n \"instance-template\"\n \"kube-env\"\n \"startup-script\"\n \"user-data\"\n \"disable-address-manager\"\n \"windows-startup-script-ps1\"\n \"common-psm1\"\n \"k8s-node-setup-psm1\"\n \"install-ssh-psm1\"\n \"user-profile-psm1\"\n \"serial-port-logging-enable\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.",
"shieldedInstanceConfig" : {
"enableSecureBoot" : "Defines whether the instance has Secure Boot enabled.\n\nSecure Boot helps ensure that the system only runs authentic software by\nverifying the digital signature of all boot components, and halting the\nboot process if signature verification fails.",
"enableIntegrityMonitoring" : "Defines whether the instance has integrity monitoring enabled.\n\nEnables monitoring and attestation of the boot integrity of the instance.\nThe attestation is performed against the integrity policy baseline. This\nbaseline is initially derived from the implicitly trusted boot image when\nthe instance is created."
},
"reservationAffinity" : {
"consumeReservationType" : "Corresponds to the type of reservation consumption.",
"values" : [ "string" ],
"key" : "Corresponds to the label key of reservation resource."
},
"serviceAccount" : "The Google Cloud Platform Service Account to be used by the node VMs.\nSpecify the email address of the Service Account; otherwise, if no Service\nAccount is specified, the \"default\" service account is used.",
"oauthScopes" : [ "string" ],
"taints" : [ {
"effect" : "Effect for taint.",
"value" : "Value for taint.",
"key" : "Key for taint."
} ],
"sandboxConfig" : {
"type" : "Type of the sandbox to use for the node."
},
"tags" : [ "string" ],
"labels" : "The map of Kubernetes labels (key/value pairs) to be applied to each node.\nThese will added in addition to any default label(s) that\nKubernetes may apply to the node.\nIn case of conflict in label keys, the applied set may differ depending on\nthe Kubernetes version -- it's best to assume the behavior is undefined\nand conflicts should be avoided.\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/",
"preemptible" : "Whether the nodes are created as preemptible VM instances. See:\nhttps://cloud.google.com/compute/docs/instances/preemptible for more\ninformation about preemptible VM instances.",
"minCpuPlatform" : "Minimum CPU platform to be used by this instance. The instance may be\nscheduled on the specified or newer CPU platform. Applicable values are the\nfriendly names of CPU platforms, such as\nminCpuPlatform: \"Intel Haswell\" or\nminCpuPlatform: \"Intel Sandy Bridge\". For more\ninformation, read [how to specify min CPU\nplatform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)",
"accelerators" : [ {
"acceleratorType" : "The accelerator type resource name. List of supported accelerators\n[here](/compute/docs/gpus)",
"acceleratorCount" : "The number of the accelerator cards exposed to an instance."
} ],
"diskType" : "Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')\n\nIf unspecified, the default disk type is 'pd-standard'",
"imageType" : "The image type to use for this node. Note that for a given image type,\nthe latest version of it will be used.",
"machineType" : "The name of a Google Compute Engine [machine\ntype](/compute/docs/machine-types) (e.g.\n`n1-standard-1`).\n\nIf unspecified, the default machine type is\n`n1-standard-1`.",
"localSsdCount" : "The number of local SSD disks to be attached to the node.\n\nThe limit for this value is dependent upon the maximum number of\ndisks available on a machine per zone. See:\nhttps://cloud.google.com/compute/docs/disks/local-ssd\nfor more information.",
"diskSizeGb" : "Size of the disk attached to each node, specified in GB.\nThe smallest allowed disk size is 10GB.\n\nIf unspecified, the default disk size is 100GB."
},
"status" : "[Output only] The status of the nodes in this pool instance."
},
"parent" : "The parent (project, location, cluster id) where the node pool will be\ncreated. Specified in the format\n'projects/*/locations/*/clusters/*'.",
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the parent field.",
"clusterId" : "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the parent field.",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the parent field."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

delete_cluster

Deletes the cluster, including the Kubernetes endpoint and all worker
nodes.

Firewalls and routes that were configured during cluster creation
are also deleted.

Other Google Compute Engine resources that might be in use by the cluster,
such as load balancer resources, are not deleted if they weren't present
when the cluster was initially created.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

projectsId (required)

Type: string

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

delete_node_pool_from_cluster

Deletes a node pool from a cluster.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

nodePoolsId (required)

Type: string

projectsId (required)

Type: string

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

get_cluster

Gets the details of a specific cluster.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

projectsId (required)

Type: string

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

get_jwks

Gets the public component of the cluster signing keys in
JSON Web Key format.
This API is not yet intended for general use, and is not available for all
clusters.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

projectsId (required)

Type: string

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

get_node_pool_for_cluster

Retrieves the requested node pool.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

nodePoolsId (required)

Type: string

projectsId (required)

Type: string

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

get_openid_configuration_for_cluster

Gets the OIDC discovery document for the cluster.
See the
OpenID Connect Discovery 1.0
specification

for details.
This API is not yet intended for general use, and is not available for all
clusters.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

projectsId (required)

Type: string

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

get_operation

Gets the specified operation.

Parameters

locationsId (required)

Type: string

operationsId (required)

Type: string

projectsId (required)

Type: string

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

get_server_config_for_cluster

Returns configuration info about the Google Kubernetes Engine service.

Parameters

locationsId (required)

Type: string

projectsId (required)

Type: string

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

list_clusters

Lists all clusters owned by a project in either the specified zone or all
zones.

Parameters

locationsId (required)

Type: string

projectsId (required)

Type: string

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

list_node_pools_for_cluster

Lists the node pools for a cluster.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

projectsId (required)

Type: string

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

list_operations_for_cluster

Lists all operations in a project in a specific zone or all zones.

Parameters

locationsId (required)

Type: string

projectsId (required)

Type: string

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

list_subnetworks

Lists subnetworks that are usable for creating clusters in a project.

Parameters

projectsId (required)

Type: string

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

filter

Filtering currently only supports equality on the networkProjectId and must
be in the form: "networkProjectId=[PROJECTID]", where networkProjectId
is the project which owns the listed subnetworks. This defaults to the
parent project ID.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

roll_back_upgrade_for_node_pool

Rolls back a previously Aborted or Failed NodePool upgrade.
This makes no changes if the last upgrade successfully completed.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

nodePoolsId (required)

Type: string

projectsId (required)

Type: string

$body

RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed
NodePool upgrade. This will be an no-op if the last upgrade successfully
completed.

Type: object

{
"nodePoolId" : "Required. Deprecated. The name of the node pool to rollback.\nThis field has been deprecated and replaced by the name field.",
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.",
"name" : "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
"clusterId" : "Required. Deprecated. The name of the cluster to rollback.\nThis field has been deprecated and replaced by the name field.",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

set_addons_for_cluster

Sets the addons for a specific cluster.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

projectsId (required)

Type: string

$body

SetAddonsConfigRequest sets the addons associated with the cluster.

Type: object

{
"addonsConfig" : {
"kubernetesDashboard" : {
"disabled" : "Whether the Kubernetes Dashboard is enabled for this cluster."
},
"httpLoadBalancing" : {
"disabled" : "Whether the HTTP Load Balancing controller is enabled in the cluster.\nWhen enabled, it runs a small pod in the cluster that manages the load\nbalancers."
},
"cloudRunConfig" : {
"disabled" : "Whether Cloud Run addon is enabled for this cluster."
},
"networkPolicyConfig" : {
"disabled" : "Whether NetworkPolicy is enabled for this cluster."
},
"horizontalPodAutoscaling" : {
"disabled" : "Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.\nWhen enabled, it ensures that metrics are collected into Stackdriver\nMonitoring."
}
},
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.",
"name" : "The name (project, location, cluster) of the cluster to set addons.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
"clusterId" : "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

set_autoscaling_for_node_pool

Sets the autoscaling settings for the specified node pool.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

nodePoolsId (required)

Type: string

projectsId (required)

Type: string

$body

SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.

Type: object

{
"nodePoolId" : "Required. Deprecated. The name of the node pool to upgrade.\nThis field has been deprecated and replaced by the name field.",
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.",
"name" : "The name (project, location, cluster, node pool) of the node pool to set\nautoscaler settings. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.",
"autoscaling" : {
"minNodeCount" : "Minimum number of nodes in the NodePool. Must be >= 1 and <=\nmax_node_count.",
"autoprovisioned" : "Can this node pool be deleted automatically.",
"maxNodeCount" : "Maximum number of nodes in the NodePool. Must be >= min_node_count. There\nhas to enough quota to scale up the cluster.",
"enabled" : "Is autoscaling enabled for this node pool."
},
"clusterId" : "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

set_legacy_abac_for_cluster

Enables or disables the ABAC authorization mechanism on a cluster.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

projectsId (required)

Type: string

$body

SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for
a cluster.

Type: object

{
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.",
"name" : "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
"clusterId" : "Required. Deprecated. The name of the cluster to update.\nThis field has been deprecated and replaced by the name field.",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.",
"enabled" : "Required. Whether ABAC authorization will be enabled in the cluster."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

set_locations_for_cluster

Sets the locations for a specific cluster.
Deprecated. Use
projects.locations.clusters.update
instead.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

projectsId (required)

Type: string

$body

SetLocationsRequest sets the locations of the cluster.

Type: object

{
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.",
"name" : "The name (project, location, cluster) of the cluster to set locations.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
"locations" : [ "string" ],
"clusterId" : "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

set_logging_for_cluster

Sets the logging service for a specific cluster.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

projectsId (required)

Type: string

$body

SetLoggingServiceRequest sets the logging service of a cluster.

Type: object

{
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.",
"name" : "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
"clusterId" : "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.",
"loggingService" : "Required. The logging service the cluster should use to write metrics.\nCurrently available options:\n\n* \"logging.googleapis.com\" - the Google Cloud Logging service\n* \"none\" - no metrics will be exported from the cluster",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

set_maintenance_policy_for_cluster

Sets the maintenance policy for a cluster.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

projectsId (required)

Type: string

$body

SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

Type: object

{
"maintenancePolicy" : {
"resourceVersion" : "A hash identifying the version of this policy, so that updates to fields of\nthe policy won't accidentally undo intermediate changes (and so that users\nof the API unaware of some fields won't accidentally remove other fields).\nMake a get() request to the cluster to get the current\nresource version and include it with requests to set the policy.",
"window" : {
"dailyMaintenanceWindow" : {
"duration" : "[Output only] Duration of the time window, automatically chosen to be\nsmallest possible in the given scenario.\nDuration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\nformat \"PTnHnMnS\".",
"startTime" : "Time within the maintenance window to start the maintenance operations.\nTime format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\nformat \"HH:MM\", where HH : [00-23] and MM : [00-59] GMT."
},
"recurringWindow" : {
"recurrence" : "An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how\nthis window reccurs. They go on for the span of time between the start and\nend time.\n\nFor example, to have something repeat every weekday, you'd use:\n FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\nTo repeat some window daily (equivalent to the DailyMaintenanceWindow):\n FREQ=DAILY\nFor the first weekend of every month:\n FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU\nThis specifies how frequently the window starts. Eg, if you wanted to have\na 9-5 UTC-4 window every weekday, you'd use something like:\n\n start time = 2019-01-01T09:00:00-0400\n end time = 2019-01-01T17:00:00-0400\n recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\n\nWindows can span multiple days. Eg, to make the window encompass every\nweekend from midnight Saturday till the last minute of Sunday UTC:\n\n start time = 2019-01-05T00:00:00Z\n end time = 2019-01-07T23:59:00Z\n recurrence = FREQ=WEEKLY;BYDAY=SA\n\nNote the start and end time's specific dates are largely arbitrary except\nto specify duration of the window and when it first starts.\nThe FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.",
"window" : {
"startTime" : "The time that the window first starts.",
"endTime" : "The time that the window ends. The end time should take place after the\nstart time."
}
},
"maintenanceExclusions" : "Exceptions to maintenance window. Non-emergency maintenance should not\noccur in these windows."
}
},
"zone" : "Required. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
"name" : "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
"clusterId" : "Required. The name of the cluster to update.",
"projectId" : "Required. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

set_management_for_node_pool

Sets the NodeManagement options for a node pool.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

nodePoolsId (required)

Type: string

projectsId (required)

Type: string

$body

SetNodePoolManagementRequest sets the node management properties of a node
pool.

Type: object

{
"nodePoolId" : "Required. Deprecated. The name of the node pool to update.\nThis field has been deprecated and replaced by the name field.",
"management" : {
"autoUpgrade" : "A flag that specifies whether node auto-upgrade is enabled for the node\npool. If enabled, node auto-upgrade helps keep the nodes in your node pool\nup to date with the latest release version of Kubernetes.",
"upgradeOptions" : {
"description" : "[Output only] This field is set when upgrades are about to commence\nwith the description of the upgrade.",
"autoUpgradeStartTime" : "[Output only] This field is set when upgrades are about to commence\nwith the approximate start time for the upgrades, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format."
},
"autoRepair" : "A flag that specifies whether the node auto-repair is enabled for the node\npool. If enabled, the nodes in this node pool will be monitored and, if\nthey fail health checks too many times, an automatic repair action will be\ntriggered."
},
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.",
"name" : "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.",
"clusterId" : "Required. Deprecated. The name of the cluster to update.\nThis field has been deprecated and replaced by the name field.",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

set_master_auth_for_cluster

Sets master auth materials. Currently supports changing the admin password
or a specific cluster, either via password generation or explicitly setting
the password.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

projectsId (required)

Type: string

$body

SetMasterAuthRequest updates the admin password of a cluster.

Type: object

{
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.",
"name" : "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
"update" : {
"clientCertificateConfig" : {
"issueClientCertificate" : "Issue a client certificate."
},
"clientCertificate" : "[Output only] Base64-encoded public certificate used by clients to\nauthenticate to the cluster endpoint.",
"password" : "The password to use for HTTP basic authentication to the master endpoint.\nBecause the master endpoint is open to the Internet, you should create a\nstrong password. If a password is provided for cluster creation, username\nmust be non-empty.",
"clientKey" : "[Output only] Base64-encoded private key used by clients to authenticate\nto the cluster endpoint.",
"clusterCaCertificate" : "[Output only] Base64-encoded public certificate that is the root of\ntrust for the cluster.",
"username" : "The username to use for HTTP basic authentication to the master endpoint.\nFor clusters v1.6.0 and later, basic authentication can be disabled by\nleaving username unspecified (or setting it to the empty string)."
},
"action" : "Required. The exact form of action to be taken on the master auth.",
"clusterId" : "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

set_monitoring_for_cluster

Sets the monitoring service for a specific cluster.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

projectsId (required)

Type: string

$body

SetMonitoringServiceRequest sets the monitoring service of a cluster.

Type: object

{
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.",
"monitoringService" : "Required. The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com/kubernetes\" - the Google Cloud Monitoring\nservice with Kubernetes-native resource model\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster",
"name" : "The name (project, location, cluster) of the cluster to set monitoring.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
"clusterId" : "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

set_network_policy_for_cluster

Enables or disables Network Policy for a cluster.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

projectsId (required)

Type: string

$body

SetNetworkPolicyRequest enables/disables network policy for a cluster.

Type: object

{
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.",
"networkPolicy" : {
"provider" : "The selected network policy provider.",
"enabled" : "Whether network policy is enabled on the cluster."
},
"name" : "The name (project, location, cluster id) of the cluster to set networking\npolicy. Specified in the format 'projects/*/locations/*/clusters/*'.",
"clusterId" : "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the name field.",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the name field."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

set_resource_labels_for_cluster

Sets labels on a cluster.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

projectsId (required)

Type: string

$body

SetLabelsRequest sets the Google Cloud Platform labels on a Google Container
Engine cluster, which will in turn set them for Google Compute Engine
resources used by that cluster

Type: object

{
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.",
"name" : "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
"resourceLabels" : "Required. The labels to set for that cluster.",
"clusterId" : "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the name field.",
"labelFingerprint" : "Required. The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nKubernetes Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a get() request to the\nresource to get the latest fingerprint.",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the name field."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

set_size_for_node_pool

Sets the size for a specific node pool.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

nodePoolsId (required)

Type: string

projectsId (required)

Type: string

$body

SetNodePoolSizeRequest sets the size a node
pool.

Type: object

{
"nodePoolId" : "Required. Deprecated. The name of the node pool to update.\nThis field has been deprecated and replaced by the name field.",
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.",
"name" : "The name (project, location, cluster, node pool id) of the node pool to set\nsize.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
"nodeCount" : "Required. The desired node count for the pool.",
"clusterId" : "Required. Deprecated. The name of the cluster to update.\nThis field has been deprecated and replaced by the name field.",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

start_ip_rotation_for_cluster

Starts master IP rotation.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

projectsId (required)

Type: string

$body

StartIPRotationRequest creates a new IP for the cluster and then performs
a node upgrade on each node pool to point to the new IP.

Type: object

{
"rotateCredentials" : "Whether to rotate credentials during IP rotation.",
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.",
"name" : "The name (project, location, cluster id) of the cluster to start IP\nrotation. Specified in the format 'projects/*/locations/*/clusters/*'.",
"clusterId" : "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the name field.",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the name field."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

update_cluster

Updates the settings of a specific cluster.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

projectsId (required)

Type: string

$body

UpdateClusterRequest updates the settings of a cluster.

Type: object

{
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.",
"name" : "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
"update" : {
"desiredDatabaseEncryption" : {
"keyName" : "Name of CloudKMS key to use for the encryption of secrets in etcd.\nEx. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key",
"state" : "Denotes the state of etcd encryption."
},
"desiredMonitoringService" : "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com/kubernetes\" - the Google Cloud Monitoring\nservice with Kubernetes-native resource model\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster",
"desiredMasterVersion" : "The Kubernetes version to change the master to.\n\nUsers may specify either explicit versions offered by\nKubernetes Engine or version aliases, which have the following behavior:\n\n- \"latest\": picks the highest valid Kubernetes version\n- \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version\n- \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version\n- \"1.X.Y-gke.N\": picks an explicit Kubernetes version\n- \"-\": picks the default Kubernetes version",
"desiredMasterAuthorizedNetworksConfig" : {
"cidrBlocks" : [ {
"displayName" : "display_name is an optional field for users to identify CIDR blocks.",
"cidrBlock" : "cidr_block must be specified in CIDR notation."
} ],
"enabled" : "Whether or not master authorized networks is enabled."
},
"desiredLocations" : [ "string" ],
"desiredShieldedNodes" : {
"enabled" : "Whether Shielded Nodes features are enabled on all nodes in this cluster."
},
"desiredIntraNodeVisibilityConfig" : {
"enabled" : "Enables intra node visibility for this cluster."
},
"desiredBinaryAuthorization" : {
"enabled" : "Enable Binary Authorization for this cluster. If enabled, all container\nimages will be validated by Binary Authorization."
},
"desiredAddonsConfig" : {
"kubernetesDashboard" : {
"disabled" : "Whether the Kubernetes Dashboard is enabled for this cluster."
},
"httpLoadBalancing" : {
"disabled" : "Whether the HTTP Load Balancing controller is enabled in the cluster.\nWhen enabled, it runs a small pod in the cluster that manages the load\nbalancers."
},
"cloudRunConfig" : {
"disabled" : "Whether Cloud Run addon is enabled for this cluster."
},
"networkPolicyConfig" : {
"disabled" : "Whether NetworkPolicy is enabled for this cluster."
},
"horizontalPodAutoscaling" : {
"disabled" : "Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.\nWhen enabled, it ensures that metrics are collected into Stackdriver\nMonitoring."
}
},
"desiredResourceUsageExportConfig" : {
"consumptionMeteringConfig" : {
"enabled" : "Whether to enable consumption metering for this cluster. If enabled, a\nsecond BigQuery table will be created to hold resource consumption\nrecords."
},
"bigqueryDestination" : {
"datasetId" : "The ID of a BigQuery Dataset."
},
"enableNetworkEgressMetering" : "Whether to enable network egress metering for this cluster. If enabled, a\ndaemonset will be created in the cluster to meter network egress traffic."
},
"desiredImageType" : "The desired image type for the node pool.\nNOTE: Set the \"desired_node_pool\" field as well.",
"desiredLoggingService" : "The logging service the cluster should use to write logs.\nCurrently available options:\n\n* \"logging.googleapis.com/kubernetes\" - the Google Cloud Logging\nservice with Kubernetes-native resource model\n* \"logging.googleapis.com\" - the Google Cloud Logging service\n* \"none\" - no logs will be exported from the cluster",
"desiredVerticalPodAutoscaling" : {
"enabled" : "Enables vertical pod autoscaling."
},
"desiredNodePoolId" : "The node pool to be upgraded. This field is mandatory if\n\"desired_node_version\", \"desired_image_family\" or\n\"desired_node_pool_autoscaling\" is specified and there is more than one\nnode pool on the cluster.",
"desiredClusterAutoscaling" : {
"autoprovisioningLocations" : [ "string" ],
"resourceLimits" : [ {
"maximum" : "Maximum amount of the resource in the cluster.",
"minimum" : "Minimum amount of the resource in the cluster.",
"resourceType" : "Resource name \"cpu\", \"memory\" or gpu-specific string."
} ],
"autoprovisioningNodePoolDefaults" : {
"management" : {
"autoUpgrade" : "A flag that specifies whether node auto-upgrade is enabled for the node\npool. If enabled, node auto-upgrade helps keep the nodes in your node pool\nup to date with the latest release version of Kubernetes.",
"upgradeOptions" : {
"description" : "[Output only] This field is set when upgrades are about to commence\nwith the description of the upgrade.",
"autoUpgradeStartTime" : "[Output only] This field is set when upgrades are about to commence\nwith the approximate start time for the upgrades, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format."
},
"autoRepair" : "A flag that specifies whether the node auto-repair is enabled for the node\npool. If enabled, the nodes in this node pool will be monitored and, if\nthey fail health checks too many times, an automatic repair action will be\ntriggered."
},
"upgradeSettings" : {
"maxSurge" : "The maximum number of nodes that can be created beyond the current size\nof the node pool during the upgrade process.",
"maxUnavailable" : "The maximum number of nodes that can be simultaneously unavailable during\nthe upgrade process. A node is considered available if its status is\nReady."
},
"serviceAccount" : "The Google Cloud Platform Service Account to be used by the node VMs. If\nservice_account is specified, scopes should be empty.",
"oauthScopes" : [ "string" ]
},
"enableNodeAutoprovisioning" : "Enables automatic node pool creation and deletion."
},
"desiredNodePoolAutoscaling" : {
"minNodeCount" : "Minimum number of nodes in the NodePool. Must be >= 1 and <=\nmax_node_count.",
"autoprovisioned" : "Can this node pool be deleted automatically.",
"maxNodeCount" : "Maximum number of nodes in the NodePool. Must be >= min_node_count. There\nhas to enough quota to scale up the cluster.",
"enabled" : "Is autoscaling enabled for this node pool."
},
"desiredNodeVersion" : "The Kubernetes version to change the nodes to (typically an\nupgrade).\n\nUsers may specify either explicit versions offered by\nKubernetes Engine or version aliases, which have the following behavior:\n\n- \"latest\": picks the highest valid Kubernetes version\n- \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version\n- \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version\n- \"1.X.Y-gke.N\": picks an explicit Kubernetes version\n- \"-\": picks the Kubernetes master version"
},
"clusterId" : "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

update_master_for_cluster

Updates the master for a specific cluster.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

projectsId (required)

Type: string

$body

UpdateMasterRequest updates the master of the cluster.

Type: object

{
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.",
"masterVersion" : "Required. The Kubernetes version to change the master to.\n\nUsers may specify either explicit versions offered by Kubernetes Engine or\nversion aliases, which have the following behavior:\n\n- \"latest\": picks the highest valid Kubernetes version\n- \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version\n- \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version\n- \"1.X.Y-gke.N\": picks an explicit Kubernetes version\n- \"-\": picks the default Kubernetes version",
"name" : "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
"clusterId" : "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string

update_node_pool_for_cluster

Updates the version and/or image type for the specified node pool.

Parameters

clustersId (required)

Type: string

locationsId (required)

Type: string

nodePoolsId (required)

Type: string

projectsId (required)

Type: string

$body

UpdateNodePoolRequests update a node pool's image and/or version.

Type: object

{
"nodePoolId" : "Required. Deprecated. The name of the node pool to upgrade.\nThis field has been deprecated and replaced by the name field.",
"zone" : "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.",
"name" : "The name (project, location, cluster, node pool) of the node pool to\nupdate. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.",
"upgradeSettings" : {
"maxSurge" : "The maximum number of nodes that can be created beyond the current size\nof the node pool during the upgrade process.",
"maxUnavailable" : "The maximum number of nodes that can be simultaneously unavailable during\nthe upgrade process. A node is considered available if its status is\nReady."
},
"locations" : [ "string" ],
"nodeVersion" : "Required. The Kubernetes version to change the nodes to (typically an\nupgrade).\n\nUsers may specify either explicit versions offered by Kubernetes Engine or\nversion aliases, which have the following behavior:\n\n- \"latest\": picks the highest valid Kubernetes version\n- \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version\n- \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version\n- \"1.X.Y-gke.N\": picks an explicit Kubernetes version\n- \"-\": picks the Kubernetes master version",
"clusterId" : "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.",
"projectId" : "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.",
"imageType" : "Required. The desired image type for the node pool."
}

alt

Data format for response.

Type: string

Potential values: json, media, proto

callback

JSONP

Type: string

fields

Selector specifying which fields to include in a partial response.

Type: string

prettyPrint

Returns response with indentations and line breaks.

Type: boolean

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Type: string

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

Type: string

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

Type: string