GetNodePool
get
/20180222/nodePools/{node_pool_id}
Get the details of a node pool.
Request
Supported Media Types
- application/json
Path Parameters
-
nodePoolId(required): string
The OCID of the node pool.
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
The node pool.
Headers
-
etag: string
For optimistic concurrency control. See if-match.
-
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 : NodePool
Type:
object
A pool of compute nodes attached to a cluster. Avoid entering confidential information.
Show Source
-
clusterId:
string
The OCID of the cluster to which this node pool is attached.Example:
ocid1.cluster.unique_ID
-
compartmentId:
string
The OCID of the compartment in which the node pool 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: {"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"}
-
id:
string
The OCID of the node pool.Example:
ocid1.nodepool.unique_ID
-
initialNodeLabels:
array initialNodeLabels
Not supported. A list of key/value pairs to add to nodes after they join the Kubernetes cluster.
-
kubernetesVersion:
string
The version of Kubernetes running on the nodes in the node pool.Example:
1.28.3
-
lifecycleDetails:
string
Details about the state of the nodepool.
-
lifecycleState:
string
Allowed Values:
[ "DELETED", "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED", "INACTIVE", "NEEDS_ATTENTION" ]
The state of the nodepool.Example:ACTIVE
-
name:
string
The name of the node pool.Example:
My Node Pool
-
nodeConfigDetails:
object NodePoolNodeConfigDetails
The size and placement configuration of nodes in the node pool.
-
nodeEvictionNodePoolSettings:
object NodeEvictionNodePoolSettings
Node Eviction Details configuration
-
nodeImageId:
string
Deprecated. See nodeSource. The OCID of the image running on the nodes in the node pool.Example:
ocid1.image.unique_ID
-
nodeImageName:
string
Deprecated. See nodeSource. The name of the image running on the nodes in the node pool.Example:
uln-pca-Oracle-Linux-8-2024.05.29_0.oci
-
nodeMetadata:
object nodeMetadata
Additional Properties Allowed: additionalPropertiesA list of key/value pairs to add to each underlying OCI instance in the node pool on launch.
-
nodes:
array nodes
The nodes in the node pool.
-
nodeShape:
string
The name of the node shape of the nodes in the node pool.Example:
VM.PCAStandard1.4
-
nodeShapeConfig:
object NodeShapeConfig
The shape configuration of the nodes.
-
nodeSource:
object NodeSourceOption
Discriminator:
sourceType
The source option for the node. -
nodeSourceDetails:
object NodeSourceDetails
Discriminator:
sourceType
The details of the node's source. -
quantityPerSubnet:
integer(int32)
The number of nodes in each subnet.Example:
1
-
sshPublicKey:
string
The SSH public key on each node in the node pool on launch.Example:
ssh-rsa remainder_of_your_public_SSH_key
-
subnetIds:
array subnetIds
The OCIDs of the subnets in which to place nodes for this node pool.
-
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"}}
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 : initialNodeLabels
Type:
array
Not supported. A list of key/value pairs to add to nodes after they join the Kubernetes cluster.
Show Source
-
Array of:
object KeyValue
The properties that define a key value pair.
Nested Schema : NodePoolNodeConfigDetails
Type:
object
The size and placement configuration of nodes in the node pool.
Show Source
-
definedTags:
object definedTags
Additional Properties Allowed: additionalPropertiesDefined tags for each node in the node pool. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
-
freeformTags:
object freeformTags
Additional Properties Allowed: additionalPropertiesFree-form tags for each node in the node pool. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
-
isPvEncryptionInTransitEnabled:
boolean
Default Value:
false
Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false. -
kmsKeyId:
string
The OCID of the Key Management Service key assigned to the boot volume.
-
nodePoolPodNetworkOptionDetails:
object NodePoolPodNetworkOptionDetails
Discriminator:
cniType
The CNI type and network details for the pods of a given node pool. -
nsgIds:
array nsgIds
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. -
placementConfigs:
array placementConfigs
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.
-
size:
integer(int32)
The number of nodes in the node pool.
Nested Schema : NodeEvictionNodePoolSettings
Type:
object
Node Eviction Details configuration
Show Source
-
evictionGraceDuration:
string
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
-
isForceDeleteAfterGraceDuration:
boolean
Default Value:
true
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 : nodeMetadata
Type:
object
Additional Properties Allowed
Show Source
A list of key/value pairs to add to each underlying OCI instance in the node pool on launch.
Nested Schema : nodes
Type:
array
The nodes in the node pool.
Show Source
-
Array of:
object Node
The properties that define a node.
Nested Schema : NodeShapeConfig
Type:
object
The shape configuration of the nodes.
Show Source
-
memoryInGBs:
number(float)
Minimum Value:
0
The total amount of memory available to each node, in gigabytes. -
ocpus:
number(float)
Minimum Value:
0
The total number of OCPUs available to each node in the node pool.
Nested Schema : NodeSourceOption
Type:
object
Discriminator:
sourceType
The source option for the node.
Show Source
-
sourceName:
string
Minimum Length:
1
Maximum Length:255
The user-friendly name of the entity corresponding to the OCID. -
sourceType(required):
string
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
-
sourceType(required):
string
Allowed Values:
[ "IMAGE" ]
The source type for the node. Use IMAGE when specifying an OCID of an image.
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
-
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 : 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 : KeyValue
Type:
object
The properties that define a key value pair.
Show Source
-
key:
string
The key of the pair.Example:
mykey
-
value:
string
The value of the pair.Example:
myvalue
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 each node in the node pool. 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 each node in the node pool. 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
-
cniType(required):
string
Minimum Length:
1
Maximum Length:255
Allowed Values:[ "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
-
Array of:
string
Minimum Length:
1
Maximum Length:255
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
-
Array of:
object NodePoolPlacementConfigDetails
The location where a node pool will place nodes.
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 : NodePoolPlacementConfigDetails
Type:
object
The location where a node pool will place nodes.
Show Source
-
availabilityDomain(required):
string
Minimum Length:
1
Maximum Length:255
The availability domain in which to place nodes. Example: AD-1 -
capacityReservationId:
string
Minimum Length:
0
Maximum Length:255
The OCID of the compute capacity reservation in which to place the compute instance. -
faultDomains:
array faultDomains
Maximum Number of Items:
3
Unique Items Required:true
A list of fault domains in which to place nodes. -
preemptibleNodeConfig:
object PreemptibleNodeConfigDetails
Configuration options for preemptible nodes.
-
subnetId(required):
string
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
-
Array of:
string
Minimum Length:
0
Maximum Length:255
Nested Schema : PreemptibleNodeConfigDetails
Type:
object
Configuration options for preemptible nodes.
Show Source
-
preemptionAction(required):
object PreemptionAction
Discriminator:
type
The action to run when the preemptible node is interrupted for eviction.
Nested Schema : PreemptionAction
Type:
object
Discriminator:
type
The action to run when the preemptible node is interrupted for eviction.
Show Source
-
type(required):
string
Allowed Values:
[ "TERMINATE" ]
The type of action to run when the instance is interrupted for eviction.
Nested Schema : Node
Type:
object
The properties that define a node.
Show Source
-
availabilityDomain:
string
The name of the availability domain in which this node is placed.Example:
AD-1
-
definedTags:
object definedTags
Additional Properties Allowed: additionalPropertiesDefined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
-
faultDomain:
string
The fault domain of this node.Example:
FAULT-DOMAIN-1
-
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"}
-
id:
string
The OCID of the compute instance backing this node.Example:
ocid1.instance.unique_ID
-
kubernetesVersion:
string
The version of Kubernetes this node is running.Example:
1.28.3
-
lifecycleDetails:
string
Details about the state of the node.Example:
waiting for SSH
-
lifecycleState:
string
Allowed Values:
[ "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILING", "INACTIVE" ]
The state of the node.Example:UPDATING
-
name:
string
The name of the node.Example:
My Kubernetes Node
-
nodeError:
object NodeError
The properties that define an upstream error while managing a node.
-
nodePoolId:
string
The OCID of the node pool to which this node belongs.Example:
ocid1.nodepool.unique_ID
-
privateIp:
string
The private IP address of this node.Example:
10.0.1.1
-
publicIp:
string
The public IP address of this node.Example:
129.1.2.3
-
subnetId:
string
The OCID of the subnet in which this node is placed.Example:
ocid1.subnet.unique_ID
-
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"}}
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 : NodeError
Type:
object
The properties that define an upstream error while managing a node.
Show Source
-
code(required):
string
A short error code that defines the upstream error, meant for programmatic parsing.Example:
LimitExceeded
-
message(required):
string
A human-readable error string of the upstream error.Example:
error validating payload
-
opc-request-id:
string
OCID for the upstream request. If you need to contact Oracle about a particular upstream request, provide the request OCID.Example:
BDA258F920471CFA70CF3655A836EAC3/AC26D111CE04292D5398192DCACCD85F/D74FF67547281CFA70CF3655A60B6DF5
-
status:
string
The status of the HTTP response encountered in the upstream error.Example:
429
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 : 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.
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