List all cluster objects.
GET {{baseUrl}}/clusters?compartmentId={{compartment_ocid}}&limit=340&sortOrder=DESC&sortBy=ID
List all the cluster objects in a compartment.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
compartmentId | string | (Required) The OCID of the compartment. | |
lifecycleState | string | A cluster lifecycle state to filter on. Can have multiple parameters of this name. | |
lifecycleState | string | A cluster lifecycle state to filter on. Can have multiple parameters of this name. | |
name | string | The name to filter on. | |
limit | number | 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. For important details about how pagination works, | |||
| see List Pagination. | |||
page | null | For list pagination. The value of the opc-next-page response header from the previous "List" call. | |
| For important details about how pagination works, see List Pagination. | |||
sortOrder | string | The optional order in which to sort the results. | |
sortBy | string | The optional field to sort the results by. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
opc-request-id | string | Unique Oracle-assigned identifier for the request. If you need to contact | |
| Oracle about a particular request, please provide the request ID. | |||
Date | string | (Required) Current Date | |
Authorization | string | (Required) Signature Authentication on Authorization header |
RESPONSES
status: OK
[{"availableKubernetesUpgrades":["v1.9.4","v1.9.4"],"compartmentId":"ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq","endpointConfig":{"isPublicIpEnabled":false,"nsgIds":["id cillum","sunt enim nulla"],"subnetId":"dolor officia"},"endpoints":{"kubernetes":"https://yourkubernetes","privateEndpoint":"https://yourPrivateEndpoint","publicEndpoint":"https://yourPublicEndpoint"},"id":"ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw","imagePolicyConfig":{"isPolicyEnabled":false,"keyDetails":[{"kmsKeyId":"in incididunt ut"},{"kmsKeyId":"id dolore"}]},"kubernetesVersion":"v1.9.4","lifecycleDetails":"waiting for node pools","lifecycleState":"UPDATING","metadata":{"createdByUserId":"ocid1.user.oc1..aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq","createdByWorkRequestId":"ocid1.clustersworkrequest.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq","deletedByUserId":"ocid1.user.oc1..aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq","deletedByWorkRequestId":"ocid1.clustersworkrequest.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq","timeCreated":"2014-03-24T14:56:49.606Z","timeDeleted":"2011-07-28T22:31:05.084Z","timeUpdated":"1994-12-21T22:56:52.092Z","updatedByUserId":"ocid1.user.oc1..aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq","updatedByWorkRequestId":"ocid1.clustersworkrequest.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq"},"name":"My Cluster Summary","options":{"addOns":{"isKubernetesDashboardEnabled":true,"isTillerEnabled":true},"admissionControllerOptions":{"isPodSecurityPolicyEnabled":false},"kubernetesNetworkConfig":{"podsCidr":"10.244.0.0/16","servicesCidr":"10.96.0.0/16"},"serviceLbSubnetIds":["ocid1.subnet.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3ofzxtlyit","ocid1.subnet.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3ofzxtlyit"]},"vcnId":"ocid1.vcn.oc1.iad.aaaaaaaa5e3hn7hk6y63awlhbvlhsumkn5p3ficbjcevbnoylvptcpkxtsaa"},{"availableKubernetesUpgrades":["v1.9.4","v1.9.4"],"compartmentId":"ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq","endpointConfig":{"isPublicIpEnabled":false,"nsgIds":["exercitation eu in","commodo sint velit"],"subnetId":"laboris Ut proident magna quis"},"endpoints":{"kubernetes":"https://yourkubernetes","privateEndpoint":"https://yourPrivateEndpoint","publicEndpoint":"https://yourPublicEndpoint"},"id":"ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw","imagePolicyConfig":{"isPolicyEnabled":false,"keyDetails":[{"kmsKeyId":"magna pariatur"},{"kmsKeyId":"id tempor Excepteur officia"}]},"kubernetesVersion":"v1.9.4","lifecycleDetails":"waiting for node pools","lifecycleState":"UPDATING","metadata":{"createdByUserId":"ocid1.user.oc1..aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq","createdByWorkRequestId":"ocid1.clustersworkrequest.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq","deletedByUserId":"ocid1.user.oc1..aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq","deletedByWorkRequestId":"ocid1.clustersworkrequest.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq","timeCreated":"1945-06-19T11:23:51.267Z","timeDeleted":"1947-03-15T20:01:40.876Z","timeUpdated":"1945-01-24T06:30:26.052Z","updatedByUserId":"ocid1.user.oc1..aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq","updatedByWorkRequestId":"ocid1.clustersworkrequest.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq"},"name":"My Cluster Summary","options":{"addOns":{"isKubernetesDashboardEnabled":true,"isTillerEnabled":true},"admissionControllerOptions":{"isPodSecurityPolicyEnabled":false},"kubernetesNetworkConfig":{"podsCidr":"10.244.0.0/16","servicesCidr":"10.96.0.0/16"},"serviceLbSubnetIds":["ocid1.subnet.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3ofzxtlyit","ocid1.subnet.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3ofzxtlyit"]},"vcnId":"ocid1.vcn.oc1.iad.aaaaaaaa5e3hn7hk6y63awlhbvlhsumkn5p3ficbjcevbnoylvptcpkxtsaa"}]