Jump to

• Request
• Response

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.

Back to Top

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.

Body ()

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.

{
    "type":"object",
    "description":"Options for creating or updating node pools.",
    "properties":{
        "kubernetesVersions":{
            "type":"array",
            "items":{
                "type":"string",
                "example":"v1.9.4"
            },
            "description":"Available Kubernetes versions."
        },
        "shapes":{
            "type":"array",
            "items":{
                "type":"string",
                "example":"VM.PCAStandard1.4"
            },
            "description":"Available shapes for nodes."
        },
        "images":{
            "type":"array",
            "items":{
                "type":"string",
                "example":"uln-pca-Oracle-Linux-8-2024.05.29_0.oci"
            },
            "description":"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."
        },
        "sources":{
            "description":"Available source of the node.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/NodeSourceOption"
            }
        }
    }
}

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

{
    "type":"array",
    "items":{
        "type":"string",
        "example":"uln-pca-Oracle-Linux-8-2024.05.29_0.oci"
    },
    "description":"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."
}

Nested Schema : kubernetesVersions

Type: array

Available Kubernetes versions.

Show Source

• Array of: string
  Example: v1.9.4

{
    "type":"array",
    "items":{
        "type":"string",
        "example":"v1.9.4"
    },
    "description":"Available Kubernetes versions."
}

Nested Schema : shapes

Type: array

Available shapes for nodes.

Show Source

• Array of: string
  Example: VM.PCAStandard1.4

{
    "type":"array",
    "items":{
        "type":"string",
        "example":"VM.PCAStandard1.4"
    },
    "description":"Available shapes for nodes."
}

Nested Schema : sources

Type: array

Available source of the node.

Show Source

• Array of: object NodeSourceOption
  Discriminator: sourceType

  The source option for the node.

{
    "description":"Available source of the node.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/NodeSourceOption"
    }
}

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.

{
    "description":"The source option for the node.",
    "discriminator":"sourceType",
    "properties":{
        "sourceType":{
            "description":"The source type of this option. IMAGE means the OCID is of an image.",
            "x-obmcs-top-level-enum":"#/definitions/NodeSourceType",
            "enum":[
                "IMAGE"
            ],
            "type":"string"
        },
        "sourceName":{
            "description":"The user-friendly name of the entity corresponding to the OCID.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        }
    },
    "required":[
        "sourceType"
    ],
    "type":"object"
}

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

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