Jump to

• Request
• Response

Get list of supported addons for a specific kubernetes version.

get

/20180222/addonOptions

Request

Supported Media Types

• application/json

Query Parameters

• addonName: string
  The name of the addon.
• kubernetesVersion(required): string
  The kubernetes version to fetch the addons.
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.

  Default Value: 100
• page: string
  Minimum Length: 1

  Maximum Length: 512

  For list pagination. The value of the opc-next-page response header from the previous List call.

  Default Value: 0
• sortBy: string
  The optional field to sort the results by.

  Allowed Values: [ "NAME", "TIME_CREATED" ]
• sortOrder: string
  The sort order to use, either ascending (ASC) or descending (DESC).

  Default Value: ASC

  Allowed Values: [ "ASC", "DESC" ]

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

A list of addon option summary objects for a specific kubernetes version.

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• 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 : schema

Type: array

Show Source

• Array of: object AddonOptionSummary
  The properties that define addon summary.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/AddonOptionSummary"
    }
}

Nested Schema : AddonOptionSummary

Type: object

The properties that define addon summary.

Show Source

• addonGroup: string
  Addon group info, a namespace concept that groups addons with similar functionalities.

  Example: oke/cluster-network
• addonSchemaVersion: string
  Addon definition schema version to validate addon.

  Example: 0.1
• 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"}}
• description: string
  Description on the addon.

  Example: BlaBla
• 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"}
• isEssential(required): boolean
  Is it an essential addon for cluster operation or not.

  Example: true
• lifecycleState(required): string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]

  The life cycle state of the addon.

  Example: ACTIVE
• name(required): string
  Name of the addon and it would be unique.

  Example: flannel
• systemTags: object systemTags
  Additional Properties Allowed: additionalProperties

  Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}
• timeCreated: string(date-time)
  The time the work request was created.

  Example: 2017-07-21T16:11:29Z
• versions(required): array versions
  The resources this work request affects.

{
    "type":"object",
    "description":"The properties that define addon summary.",
    "required":[
        "versions",
        "name",
        "isEssential",
        "lifecycleState"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the addon and it would be unique.",
            "example":"flannel"
        },
        "addonSchemaVersion":{
            "type":"string",
            "description":"Addon definition schema version to validate addon.",
            "example":"0.1"
        },
        "addonGroup":{
            "type":"string",
            "description":"Addon group info, a namespace concept that groups addons with similar functionalities.",
            "example":"oke/cluster-network"
        },
        "lifecycleState":{
            "type":"string",
            "enum":[
                "ACTIVE",
                "INACTIVE"
            ],
            "description":"The life cycle state of the addon.",
            "example":"ACTIVE"
        },
        "description":{
            "type":"string",
            "description":"Description on the addon.",
            "example":"BlaBla"
        },
        "isEssential":{
            "description":"Is it an essential addon for cluster operation or not.",
            "type":"boolean",
            "example":true
        },
        "versions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AddonVersions"
            },
            "description":"The resources this work request affects."
        },
        "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
                }
            }
        },
        "systemTags":{
            "description":"Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}} ",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}` ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string, integer and boolean types are supported. "
                }
            }
        },
        "timeCreated":{
            "type":"string",
            "description":"The time the work request was created.",
            "example":"2017-07-21T16:11:29Z",
            "format":"date-time"
        }
    }
}

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

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`

{
    "description":"Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}} ",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}` ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string, integer and boolean types are supported. "
        }
    }
}

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

Nested Schema : versions

Type: array

The resources this work request affects.

Show Source

• Array of: object AddonVersions
  The properties that define a work request resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/AddonVersions"
    },
    "description":"The resources this work request affects."
}

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

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only string, integer and boolean types are supported.

{
    "type":"object",
    "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}` ",
    "additionalProperties":{
        "type":"object",
        "description":"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 : AddonVersions

Type: object

The properties that define a work request resource.

Show Source

• configurations: array configurations
  Addon version configuration details.
• description: string
  Information about the addon version.

  Example: Information about addon version and if any recent changes
• kubernetesVersionFilters: object KubernetesVersionsFilters
  The range of kubernetes versions an addon can be configured.
• status: string
  Allowed Values: [ "ACTIVE", "DEPRECATED", "PREVIEW", "RECALLED" ]

  Current state of the addon, only active will be visible to customer, visibility of versions in other status will be filtered based on limits property.

  Example: ACTIVE
• versionNumber: string
  Version number, need be comparable within an addon.

  Example: x.y.z

{
    "type":"object",
    "description":"The properties that define a work request resource.",
    "properties":{
        "status":{
            "type":"string",
            "enum":[
                "ACTIVE",
                "DEPRECATED",
                "PREVIEW",
                "RECALLED"
            ],
            "description":"Current state of the addon, only active will be visible to customer, visibility of versions in other status will be filtered  based on limits property.",
            "example":"ACTIVE"
        },
        "versionNumber":{
            "type":"string",
            "description":"Version number, need be comparable within an addon.",
            "example":"x.y.z"
        },
        "description":{
            "type":"string",
            "description":"Information about the addon version.",
            "example":"Information about addon version and if any recent changes"
        },
        "kubernetesVersionFilters":{
            "description":"The range of kubernetes versions an addon can be configured.",
            "$ref":"#/definitions/KubernetesVersionsFilters"
        },
        "configurations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AddonVersionConfiguration"
            },
            "description":"Addon version configuration details."
        }
    }
}

Nested Schema : configurations

Type: array

Addon version configuration details.

Show Source

• Array of: object AddonVersionConfiguration
  Addon version configuration details.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/AddonVersionConfiguration"
    },
    "description":"Addon version configuration details."
}

Nested Schema : KubernetesVersionsFilters

Type: object

The range of kubernetes versions an addon can be configured.

Show Source

• exactKubernetesVersions: array exactKubernetesVersions
  Unique Items Required: true

  The exact version of kubernetes that are compatible.
• maximumVersion: string
  The latest kubernetes version.

  Example: 1.23.0
• minimalVersion: string
  The earliest kubernetes version.

  Example: 1.11.0

{
    "type":"object",
    "description":"The range of kubernetes versions an addon can be configured.",
    "properties":{
        "minimalVersion":{
            "description":"The earliest kubernetes version.",
            "type":"string",
            "example":"1.11.0"
        },
        "maximumVersion":{
            "description":"The latest kubernetes version.",
            "type":"string",
            "example":"1.23.0"
        },
        "exactKubernetesVersions":{
            "type":"array",
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":255
            },
            "description":"The exact version of kubernetes that are compatible. ",
            "uniqueItems":true
        }
    }
}

Nested Schema : AddonVersionConfiguration

Type: object

Addon version configuration details.

Show Source

• description: string
  Information about the addon version configuration.

  Example: Addon version configuration information
• displayName: string
  Display name of addon version.

  Example: LabelName
• isRequired: boolean
  If the the configuration is required or not.

  Example: true
• key: string
  Addon configuration key

  Example: labels
• value: string
  Addon configuration value

  Example: value

{
    "type":"object",
    "description":"Addon version configuration details.",
    "properties":{
        "isRequired":{
            "description":"If the the configuration is required or not.",
            "type":"boolean",
            "example":true
        },
        "key":{
            "type":"string",
            "description":"Addon configuration key",
            "example":"labels"
        },
        "value":{
            "type":"string",
            "description":"Addon configuration value",
            "example":"value"
        },
        "displayName":{
            "type":"string",
            "description":"Display name of addon version.",
            "example":"LabelName"
        },
        "description":{
            "type":"string",
            "description":"Information about the addon version configuration.",
            "example":"Addon version configuration information"
        }
    }
}

Nested Schema : exactKubernetesVersions

Type: array

Unique Items Required: true

The exact version of kubernetes that are compatible.

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 255

{
    "type":"array",
    "items":{
        "type":"string",
        "minLength":1,
        "maxLength":255
    },
    "description":"The exact version of kubernetes that are compatible. ",
    "uniqueItems":true
}

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