Method: projects.locations.clusters.upgrade

Upgrades a single cluster.

HTTP request

POST https://edgecontainer.googleapis.com/v1/{name=projects/*/locations/*/clusters/*}:upgrade

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the cluster.

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

  • edgecontainer.clusters.upgrade

Request body

The request body contains data with the following structure:

JSON representation
{
  "targetVersion": string,
  "schedule": enum (Schedule),
  "requestId": string
}
Fields
targetVersion

string

Required. The version the cluster is going to be upgraded to.

schedule

enum (Schedule)

The schedule for the upgrade.

requestId

string

A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if requestId is provided.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Schedule

Represents the schedule about when the cluster is going to be upgraded.

Enums
SCHEDULE_UNSPECIFIED Unspecified. The default is to upgrade the cluster immediately which is the only option today.
IMMEDIATELY The cluster is going to be upgraded immediately after receiving the request.