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

ListNodePools

get

/20180222/nodePools

List all node pools in a compartment. Optionally filter the list by cluster.

Request

Supported Media Types
Query Parameters
  • The OCID of the cluster.
  • Minimum Length: 1
    Maximum Length: 255
    The OCID of the compartment.
  • Collection Format: multi
    A list of nodepool lifecycle states on which to filter, matching any of the list items (OR logic). Example: [ACTIVE, DELETING]
    • Allowed Values: [ "DELETED", "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED", "INACTIVE", "NEEDS_ATTENTION" ]
  • 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 node pool 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 : NodePoolSummary
Type: object
The properties that define a node pool summary.
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: {"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 : initialNodeLabels
Type: array
A list of key/value pairs to add to nodes after they join the Kubernetes cluster. Labels can be used to target pods for scheduling on specific nodes or groups of nodes.
Show Source
Nested Schema : NodePoolNodeConfigDetails
Type: object
The size and placement configuration of nodes in the node pool.
Show Source
Nested Schema : NodeEvictionNodePoolSettings
Type: object
Node eviction details configuration.
Show Source
  • Number of minutes in ISO 8601 format after which OKE will give up eviction (cordon and drain) of the pods on the node. Default PT60M, minimum PT1M, maximum PT60M.
    Example: PT30M
  • Default Value: false
    Whether the underlying compute instance should be deleted if you cannot evict all the pods within the grace period. Private Cloud Appliance always deletes the compute instance after the grace period even if some pods are not evicted.
Nested Schema : NodePoolCyclingDetails
Type: object
Node pool cycling settings.
Show Source
  • Default Value: false
    To apply the changes in this update to all nodes in the nodepool (to node cycle the node pool), set isNodeCyclingEnabled to true.
  • Minimum Length: 1
    Maximum Length: 4
    Default Value: 1
    The maximum number of new nodes that can be starting at any time during this update operation. Set this value to avoid adding too many new nodes before existing nodes are terminated, which could incur excessive cost. The default value is 1. The maximum value is 5. Either maximumUnavailable or maximumSurge must be greater than 0. The value can be set to either a number (from 0 to the configured number of nodes in the node pool, but not greater than 5) or a percentage (from 0% to 100%, but not a percentage that would result in a number greater than 5).
    Example: 10%
  • Minimum Length: 1
    Maximum Length: 4
    Default Value: 0
    The maximum number of existing nodes that can be terminating at any time during this update operation. Set this value to ensure that enough nodes remain to handle the workload. The default value is 0. The maximum value is 7. Either maximumUnavailable or maximumSurge must be greater than 0. The value can be set to either a number (from 0 to the configured number of nodes in the node pool, but not greater than 7) or a percentage (from 0% to 100%, but not a percentage that would result in a number greater than 7).
    Example: 2
Nested Schema : NodeShapeConfig
Type: object
The shape configuration of the nodes.
Show Source
Nested Schema : NodeSourceOption
Type: object
Discriminator: sourceType
The source option for the node.
Show Source
  • Minimum Length: 1
    Maximum Length: 255
    The user-friendly name of the entity corresponding to the OCID.
  • Allowed Values: [ "IMAGE" ]
    The source type of this option. IMAGE means the OCID is of an image.
Nested Schema : NodeSourceDetails
Type: object
Discriminator: sourceType
The details of the node's source.
Show Source
Nested Schema : subnetIds
Type: array
The OCIDs of the subnets in which to place nodes for this node pool.
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 : 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 : KeyValue
Type: object
The properties that define a key value pair.
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: {"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 : NodePoolPodNetworkOptionDetails
Type: object
Discriminator: cniType
The CNI type and network details for the pods of a given node pool.
Show Source
  • Minimum Length: 1
    Maximum Length: 255
    Allowed Values: [ "OCI_VCN_IP_NATIVE", "FLANNEL_OVERLAY" ]
    The CNI plugin used by this node pool.
Nested Schema : nsgIds
Type: array
Maximum Number of Items: 5
Unique Items Required: true
The OCIDs of the Network Security Groups (NSGs) to associate nodes for this node pool with.
Show Source
Nested Schema : placementConfigs
Type: array
The placement configurations for the node pool. Provide one placement configuration for each availability domain in which you intend to launch a node. To use the node pool with a regional subnet, provide a placement configuration for each availability domain, and include the regional subnet in each placement configuration.
Show Source
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 : NodePoolPlacementConfigDetails
Type: object
The location where a node pool will place nodes.
Show Source
  • Minimum Length: 1
    Maximum Length: 255
    The availability domain in which to place nodes. Example: AD-1
  • Minimum Length: 0
    Maximum Length: 255
    The OCID of the compute capacity reservation in which to place the compute instance.
  • faultDomains
    Maximum Number of Items: 3
    Unique Items Required: true
    A list of fault domains in which to place nodes.
  • PreemptibleNodeConfigDetails
    Configuration options for preemptible nodes.
  • Minimum Length: 1
    Maximum Length: 255
    The OCID of the subnet in which to place nodes. Specify a subnet that has configuration like the worker subnet described in "Creating an OKE Worker Subnet" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/oke/oke-subnet-worker.html#oke-subnet-worker). The subnet must have rules set to communicate with the control plane endpoint. The subnet must use the private route table and must have a security list like the worker-seclist security list.
Nested Schema : faultDomains
Type: array
Maximum Number of Items: 3
Unique Items Required: true
A list of fault domains in which to place nodes.
Show Source
Nested Schema : PreemptibleNodeConfigDetails
Type: object
Configuration options for preemptible nodes.
Show Source
Nested Schema : PreemptionAction
Type: object
Discriminator: type
The action to run when the preemptible node is interrupted for eviction.
Show Source
  • Allowed Values: [ "TERMINATE" ]
    The type of action to run when the instance is interrupted for eviction.
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