BareMetal API, REST: Configuration.List

Field

Description

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is greater than page_size,
the service returns a ListConfigurationsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Default value is 20.

The maximum value is 1000.

pageToken

string

Page token. To get the next page of results, set page_token to the
ListConfigurationsResponse.nextPageToken returned by a previous list request.

orderBy

string

By which column the listing should be ordered and in which direction,
format is "createdAt desc". "id asc" if omitted.
Supported fields: ["id", "name"].
Both snake_case and camelCase are supported for fields.

filter

string

A filter expression that filters resources listed in the response.
The expression consists of one or more conditions united by AND operator: <condition1> [AND <condition2> [<...> AND <conditionN>]].
Each condition has the form <field> <operator> <value>, where:

1. <field> is the field name. Currently you can use filtering only on the limited number of fields.
2. <operator> is a logical operator, one of = (equal), : (substring).
3. <value> represents a value.
   String values should be written in double (") or single (') quotes. C-style escape sequences are supported (\" turns to ", \' to ', \\ to backslash).
   Example: "key1='value' AND key2='value'"
   Supported operators: ["AND"].
   Supported fields: ["id", "name"].
   Both snake_case and camelCase are supported for fields.

folderId

string

ID of the folder to return a Configuration resource for.
To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.

The maximum string length in characters is 50. Value must match the regular expression [a-z][a-z0-9.-]*.

Field

Description

configurations[]

Configuration

List of Configuration resources.

nextPageToken

string

Token for getting the next page of the list. If the number of results is greater than
ListConfigurationsRequest.pageSize, use next_page_token as the value
for the ListConfigurationsRequest.pageToken parameter in the next list request.
Each subsequent page will have its own next_page_token to continue paging through the results.

Field

Description

id

string

ID of the configuration.

name

string

Name of the configuration.

memoryGib

string (int64)

Random-access memory (RAM) size in gibibytes (2^30 bytes).

cpu

CPU

CPU configuration.

diskDrives[]

DiskDriveConfiguration

Array of disk drive configurations.

networkCapacityGbps

string (int64)

Network capacity or bandwidth in gigabits per second.

cpuNum

string (int64)

Number of cpu.

networkInterfaces[]

ConfigurationNetworkInterface

Network interfaces of the configuration.

mountingAvailability

enum (MountingAvailability)

Indicates whether the mounting option is available or not for this configuration.

• AVAILABLE: Mounting is available.
• UNAVAILABLE: Mounting is unavailable.

Field

Description

name

string

Name of the CPU.

vendor

string

Vendor of the CPU.

cores

string (int64)

@deprecated. Number of cores.

physicalCores

string (int64)

Number of physical cores per CPU (socket).

frequencyMhz

string (int64)

Frequency of the CPU in megahertz (MHz).

Value must be greater than 0.

threads

string (int64)

Number of threads (logical cores) per CPU (socket).

Field

Description

type

enum (DiskDriveType)

Type of the disk drive.

• HDD: Hard disk drive (magnetic storage).
• SSD: Solid state drive with SATA/SAS interface.
• NVME: Solid state drive with NVMe interface.

diskCount

string (int64)

Number of disk drives.

diskSizeGib

string (int64)

Size of a single disk drive in gibibytes (2^30 bytes).

Field

Description

id

string

Id of the network interface
Not used while creating interfaces

name

string

Name of the network interface

configurationId

string

Id of the configuration

linkSpeedGbps

string (int64)

Link speed in gigabits per second

availableModes[]

enum (InterfaceMode)

Available modes for the network interface

• PRIVATE: Private network interface mode.
• PUBLIC: Public network interface mode.

mcLagOptions

MCLagAggregationOptions

MC-LAG configuration options for aggregated interfaces

Field

Description

interfaceCount

string (int64)

Number of interfaces in the MC-LAG aggregation.