1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="container_v1.html">Kubernetes Engine API</a> . <a href="container_v1.projects.html">projects</a> . <a href="container_v1.projects.zones.html">zones</a> . <a href="container_v1.projects.zones.clusters.html">clusters</a> . <a href="container_v1.projects.zones.clusters.nodePools.html">nodePools</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#autoscaling">autoscaling(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</a></code></p> 79<p class="firstline">Sets the autoscaling settings for the specified node pool.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(projectId, zone, clusterId, body, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a node pool for a cluster.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a node pool from a cluster.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Retrieves the requested node pool.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(projectId, zone, clusterId, parent=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists the node pools for a cluster.</p> 92<p class="toc_element"> 93 <code><a href="#rollback">rollback(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</a></code></p> 94<p class="firstline">Rolls back a previously Aborted or Failed NodePool upgrade.</p> 95<p class="toc_element"> 96 <code><a href="#setManagement">setManagement(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</a></code></p> 97<p class="firstline">Sets the NodeManagement options for a node pool.</p> 98<p class="toc_element"> 99 <code><a href="#setSize">setSize(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</a></code></p> 100<p class="firstline">Sets the size for a specific node pool.</p> 101<p class="toc_element"> 102 <code><a href="#update">update(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</a></code></p> 103<p class="firstline">Updates the version and/or image type for the specified node pool.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="autoscaling">autoscaling(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</code> 107 <pre>Sets the autoscaling settings for the specified node pool. 108 109Args: 110 projectId: string, Deprecated. The Google Developers Console [project ID or project 111number](https://support.google.com/cloud/answer/6158840). 112This field has been deprecated and replaced by the name field. (required) 113 zone: string, Deprecated. The name of the Google Compute Engine 114[zone](/compute/docs/zones#available) in which the cluster 115resides. 116This field has been deprecated and replaced by the name field. (required) 117 clusterId: string, Deprecated. The name of the cluster to upgrade. 118This field has been deprecated and replaced by the name field. (required) 119 nodePoolId: string, Deprecated. The name of the node pool to upgrade. 120This field has been deprecated and replaced by the name field. (required) 121 body: object, The request body. (required) 122 The object takes the form of: 123 124{ # SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool. 125 "name": "A String", # The name (project, location, cluster, node pool) of the node pool to set 126 # autoscaler settings. Specified in the format 127 # 'projects/*/locations/*/clusters/*/nodePools/*'. 128 "zone": "A String", # Deprecated. The name of the Google Compute Engine 129 # [zone](/compute/docs/zones#available) in which the cluster 130 # resides. 131 # This field has been deprecated and replaced by the name field. 132 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project 133 # number](https://support.google.com/cloud/answer/6158840). 134 # This field has been deprecated and replaced by the name field. 135 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaling configuration for the node pool. 136 # adjust the size of the node pool to the current cluster usage. 137 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= 138 # max_node_count. 139 "enabled": True or False, # Is autoscaling enabled for this node pool. 140 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There 141 # has to enough quota to scale up the cluster. 142 }, 143 "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. 144 # This field has been deprecated and replaced by the name field. 145 "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. 146 # This field has been deprecated and replaced by the name field. 147 } 148 149 x__xgafv: string, V1 error format. 150 Allowed values 151 1 - v1 error format 152 2 - v2 error format 153 154Returns: 155 An object of the form: 156 157 { # This operation resource represents operations that may have happened or are 158 # happening on the cluster. All fields are output only. 159 "status": "A String", # The current status of the operation. 160 "selfLink": "A String", # Server-defined URL for the resource. 161 "name": "A String", # The server-assigned ID for the operation. 162 "zone": "A String", # The name of the Google Compute Engine 163 # [zone](/compute/docs/zones#available) in which the operation 164 # is taking place. 165 # This field is deprecated, use location instead. 166 "startTime": "A String", # [Output only] The time the operation started, in 167 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 168 "detail": "A String", # Detailed operation progress, if available. 169 "operationType": "A String", # The operation type. 170 "targetLink": "A String", # Server-defined URL for the target of the operation. 171 "location": "A String", # [Output only] The name of the Google Compute Engine 172 # [zone](/compute/docs/regions-zones/regions-zones#available) or 173 # [region](/compute/docs/regions-zones/regions-zones#available) in which 174 # the cluster resides. 175 "nodepoolConditions": [ # Which conditions caused the current node pool state. 176 { # StatusCondition describes why a cluster or a node pool has a certain status 177 # (e.g., ERROR or DEGRADED). 178 "message": "A String", # Human-friendly representation of the condition 179 "code": "A String", # Machine-friendly representation of the condition 180 }, 181 ], 182 "endTime": "A String", # [Output only] The time the operation completed, in 183 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 184 "statusMessage": "A String", # If an error has occurred, a textual description of the error. 185 "clusterConditions": [ # Which conditions caused the current cluster state. 186 { # StatusCondition describes why a cluster or a node pool has a certain status 187 # (e.g., ERROR or DEGRADED). 188 "message": "A String", # Human-friendly representation of the condition 189 "code": "A String", # Machine-friendly representation of the condition 190 }, 191 ], 192 }</pre> 193</div> 194 195<div class="method"> 196 <code class="details" id="create">create(projectId, zone, clusterId, body, x__xgafv=None)</code> 197 <pre>Creates a node pool for a cluster. 198 199Args: 200 projectId: string, Deprecated. The Google Developers Console [project ID or project 201number](https://developers.google.com/console/help/new/#projectnumber). 202This field has been deprecated and replaced by the parent field. (required) 203 zone: string, Deprecated. The name of the Google Compute Engine 204[zone](/compute/docs/zones#available) in which the cluster 205resides. 206This field has been deprecated and replaced by the parent field. (required) 207 clusterId: string, Deprecated. The name of the cluster. 208This field has been deprecated and replaced by the parent field. (required) 209 body: object, The request body. (required) 210 The object takes the form of: 211 212{ # CreateNodePoolRequest creates a node pool for a cluster. 213 "parent": "A String", # The parent (project, location, cluster id) where the node pool will be 214 # created. Specified in the format 215 # 'projects/*/locations/*/clusters/*'. 216 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project 217 # number](https://developers.google.com/console/help/new/#projectnumber). 218 # This field has been deprecated and replaced by the parent field. 219 "clusterId": "A String", # Deprecated. The name of the cluster. 220 # This field has been deprecated and replaced by the parent field. 221 "nodePool": { # NodePool contains the name and configuration for a cluster's node pool. # The node pool to create. 222 # Node pools are a set of nodes (i.e. VM's), with a common configuration and 223 # specification, under the control of the cluster master. They may have a set 224 # of Kubernetes labels applied to them, which may be used to reference them 225 # during pod scheduling. They may also be resized up or down, to accommodate 226 # the workload. 227 "status": "A String", # [Output only] The status of the nodes in this pool instance. 228 "statusMessage": "A String", # [Output only] Additional information about the current status of this 229 # node pool instance, if available. 230 "name": "A String", # The name of the node pool. 231 "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance 232 # groups](/compute/docs/instance-groups/creating-groups-of-managed-instances) 233 # associated with this node pool. 234 "A String", 235 ], 236 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled 237 # only if a valid configuration is present. 238 # adjust the size of the node pool to the current cluster usage. 239 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= 240 # max_node_count. 241 "enabled": True or False, # Is autoscaling enabled for this node pool. 242 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There 243 # has to enough quota to scale up the cluster. 244 }, 245 "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run 246 # simultaneously on a node in the node pool. 247 "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. 248 }, 249 "version": "A String", # The version of the Kubernetes of this node. 250 "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your 251 # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> 252 # is sufficient for this number of instances. You must also have available 253 # firewall and routes quota. 254 "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. 255 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. 256 # node pool. 257 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node 258 # pool. If enabled, the nodes in this node pool will be monitored and, if 259 # they fail health checks too many times, an automatic repair action will be 260 # triggered. 261 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. 262 # the Auto Upgrades will proceed. 263 "description": "A String", # [Output only] This field is set when upgrades are about to commence 264 # with the description of the upgrade. 265 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence 266 # with the approximate start time for the upgrades, in 267 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 268 }, 269 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node 270 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool 271 # up to date with the latest release version of Kubernetes. 272 }, 273 "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. 274 "taints": [ # List of kubernetes taints to be applied to each node. 275 # 276 # For more information, including usage and the valid values, see: 277 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ 278 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect 279 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. 280 # 281 # For more information, including usage and the valid values, see: 282 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ 283 "key": "A String", # Key for taint. 284 "effect": "A String", # Effect for taint. 285 "value": "A String", # Value for taint. 286 }, 287 ], 288 "machineType": "A String", # The name of a Google Compute Engine [machine 289 # type](/compute/docs/machine-types) (e.g. 290 # `n1-standard-1`). 291 # 292 # If unspecified, the default machine type is 293 # `n1-standard-1`. 294 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify 295 # valid sources or targets for network firewalls and are specified by 296 # the client during cluster or node pool creation. Each tag within the list 297 # must comply with RFC1035. 298 "A String", 299 ], 300 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: 301 # https://cloud.google.com/compute/docs/instances/preemptible for more 302 # information about preemptible VM instances. 303 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. 304 # These will added in addition to any default label(s) that 305 # Kubernetes may apply to the node. 306 # In case of conflict in label keys, the applied set may differ depending on 307 # the Kubernetes version -- it's best to assume the behavior is undefined 308 # and conflicts should be avoided. 309 # For more information, including usage and the valid values, see: 310 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ 311 "a_key": "A String", 312 }, 313 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If 314 # no Service Account is specified, the "default" service account is used. 315 "oauthScopes": [ # The set of Google API scopes to be made available on all of the 316 # node VMs under the "default" service account. 317 # 318 # The following scopes are recommended, but not required, and by default are 319 # not included: 320 # 321 # * `https://www.googleapis.com/auth/compute` is required for mounting 322 # persistent storage on your nodes. 323 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for 324 # communicating with **gcr.io** 325 # (the [Google Container Registry](/container-registry/)). 326 # 327 # If unspecified, no scopes are added, unless Cloud Logging or Cloud 328 # Monitoring are enabled, in which case their required scopes will be added. 329 "A String", 330 ], 331 "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') 332 # 333 # If unspecified, the default disk type is 'pd-standard' 334 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. 335 # The smallest allowed disk size is 10GB. 336 # 337 # If unspecified, the default disk size is 100GB. 338 "accelerators": [ # A list of hardware accelerators to be attached to each node. 339 # See https://cloud.google.com/compute/docs/gpus for more information about 340 # support for GPUs. 341 { # AcceleratorConfig represents a Hardware Accelerator request. 342 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. 343 "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators 344 # [here](/compute/docs/gpus/#Introduction) 345 }, 346 ], 347 "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be 348 # scheduled on the specified or newer CPU platform. Applicable values are the 349 # friendly names of CPU platforms, such as 350 # <code>minCpuPlatform: "Intel Haswell"</code> or 351 # <code>minCpuPlatform: "Intel Sandy Bridge"</code>. For more 352 # information, read [how to specify min CPU 353 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) 354 "metadata": { # The metadata key/value pairs assigned to instances in the cluster. 355 # 356 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes 357 # in length. These are reflected as part of a URL in the metadata server. 358 # Additionally, to avoid ambiguity, keys must not conflict with any other 359 # metadata keys for the project or be one of the reserved keys: 360 # "cluster-location" 361 # "cluster-name" 362 # "cluster-uid" 363 # "configure-sh" 364 # "containerd-configure-sh" 365 # "enable-os-login" 366 # "gci-update-strategy" 367 # "gci-ensure-gke-docker" 368 # "instance-template" 369 # "kube-env" 370 # "startup-script" 371 # "user-data" 372 # "disable-address-manager" 373 # "windows-startup-script-ps1" 374 # "common-psm1" 375 # "k8s-node-setup-psm1" 376 # "install-ssh-psm1" 377 # "user-profile-psm1" 378 # "serial-port-logging-enable" 379 # 380 # Values are free-form strings, and only have meaning as interpreted by 381 # the image running in the instance. The only restriction placed on them is 382 # that each value's size must be less than or equal to 32 KB. 383 # 384 # The total size of all keys and values must be less than 512 KB. 385 "a_key": "A String", 386 }, 387 "imageType": "A String", # The image type to use for this node. Note that for a given image type, 388 # the latest version of it will be used. 389 "localSsdCount": 42, # The number of local SSD disks to be attached to the node. 390 # 391 # The limit for this value is dependant upon the maximum number of 392 # disks available on a machine per zone. See: 393 # https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits 394 # for more information. 395 }, 396 "conditions": [ # Which conditions caused the current node pool state. 397 { # StatusCondition describes why a cluster or a node pool has a certain status 398 # (e.g., ERROR or DEGRADED). 399 "message": "A String", # Human-friendly representation of the condition 400 "code": "A String", # Machine-friendly representation of the condition 401 }, 402 ], 403 "selfLink": "A String", # [Output only] Server-defined URL for the resource. 404 }, 405 "zone": "A String", # Deprecated. The name of the Google Compute Engine 406 # [zone](/compute/docs/zones#available) in which the cluster 407 # resides. 408 # This field has been deprecated and replaced by the parent field. 409 } 410 411 x__xgafv: string, V1 error format. 412 Allowed values 413 1 - v1 error format 414 2 - v2 error format 415 416Returns: 417 An object of the form: 418 419 { # This operation resource represents operations that may have happened or are 420 # happening on the cluster. All fields are output only. 421 "status": "A String", # The current status of the operation. 422 "selfLink": "A String", # Server-defined URL for the resource. 423 "name": "A String", # The server-assigned ID for the operation. 424 "zone": "A String", # The name of the Google Compute Engine 425 # [zone](/compute/docs/zones#available) in which the operation 426 # is taking place. 427 # This field is deprecated, use location instead. 428 "startTime": "A String", # [Output only] The time the operation started, in 429 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 430 "detail": "A String", # Detailed operation progress, if available. 431 "operationType": "A String", # The operation type. 432 "targetLink": "A String", # Server-defined URL for the target of the operation. 433 "location": "A String", # [Output only] The name of the Google Compute Engine 434 # [zone](/compute/docs/regions-zones/regions-zones#available) or 435 # [region](/compute/docs/regions-zones/regions-zones#available) in which 436 # the cluster resides. 437 "nodepoolConditions": [ # Which conditions caused the current node pool state. 438 { # StatusCondition describes why a cluster or a node pool has a certain status 439 # (e.g., ERROR or DEGRADED). 440 "message": "A String", # Human-friendly representation of the condition 441 "code": "A String", # Machine-friendly representation of the condition 442 }, 443 ], 444 "endTime": "A String", # [Output only] The time the operation completed, in 445 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 446 "statusMessage": "A String", # If an error has occurred, a textual description of the error. 447 "clusterConditions": [ # Which conditions caused the current cluster state. 448 { # StatusCondition describes why a cluster or a node pool has a certain status 449 # (e.g., ERROR or DEGRADED). 450 "message": "A String", # Human-friendly representation of the condition 451 "code": "A String", # Machine-friendly representation of the condition 452 }, 453 ], 454 }</pre> 455</div> 456 457<div class="method"> 458 <code class="details" id="delete">delete(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)</code> 459 <pre>Deletes a node pool from a cluster. 460 461Args: 462 projectId: string, Deprecated. The Google Developers Console [project ID or project 463number](https://developers.google.com/console/help/new/#projectnumber). 464This field has been deprecated and replaced by the name field. (required) 465 zone: string, Deprecated. The name of the Google Compute Engine 466[zone](/compute/docs/zones#available) in which the cluster 467resides. 468This field has been deprecated and replaced by the name field. (required) 469 clusterId: string, Deprecated. The name of the cluster. 470This field has been deprecated and replaced by the name field. (required) 471 nodePoolId: string, Deprecated. The name of the node pool to delete. 472This field has been deprecated and replaced by the name field. (required) 473 name: string, The name (project, location, cluster, node pool id) of the node pool to 474delete. Specified in the format 475'projects/*/locations/*/clusters/*/nodePools/*'. 476 x__xgafv: string, V1 error format. 477 Allowed values 478 1 - v1 error format 479 2 - v2 error format 480 481Returns: 482 An object of the form: 483 484 { # This operation resource represents operations that may have happened or are 485 # happening on the cluster. All fields are output only. 486 "status": "A String", # The current status of the operation. 487 "selfLink": "A String", # Server-defined URL for the resource. 488 "name": "A String", # The server-assigned ID for the operation. 489 "zone": "A String", # The name of the Google Compute Engine 490 # [zone](/compute/docs/zones#available) in which the operation 491 # is taking place. 492 # This field is deprecated, use location instead. 493 "startTime": "A String", # [Output only] The time the operation started, in 494 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 495 "detail": "A String", # Detailed operation progress, if available. 496 "operationType": "A String", # The operation type. 497 "targetLink": "A String", # Server-defined URL for the target of the operation. 498 "location": "A String", # [Output only] The name of the Google Compute Engine 499 # [zone](/compute/docs/regions-zones/regions-zones#available) or 500 # [region](/compute/docs/regions-zones/regions-zones#available) in which 501 # the cluster resides. 502 "nodepoolConditions": [ # Which conditions caused the current node pool state. 503 { # StatusCondition describes why a cluster or a node pool has a certain status 504 # (e.g., ERROR or DEGRADED). 505 "message": "A String", # Human-friendly representation of the condition 506 "code": "A String", # Machine-friendly representation of the condition 507 }, 508 ], 509 "endTime": "A String", # [Output only] The time the operation completed, in 510 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 511 "statusMessage": "A String", # If an error has occurred, a textual description of the error. 512 "clusterConditions": [ # Which conditions caused the current cluster state. 513 { # StatusCondition describes why a cluster or a node pool has a certain status 514 # (e.g., ERROR or DEGRADED). 515 "message": "A String", # Human-friendly representation of the condition 516 "code": "A String", # Machine-friendly representation of the condition 517 }, 518 ], 519 }</pre> 520</div> 521 522<div class="method"> 523 <code class="details" id="get">get(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)</code> 524 <pre>Retrieves the requested node pool. 525 526Args: 527 projectId: string, Deprecated. The Google Developers Console [project ID or project 528number](https://developers.google.com/console/help/new/#projectnumber). 529This field has been deprecated and replaced by the name field. (required) 530 zone: string, Deprecated. The name of the Google Compute Engine 531[zone](/compute/docs/zones#available) in which the cluster 532resides. 533This field has been deprecated and replaced by the name field. (required) 534 clusterId: string, Deprecated. The name of the cluster. 535This field has been deprecated and replaced by the name field. (required) 536 nodePoolId: string, Deprecated. The name of the node pool. 537This field has been deprecated and replaced by the name field. (required) 538 name: string, The name (project, location, cluster, node pool id) of the node pool to 539get. Specified in the format 540'projects/*/locations/*/clusters/*/nodePools/*'. 541 x__xgafv: string, V1 error format. 542 Allowed values 543 1 - v1 error format 544 2 - v2 error format 545 546Returns: 547 An object of the form: 548 549 { # NodePool contains the name and configuration for a cluster's node pool. 550 # Node pools are a set of nodes (i.e. VM's), with a common configuration and 551 # specification, under the control of the cluster master. They may have a set 552 # of Kubernetes labels applied to them, which may be used to reference them 553 # during pod scheduling. They may also be resized up or down, to accommodate 554 # the workload. 555 "status": "A String", # [Output only] The status of the nodes in this pool instance. 556 "statusMessage": "A String", # [Output only] Additional information about the current status of this 557 # node pool instance, if available. 558 "name": "A String", # The name of the node pool. 559 "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance 560 # groups](/compute/docs/instance-groups/creating-groups-of-managed-instances) 561 # associated with this node pool. 562 "A String", 563 ], 564 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled 565 # only if a valid configuration is present. 566 # adjust the size of the node pool to the current cluster usage. 567 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= 568 # max_node_count. 569 "enabled": True or False, # Is autoscaling enabled for this node pool. 570 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There 571 # has to enough quota to scale up the cluster. 572 }, 573 "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run 574 # simultaneously on a node in the node pool. 575 "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. 576 }, 577 "version": "A String", # The version of the Kubernetes of this node. 578 "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your 579 # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> 580 # is sufficient for this number of instances. You must also have available 581 # firewall and routes quota. 582 "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. 583 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. 584 # node pool. 585 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node 586 # pool. If enabled, the nodes in this node pool will be monitored and, if 587 # they fail health checks too many times, an automatic repair action will be 588 # triggered. 589 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. 590 # the Auto Upgrades will proceed. 591 "description": "A String", # [Output only] This field is set when upgrades are about to commence 592 # with the description of the upgrade. 593 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence 594 # with the approximate start time for the upgrades, in 595 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 596 }, 597 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node 598 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool 599 # up to date with the latest release version of Kubernetes. 600 }, 601 "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. 602 "taints": [ # List of kubernetes taints to be applied to each node. 603 # 604 # For more information, including usage and the valid values, see: 605 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ 606 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect 607 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. 608 # 609 # For more information, including usage and the valid values, see: 610 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ 611 "key": "A String", # Key for taint. 612 "effect": "A String", # Effect for taint. 613 "value": "A String", # Value for taint. 614 }, 615 ], 616 "machineType": "A String", # The name of a Google Compute Engine [machine 617 # type](/compute/docs/machine-types) (e.g. 618 # `n1-standard-1`). 619 # 620 # If unspecified, the default machine type is 621 # `n1-standard-1`. 622 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify 623 # valid sources or targets for network firewalls and are specified by 624 # the client during cluster or node pool creation. Each tag within the list 625 # must comply with RFC1035. 626 "A String", 627 ], 628 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: 629 # https://cloud.google.com/compute/docs/instances/preemptible for more 630 # information about preemptible VM instances. 631 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. 632 # These will added in addition to any default label(s) that 633 # Kubernetes may apply to the node. 634 # In case of conflict in label keys, the applied set may differ depending on 635 # the Kubernetes version -- it's best to assume the behavior is undefined 636 # and conflicts should be avoided. 637 # For more information, including usage and the valid values, see: 638 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ 639 "a_key": "A String", 640 }, 641 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If 642 # no Service Account is specified, the "default" service account is used. 643 "oauthScopes": [ # The set of Google API scopes to be made available on all of the 644 # node VMs under the "default" service account. 645 # 646 # The following scopes are recommended, but not required, and by default are 647 # not included: 648 # 649 # * `https://www.googleapis.com/auth/compute` is required for mounting 650 # persistent storage on your nodes. 651 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for 652 # communicating with **gcr.io** 653 # (the [Google Container Registry](/container-registry/)). 654 # 655 # If unspecified, no scopes are added, unless Cloud Logging or Cloud 656 # Monitoring are enabled, in which case their required scopes will be added. 657 "A String", 658 ], 659 "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') 660 # 661 # If unspecified, the default disk type is 'pd-standard' 662 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. 663 # The smallest allowed disk size is 10GB. 664 # 665 # If unspecified, the default disk size is 100GB. 666 "accelerators": [ # A list of hardware accelerators to be attached to each node. 667 # See https://cloud.google.com/compute/docs/gpus for more information about 668 # support for GPUs. 669 { # AcceleratorConfig represents a Hardware Accelerator request. 670 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. 671 "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators 672 # [here](/compute/docs/gpus/#Introduction) 673 }, 674 ], 675 "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be 676 # scheduled on the specified or newer CPU platform. Applicable values are the 677 # friendly names of CPU platforms, such as 678 # <code>minCpuPlatform: "Intel Haswell"</code> or 679 # <code>minCpuPlatform: "Intel Sandy Bridge"</code>. For more 680 # information, read [how to specify min CPU 681 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) 682 "metadata": { # The metadata key/value pairs assigned to instances in the cluster. 683 # 684 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes 685 # in length. These are reflected as part of a URL in the metadata server. 686 # Additionally, to avoid ambiguity, keys must not conflict with any other 687 # metadata keys for the project or be one of the reserved keys: 688 # "cluster-location" 689 # "cluster-name" 690 # "cluster-uid" 691 # "configure-sh" 692 # "containerd-configure-sh" 693 # "enable-os-login" 694 # "gci-update-strategy" 695 # "gci-ensure-gke-docker" 696 # "instance-template" 697 # "kube-env" 698 # "startup-script" 699 # "user-data" 700 # "disable-address-manager" 701 # "windows-startup-script-ps1" 702 # "common-psm1" 703 # "k8s-node-setup-psm1" 704 # "install-ssh-psm1" 705 # "user-profile-psm1" 706 # "serial-port-logging-enable" 707 # 708 # Values are free-form strings, and only have meaning as interpreted by 709 # the image running in the instance. The only restriction placed on them is 710 # that each value's size must be less than or equal to 32 KB. 711 # 712 # The total size of all keys and values must be less than 512 KB. 713 "a_key": "A String", 714 }, 715 "imageType": "A String", # The image type to use for this node. Note that for a given image type, 716 # the latest version of it will be used. 717 "localSsdCount": 42, # The number of local SSD disks to be attached to the node. 718 # 719 # The limit for this value is dependant upon the maximum number of 720 # disks available on a machine per zone. See: 721 # https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits 722 # for more information. 723 }, 724 "conditions": [ # Which conditions caused the current node pool state. 725 { # StatusCondition describes why a cluster or a node pool has a certain status 726 # (e.g., ERROR or DEGRADED). 727 "message": "A String", # Human-friendly representation of the condition 728 "code": "A String", # Machine-friendly representation of the condition 729 }, 730 ], 731 "selfLink": "A String", # [Output only] Server-defined URL for the resource. 732 }</pre> 733</div> 734 735<div class="method"> 736 <code class="details" id="list">list(projectId, zone, clusterId, parent=None, x__xgafv=None)</code> 737 <pre>Lists the node pools for a cluster. 738 739Args: 740 projectId: string, Deprecated. The Google Developers Console [project ID or project 741number](https://developers.google.com/console/help/new/#projectnumber). 742This field has been deprecated and replaced by the parent field. (required) 743 zone: string, Deprecated. The name of the Google Compute Engine 744[zone](/compute/docs/zones#available) in which the cluster 745resides. 746This field has been deprecated and replaced by the parent field. (required) 747 clusterId: string, Deprecated. The name of the cluster. 748This field has been deprecated and replaced by the parent field. (required) 749 parent: string, The parent (project, location, cluster id) where the node pools will be 750listed. Specified in the format 'projects/*/locations/*/clusters/*'. 751 x__xgafv: string, V1 error format. 752 Allowed values 753 1 - v1 error format 754 2 - v2 error format 755 756Returns: 757 An object of the form: 758 759 { # ListNodePoolsResponse is the result of ListNodePoolsRequest. 760 "nodePools": [ # A list of node pools for a cluster. 761 { # NodePool contains the name and configuration for a cluster's node pool. 762 # Node pools are a set of nodes (i.e. VM's), with a common configuration and 763 # specification, under the control of the cluster master. They may have a set 764 # of Kubernetes labels applied to them, which may be used to reference them 765 # during pod scheduling. They may also be resized up or down, to accommodate 766 # the workload. 767 "status": "A String", # [Output only] The status of the nodes in this pool instance. 768 "statusMessage": "A String", # [Output only] Additional information about the current status of this 769 # node pool instance, if available. 770 "name": "A String", # The name of the node pool. 771 "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance 772 # groups](/compute/docs/instance-groups/creating-groups-of-managed-instances) 773 # associated with this node pool. 774 "A String", 775 ], 776 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled 777 # only if a valid configuration is present. 778 # adjust the size of the node pool to the current cluster usage. 779 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= 780 # max_node_count. 781 "enabled": True or False, # Is autoscaling enabled for this node pool. 782 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There 783 # has to enough quota to scale up the cluster. 784 }, 785 "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run 786 # simultaneously on a node in the node pool. 787 "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. 788 }, 789 "version": "A String", # The version of the Kubernetes of this node. 790 "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your 791 # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> 792 # is sufficient for this number of instances. You must also have available 793 # firewall and routes quota. 794 "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. 795 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. 796 # node pool. 797 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node 798 # pool. If enabled, the nodes in this node pool will be monitored and, if 799 # they fail health checks too many times, an automatic repair action will be 800 # triggered. 801 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. 802 # the Auto Upgrades will proceed. 803 "description": "A String", # [Output only] This field is set when upgrades are about to commence 804 # with the description of the upgrade. 805 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence 806 # with the approximate start time for the upgrades, in 807 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 808 }, 809 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node 810 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool 811 # up to date with the latest release version of Kubernetes. 812 }, 813 "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. 814 "taints": [ # List of kubernetes taints to be applied to each node. 815 # 816 # For more information, including usage and the valid values, see: 817 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ 818 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect 819 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. 820 # 821 # For more information, including usage and the valid values, see: 822 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ 823 "key": "A String", # Key for taint. 824 "effect": "A String", # Effect for taint. 825 "value": "A String", # Value for taint. 826 }, 827 ], 828 "machineType": "A String", # The name of a Google Compute Engine [machine 829 # type](/compute/docs/machine-types) (e.g. 830 # `n1-standard-1`). 831 # 832 # If unspecified, the default machine type is 833 # `n1-standard-1`. 834 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify 835 # valid sources or targets for network firewalls and are specified by 836 # the client during cluster or node pool creation. Each tag within the list 837 # must comply with RFC1035. 838 "A String", 839 ], 840 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: 841 # https://cloud.google.com/compute/docs/instances/preemptible for more 842 # information about preemptible VM instances. 843 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. 844 # These will added in addition to any default label(s) that 845 # Kubernetes may apply to the node. 846 # In case of conflict in label keys, the applied set may differ depending on 847 # the Kubernetes version -- it's best to assume the behavior is undefined 848 # and conflicts should be avoided. 849 # For more information, including usage and the valid values, see: 850 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ 851 "a_key": "A String", 852 }, 853 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If 854 # no Service Account is specified, the "default" service account is used. 855 "oauthScopes": [ # The set of Google API scopes to be made available on all of the 856 # node VMs under the "default" service account. 857 # 858 # The following scopes are recommended, but not required, and by default are 859 # not included: 860 # 861 # * `https://www.googleapis.com/auth/compute` is required for mounting 862 # persistent storage on your nodes. 863 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for 864 # communicating with **gcr.io** 865 # (the [Google Container Registry](/container-registry/)). 866 # 867 # If unspecified, no scopes are added, unless Cloud Logging or Cloud 868 # Monitoring are enabled, in which case their required scopes will be added. 869 "A String", 870 ], 871 "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') 872 # 873 # If unspecified, the default disk type is 'pd-standard' 874 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. 875 # The smallest allowed disk size is 10GB. 876 # 877 # If unspecified, the default disk size is 100GB. 878 "accelerators": [ # A list of hardware accelerators to be attached to each node. 879 # See https://cloud.google.com/compute/docs/gpus for more information about 880 # support for GPUs. 881 { # AcceleratorConfig represents a Hardware Accelerator request. 882 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. 883 "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators 884 # [here](/compute/docs/gpus/#Introduction) 885 }, 886 ], 887 "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be 888 # scheduled on the specified or newer CPU platform. Applicable values are the 889 # friendly names of CPU platforms, such as 890 # <code>minCpuPlatform: "Intel Haswell"</code> or 891 # <code>minCpuPlatform: "Intel Sandy Bridge"</code>. For more 892 # information, read [how to specify min CPU 893 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) 894 "metadata": { # The metadata key/value pairs assigned to instances in the cluster. 895 # 896 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes 897 # in length. These are reflected as part of a URL in the metadata server. 898 # Additionally, to avoid ambiguity, keys must not conflict with any other 899 # metadata keys for the project or be one of the reserved keys: 900 # "cluster-location" 901 # "cluster-name" 902 # "cluster-uid" 903 # "configure-sh" 904 # "containerd-configure-sh" 905 # "enable-os-login" 906 # "gci-update-strategy" 907 # "gci-ensure-gke-docker" 908 # "instance-template" 909 # "kube-env" 910 # "startup-script" 911 # "user-data" 912 # "disable-address-manager" 913 # "windows-startup-script-ps1" 914 # "common-psm1" 915 # "k8s-node-setup-psm1" 916 # "install-ssh-psm1" 917 # "user-profile-psm1" 918 # "serial-port-logging-enable" 919 # 920 # Values are free-form strings, and only have meaning as interpreted by 921 # the image running in the instance. The only restriction placed on them is 922 # that each value's size must be less than or equal to 32 KB. 923 # 924 # The total size of all keys and values must be less than 512 KB. 925 "a_key": "A String", 926 }, 927 "imageType": "A String", # The image type to use for this node. Note that for a given image type, 928 # the latest version of it will be used. 929 "localSsdCount": 42, # The number of local SSD disks to be attached to the node. 930 # 931 # The limit for this value is dependant upon the maximum number of 932 # disks available on a machine per zone. See: 933 # https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits 934 # for more information. 935 }, 936 "conditions": [ # Which conditions caused the current node pool state. 937 { # StatusCondition describes why a cluster or a node pool has a certain status 938 # (e.g., ERROR or DEGRADED). 939 "message": "A String", # Human-friendly representation of the condition 940 "code": "A String", # Machine-friendly representation of the condition 941 }, 942 ], 943 "selfLink": "A String", # [Output only] Server-defined URL for the resource. 944 }, 945 ], 946 }</pre> 947</div> 948 949<div class="method"> 950 <code class="details" id="rollback">rollback(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</code> 951 <pre>Rolls back a previously Aborted or Failed NodePool upgrade. 952This makes no changes if the last upgrade successfully completed. 953 954Args: 955 projectId: string, Deprecated. The Google Developers Console [project ID or project 956number](https://support.google.com/cloud/answer/6158840). 957This field has been deprecated and replaced by the name field. (required) 958 zone: string, Deprecated. The name of the Google Compute Engine 959[zone](/compute/docs/zones#available) in which the cluster 960resides. 961This field has been deprecated and replaced by the name field. (required) 962 clusterId: string, Deprecated. The name of the cluster to rollback. 963This field has been deprecated and replaced by the name field. (required) 964 nodePoolId: string, Deprecated. The name of the node pool to rollback. 965This field has been deprecated and replaced by the name field. (required) 966 body: object, The request body. (required) 967 The object takes the form of: 968 969{ # RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed 970 # NodePool upgrade. This will be an no-op if the last upgrade successfully 971 # completed. 972 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project 973 # number](https://support.google.com/cloud/answer/6158840). 974 # This field has been deprecated and replaced by the name field. 975 "clusterId": "A String", # Deprecated. The name of the cluster to rollback. 976 # This field has been deprecated and replaced by the name field. 977 "name": "A String", # The name (project, location, cluster, node pool id) of the node poll to 978 # rollback upgrade. 979 # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. 980 "zone": "A String", # Deprecated. The name of the Google Compute Engine 981 # [zone](/compute/docs/zones#available) in which the cluster 982 # resides. 983 # This field has been deprecated and replaced by the name field. 984 "nodePoolId": "A String", # Deprecated. The name of the node pool to rollback. 985 # This field has been deprecated and replaced by the name field. 986 } 987 988 x__xgafv: string, V1 error format. 989 Allowed values 990 1 - v1 error format 991 2 - v2 error format 992 993Returns: 994 An object of the form: 995 996 { # This operation resource represents operations that may have happened or are 997 # happening on the cluster. All fields are output only. 998 "status": "A String", # The current status of the operation. 999 "selfLink": "A String", # Server-defined URL for the resource. 1000 "name": "A String", # The server-assigned ID for the operation. 1001 "zone": "A String", # The name of the Google Compute Engine 1002 # [zone](/compute/docs/zones#available) in which the operation 1003 # is taking place. 1004 # This field is deprecated, use location instead. 1005 "startTime": "A String", # [Output only] The time the operation started, in 1006 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1007 "detail": "A String", # Detailed operation progress, if available. 1008 "operationType": "A String", # The operation type. 1009 "targetLink": "A String", # Server-defined URL for the target of the operation. 1010 "location": "A String", # [Output only] The name of the Google Compute Engine 1011 # [zone](/compute/docs/regions-zones/regions-zones#available) or 1012 # [region](/compute/docs/regions-zones/regions-zones#available) in which 1013 # the cluster resides. 1014 "nodepoolConditions": [ # Which conditions caused the current node pool state. 1015 { # StatusCondition describes why a cluster or a node pool has a certain status 1016 # (e.g., ERROR or DEGRADED). 1017 "message": "A String", # Human-friendly representation of the condition 1018 "code": "A String", # Machine-friendly representation of the condition 1019 }, 1020 ], 1021 "endTime": "A String", # [Output only] The time the operation completed, in 1022 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1023 "statusMessage": "A String", # If an error has occurred, a textual description of the error. 1024 "clusterConditions": [ # Which conditions caused the current cluster state. 1025 { # StatusCondition describes why a cluster or a node pool has a certain status 1026 # (e.g., ERROR or DEGRADED). 1027 "message": "A String", # Human-friendly representation of the condition 1028 "code": "A String", # Machine-friendly representation of the condition 1029 }, 1030 ], 1031 }</pre> 1032</div> 1033 1034<div class="method"> 1035 <code class="details" id="setManagement">setManagement(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</code> 1036 <pre>Sets the NodeManagement options for a node pool. 1037 1038Args: 1039 projectId: string, Deprecated. The Google Developers Console [project ID or project 1040number](https://support.google.com/cloud/answer/6158840). 1041This field has been deprecated and replaced by the name field. (required) 1042 zone: string, Deprecated. The name of the Google Compute Engine 1043[zone](/compute/docs/zones#available) in which the cluster 1044resides. 1045This field has been deprecated and replaced by the name field. (required) 1046 clusterId: string, Deprecated. The name of the cluster to update. 1047This field has been deprecated and replaced by the name field. (required) 1048 nodePoolId: string, Deprecated. The name of the node pool to update. 1049This field has been deprecated and replaced by the name field. (required) 1050 body: object, The request body. (required) 1051 The object takes the form of: 1052 1053{ # SetNodePoolManagementRequest sets the node management properties of a node 1054 # pool. 1055 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for the node pool. 1056 # node pool. 1057 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node 1058 # pool. If enabled, the nodes in this node pool will be monitored and, if 1059 # they fail health checks too many times, an automatic repair action will be 1060 # triggered. 1061 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. 1062 # the Auto Upgrades will proceed. 1063 "description": "A String", # [Output only] This field is set when upgrades are about to commence 1064 # with the description of the upgrade. 1065 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence 1066 # with the approximate start time for the upgrades, in 1067 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1068 }, 1069 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node 1070 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool 1071 # up to date with the latest release version of Kubernetes. 1072 }, 1073 "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set 1074 # management properties. Specified in the format 1075 # 'projects/*/locations/*/clusters/*/nodePools/*'. 1076 "zone": "A String", # Deprecated. The name of the Google Compute Engine 1077 # [zone](/compute/docs/zones#available) in which the cluster 1078 # resides. 1079 # This field has been deprecated and replaced by the name field. 1080 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project 1081 # number](https://support.google.com/cloud/answer/6158840). 1082 # This field has been deprecated and replaced by the name field. 1083 "clusterId": "A String", # Deprecated. The name of the cluster to update. 1084 # This field has been deprecated and replaced by the name field. 1085 "nodePoolId": "A String", # Deprecated. The name of the node pool to update. 1086 # This field has been deprecated and replaced by the name field. 1087 } 1088 1089 x__xgafv: string, V1 error format. 1090 Allowed values 1091 1 - v1 error format 1092 2 - v2 error format 1093 1094Returns: 1095 An object of the form: 1096 1097 { # This operation resource represents operations that may have happened or are 1098 # happening on the cluster. All fields are output only. 1099 "status": "A String", # The current status of the operation. 1100 "selfLink": "A String", # Server-defined URL for the resource. 1101 "name": "A String", # The server-assigned ID for the operation. 1102 "zone": "A String", # The name of the Google Compute Engine 1103 # [zone](/compute/docs/zones#available) in which the operation 1104 # is taking place. 1105 # This field is deprecated, use location instead. 1106 "startTime": "A String", # [Output only] The time the operation started, in 1107 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1108 "detail": "A String", # Detailed operation progress, if available. 1109 "operationType": "A String", # The operation type. 1110 "targetLink": "A String", # Server-defined URL for the target of the operation. 1111 "location": "A String", # [Output only] The name of the Google Compute Engine 1112 # [zone](/compute/docs/regions-zones/regions-zones#available) or 1113 # [region](/compute/docs/regions-zones/regions-zones#available) in which 1114 # the cluster resides. 1115 "nodepoolConditions": [ # Which conditions caused the current node pool state. 1116 { # StatusCondition describes why a cluster or a node pool has a certain status 1117 # (e.g., ERROR or DEGRADED). 1118 "message": "A String", # Human-friendly representation of the condition 1119 "code": "A String", # Machine-friendly representation of the condition 1120 }, 1121 ], 1122 "endTime": "A String", # [Output only] The time the operation completed, in 1123 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1124 "statusMessage": "A String", # If an error has occurred, a textual description of the error. 1125 "clusterConditions": [ # Which conditions caused the current cluster state. 1126 { # StatusCondition describes why a cluster or a node pool has a certain status 1127 # (e.g., ERROR or DEGRADED). 1128 "message": "A String", # Human-friendly representation of the condition 1129 "code": "A String", # Machine-friendly representation of the condition 1130 }, 1131 ], 1132 }</pre> 1133</div> 1134 1135<div class="method"> 1136 <code class="details" id="setSize">setSize(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</code> 1137 <pre>Sets the size for a specific node pool. 1138 1139Args: 1140 projectId: string, Deprecated. The Google Developers Console [project ID or project 1141number](https://support.google.com/cloud/answer/6158840). 1142This field has been deprecated and replaced by the name field. (required) 1143 zone: string, Deprecated. The name of the Google Compute Engine 1144[zone](/compute/docs/zones#available) in which the cluster 1145resides. 1146This field has been deprecated and replaced by the name field. (required) 1147 clusterId: string, Deprecated. The name of the cluster to update. 1148This field has been deprecated and replaced by the name field. (required) 1149 nodePoolId: string, Deprecated. The name of the node pool to update. 1150This field has been deprecated and replaced by the name field. (required) 1151 body: object, The request body. (required) 1152 The object takes the form of: 1153 1154{ # SetNodePoolSizeRequest sets the size a node 1155 # pool. 1156 "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set 1157 # size. 1158 # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. 1159 "zone": "A String", # Deprecated. The name of the Google Compute Engine 1160 # [zone](/compute/docs/zones#available) in which the cluster 1161 # resides. 1162 # This field has been deprecated and replaced by the name field. 1163 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project 1164 # number](https://support.google.com/cloud/answer/6158840). 1165 # This field has been deprecated and replaced by the name field. 1166 "clusterId": "A String", # Deprecated. The name of the cluster to update. 1167 # This field has been deprecated and replaced by the name field. 1168 "nodePoolId": "A String", # Deprecated. The name of the node pool to update. 1169 # This field has been deprecated and replaced by the name field. 1170 "nodeCount": 42, # The desired node count for the pool. 1171 } 1172 1173 x__xgafv: string, V1 error format. 1174 Allowed values 1175 1 - v1 error format 1176 2 - v2 error format 1177 1178Returns: 1179 An object of the form: 1180 1181 { # This operation resource represents operations that may have happened or are 1182 # happening on the cluster. All fields are output only. 1183 "status": "A String", # The current status of the operation. 1184 "selfLink": "A String", # Server-defined URL for the resource. 1185 "name": "A String", # The server-assigned ID for the operation. 1186 "zone": "A String", # The name of the Google Compute Engine 1187 # [zone](/compute/docs/zones#available) in which the operation 1188 # is taking place. 1189 # This field is deprecated, use location instead. 1190 "startTime": "A String", # [Output only] The time the operation started, in 1191 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1192 "detail": "A String", # Detailed operation progress, if available. 1193 "operationType": "A String", # The operation type. 1194 "targetLink": "A String", # Server-defined URL for the target of the operation. 1195 "location": "A String", # [Output only] The name of the Google Compute Engine 1196 # [zone](/compute/docs/regions-zones/regions-zones#available) or 1197 # [region](/compute/docs/regions-zones/regions-zones#available) in which 1198 # the cluster resides. 1199 "nodepoolConditions": [ # Which conditions caused the current node pool state. 1200 { # StatusCondition describes why a cluster or a node pool has a certain status 1201 # (e.g., ERROR or DEGRADED). 1202 "message": "A String", # Human-friendly representation of the condition 1203 "code": "A String", # Machine-friendly representation of the condition 1204 }, 1205 ], 1206 "endTime": "A String", # [Output only] The time the operation completed, in 1207 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1208 "statusMessage": "A String", # If an error has occurred, a textual description of the error. 1209 "clusterConditions": [ # Which conditions caused the current cluster state. 1210 { # StatusCondition describes why a cluster or a node pool has a certain status 1211 # (e.g., ERROR or DEGRADED). 1212 "message": "A String", # Human-friendly representation of the condition 1213 "code": "A String", # Machine-friendly representation of the condition 1214 }, 1215 ], 1216 }</pre> 1217</div> 1218 1219<div class="method"> 1220 <code class="details" id="update">update(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</code> 1221 <pre>Updates the version and/or image type for the specified node pool. 1222 1223Args: 1224 projectId: string, Deprecated. The Google Developers Console [project ID or project 1225number](https://support.google.com/cloud/answer/6158840). 1226This field has been deprecated and replaced by the name field. (required) 1227 zone: string, Deprecated. The name of the Google Compute Engine 1228[zone](/compute/docs/zones#available) in which the cluster 1229resides. 1230This field has been deprecated and replaced by the name field. (required) 1231 clusterId: string, Deprecated. The name of the cluster to upgrade. 1232This field has been deprecated and replaced by the name field. (required) 1233 nodePoolId: string, Deprecated. The name of the node pool to upgrade. 1234This field has been deprecated and replaced by the name field. (required) 1235 body: object, The request body. (required) 1236 The object takes the form of: 1237 1238{ # UpdateNodePoolRequests update a node pool's image and/or version. 1239 "name": "A String", # The name (project, location, cluster, node pool) of the node pool to 1240 # update. Specified in the format 1241 # 'projects/*/locations/*/clusters/*/nodePools/*'. 1242 "zone": "A String", # Deprecated. The name of the Google Compute Engine 1243 # [zone](/compute/docs/zones#available) in which the cluster 1244 # resides. 1245 # This field has been deprecated and replaced by the name field. 1246 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project 1247 # number](https://support.google.com/cloud/answer/6158840). 1248 # This field has been deprecated and replaced by the name field. 1249 "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. 1250 # This field has been deprecated and replaced by the name field. 1251 "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. 1252 # This field has been deprecated and replaced by the name field. 1253 "nodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an 1254 # upgrade). 1255 # 1256 # Users may specify either explicit versions offered by Kubernetes Engine or 1257 # version aliases, which have the following behavior: 1258 # 1259 # - "latest": picks the highest valid Kubernetes version 1260 # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version 1261 # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version 1262 # - "1.X.Y-gke.N": picks an explicit Kubernetes version 1263 # - "-": picks the Kubernetes master version 1264 "imageType": "A String", # The desired image type for the node pool. 1265 } 1266 1267 x__xgafv: string, V1 error format. 1268 Allowed values 1269 1 - v1 error format 1270 2 - v2 error format 1271 1272Returns: 1273 An object of the form: 1274 1275 { # This operation resource represents operations that may have happened or are 1276 # happening on the cluster. All fields are output only. 1277 "status": "A String", # The current status of the operation. 1278 "selfLink": "A String", # Server-defined URL for the resource. 1279 "name": "A String", # The server-assigned ID for the operation. 1280 "zone": "A String", # The name of the Google Compute Engine 1281 # [zone](/compute/docs/zones#available) in which the operation 1282 # is taking place. 1283 # This field is deprecated, use location instead. 1284 "startTime": "A String", # [Output only] The time the operation started, in 1285 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1286 "detail": "A String", # Detailed operation progress, if available. 1287 "operationType": "A String", # The operation type. 1288 "targetLink": "A String", # Server-defined URL for the target of the operation. 1289 "location": "A String", # [Output only] The name of the Google Compute Engine 1290 # [zone](/compute/docs/regions-zones/regions-zones#available) or 1291 # [region](/compute/docs/regions-zones/regions-zones#available) in which 1292 # the cluster resides. 1293 "nodepoolConditions": [ # Which conditions caused the current node pool state. 1294 { # StatusCondition describes why a cluster or a node pool has a certain status 1295 # (e.g., ERROR or DEGRADED). 1296 "message": "A String", # Human-friendly representation of the condition 1297 "code": "A String", # Machine-friendly representation of the condition 1298 }, 1299 ], 1300 "endTime": "A String", # [Output only] The time the operation completed, in 1301 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1302 "statusMessage": "A String", # If an error has occurred, a textual description of the error. 1303 "clusterConditions": [ # Which conditions caused the current cluster state. 1304 { # StatusCondition describes why a cluster or a node pool has a certain status 1305 # (e.g., ERROR or DEGRADED). 1306 "message": "A String", # Human-friendly representation of the condition 1307 "code": "A String", # Machine-friendly representation of the condition 1308 }, 1309 ], 1310 }</pre> 1311</div> 1312 1313</body></html>