1. REST API for Oracle Private Cloud Appliance Compute Enclave
  2. Tasks
  3. Container Engine
  4. Clusters

ListClusters

get

/20180222/clusters

List all the cluster objects in a compartment.

Request

Supported Media Types
Query Parameters
  • Minimum Length: 1
    Maximum Length: 255
    The OCID of the compartment.
  • Collection Format: multi
    A cluster lifecycle state to filter on. Can have multiple parameters of this name.
    • Allowed Values: [ "CREATING", "ACTIVE", "FAILED", "DELETING", "DELETED", "UPDATING" ]
  • Minimum Value: 1
    Maximum Value: 1000
    For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.
    Default Value: 100
  • The name to filter on.
  • Minimum Length: 1
    Maximum Length: 512
    For list pagination. The value of the opc-next-page response header from the previous List call.
    Default Value: 0
  • The optional field to sort the results by.
    Allowed Values: [ "ID", "NAME", "TIME_CREATED" ]
  • The sort order to use, either ascending (ASC) or descending (DESC).
    Default Value: ASC
    Allowed Values: [ "ASC", "DESC" ]
Header Parameters
  • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Back to Top

Response

Supported Media Types

200 Response

A list of cluster summary objects.
Headers
  • For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : ClusterSummary
Type: object
The properties that define a cluster summary.
Show Source
Nested Schema : availableKubernetesUpgrades
Type: array
Available Kubernetes versions to which the clusters masters may be upgraded.
Show Source
Nested Schema : clusterPodNetworkOptions
Type: array
Maximum Number of Items: 255
Unique Items Required: true
Available CNIs and network options for existing and new node pools of the cluster.
Show Source
Nested Schema : definedTags
Type: object
Additional Properties Allowed
Show Source
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"OraclePCA": {"sshkey": "ssh-rsa remainder_of_your_public_SSH_key", "cpNodeCount": 1, "cpNodeShape": "VM.PCAStandard1.Flex", "cpNodeShapeConfig": {"ocpus": 2, "memoryInGBs": 24}}}
Example:
{
    "Operations":{
        "CostCenter":42
    }
}
Nested Schema : ClusterEndpointConfig
Type: object
The properties that define the network configuration for the Cluster endpoint.
Show Source
  • Default Value: false
    Whether the cluster should be assigned a public IP address. Defaults to false. Set this to true.
  • nsgIds
    Maximum Number of Items: 5
    Unique Items Required: true
    A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint.
  • The regional subnet in which to place the cluster endpoint. Select the subnet that has configuration like the control-plane-endpoint subnet described in "Creating an OKE Control Plane Load Balancer Subnet" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/oke/oke-subnet-controlplanelb.html#oke-subnet-controlplanelb).
Nested Schema : ClusterEndpoints
Type: object
The properties that define endpoints for a cluster.
Show Source
  • The non-native networking Kubernetes API server endpoint.
    Example: https://yourkubernetes
  • The private native networking Kubernetes API server endpoint.
    Example: https://yourPrivateEndpoint
  • The public native networking Kubernetes API server endpoint, if one was requested.
    Example: https://yourPublicEndpoint
  • The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint'
    Example: https://clusterinfo.subnetLabel.vcnLabel.oraclevcn.com:6443
Nested Schema : freeformTags
Type: object
Additional Properties Allowed
Show Source
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 : GovernancePolicyConfig
Type: object
The properties that define whether policy governance is enabled.
Show Source
Nested Schema : ImagePolicyConfig
Type: object
The properties that define a image verification policy.
Show Source
Nested Schema : ClusterMetadata
Type: object
The properties that define metadata for a cluster.
Show Source
Nested Schema : ClusterCreateOptions
Type: object
The properties that define extra options for a cluster.
Show Source
Nested Schema : systemTags
Type: object
Additional Properties Allowed
Show Source
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}
Nested Schema : ClusterPodNetworkOptionDetails
Type: object
Discriminator: cniType
The CNI type and network details applicable to the node pools of the cluster.
Show Source
  • Minimum Length: 1
    Maximum Length: 255
    Allowed Values: [ "OCI_VCN_IP_NATIVE", "FLANNEL_OVERLAY" ]
    The CNI used by the node pools of this cluster.
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
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 : nsgIds
Type: array
Maximum Number of Items: 5
Unique Items Required: true
A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint.
Show Source
Nested Schema : keyDetails
Type: array
A list of KMS key details.
Show Source
Nested Schema : KeyDetails
Type: object
The properties that define the kms keys used by OKE for Image Signature verification.
Show Source
  • 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.
Nested Schema : AddOnOptions
Type: object
The properties that define options for supported add-ons.
Show Source
Nested Schema : AdmissionControllerOptions
Type: object
The properties that define supported admission controllers.
Show Source
Nested Schema : KubernetesNetworkConfig
Type: object
The properties that define the network configuration for Kubernetes.
Show Source
  • Default Value: 10.244.0.0/16
    The CIDR block for Kubernetes pods. Optional, defaults to 10.244.0.0/16.
    Example: 10.244.0.0/16
  • Default Value: 10.96.0.0/16
    The CIDR block for Kubernetes services. Optional, defaults to 10.96.0.0/16.
    Example: 10.96.0.0/16
Nested Schema : PersistentVolumeConfigDetails
Type: object
Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
Show Source
Nested Schema : ServiceLbConfigDetails
Type: object
Configuration to be applied to load balancers created by Kubernetes services
Show Source
Nested Schema : serviceLbSubnetIds
Type: array
The subnet that is configured to host the load balancer in an OKE cluster. Specify the OCID of the subnet that has the configuration of the service-lb subnet described in "Creating an OKE Worker Load Balancer Subnet" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/oke/oke-subnet-workerlb.html#oke-subnet-workerlb). Do not specify more than one subnet.
Show Source
  • Example: ocid1.subnet.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3ofzxtlyit
Nested Schema : definedTags
Type: object
Additional Properties Allowed
Show Source
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
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
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
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
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
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 : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`
Nested Schema : additionalProperties
Type: object
The value of the tag. Only string, integer and boolean types are supported.

401 Response

Unauthorized
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

404 Response

Not Found
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

429 Response

Too Many Requests
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

500 Response

Internal Server Error
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

Default Response

An error has occurred.
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.
Back to Top