REST Resource: projects.locations.operations

Resource: Operation

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

JSON representation 
{
  "name": string,
  "zone": string,
  "operationType": enum (Type),
  "status": enum (Status),
  "detail": string,
  "statusMessage": string,
  "selfLink": string,
  "targetLink": string,
  "location": string,
  "startTime": string,
  "endTime": string,
  "progress": {
    object (OperationProgress)
  },
  "clusterConditions": [
    {
      object (StatusCondition)
    }
  ],
  "nodepoolConditions": [
    {
      object (StatusCondition)
    }
  ],
  "error": {
    object (Status)
  }
}
Fields
name

string

Output only. The server-assigned ID for the operation.
zone
(deprecated)

string

Output only. The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.
operationType

enum (Type)

Output only. The operation type.
status

enum (Status)

Output only. The current status of the operation.
detail

string

Output only. Detailed operation progress, if available.
statusMessage
(deprecated)

string

Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
location

string

Output only. The name of the Google Compute Engine zone or region in which the cluster resides.
startTime

string

Output only. The time the operation started, in RFC3339 text format.
endTime

string

Output only. The time the operation completed, in RFC3339 text format.
progress

object (OperationProgress)

Output only. Progress information for an operation.
clusterConditions[]
(deprecated)

object (StatusCondition)

Which conditions caused the current cluster state. Deprecated. Use field error instead.
nodepoolConditions[]
(deprecated)

object (StatusCondition)

Which conditions caused the current node pool state. Deprecated. Use field error instead.
error

object (Status)

The error result of the operation in case of failure.

Type

Operation type categorizes the operation.

Enums
TYPE_UNSPECIFIED Not set.
CREATE_CLUSTER

The cluster is being created. The cluster should be assumed to be unusable until the operation finishes.

In the event of the operation failing, the cluster will enter the [ERROR state][Cluster.Status.ERROR] and eventually be deleted.
DELETE_CLUSTER

The cluster is being deleted. The cluster should be assumed to be unusable as soon as this operation starts.

In the event of the operation failing, the cluster will enter the [ERROR state][Cluster.Status.ERROR] and the deletion will be automatically retried until completed.
UPGRADE_MASTER The cluster version is being updated. Note that this includes "upgrades" to the same version, which are simply a recreation. This also includes auto-upgrades. For more details, see documentation on cluster upgrades.
UPGRADE_NODES

A node pool is being updated. Despite calling this an "upgrade", this includes most forms of updates to node pools. This also includes auto-upgrades.

This operation sets the progress field and may be canceled.

The upgrade strategy depends on node pool configuration. The nodes are generally still usable during this operation.
REPAIR_CLUSTER A problem has been detected with the control plane and is being repaired. This operation type is initiated by GKE. For more details, see documentation on repairs.
UPDATE_CLUSTER

The cluster is being updated. This is a broad category of operations and includes operations that only change metadata as well as those that must recreate the entire cluster. If the control plane must be recreated, this will cause temporary downtime for zonal clusters.

Some features require recreating the nodes as well. Those will be recreated as separate operations and the update may not be completely functional until the node pools recreations finish. Node recreations will generally follow maintenance policies.

Some GKE-initiated operations use this type. This includes certain types of auto-upgrades and incident mitigations.
CREATE_NODE_POOL

A node pool is being created. The node pool should be assumed to be unusable until this operation finishes. In the event of an error, the node pool may be partially created.

If enabled, node autoprovisioning may have automatically initiated such operations.
DELETE_NODE_POOL The node pool is being deleted. The node pool should be assumed to be unusable as soon as this operation starts.
SET_NODE_POOL_MANAGEMENT The node pool's manamagent field is being updated. These operations only update metadata and may be concurrent with most other operations.
AUTO_REPAIR_NODES A problem has been detected with nodes and they are being repaired. This operation type is initiated by GKE, typically automatically. This operation may be concurrent with other operations and there may be multiple repairs occurring on the same node pool.
AUTO_UPGRADE_NODES

Unused. Automatic node upgrade uses UPGRADE_NODES.
SET_LABELS

Unused. Updating labels uses UPDATE_CLUSTER.
SET_MASTER_AUTH

Unused. Updating master auth uses UPDATE_CLUSTER.
SET_NODE_POOL_SIZE The node pool is being resized. With the exception of resizing to or from size zero, the node pool is generally usable during this operation.
SET_NETWORK_POLICY

Unused. Updating network policy uses UPDATE_CLUSTER.
SET_MAINTENANCE_POLICY

Unused. Updating maintenance policy uses UPDATE_CLUSTER.
RESIZE_CLUSTER The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see documentation on resizes.
FLEET_FEATURE_UPGRADE Fleet features of GKE Enterprise are being upgraded. The cluster should be assumed to be blocked for other upgrades until the operation finishes.

Status

Current status of the operation.

Enums
STATUS_UNSPECIFIED Not set.
PENDING The operation has been created.
RUNNING The operation is currently running.
DONE The operation is done, either cancelled or completed.
ABORTING The operation is aborting.

OperationProgress

Information about operation (or operation stage) progress.

JSON representation 
{
  "name": string,
  "status": enum (Status),
  "metrics": [
    {
      object (Metric)
    }
  ],
  "stages": [
    {
      object (OperationProgress)
    }
  ]
}
Fields
name

string

A non-parameterized string describing an operation stage. Unset for single-stage operations.
status

enum (Status)

Status of an operation stage. Unset for single-stage operations.
metrics[]

object (Metric)

Progress metric bundle, for example: metrics: [{name: "nodes done", intValue: 15}, {name: "nodes total", intValue: 32}] or metrics: [{name: "progress", doubleValue: 0.56}, {name: "progress scale", doubleValue: 1.0}]
stages[]

object (OperationProgress)

Substages of an operation or a stage.

Metric

Progress metric is (string, int|float|string) pair.

JSON representation 
{
  "name": string,

  // Union field value can be only one of the following:
  "intValue": string,
  "doubleValue": number,
  "stringValue": string
  // End of list of possible types for union field value.
}
Fields
name

string

Required. Metric name, e.g., "nodes total", "percent done".
Union field value. Strictly one of the values is required. value can be only one of the following:
intValue

string (int64 format)

For metrics with integer value.
doubleValue

number

For metrics with floating point value.
stringValue

string

For metrics with custom values (ratios, visual progress, etc.).

Methods

cancel

 Cancels the specified operation.

get

 Gets the specified operation.

list

 Lists all operations in a project in the specified zone or all zones.