Contact UsGet started

Managed Service for ClickHouse API, gRPC: ResourcePresetService.List

Written by
Updated at October 17, 2024

Retrieves the list of available ResourcePreset resources.

gRPC request

rpc List (ListResourcePresetsRequest) returns (ListResourcePresetsResponse)

ListResourcePresetsRequest

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

Field

Description

pageSize

int64

The maximum number of results per page to return. If the number of available
results is larger than pageSize, the service returns a ListResourcePresetsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

pageToken

string

Page token. To get the next page of results, Set pageToken to the ListResourcePresetsResponse.nextPageToken
returned by the previous list request.

ListResourcePresetsResponse

{
  "resourcePresets": [
    {
      "id": "string",
      "zoneIds": [
        "string"
      ],
      "cores": "int64",
      "memory": "int64"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

resourcePresets[]

ResourcePreset

List of ResourcePreset resources.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListResourcePresetsRequest.pageSize, use the nextPageToken as the value
for the ListResourcePresetsRequest.pageToken parameter in the next list request. Each subsequent
list request will have its own nextPageToken to continue paging through the results.

ResourcePreset

A ResourcePreset resource for describing hardware configuration presets.

Field

Description

id

string

ID of the ResourcePreset resource.

zoneIds[]

string

IDs of availability zones where the resource preset is available.

cores

int64

Number of CPU cores for a ClickHouse host created with the preset.

memory

int64

RAM volume for a ClickHouse host created with the preset, in bytes.
Previous
Get
Next
Overview