Overview

Service for managing custom image catalogs and their associated Cloudera Runtime and FreeIPA images.

Version information

Version : 0.9.112

License information

License : Apache 2.0
Terms of service : https://www.cloudera.com/legal/commercial-terms-and-conditions.html

URI scheme

Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Paths

Create custom image catalog

POST /api/v1/imagecatalog/createCustomCatalog

Description

Creates a new image catalog for Cloudera Runtime and FreeIPA images.

Parameters

Type Name Schema

Body

input
required

CreateCustomCatalogRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

CreateCustomCatalogResponse

default

The default response on an error.

Error

Delete custom image catalog

POST /api/v1/imagecatalog/deleteCustomCatalog

Description

Deletes an existing image catalog.

Parameters

Type Name Schema

Body

input
required

DeleteCustomCatalogRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DeleteCustomCatalogResponse

default

The default response on an error.

Error

Delete FreeIPA image

POST /api/v1/imagecatalog/deleteFreeipaImage

Description

Deletes a FreeIPA image from a given catalog.

Parameters

Type Name Schema

Body

input
required

DeleteFreeipaImageRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DeleteFreeipaImageResponse

default

The default response on an error.

Error

Delete Cloudera Runtime image

POST /api/v1/imagecatalog/deleteRuntimeImage

Description

Deletes a Cloudera Runtime image from a given catalog.

Parameters

Type Name Schema

Body

input
required

DeleteRuntimeImageRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DeleteRuntimeImageResponse

default

The default response on an error.

Error

Describe custom image catalog

POST /api/v1/imagecatalog/describeCustomCatalog

Description

Retrieves data about an existing image catalog.

Parameters

Type Name Schema

Body

input
required

DescribeCustomCatalogRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeCustomCatalogResponse

default

The default response on an error.

Error

Describe custom image

POST /api/v1/imagecatalog/describeCustomImage

Description

Retrieves data about a specific image from a given catalog.

Parameters

Type Name Schema

Body

input
required

DescribeCustomImageRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeCustomImageResponse

default

The default response on an error.

Error

Describe default image

POST /api/v1/imagecatalog/describeDefaultImage

Description

Retrieves an image directly by id from the default catalog.

Parameters

Type Name Schema

Body

input
required

DescribeDefaultImageRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeDefaultImageResponse

default

The default response on an error.

Error

Find default image

POST /api/v1/imagecatalog/findDefaultImage

Description

Retrieves an image based on the filters from the default catalog.

Parameters

Type Name Schema

Body

input
required

FindDefaultImageRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

FindDefaultImageResponse

default

The default response on an error.

Error

List custom image catalogs

POST /api/v1/imagecatalog/listCustomCatalogs

Description

Lists all the Cloudera Runtime/FreeIPA image catalogs accessible for the user.

Parameters

Type Name Schema

Body

input
required

ListCustomCatalogsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListCustomCatalogsResponse

default

The default response on an error.

Error

Add or update FreeIPA image

POST /api/v1/imagecatalog/setFreeipaImage

Description

Adds or updates a FreeIPA image in the catalog.

Parameters

Type Name Schema

Body

input
required

SetFreeipaImageRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

SetFreeipaImageResponse

default

The default response on an error.

Error

Add or update Cloudera Runtime image

POST /api/v1/imagecatalog/setRuntimeImage

Description

Adds or updates a Cloudera Runtime image in the catalog.

Parameters

Type Name Schema

Body

input
required

SetRuntimeImageRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

SetRuntimeImageResponse

default

The default response on an error.

Error

Definitions

CreateCustomCatalogRequest

The request object to create a custom image catalog.

Name Description Schema

catalogName
required

Image catalog name

string

description
optional

Image catalog description

string

CreateCustomCatalogResponse

The response object returned in case the custom image catalog has been successfully created.

Type : object

CustomImageCatalog

Basic image catalog data.

Name Description Schema

description
optional

Image catalog description

string

name
optional

Image catalog name

string

DeleteCustomCatalogRequest

The request object to delete a custom image catalog.

Name Description Schema

catalogName
required

Image catalog name

string

DeleteCustomCatalogResponse

The response object returned in case of successful custom image catalog deletion.

Type : object

DeleteFreeipaImageRequest

The request object to delete FreeIPA image from a catalog.

Name Description Schema

catalogName
required

Image catalog name

string

imageId
required

Image UUID

string

DeleteFreeipaImageResponse

The response object returned in case the FreeIPA image has been successfully removed from the catalog.

Name Description Schema

imageId
optional

Image UUID

string

DeleteRuntimeImageRequest

The request object to delete Cloudera Runtime image from a catalog.

Name Description Schema

catalogName
required

Image catalog name

string

imageId
required

Image UUID

string

DeleteRuntimeImageResponse

The response object returned in case the Cloudera Runtime image has been successfully removed from the catalog.

Name Description Schema

imageId
optional

Image UUID

string

DescribeCustomCatalogRequest

The request object to retrieve data about a custom catalog.

Name Description Schema

catalogName
required

Image catalog name

string

DescribeCustomCatalogResponse

The response object holding the retrieved data of a custom catalog.

Name Description Schema

catalogName
optional

Image catalog name

string

description
optional

Image catalog description

string

images
optional

Detailed information of the images contained within

< ImageItemResponse > array

DescribeCustomImageRequest

The request object to retrieve data of an image from the given catalog.

Name Description Schema

catalogName
required

Image catalog name

string

imageId
required

Image UUID

string

DescribeCustomImageResponse

The response object holding the data of the image retrieved from the given custom catalog.

Name Description Schema

baseParcelUrl
optional

Base parcel URL

string

imageDate
optional

Image creation date

integer (int64)

imageId
optional

Image UUID

string

imageType
optional

Image type - either "FREEIPA" or "RUNTIME"

VmImageType

provider
optional

Cloud provider - either AWS, AZURE or GCP

VmImageProvider

sourceImageDate
optional

Customized image creation date

integer (int64)

sourceImageId
optional

Customized image UUID

string

versions
optional

Package versions

< string, string > map

vmImages
optional

List of images

< VmImageResponse > array

DescribeDefaultImageRequest

The request object to retrieve an image from the default image catalog.

Name Description Schema

imageId
required

Image UUID

string

DescribeDefaultImageResponse

The response object for holding data about an image retrieved from the default image catalog.

Name Description Schema

imageId
optional

Image UUID

string

vmImages
optional

List of images

< VmImageResponse > array

Error

An object returned on an error.

Name Description Schema

code
optional

The error code.

string

message
optional

The error message.

string

FindDefaultImageRequest

The request object to filter data that is used for retrieving an image from the default image catalog.

Name Description Schema

imageType
required

Image type - either "FREEIPA" or "RUNTIME"

VmImageType

provider
required

Cloud provider - either AWS, AZURE or GCP

VmImageProvider

runtimeVersion
optional

Cloudera runtime version

string

FindDefaultImageResponse

The response object for holding data about an image retrieved from the default image catalog.

Name Description Schema

imageId
optional

Image UUID

string

vmImages
optional

List of images

< VmImageResponse > array

ImageItemResponse

Model holding detailed information about a custom VM image.

Name Description Schema

imageDate
optional

Image creation date

integer (int64)

imageId
optional

Image UUID

string

imageType
optional

Image type - either "FREEIPA" or "RUNTIME"

VmImageType

provider
optional

Cloud provider - either AWS, AZURE or GCP

VmImageProvider

sourceImageDate
optional

Customized image creation date

integer (int64)

sourceImageId
optional

Customized image UUID

string

versions
optional

Package versions

< string, string > map

ListCustomCatalogsRequest

The request object to list the registered custom image catalogs.

Type : object

ListCustomCatalogsResponse

The response object for the list of registered image catalogs.

Name Description Schema

imageCatalogs
optional

The list of registered image catalogs

< CustomImageCatalog > array

SetFreeipaImageRequest

The request object to add or update a FreeIPA image in a catalog.

Name Description Schema

baseParcelUrl
optional

Base parcel URL

string

catalogName
required

Image catalog name

string

imageId
optional

Image UUID. If this is empty, a randomly generated UUID is used

string

sourceImageId
required

UUID of the image customized by the current image

string

vmImages
required

List of images

< VmImageRequest > array

SetFreeipaImageResponse

The response object holding data about the added or updated FreeIPA image.

Name Description Schema

imageId
optional

Image UUID

string

SetRuntimeImageRequest

The request object to add or update a Cloudera Runtime image in a catalog.

Name Description Schema

baseParcelUrl
optional

Base parcel URL

string

catalogName
required

Image catalog name

string

imageId
optional

Image UUID. If this is empty, a randomly generated UUID is used

string

sourceImageId
required

UUID of the image customized by the current image

string

vmImages
required

List of images

< VmImageRequest > array

SetRuntimeImageResponse

The response object holding data about the added or updated Cloudera Runtime image.

Name Description Schema

imageId
optional

Image UUID

string

VmImageProvider

Object representing a valid cloud provider name. AWS - The image is an AWS VM image AZURE - The image is an Azure VM image GCP - The image is a GCP VM image

Type : enum (AWS, AZURE, GCP)

VmImageRequest

Model holding information about a custom VM image and the cloud region it belongs to. The format of the image reference is specific to the cloud provider, e.g. URL in case of Azure, AMI ID in case of AWS.

Name Description Schema

imageReference
required

Image reference

string

region
required

Region

string

VmImageResponse

Model holding information about a custom VM image and the cloud region it belongs to. The format of the image reference is specific to the cloud provider, e.g. URL in case of Azure, AMI ID in case of AWS.

Name Description Schema

imageReference
optional

Image reference

string

region
optional

Region

string

VmImageType

Object representing a valid VM image type. FREEIPA - FreeIPA image RUNTIME - Cloudera Runtime image

Type : enum (FREEIPA, RUNTIME)


Copyright © 2024 Cloudera, Inc. All rights reserved.