v1

latestOpenAPI 3.0.0raw.githubusercontent.com2024-06-14254049.0 KB
Volumes

Update a Volume

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

created_atinteger

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

updated_atinteger

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

volume_idstring

Unique identifier for 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.