Method: projects.locations.clusters.checkAutopilotCompatibility

Checks the cluster compatibility with Autopilot mode, and returns a list of compatibility issues.

HTTP request

GET https://container.googleapis.com/v1/{name=projects/*/locations/*/clusters/*}:checkAutopilotCompatibility

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The name (project, location, cluster) of the cluster to retrieve. Specified in the format projects/*/locations/*/clusters/*.

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

  • container.clusters.get

Request body

The request body must be empty.

Response body

CheckAutopilotCompatibilityResponse has a list of compatibility issues.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "issues": [
    {
      object (AutopilotCompatibilityIssue)
    }
  ],
  "summary": string
}
Fields
issues[]

object (AutopilotCompatibilityIssue)

The list of issues for the given operation.
summary

string

The summary of the autopilot compatibility response.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

AutopilotCompatibilityIssue

AutopilotCompatibilityIssue contains information about a specific compatibility issue with Autopilot mode.

JSON representation 
{
  "lastObservation": string,
  "constraintType": string,
  "incompatibilityType": enum (IssueType),
  "subjects": [
    string
  ],
  "documentationUrl": string,
  "description": string
}
Fields
lastObservation

string (Timestamp format)

The last time when this issue was observed.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
constraintType

string

The constraint type of the issue.
incompatibilityType

enum (IssueType)

The incompatibility type of this issue.
subjects[]

string

The name of the resources which are subject to this issue.
documentationUrl

string

A URL to a public documentation, which addresses resolving this issue.
description

string

The description of the issue.

IssueType

The type of the reported issue.

Enums
UNSPECIFIED Default value, should not be used.
INCOMPATIBILITY Indicates that the issue is a known incompatibility between the cluster and Autopilot mode.
ADDITIONAL_CONFIG_REQUIRED Indicates the issue is an incompatibility if customers take no further action to resolve.
PASSED_WITH_OPTIONAL_CONFIG Indicates the issue is not an incompatibility, but depending on the workloads business logic, there is a potential that they won't work on Autopilot.