Jump to

• Request
• Response

GetClusterOptions

get

/20180222/clusterOptions/{cluster_option_id}

Get options available for clusters.

Request

Supported Media Types

• application/json

Path Parameters

• clusterOptionId(required): string
  The OCID of the option set to retrieve. Use "all" to get all options, or use a cluster OCID to get options specific to that 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 cluster options.

Headers

• opc-request-id: string
  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 : ClusterOptions

Type: object

Options for creating or updating clusters.

Show Source

• clusterPodNetworkOptions: array clusterPodNetworkOptions
  Maximum Number of Items: 255

  Unique Items Required: true

  Available CNIs and network options for existing and new node pools of the cluster.
• kubernetesVersions: array kubernetesVersions
  Available Kubernetes versions.

{
    "type":"object",
    "description":"Options for creating or updating clusters.",
    "properties":{
        "kubernetesVersions":{
            "type":"array",
            "items":{
                "type":"string",
                "example":"v1.9.4"
            },
            "description":"Available Kubernetes versions."
        },
        "clusterPodNetworkOptions":{
            "x-default-description":"when unspecified in case of updates, the current value of this field will be preserved, else value set to null",
            "type":"array",
            "maxItems":255,
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ClusterPodNetworkOptionDetails"
            },
            "description":"Available CNIs and network options for existing and new node pools of the cluster."
        }
    }
}

Nested Schema : clusterPodNetworkOptions

Type: array

Maximum Number of Items: 255

Unique Items Required: true

Available CNIs and network options for existing and new node pools of the cluster.

Show Source

• Array of: object ClusterPodNetworkOptionDetails
  Discriminator: cniType

  The CNI type and network details applicable to the node pools of the cluster.

{
    "x-default-description":"when unspecified in case of updates, the current value of this field will be preserved, else value set to null",
    "type":"array",
    "maxItems":255,
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ClusterPodNetworkOptionDetails"
    },
    "description":"Available CNIs and network options for existing and new node pools of the cluster."
}

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 : ClusterPodNetworkOptionDetails

Type: object

Discriminator: cniType

The CNI type and network details applicable to the node pools of the cluster.

Show Source

• cniType(required): string
  Minimum Length: 1

  Maximum Length: 255

  Allowed Values: [ "OCI_VCN_IP_NATIVE", "FLANNEL_OVERLAY" ]

  The CNI used by the node pools of this cluster.

{
    "description":"The CNI type and network details applicable to the node pools of the cluster.",
    "discriminator":"cniType",
    "required":[
        "cniType"
    ],
    "properties":{
        "cniType":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "enum":[
                "OCI_VCN_IP_NATIVE",
                "FLANNEL_OVERLAY"
            ],
            "description":"The CNI used by the node pools of this cluster."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  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

• code(required): string
  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).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Headers

• opc-request-id: string
  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

• code(required): string
  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).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  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

• code(required): string
  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).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  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

• code(required): string
  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).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  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

• code(required): string
  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).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top