Jump to

• Request
• Response

UpdateCluster

put

/20180222/clusters/{cluster_id}

Update the details of a cluster.

Request

Supported Media Types

• application/json

Path Parameters

• clusterId(required): string
  The OCID of the cluster.

Header Parameters

• if-match: string
  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

The details of the cluster to update.

Root Schema : UpdateClusterDetails

Type: object

The properties that define a request to update a cluster.

Show Source

• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
• governancePolicyConfig: object UpdateGovernancePolicyConfigDetails
  The properties that define policy governance.
• imagePolicyConfig: object UpdateImagePolicyConfigDetails
  The properties that define a image verification policy.
• kubernetesVersion: string
  The version of Kubernetes to which to upgrade the control plane nodes.

  Example: 1.28.3
• name: string
  The new name for the cluster. Avoid entering confidential information.

  Example: My Updated Cluster
• options: object UpdateClusterOptionsDetails
  The properties that define extra options updating a cluster.

{
    "type":"object",
    "description":"The properties that define a request to update a cluster.",
    "properties":{
        "name":{
            "type":"string",
            "description":"The new name for the cluster. Avoid entering confidential information.",
            "example":"My Updated Cluster"
        },
        "kubernetesVersion":{
            "type":"string",
            "description":"The version of Kubernetes to which to upgrade the control plane nodes.",
            "example":"1.28.3"
        },
        "options":{
            "$ref":"#/definitions/UpdateClusterOptionsDetails"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "example":{
                "Department":"Finance"
            }
        },
        "definedTags":{
            "type":"object",
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported."
                }
            },
            "example":{
                "Operations":{
                    "CostCenter":"42"
                }
            }
        },
        "imagePolicyConfig":{
            "$ref":"#/definitions/UpdateImagePolicyConfigDetails",
            "description":"The image verification policy for signature validation. Once a policy is created and enabled with one or more kms keys, the policy will ensure all images deployed has been signed with the key(s) attached to the policy."
        },
        "governancePolicyConfig":{
            "$ref":"#/definitions/UpdateGovernancePolicyConfigDetails",
            "description":"Governance policy configuration."
        }
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

{
    "type":"object",
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported."
        }
    },
    "example":{
        "Operations":{
            "CostCenter":"42"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}

Example:

{
    "Operations":{
        "CostCenter":"42"
    }
}

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "example":{
        "Department":"Finance"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Example:

{
    "Department":"Finance"
}

Nested Schema : UpdateGovernancePolicyConfigDetails

Type: object

The properties that define policy governance.

Match All

Show Source

• object GovernancePolicyConfig
  The properties that define whether policy governance is enabled.

{
    "description":"The properties that define policy governance.",
    "allOf":[
        {
            "$ref":"#/definitions/GovernancePolicyConfig"
        }
    ],
    "type":"object"
}

Nested Schema : UpdateImagePolicyConfigDetails

Type: object

The properties that define a image verification policy.

Match All

Show Source

• object ImagePolicyConfig
  The properties that define a image verification policy.

{
    "description":"The properties that define a image verification policy.",
    "allOf":[
        {
            "$ref":"#/definitions/ImagePolicyConfig"
        }
    ],
    "type":"object"
}

Nested Schema : UpdateClusterOptionsDetails

Type: object

The properties that define extra options updating a cluster.

Show Source

• admissionControllerOptions: object AdmissionControllerOptions
  The properties that define supported admission controllers.
• persistentVolumeConfig: object PersistentVolumeConfigDetails
  Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
• serviceLbConfig: object ServiceLbConfigDetails
  Configuration to be applied to load balancers created by Kubernetes services

{
    "type":"object",
    "description":"The properties that define extra options updating a cluster.",
    "properties":{
        "admissionControllerOptions":{
            "description":"Configurable cluster admission controllers.",
            "$ref":"#/definitions/AdmissionControllerOptions"
        },
        "persistentVolumeConfig":{
            "$ref":"#/definitions/PersistentVolumeConfigDetails"
        },
        "serviceLbConfig":{
            "$ref":"#/definitions/ServiceLbConfigDetails"
        }
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported."
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Nested Schema : GovernancePolicyConfig

Type: object

The properties that define whether policy governance is enabled.

Show Source

• isPolicyEnabled: boolean
  Default Value: false

  Whether the policy governance is enabled. Defaults to false.
• policyId: string
  Minimum Length: 1

  Maximum Length: 255

  Unique policy identifier.

{
    "type":"object",
    "description":"The properties that define whether policy governance is enabled.",
    "properties":{
        "isPolicyEnabled":{
            "type":"boolean",
            "description":"Whether the policy governance is enabled. Defaults to false.",
            "default":false
        },
        "policyId":{
            "type":"string",
            "description":"Unique policy identifier.",
            "minLength":"1",
            "maxLength":"255"
        }
    }
}

Nested Schema : ImagePolicyConfig

Type: object

The properties that define a image verification policy.

Show Source

• isPolicyEnabled: boolean
  Default Value: false

  Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.
• keyDetails: array keyDetails
  A list of KMS key details.

{
    "type":"object",
    "description":"The properties that define a image verification policy.",
    "properties":{
        "isPolicyEnabled":{
            "type":"boolean",
            "description":"Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.",
            "default":false
        },
        "keyDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/KeyDetails"
            },
            "description":"A list of KMS key details."
        }
    }
}

Nested Schema : keyDetails

Type: array

A list of KMS key details.

Show Source

• Array of: object KeyDetails
  The properties that define the kms keys used by OKE for Image Signature verification.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/KeyDetails"
    },
    "description":"A list of KMS key details."
}

Nested Schema : KeyDetails

Type: object

The properties that define the kms keys used by OKE for Image Signature verification.

Show Source

• kmsKeyId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCIDs of the KMS key that will be used to verify whether the images are signed by an approved source.

{
    "type":"object",
    "description":"The properties that define the kms keys used by OKE for Image Signature verification.",
    "properties":{
        "kmsKeyId":{
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "description":"The OCIDs of the KMS key that will be used to verify whether the images are signed by an approved source."
        }
    }
}

Nested Schema : AdmissionControllerOptions

Type: object

The properties that define supported admission controllers.

Show Source

• isPodSecurityPolicyEnabled: boolean
  Default Value: false

  Whether or not to enable the Pod Security Policy admission controller.

  Example: false

{
    "type":"object",
    "description":"The properties that define supported admission controllers.",
    "properties":{
        "isPodSecurityPolicyEnabled":{
            "description":"Whether or not to enable the Pod Security Policy admission controller.",
            "type":"boolean",
            "example":false,
            "default":false
        }
    }
}

Nested Schema : PersistentVolumeConfigDetails

Type: object

Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)

Show Source

• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

{
    "type":"object",
    "description":"Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)",
    "properties":{
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "example":{
                "Department":"Finance"
            }
        },
        "definedTags":{
            "type":"object",
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported."
                }
            },
            "example":{
                "Operations":{
                    "CostCenter":"42"
                }
            }
        }
    }
}

Nested Schema : ServiceLbConfigDetails

Type: object

Configuration to be applied to load balancers created by Kubernetes services

Show Source

• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

{
    "type":"object",
    "description":"Configuration to be applied to load balancers created by Kubernetes services",
    "properties":{
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "example":{
                "Department":"Finance"
            }
        },
        "definedTags":{
            "type":"object",
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported."
                }
            },
            "example":{
                "Operations":{
                    "CostCenter":"42"
                }
            }
        }
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

{
    "type":"object",
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported."
        }
    },
    "example":{
        "Operations":{
            "CostCenter":"42"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}

Example:

{
    "Operations":{
        "CostCenter":"42"
    }
}

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "example":{
        "Department":"Finance"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Example:

{
    "Department":"Finance"
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported."
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

{
    "type":"object",
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported."
        }
    },
    "example":{
        "Operations":{
            "CostCenter":"42"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}

Example:

{
    "Operations":{
        "CostCenter":"42"
    }
}

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "example":{
        "Department":"Finance"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Example:

{
    "Department":"Finance"
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported."
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
• opc-work-request-id: string
  The OCID of the work request handling the operation.

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

412 Response

Precondition Failed

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top