Yandex Cloud
Search
Contact UsGet started
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • AI Studio
    • Business tools
  • 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
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
© 2025 Direct Cursus Technology L.L.C.
Yandex Compute Cloud
  • Yandex Container Solution
  • Access management
  • Pricing policy
  • Terraform reference
    • API authentication
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • ListOperations
        • ListInstances
        • ListHosts
        • UpdateHost
        • ListAccessBindings
        • SetAccessBindings
        • UpdateAccessBindings
  • Monitoring metrics
  • Audit Trails events
  • Release notes

In this article:

  • gRPC request
  • ListHostGroupHostsRequest
  • ListHostGroupHostsResponse
  • Host
  • Replacement
  1. API reference
  2. gRPC
  3. HostGroup
  4. ListHosts

Compute Cloud API, gRPC: HostGroupService.ListHosts

Written by
Yandex Cloud
Updated at November 26, 2024
  • gRPC request
  • ListHostGroupHostsRequest
  • ListHostGroupHostsResponse
  • Host
  • Replacement

Lists hosts that belongs to the specified host group.

gRPC requestgRPC request

rpc ListHosts (ListHostGroupHostsRequest) returns (ListHostGroupHostsResponse)

ListHostGroupHostsRequestListHostGroupHostsRequest

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

Field

Description

host_group_id

string

Required field. ID of the host group to list hosts for.
To get the host group ID, use HostGroupService.List request.

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 ListHostGroupHostsResponse.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 ListHostGroupHostsResponse.next_page_token
returned by a previous list request.

ListHostGroupHostsResponseListHostGroupHostsResponse

{
  "hosts": [
    {
      "id": "string",
      "status": "Status",
      "server_id": "string",
      "replacement": {
        "host_id": "string",
        "deadline_at": "google.protobuf.Timestamp"
      }
    }
  ],
  "next_page_token": "string"
}

Field

Description

hosts[]

Host

Lists hosts for the specified host group.

next_page_token

string

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

HostHost

Represents a dedicated host

Field

Description

id

string

ID of the host.

status

enum Status

Current status of the host. New instances are unable to start on host in DOWN status.

  • STATUS_UNSPECIFIED
  • UP
  • DOWN

server_id

string

ID of the physical server that the host belongs to.

replacement

Replacement

Set temporarily if maintenance is planned for this host, and a new host was provided as a replacement.

ReplacementReplacement

Field

Description

host_id

string

ID of the host which replaces this one.

deadline_at

google.protobuf.Timestamp

The date and time when this host will be automatically freed of instances.

Was the article helpful?

Previous
ListInstances
Next
UpdateHost
© 2025 Direct Cursus Technology L.L.C.