UNunitycatalog
Volumes

List Volumes

Changed on

Gets an array of available volumes under the parent catalog and schema. There is no guarantee of a specific ordering of the elements in the array.

get/volumes

Request

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

Query parameters

catalog_namestring required

The identifier of the catalog

schema_namestring required

The identifier of the schema

max_resultsinteger

Maximum number of volumes to return (page length).

If not set, the page length is set to a server configured value.

  • when set to a value greater than 0, the page length is the minimum of this value and a server configured value;
  • when set to 0, the page length is set to a server configured value;
  • when set to a value less than 0, an invalid parameter error is returned;

Note: this parameter controls only the maximum number of volumes to return. The actual number of volumes returned in a page may be smaller than this value, including 0, even if there are more pages.

page_tokenstring

Opaque token returned by a previous request. It must be included in the request to retrieve the next page of results (pagination).

Response

The volume list was successfully retrieved

next_page_tokenstring

Opaque token to retrieve the next page of results. Absent if there are no more pages. page_token should be set to this value for the next request to retrieve the next page of results.

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