Contact UsGet started

Managed Service for ClickHouse API, gRPC: ResourcePresetService.List

Written by
Updated at November 26, 2024

Retrieves the list of available ResourcePreset resources.

gRPC request

rpc List (ListResourcePresetsRequest) returns (ListResourcePresetsResponse)

ListResourcePresetsRequest

{
  "page_size": "int64",
  "page_token": "string"
}

Field

Description

page_size

int64

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

page_token

string

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

ListResourcePresetsResponse

{
  "resource_presets": [
    {
      "id": "string",
      "zone_ids": [
        "string"
      ],
      "cores": "int64",
      "memory": "int64"
    }
  ],
  "next_page_token": "string"
}

Field

Description

resource_presets[]

ResourcePreset

List of ResourcePreset resources.

next_page_token

string

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

ResourcePreset

A ResourcePreset resource for describing hardware configuration presets.

Field

Description

id

string

ID of the ResourcePreset resource.

zone_ids[]

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