UNunitycatalog
Volumes

Update a Volume

Changed on

Updates the specified volume under the specified parent catalog and schema.

Currently only the name or the comment of the volume could be updated.

patch/volumes/{name}

Request

  • Base URL
    http://localhost:8080/api/2.1/unity-catalog
  • Auth
    none declared

Request body

commentstring

The comment attached to the volume

new_namestring

New name for the volume.

Response

Successfully updated the properties of the volume

catalog_namestring

The name of the catalog where the schema and the volume are

schema_namestring

The name of the schema where the volume is

namestring

The name of the volume

commentstring

The comment attached to the volume

ownerstring

The identifier of the user who owns the volume

created_atinteger

Time at which this volume was created, in epoch milliseconds.

created_bystring

TThe identifier of the user who created the volume

updated_atinteger

Time at which this volume was last modified, in epoch milliseconds.

updated_bystring

The identifier of the user who updated the volume last time

volume_idstring

Unique identifier of the volume

volume_type'MANAGED' | 'EXTERNAL'

The type of the volume

storage_locationstring

The storage location of the volume

full_namestring

Full name of volume, in form of catalog_name.schema_name.volume_name.

Changes

  • 2dd9fd4253e0Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status