GetNodePoolOptions
get
/20180222/nodePoolOptions/{node_pool_option_id}
Get options available for node pools.
Request
Supported Media Types
- application/json
Path Parameters
-
nodePoolOptionId(required): string
The OCID of the option set to retrieve. Use "all" get all options, or use a cluster OCID to get options specific to the provided cluster.
Query Parameters
-
compartmentId: string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment.Default Value:none
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 options.
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 : NodePoolOptions
Type:
object
Options for creating or updating node pools.
Show Source
-
images:
array images
Deprecated. See sources. When creating a node pool using the CreateNodePoolDetails object, only image names contained in this property can be passed to the nodeImageName property.
-
kubernetesVersions:
array kubernetesVersions
Available Kubernetes versions.
-
shapes:
array shapes
Available shapes for nodes.
-
sources:
array sources
Available source of the node.
Nested Schema : images
Type:
array
Deprecated. See sources. When creating a node pool using the CreateNodePoolDetails object, only image names contained in this property can be passed to the nodeImageName property.
Show Source
-
Array of:
string
Example:
uln-pca-Oracle-Linux-8-2024.05.29_0.oci
Nested Schema : kubernetesVersions
Type:
array
Available Kubernetes versions.
Show Source
-
Array of:
string
Example:
v1.9.4
Nested Schema : shapes
Type:
array
Available shapes for nodes.
Show Source
-
Array of:
string
Example:
VM.PCAStandard1.4
Nested Schema : sources
Type:
array
Available source of the node.
Show Source
-
Array of:
object NodeSourceOption
Discriminator:
sourceType
The source option for the node.
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.
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