Yandex Cloud
Search
Contact UsTry it for free
  • Customer Stories
  • Documentation
  • Blog
  • All Services
  • System Status
  • Marketplace
    • Featured
    • Infrastructure & Network
    • Data Platform
    • AI for business
    • Security
    • DevOps tools
    • Serverless
    • Monitoring & Resources
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Center for Technologies and Society
    • Yandex Cloud Partner program
    • Price calculator
    • Pricing plans
  • Customer Stories
  • Documentation
  • Blog
© 2026 Direct Cursus Technology L.L.C.
Yandex BareMetal
    • All guides
    • Overview
      • Overview
      • Stock server configurations
      • Custom server configuration
      • Personalized server configuration
      • Overview
      • DHCP
      • MC-LAG
      • Restrictions in BareMetal networks
      • Overview
      • Images
      • Audit Trails events
      • Access management
      • Additional server settings
        • API authentication
          • Overview
            • Overview
            • Get
            • List
      • Monitoring metrics
    • Quotas and limits
  • Pricing policy
  • FAQ

In this article:

  • gRPC request
  • ListHardwarePoolsRequest
  • ListHardwarePoolsResponse
  • HardwarePool
  1. Concepts
  2. Setup and management
  3. API reference
  4. gRPC
  5. HardwarePool
  6. List

BareMetal API, gRPC: HardwarePoolService.List

Written by
Yandex Cloud
Updated at March 28, 2025
  • gRPC request
  • ListHardwarePoolsRequest
  • ListHardwarePoolsResponse
  • HardwarePool

Retrieves the list of HardwarePool resources.

gRPC requestgRPC request

rpc List (ListHardwarePoolsRequest) returns (ListHardwarePoolsResponse)

ListHardwarePoolsRequestListHardwarePoolsRequest

{
  "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 greater than page_size,
the service returns a ListHardwarePoolsResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.
Default value is 20.

page_token

string

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

ListHardwarePoolsResponseListHardwarePoolsResponse

{
  "hardware_pools": [
    {
      "id": "string",
      "zone_id": "string"
    }
  ],
  "next_page_token": "string"
}

Field

Description

hardware_pools[]

HardwarePool

List of HardwarePool resources.

next_page_token

string

Token for getting the next page of the list. If the number of results is greater than
[ListHardwarePoolsResponse.page_size], use next_page_token as the value
for the [ListHardwarePoolsResponse.page_token] parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

HardwarePoolHardwarePool

A HardwarePool resource.

Field

Description

id

string

ID of the hardware pool.

zone_id

string

ID of the zone where the hardware pool is located.

To get the zone ID use a ZoneService.List request.

Was the article helpful?

Previous
Get
Next
Overview
© 2026 Direct Cursus Technology L.L.C.