gateway.openapi_Gateway

Update Node Pool

patch/v1/accounts/{account_id}/nodePools/{node_pool_id}

Path parameters

account_idstring required

The Account Id

node_pool_idstring required

The Node Pool Id

Request body

displayNamestring

Human-readable display name of the node pool. e.g. "My Node Pool" Must be fewer than 64 characters long.

createTimestring date-time

The creation time of the node pool.

minNodeCountinteger

https://cloud.google.com/kubernetes-engine/quotas Minimum number of nodes in this node pool. Must be a non-negative integer less than or equal to max_node_count. If not specified, the default is 0.

maxNodeCountinteger

https://cloud.google.com/kubernetes-engine/quotas Maximum number of nodes in this node pool. Must be a positive integer greater than or equal to min_node_count. If not specified, the default is 1.

overprovisionNodeCountinteger

The number of nodes to overprovision by the autoscaler. Must be a non-negative integer and less than or equal to min_node_count and max_node_count-min_node_count. If not specified, the default is 0.

annotationsobject

Arbitrary, user-specified metadata. Keys and values must adhere to Kubernetes constraints: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set Additionally, the "fireworks.ai/" prefix is reserved.

state'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'DELETING' | 'FAILED'
  • CREATING: The cluster is still being created.
  • READY: The node pool is ready to be used.
  • DELETING: The node pool is being deleted.
  • FAILED: Node pool is not operational. Consult 'status' for detailed messaging. Node pool needs to be deleted and re-created.
updateTimestring date-time

The update time for the node pool.

Response

A successful response.

namestring
displayNamestring

Human-readable display name of the node pool. e.g. "My Node Pool" Must be fewer than 64 characters long.

createTimestring date-time

The creation time of the node pool.

minNodeCountinteger

https://cloud.google.com/kubernetes-engine/quotas Minimum number of nodes in this node pool. Must be a non-negative integer less than or equal to max_node_count. If not specified, the default is 0.

maxNodeCountinteger

https://cloud.google.com/kubernetes-engine/quotas Maximum number of nodes in this node pool. Must be a positive integer greater than or equal to min_node_count. If not specified, the default is 1.

overprovisionNodeCountinteger

The number of nodes to overprovision by the autoscaler. Must be a non-negative integer and less than or equal to min_node_count and max_node_count-min_node_count. If not specified, the default is 0.

annotationsobject

Arbitrary, user-specified metadata. Keys and values must adhere to Kubernetes constraints: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set Additionally, the "fireworks.ai/" prefix is reserved.

state'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'DELETING' | 'FAILED'
  • CREATING: The cluster is still being created.
  • READY: The node pool is ready to be used.
  • DELETING: The node pool is being deleted.
  • FAILED: Node pool is not operational. Consult 'status' for detailed messaging. Node pool needs to be deleted and re-created.
updateTimestring date-time

The update time for the node pool.

Changes

Changed in 1 of the 27 revisions of this API.3

    • the endpoint scheme security BearerAuth was added to the API

      api-security-added

    • api tag gateway.openapi_Gateway added

      api-tag-added

    • api tag Gateway removed

      api-tag-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog