Yandex Cloud
Поиск
Связаться с намиПопробовать бесплатно
  • Кейсы
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
  • Marketplace
    • Доступны в регионе
    • Инфраструктура и сеть
    • Платформа данных
    • Искусственный интеллект
    • Безопасность
    • Инструменты DevOps
    • Бессерверные вычисления
    • Управление ресурсами
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Партнёрская программа
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Калькулятор цен
    • Тарифы
    • Акции и free tier
  • Кейсы
  • Документация
  • Блог
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ТОО «Облачные Сервисы Казахстан»
Yandex BareMetal
    • Все инструкции
    • Обзор сервиса
      • Обзор
      • Готовые конфигурации серверов
      • Своя конфигурация сервера
      • Конфигурация сервера под заказ
      • Обзор
      • Публичная сеть
      • Приватная сеть
      • DHCP
      • MC-LAG
      • Ограничения в сетях BareMetal
      • Обзор
      • Образы
      • Управление доступом
      • Дополнительные настройки серверов
      • Консоль управления
        • Аутентификация в API
          • Overview
            • Overview
            • Get
            • List
            • Create
            • BatchCreate
            • Update
            • PowerOff
            • PowerOn
            • Reboot
            • Reinstall
            • ListOperations
            • StartProlongation
            • StopProlongation
      • Метрики Monitoring
    • Квоты и лимиты
  • Правила тарификации
  • Вопросы и ответы

В этой статье:

  • gRPC request
  • GetServerRequest
  • Server
  • OsSettings
  • Storage
  • Disk
  • Raid
  • StoragePartition
  • NetworkInterface
  • PrivateSubnetNetworkInterface
  • PublicSubnetNetworkInterface
  • PrivateNetworkInterface
  • VLANSubinterface
  • PublicNetworkInterface
  • NativeSubnet
  • NewNativeSubnet
  1. Концепции
  2. Настройка и управление
  3. Справочник API
  4. gRPC (англ.)
  5. Server
  6. Get

BareMetal API, gRPC: ServerService.Get

Статья создана
Yandex Cloud
Обновлена 21 апреля 2026 г.
  • gRPC request
  • GetServerRequest
  • Server
  • OsSettings
  • Storage
  • Disk
  • Raid
  • StoragePartition
  • NetworkInterface
  • PrivateSubnetNetworkInterface
  • PublicSubnetNetworkInterface
  • PrivateNetworkInterface
  • VLANSubinterface
  • PublicNetworkInterface
  • NativeSubnet
  • NewNativeSubnet

Returns the specific Server resource.
To get the list of available Server resources, make a List request.

gRPC requestgRPC request

rpc Get (GetServerRequest) returns (Server)

GetServerRequestGetServerRequest

{
  "server_id": "string"
}

Field

Description

server_id

string

ID of the Server resource to return.
To get the server ID, use a ServerService.List request.

Value must match the regular expression [a-z][a-z0-9]*.

ServerServer

{
  "id": "string",
  "cloud_id": "string",
  "folder_id": "string",
  "name": "string",
  "description": "string",
  "zone_id": "string",
  "hardware_pool_id": "string",
  "status": "Status",
  "os_settings": {
    "image_id": "string",
    "ssh_public_key": "string",
    "storages": [
      {
        // Includes only one of the fields `disk`, `raid`
        "disk": {
          "id": "string",
          "type": "DiskDriveType",
          "size_gib": "int64"
        },
        "raid": {
          "type": "RaidType",
          "disks": [
            {
              "id": "string",
              "type": "DiskDriveType",
              "size_gib": "int64"
            }
          ]
        },
        // end of the list of possible fields
        "partitions": [
          {
            "type": "StoragePartitionType",
            "size_gib": "int64",
            "mount_point": "string"
          }
        ]
      }
    ]
  },
  "network_interfaces": [
    {
      // Includes only one of the fields `private_subnet`, `public_subnet`
      "private_subnet": {
        "private_subnet_id": "string"
      },
      "public_subnet": {
        "public_subnet_id": "string"
      },
      // end of the list of possible fields
      // Includes only one of the fields `private_interface`, `public_interface`
      "private_interface": {
        "native_subnet_id": "string",
        "ip_address": "string",
        "mac_limit": "int64",
        "vlan_subinterfaces": [
          {
            "tagged_subnet_id": "string",
            "ip_address": "string",
            "mac_limit": "int64"
          }
        ]
      },
      "public_interface": {
        // Includes only one of the fields `native_subnet`, `new_native_subnet`
        "native_subnet": {
          "subnet_id": "string"
        },
        "new_native_subnet": {
          "addressing_type": "AddressingType"
        },
        // end of the list of possible fields
        "ip_address": "string",
        "native_subnet_id": "string",
        "mac_limit": "int64"
      },
      // end of the list of possible fields
      "id": "string",
      "mac_address": "string",
      "ip_address": "string"
    }
  ],
  "configuration_id": "string",
  "disks": [
    {
      "id": "string",
      "type": "DiskDriveType",
      "size_gib": "int64"
    }
  ],
  "created_at": "google.protobuf.Timestamp",
  "labels": "map<string, string>"
}

A Server resource.

Field

Description

id

string

ID of the server.

cloud_id

string

ID of the cloud that the server belongs to.

folder_id

string

ID of the folder that the server belongs to.

name

string

Name of the server.
The name is unique within the folder.

description

string

Description of the server.

zone_id

string

ID of the availability zone where the server is resides.

hardware_pool_id

string

ID of the hardware pool that the server belongs to.

status

enum Status

Status of the server.

  • PROVISIONING: Server is waiting for to be allocated from the hardware pool.
  • STOPPING: Server is being stopped.
  • STOPPED: Server has been stopped.
  • STARTING: Server is being started.
  • RESTARTING: Server is being restarted.
  • ERROR: Server encountered a problem and cannot operate.
  • DELETING: Server is being deleted.
  • REINSTALLING: Server operating system is being reinstalled.
  • UPDATING: Server is being updated.
  • QUARANTINED: Server has been quarantined
  • RUNNING: Server is running normaly

os_settings

OsSettings

Operating system specific settings of the server. Optional, will be empty if the server is
provisioned without an operating system.

network_interfaces[]

NetworkInterface

Array of network interfaces that are attached to the instance.

configuration_id

string

ID of the configuration that was used to create the server.

disks[]

Disk

Array of disks that are attached to the server.

created_at

google.protobuf.Timestamp

Creation timestamp.

labels

object (map<string, string>)

Resource labels as key:value pairs.

OsSettingsOsSettings

Field

Description

image_id

string

ID of the image that the server was created from.

ssh_public_key

string

Public SSH key of the server.

storages[]

Storage

List of storages.

StorageStorage

Storage, a OS-level storage entity used for creating partitions. For example, this could
represent a plain disk or a software RAID of disks.

Field

Description

disk

Disk

Disk storage.

Includes only one of the fields disk, raid.

Storage type.

raid

Raid

RAID storage.

Includes only one of the fields disk, raid.

Storage type.

partitions[]

StoragePartition

Array of partitions created on the storage.

DiskDisk

Disk.

Field

Description

id

string

ID of the disk.

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.

size_gib

int64

Size of the disk in gibibytes (2^30 bytes).

RaidRaid

RAID storage.

Field

Description

type

enum RaidType

RAID type.

  • RAID0: RAID0 configuration.
  • RAID1: RAID1 configuration.
  • RAID10: RAID10 configuration.

disks[]

Disk

Array of disks in the RAID configuration.

StoragePartitionStoragePartition

Field

Description

type

enum StoragePartitionType

Partition type.

  • EXT4: ext4 file system partition type.
  • SWAP: Swap partition type.
  • EXT3: ext3 file system partition type.
  • XFS: XFS file system partition type.

size_gib

int64

Size of the storage partition in gibibytes (2^30 bytes).

mount_point

string

Storage mount point.

NetworkInterfaceNetworkInterface

Field

Description

private_subnet

PrivateSubnetNetworkInterface

@deprecated Private subnet.

Includes only one of the fields private_subnet, public_subnet.

@deprecated. Use interface instead.
Subnet that the network interface belongs to.

public_subnet

PublicSubnetNetworkInterface

@deprecated Public subnet.

Includes only one of the fields private_subnet, public_subnet.

@deprecated. Use interface instead.
Subnet that the network interface belongs to.

private_interface

PrivateNetworkInterface

Private interface.

Includes only one of the fields private_interface, public_interface.

public_interface

PublicNetworkInterface

Public interface.

Includes only one of the fields private_interface, public_interface.

id

string

ID of the network interface.

mac_address

string

MAC address that is assigned to the network interface.
Read only field.

ip_address

string

@deprecated. Use interface.ipaddress instead.
IPv4 address that is assigned to the server for this network interface.
Read only field.

PrivateSubnetNetworkInterfacePrivateSubnetNetworkInterface

Field

Description

private_subnet_id

string

ID of the private subnet.

PublicSubnetNetworkInterfacePublicSubnetNetworkInterface

Field

Description

public_subnet_id

string

ID of the public subnet.
A new ephemeral public subnet will be created if not specified.

PrivateNetworkInterfacePrivateNetworkInterface

Field

Description

native_subnet_id

string

ID of the private subnet which is used as native subnet for interface.

ip_address

string

IPv4 address that is assigned to the server for this network interface.
Read only field.

mac_limit

int64

Limit of MAC addresses in the native subnet.
Read only field.

vlan_subinterfaces[]

VLANSubinterface

Array of VLAN subinterfaces. Additional tagged subnets for the interface.

VLANSubinterfaceVLANSubinterface

Field

Description

tagged_subnet_id

string

ID of the private subnet which is used as tagged subnet for interface.

ip_address

string

IPv4 address that is assigned to the VLAN subinterface.
Read only field.

mac_limit

int64

Limit of MAC addresses in the tagged subnet.
Read only field.

PublicNetworkInterfacePublicNetworkInterface

Field

Description

native_subnet

NativeSubnet

Use existing native subnet.
Input only field.

Includes only one of the fields native_subnet, new_native_subnet.

Native subnet configuration.
Input only field.

new_native_subnet

NewNativeSubnet

Create new native subnet.
Input only field.

Includes only one of the fields native_subnet, new_native_subnet.

Native subnet configuration.
Input only field.

ip_address

string

IPv4 address that is assigned to the server for this network interface.
Read only field.

native_subnet_id

string

ID of the public subnet which is used as native subnet for interface.
Read only field.

mac_limit

int64

Limit of MAC addresses in the native subnet.
Read only field.

NativeSubnetNativeSubnet

Configuration for using existing native subnet.

Field

Description

subnet_id

string

ID of the existing public subnet.

NewNativeSubnetNewNativeSubnet

Configuration for creating new native subnet.

Field

Description

addressing_type

enum AddressingType

Addressing type (DHCP | Static).

  • DHCP: DHCP addressing.
  • STATIC: Static addressing.

Была ли статья полезна?

Предыдущая
Overview
Следующая
List
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ТОО «Облачные Сервисы Казахстан»