ListClusters
get
/20180222/clusters
List all the cluster objects in a compartment.
Request
Supported Media Types
- application/json
Query Parameters
-
compartmentId(required): string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment. -
lifecycleState: array[string]
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" ]
-
-
limit: integer
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
-
name: string
The name to filter on.
-
page: string
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:oracle.doceng.json.BetterJsonNull@2c07545f
-
sortBy: string
The optional field to sort the results by.Allowed Values:
[ "ID", "NAME", "TIME_CREATED" ]
-
sortOrder: string
The sort order to use, either ascending (ASC) or descending (DESC).Allowed Values:
[ "ASC", "DESC" ]
Header Parameters
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Response
Supported Media Types
- application/json
200 Response
A list of cluster summary objects.
Headers
-
opc-next-page: string
For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object ClusterSummary
The properties that define a cluster summary.
Nested Schema : ClusterSummary
Type:
object
The properties that define a cluster summary.
Show Source
-
availableKubernetesUpgrades:
array availableKubernetesUpgrades
Available Kubernetes versions to which the clusters masters may be upgraded.
-
clusterPodNetworkOptions:
array clusterPodNetworkOptions
Maximum Number of Items:
255
Unique Items Required:true
Available CNIs and network options for existing and new node pools of the cluster. -
compartmentId:
string
The OCID of the compartment in which the cluster exists.Example:
ocid1.compartment.unique_ID
-
definedTags:
object definedTags
Additional Properties Allowed: additionalPropertiesDefined 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}}}
-
endpointConfig:
object ClusterEndpointConfig
The properties that define the network configuration for the Cluster endpoint.
-
endpoints:
object ClusterEndpoints
The properties that define endpoints for a cluster.
-
freeformTags:
object freeformTags
Additional Properties Allowed: additionalPropertiesFree-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 GovernancePolicyConfig
The properties that define whether policy governance is enabled.
-
id:
string
The OCID of the cluster.Example:
ocid1.cluster.unique_ID
-
imagePolicyConfig:
object ImagePolicyConfig
The properties that define a image verification policy.
-
kubernetesVersion:
string
The version of Kubernetes to run on the control plane nodes.Example:
1.28.3
-
lifecycleDetails:
string
Details about the state of the cluster masters.Example:
waiting for node pools
-
lifecycleState:
string
Allowed Values:
[ "CREATING", "ACTIVE", "FAILED", "DELETING", "DELETED", "UPDATING" ]
The state of the cluster masters.Example:UPDATING
-
metadata:
object ClusterMetadata
The properties that define metadata for a cluster.
-
name:
string
The name of the cluster.Example:
My Cluster
-
options:
object ClusterCreateOptions
The properties that define extra options for a cluster.
-
systemTags:
object systemTags
Additional Properties Allowed: additionalPropertiesUsage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}
-
vcnId:
string
The OCID of the virtual cloud network (VCN) in which the cluster existsExample:
ocid1.vcn.unique_ID
Nested Schema : availableKubernetesUpgrades
Type:
array
Available Kubernetes versions to which the clusters masters may be upgraded.
Show Source
-
Array of:
string
Example:
v1.9.4
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
-
Array of:
object ClusterPodNetworkOptionDetails
Discriminator:
cniType
The CNI type and network details applicable to the node pools of the cluster.
Nested Schema : definedTags
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing a defined tag key and value, scoped to a namespace. Example: {"sshkey": "ssh-rsa remainder_of_your_public_SSH_key"}
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:
{
"OraclePCA":{
"sshkey":"ssh-rsa remainder_of_your_public_SSH_key",
"cpNodeCount":"1",
"cpNodeShape":"VM.PCAStandard1.Flex",
"cpNodeShapeConfig":{
"ocpus":"2",
"memoryInGBs":"24"
}
}
}
Nested Schema : ClusterEndpointConfig
Type:
object
The properties that define the network configuration for the Cluster endpoint.
Show Source
-
isPublicIpEnabled:
boolean
Default Value:
false
Whether the cluster should be assigned a public IP address. Defaults to false. Set this to true. -
nsgIds:
array 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. -
subnetId:
string
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
-
kubernetes:
string
The non-native networking Kubernetes API server endpoint.Example:
https://yourkubernetes
-
privateEndpoint:
string
The private native networking Kubernetes API server endpoint.Example:
https://yourPrivateEndpoint
-
publicEndpoint:
string
The public native networking Kubernetes API server endpoint, if one was requested.Example:
https://yourPublicEndpoint
-
vcnHostnameEndpoint:
string
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
-
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.
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.
Nested Schema : ClusterMetadata
Type:
object
The properties that define metadata for a cluster.
Show Source
-
createdByUserId:
string
The user that created the cluster.Example:
ocid1.user.unique_ID
-
createdByWorkRequestId:
string
The OCID of the work request that created the cluster.Example:
ocid1.clustersworkrequest.unique_ID
-
deletedByUserId:
string
The user tjat deleted the cluster.Example:
ocid1.user.unique_ID
-
deletedByWorkRequestId:
string
The OCID of the work request that deleted the cluster.Example:
ocid1.clustersworkrequest.unique_ID
-
timeCreated:
string(date-time)
The time the cluster was created.Example:
2017-07-21T16:11:29Z
-
timeDeleted:
string(date-time)
The time the cluster was deleted.Example:
2017-07-21T16:11:29Z
-
timeUpdated:
string(date-time)
The time the cluster was updated.Example:
2017-07-21T16:11:29Z
-
updatedByUserId:
string
The user that updated the cluster.Example:
ocid1.user.unique_ID
-
updatedByWorkRequestId:
string
The OCID of the work request that updated the cluster.Example:
ocid1.clustersworkrequest.unique_ID
Nested Schema : ClusterCreateOptions
Type:
object
The properties that define extra options for a cluster.
Show Source
-
addOns:
object AddOnOptions
The properties that define options for supported add-ons.
-
admissionControllerOptions:
object AdmissionControllerOptions
The properties that define supported admission controllers.
-
kubernetesNetworkConfig:
object KubernetesNetworkConfig
The properties that define the network configuration for Kubernetes.
-
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
-
serviceLbSubnetIds:
array serviceLbSubnetIds
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.
Nested Schema : systemTags
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}
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
-
cniType(required):
string
Minimum Length:
1
Maximum Length:255
Allowed Values:[ "FLANNEL_OVERLAY" ]
The CNI used by the node pools of this cluster.
Nested Schema : additionalProperties
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
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: {"sshkey": "ssh-rsa remainder_of_your_public_SSH_key"}
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
-
Array of:
string
Minimum Length:
1
Maximum Length:255
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.
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.
Nested Schema : AddOnOptions
Type:
object
The properties that define options for supported add-ons.
Show Source
-
isKubernetesDashboardEnabled:
boolean
Whether or not to enable the Kubernetes Dashboard add-on.Example:
true
-
isTillerEnabled:
boolean
Whether or not to enable the Tiller add-on.Example:
true
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
Nested Schema : KubernetesNetworkConfig
Type:
object
The properties that define the network configuration for Kubernetes.
Show Source
-
podsCidr:
string
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
-
servicesCidr:
string
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
-
definedTags:
object definedTags
Additional Properties Allowed: additionalPropertiesDefined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
-
freeformTags:
object freeformTags
Additional Properties Allowed: additionalPropertiesFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
Nested Schema : ServiceLbConfigDetails
Type:
object
Configuration to be applied to load balancers created by Kubernetes services
Show Source
-
definedTags:
object definedTags
Additional Properties Allowed: additionalPropertiesDefined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
-
freeformTags:
object freeformTags
Additional Properties Allowed: additionalPropertiesFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
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
-
Array of:
string
Example:
ocid1.subnet.unique_ID
Nested Schema : definedTags
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing a defined tag key and value, scoped to a namespace. Example: {"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
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.
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: additionalPropertiesKey-value pair representing a defined tag key and value, scoped to a namespace. Example: {"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
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.
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
-
object additionalProperties
The value of the tag. Only string, integer and boolean types are supported.
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
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
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
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.
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
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.
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
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.
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
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.
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