Contact UsGet started

Managed Service for ClickHouse API, gRPC: VersionsService.List

Written by
Updated at October 17, 2024

Returns list of available ClickHouse versions.

gRPC request

rpc List (ListVersionsRequest) returns (ListVersionsResponse)

ListVersionsRequest

{
  "pageSize": "int64",
  "pageToken": "string"
}

Field

Description

pageSize

int64

The maximum number of results per page that should be returned. If the number of available
results is larger than pageSize, the service returns a ListVersionsResponse.nextPageToken that can be used
to get the next page of results in subsequent ListVersions requests.
Default value: 100.

pageToken

string

Page token. Set pageToken to the ListVersionsResponse.nextPageToken returned by a previous ListVersions
request to get the next page of results.

ListVersionsResponse

{
  "version": [
    {
      "id": "string",
      "name": "string",
      "deprecated": "bool",
      "updatableTo": [
        "string"
      ]
    }
  ],
  "nextPageToken": "string"
}

Field

Description

version[]

Version

Requested list of available versions.

nextPageToken

string

This token allows you to get the next page of results for ListVersions requests,
if the number of results is larger than ListVersionsRequest.pageSize specified in the request.
To get the next page, specify the value of nextPageToken as a value for
the ListVersionsRequest.pageToken parameter in the next ListVerions request. Subsequent ListVersions
requests will have their own nextPageToken to continue paging through the results.

Version

Field

Description

id

string

ID of the version.

name

string

Name of the version.

deprecated

bool

Whether version is deprecated.

updatableTo[]

string

List of versions that can be updated from current.
Previous
Overview
Next
Overview