Skip to main content

API reference

To work with the module: import cgc.sdk.volume

volume_list​

Lists all volumes in the current context.

Signature:

volume_list() -> dict

Returns:

  • dict: Response containing list of volumes
    • code: HTTP status code
    • details: Contains volume information

volume_storage_class_details​

Gets detailed information about a specific storage class.

Signature:

volume_storage_class_details(storage_class: str) -> dict

Parameters:

  • storage_class (str, required): Name of the storage class to query

Returns:

  • dict: Response with storage class details
    • code: HTTP status code
    • details: Storage class configuration information

volume_create​

Creates a new volume with specified size and storage class.

Signature:

volume_create(
    name: str,
    size: int,
    storage_class: str = None
) -> dict

Parameters:

  • name (str, required): Unique name for the volume
  • size (int, required): Volume size in GB
  • storage_class (str): Storage class to use (defaults to cluster default if not specified)

Returns:

  • dict: Response with creation status
    • code: HTTP status code
    • details: Volume creation details

volume_delete​

Deletes an existing volume.

Signature:

volume_delete(
    name: str,
    force: bool = False
) -> dict

Parameters:

  • name (str, required): Name of volume to delete
  • force (bool): Force deletion even if volume is in use (default: False)

Returns:

  • dict: Response with deletion status
    • code: HTTP status code
    • details: Deletion operation details

volume_mount​

Mounts a volume to a target resource.

Signature:

volume_mount(
    name: str,
    target: str,
    start_mount_path: str = None,
    full_mount_path: str = None
) -> dict

Parameters:

  • name (str, required): Name of volume to mount
  • target (str, required): Name of target resource to mount to
  • start_mount_path (str): Starting path for mount operation
  • full_mount_path (str): Complete mount path specification

Returns:

  • dict: Response with mount operation status
    • code: HTTP status code
    • details: Mount operation details

volume_umount​

Unmounts a volume from target resources.

Signature:

volume_umount(
    name: str,
    target_template_names: list = None,
    force: bool = False
) -> dict

Parameters:

  • name (str, required): Name of volume to unmount
  • target_template_names (list): List of target resource names to unmount from (defaults to all if not specified)
  • force (bool): Force unmount operation (default: False)

Returns:

  • dict: Response with unmount operation status
    • code: HTTP status code
    • details: Unmount operation details

volume_ready​

Checks if a volume is ready for use.

Signature:

volume_ready(name: str) -> bool

Parameters:

  • name (str, required): Name of volume to check

Returns:

  • bool: True if volume is ready, False otherwise

get_available_storage_classes​

Gets list of all available storage classes for the current context.

Signature:

get_available_storage_classes() -> list

Returns:

  • list: List of available storage class names

get_default_storage_class​

Gets the default storage class for the current context.

Signature:

get_default_storage_class() -> str

Returns:

  • str: Name of the default storage class