Skip to main content

List

Retrieves the list of available resource presets.

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const ListResourcePresetsRequest =
cloudApi.dataproc.resource_preset_service.ListResourcePresetsRequest;

(async () => {
const authToken = process.env["YC_OAUTH_TOKEN"];
const session = new Session({ oauthToken: authToken });
const client = session.client(serviceClients.ResourcePresetServiceClient);

const result = await client.list(
ListResourcePresetsRequest.fromPartial({
// pageSize: 0,
// pageToken: "pageToken"
})
);
console.log(result);
})();

ListResourcePresetsRequest

pageSize : int64

The maximum number of results per page to return.

If the number of available results is larger than page_size, the API returns a ListResourcePresetsResponse.next_page_token that can be used to get the next page of results in the subsequent ResourcePresetService.List requests.

pageToken : string

Page token that can be used to iterate through multiple pages of results.

To get the next page of results, set page_token to the ListResourcePresetsResponse.next_page_token returned by the previous ResourcePresetService.List request.

ListResourcePresetsResponse

resourcePresets : ResourcePreset

List of resource presets.

nextPageToken : string

The token that can be used to get the next page of results.

If the number of results is larger than ListResourcePresetsRequest.page_size, use the next_page_token as the value for the ListResourcePresetsRequest.page_token in the subsequent ResourcePresetService.List request to iterate through multiple pages of results.

Each of the subsequent ResourcePresetService.List requests should use the next_page_token value returned by the previous request to continue paging through the results.

ResourcePreset

An object that represents MySQL resource preset. A resource preset defines hardware configuration for cluster hosts.

See the documentation for details.

id : string

ID of the resource preset that defines available computational resources (vCPU, RAM, etc.) for a cluster host.

zoneIds : string

IDs of availability zones where the resource preset is available.

cores : int64

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

memory : int64

RAM volume for a MySQL host created with the preset, in bytes.