Jump to

• Request
• Response

UpdateNodePool

put

/20180222/nodePools/{node_pool_id}

Update the details of a node pool.

Request

Supported Media Types

• application/json

Path Parameters

• nodePoolId(required): string
  The OCID of the node pool.

Query Parameters

• isForceDeletionAfterOverrideGraceDuration: boolean
  Whether the underlying compute instance should be deleted if you cannot evict all the pods within grace period. Private Cloud Appliance always behaves as if this value is true.
• overrideEvictionGraceDuration: string(x-obmcs-duration)
  The number of minutes after which OKE will give up eviction of the pods on the node, specified in ISO 8601 format. Specify PT0M to delete the node without cordon and drain. The default value is PT60M, the minimum is PT0M, and the maximum is PT60M.

Header Parameters

• if-match: string
  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

The fields to update in a node pool.

Root Schema : UpdateNodePoolDetails

Type: object

The properties that define a request to update a node pool.

Show Source

• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
• 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 to which to upgrade the nodes in the node pool.

  Example: 1.28.3
• name: string
  The new name for the cluster. Avoid entering confidential information.

  Example: My Updated Node Pool
• nodeConfigDetails: object UpdateNodePoolNodeConfigDetails
  The size and placement configuration of nodes in the node pool.
• nodeEvictionNodePoolSettings: object NodeEvictionNodePoolSettings
  Node Eviction Details configuration
• nodeMetadata: object nodeMetadata
  Additional Properties Allowed: additionalProperties

  A list of key/value pairs to add to each underlying OCI instance in the node pool on launch.
• nodeShape: string
  The name of the node shape of the nodes in the node pool used on launch.

  Example: VM.PCAStandard1.4
• nodeShapeConfig: object UpdateNodeShapeConfigDetails
  The shape configuration of the nodes.
• nodeSourceDetails: object NodeSourceDetails
  Discriminator: sourceType

  The details of the node's source.
• quantityPerSubnet: integer(int32)
  The number of nodes to have in each subnet specified in the subnetIds property. This property is deprecated. Use nodeConfigDetails instead. If the current value of quantityPerSubnet is greater than 0, you can only use quantityPerSubnet to scale the node pool. If the current value of quantityPerSubnet is equal to 0 and the current value of size in nodeConfigDetails is greater than 0, before you can use quantityPerSubnet, you must first scale the node pool to 0 nodes using nodeConfigDetails.

  Example: 1
• sshPublicKey: string
  The SSH public key to add to 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. This property is deprecated. Use nodeConfigDetails instead. Only one of the subnetIds or nodeConfigDetails properties can be specified.

{
    "type":"object",
    "description":"The properties that define a request to update a node pool.",
    "properties":{
        "name":{
            "type":"string",
            "description":"The new name for the cluster. Avoid entering confidential information.",
            "example":"My Updated Node Pool"
        },
        "kubernetesVersion":{
            "type":"string",
            "description":"The version of Kubernetes to which to upgrade the nodes in the node pool.",
            "example":"1.28.3"
        },
        "initialNodeLabels":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/KeyValue"
            },
            "description":"Not supported. A list of key/value pairs to add to nodes after they join the Kubernetes cluster."
        },
        "quantityPerSubnet":{
            "type":"integer",
            "format":"int32",
            "description":"The number of nodes to have in each subnet specified in the subnetIds property. This property is deprecated. Use nodeConfigDetails instead. If the current value of quantityPerSubnet is greater than 0, you can only use quantityPerSubnet to scale the node pool. If the current value of quantityPerSubnet is equal to 0 and the current value of size in nodeConfigDetails is greater than 0, before you can use quantityPerSubnet, you must first scale the node pool to 0 nodes using nodeConfigDetails.",
            "example":"1"
        },
        "subnetIds":{
            "type":"array",
            "items":{
                "type":"string",
                "minLength":"1",
                "maxLength":"255"
            },
            "description":"The OCIDs of the subnets in which to place nodes for this node pool. This property is deprecated. Use nodeConfigDetails instead. Only one of the subnetIds or nodeConfigDetails properties can be specified."
        },
        "nodeConfigDetails":{
            "description":"The configuration of nodes in the node pool. Only one of the subnetIds or nodeConfigDetails properties should be specified. If the current value of quantityPerSubnet is greater than 0, the node pool may still be scaled using quantityPerSubnet. Before you can use nodeConfigDetails, you must first scale the node pool to 0 nodes using quantityPerSubnet.",
            "$ref":"#/definitions/UpdateNodePoolNodeConfigDetails"
        },
        "nodeMetadata":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"A list of key/value pairs to add to each underlying OCI instance in the node pool on launch."
        },
        "nodeSourceDetails":{
            "$ref":"#/definitions/NodeSourceDetails",
            "description":"Specify the source to use to launch nodes in the node pool. Currently, image is the only supported source."
        },
        "sshPublicKey":{
            "type":"string",
            "description":"The SSH public key to add to each node in the node pool on launch.",
            "example":"ssh-rsa remainder_of_your_public_SSH_key"
        },
        "nodeShape":{
            "type":"string",
            "description":"The name of the node shape of the nodes in the node pool used on launch.",
            "example":"VM.PCAStandard1.4"
        },
        "nodeShapeConfig":{
            "$ref":"#/definitions/UpdateNodeShapeConfigDetails",
            "description":"Specify the configuration of the shape to launch nodes in the node pool."
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "example":{
                "Department":"Finance"
            }
        },
        "definedTags":{
            "type":"object",
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported."
                }
            },
            "example":{
                "Operations":{
                    "CostCenter":"42"
                }
            }
        },
        "nodeEvictionNodePoolSettings":{
            "$ref":"#/definitions/NodeEvictionNodePoolSettings"
        }
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

{
    "type":"object",
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported."
        }
    },
    "example":{
        "Operations":{
            "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

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "example":{
        "Department":"Finance"
    }
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/KeyValue"
    },
    "description":"Not supported. A list of key/value pairs to add to nodes after they join the Kubernetes cluster."
}

Nested Schema : UpdateNodePoolNodeConfigDetails

Type: object

The size and placement configuration of nodes in the node pool.

Show Source

• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined 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: additionalProperties

  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"}
• 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.

{
    "type":"object",
    "description":"The size and placement configuration of nodes in the node pool.",
    "properties":{
        "size":{
            "description":"The number of nodes in the node pool.",
            "type":"integer",
            "format":"int32"
        },
        "nsgIds":{
            "type":"array",
            "items":{
                "type":"string",
                "minLength":"1",
                "maxLength":"255"
            },
            "description":"The OCIDs of the Network Security Groups (NSGs) to associate nodes for this node pool with.",
            "maxItems":"5",
            "uniqueItems":true
        },
        "kmsKeyId":{
            "type":"string",
            "description":"The OCID of the Key Management Service key assigned to the boot volume."
        },
        "isPvEncryptionInTransitEnabled":{
            "type":"boolean",
            "description":"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.",
            "default":false
        },
        "freeformTags":{
            "description":"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\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "example":{
                "Department":"Finance"
            }
        },
        "definedTags":{
            "type":"object",
            "description":"Defined tags for each node in the node pool. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported."
                }
            },
            "example":{
                "Operations":{
                    "CostCenter":"42"
                }
            }
        },
        "placementConfigs":{
            "description":"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.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/NodePoolPlacementConfigDetails"
            }
        },
        "nodePoolPodNetworkOptionDetails":{
            "description":"The CNI related configuration of pods in the node pool.",
            "$ref":"#/definitions/NodePoolPodNetworkOptionDetails"
        }
    }
}

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.

{
    "type":"object",
    "description":"Node Eviction Details configuration",
    "properties":{
        "evictionGraceDuration":{
            "description":"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.",
            "type":"string",
            "example":"PT30M"
        },
        "isForceDeleteAfterGraceDuration":{
            "description":"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.",
            "type":"boolean",
            "default":true
        }
    }
}

Nested Schema : nodeMetadata

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"A list of key/value pairs to add to each underlying OCI instance in the node pool on launch."
}

A list of key/value pairs to add to each underlying OCI instance in the node pool on launch.

Nested Schema : UpdateNodeShapeConfigDetails

Type: object

The shape configuration of the nodes.

Match All

Show Source

• object NodeShapeConfig
  The shape configuration of the nodes.

{
    "description":"The shape configuration of the nodes.",
    "allOf":[
        {
            "$ref":"#/definitions/NodeShapeConfig"
        }
    ],
    "type":"object"
}

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.

{
    "description":"The details of the node's source.",
    "discriminator":"sourceType",
    "properties":{
        "sourceType":{
            "description":"The source type for the node. Use IMAGE when specifying an OCID of an image.",
            "x-obmcs-top-level-enum":"#/definitions/NodeSourceType",
            "enum":[
                "IMAGE"
            ],
            "type":"string"
        }
    },
    "required":[
        "sourceType"
    ],
    "type":"object"
}

Nested Schema : subnetIds

Type: array

The OCIDs of the subnets in which to place nodes for this node pool. This property is deprecated. Use nodeConfigDetails instead. Only one of the subnetIds or nodeConfigDetails properties can be specified.

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 255

{
    "type":"array",
    "items":{
        "type":"string",
        "minLength":"1",
        "maxLength":"255"
    },
    "description":"The OCIDs of the subnets in which to place nodes for this node pool. This property is deprecated. Use nodeConfigDetails instead. Only one of the subnetIds or nodeConfigDetails properties can be specified."
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
    "additionalProperties":{
        "type":"object",
        "description":"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

{
    "type":"object",
    "description":"The properties that define a key value pair.",
    "properties":{
        "key":{
            "type":"string",
            "description":"The key of the pair.",
            "example":"mykey"
        },
        "value":{
            "type":"string",
            "description":"The value of the pair.",
            "example":"myvalue"
        }
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

{
    "type":"object",
    "description":"Defined tags for each node in the node pool. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported."
        }
    },
    "example":{
        "Operations":{
            "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

• string

{
    "description":"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\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "example":{
        "Department":"Finance"
    }
}

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.

{
    "description":"The CNI type and network details for the pods of a given node pool.",
    "discriminator":"cniType",
    "required":[
        "cniType"
    ],
    "properties":{
        "cniType":{
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "enum":[
                "FLANNEL_OVERLAY"
            ],
            "description":"The CNI plugin used by this node pool."
        }
    },
    "type":"object"
}

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

{
    "type":"array",
    "items":{
        "type":"string",
        "minLength":"1",
        "maxLength":"255"
    },
    "description":"The OCIDs of the Network Security Groups (NSGs) to associate nodes for this node pool with.",
    "maxItems":"5",
    "uniqueItems":true
}

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.

{
    "description":"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.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/NodePoolPlacementConfigDetails"
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
    "additionalProperties":{
        "type":"object",
        "description":"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.

{
    "type":"object",
    "description":"The location where a node pool will place nodes.",
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain in which to place nodes. Example: AD-1 ",
            "minLength":"1",
            "maxLength":"255",
            "type":"string"
        },
        "subnetId":{
            "description":"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.",
            "minLength":"1",
            "maxLength":"255",
            "type":"string"
        },
        "capacityReservationId":{
            "description":"The OCID of the compute capacity reservation in which to place the compute instance.",
            "minLength":"0",
            "maxLength":"255",
            "type":"string"
        },
        "preemptibleNodeConfig":{
            "$ref":"#/definitions/PreemptibleNodeConfigDetails"
        },
        "faultDomains":{
            "type":"array",
            "items":{
                "type":"string",
                "minLength":"0",
                "maxLength":"255"
            },
            "description":"A list of fault domains in which to place nodes.",
            "maxItems":"3",
            "uniqueItems":true
        }
    },
    "required":[
        "availabilityDomain",
        "subnetId"
    ]
}

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

{
    "type":"array",
    "items":{
        "type":"string",
        "minLength":"0",
        "maxLength":"255"
    },
    "description":"A list of fault domains in which to place nodes.",
    "maxItems":"3",
    "uniqueItems":true
}

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.

{
    "required":[
        "preemptionAction"
    ],
    "description":"Configuration options for preemptible nodes.",
    "type":"object",
    "properties":{
        "preemptionAction":{
            "$ref":"#/definitions/PreemptionAction"
        }
    }
}

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.

{
    "required":[
        "type"
    ],
    "description":"The action to run when the preemptible node is interrupted for eviction.",
    "discriminator":"type",
    "properties":{
        "type":{
            "description":"The type of action to run when the instance is interrupted for eviction.",
            "type":"string",
            "enum":[
                "TERMINATE"
            ]
        }
    },
    "type":"object"
}

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.

{
    "description":"The shape configuration of the nodes.",
    "properties":{
        "ocpus":{
            "description":"The total number of OCPUs available to each node in the node pool.",
            "type":"number",
            "format":"float",
            "minimum":"0"
        },
        "memoryInGBs":{
            "description":"The total amount of memory available to each node, in gigabytes.",
            "format":"float",
            "minimum":"0",
            "type":"number",
            "x-default-description":"null"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted

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.
• opc-work-request-id: string
  The OCID of the work request handling the operation.

400 Response

Bad Request

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.

Body ()

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

Body ()

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

Body ()

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

409 Response

Conflict

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.

Body ()

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

412 Response

Precondition Failed

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.

Body ()

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

Body ()

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

Body ()

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

Body ()

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top