Contact UsGet started

Compute Cloud API, gRPC: HostGroupService.List

Written by
Updated at December 17, 2024

Retrieves the list of host groups in the specified folder.

gRPC request

rpc List (ListHostGroupsRequest) returns (ListHostGroupsResponse)

ListHostGroupsRequest

{
  "folder_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "filter": "string",
  "order_by": "string"
}

Field

Description

folder_id

string

Required field. ID of the folder to list host groups in.
To get the folder ID, use yandex.cloud.resourcemanager.v1.FolderService.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 ListHostGroupsResponse.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 ListHostGroupsResponse.next_page_token
returned by a previous list request.

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 =, !=, IN, NOT IN.
  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).

order_by

string

By which column the listing should be ordered and in which direction,
format is "createdAt desc". "id asc" if omitted.
The default sorting order is ascending

ListHostGroupsResponse

{
  "host_groups": [
    {
      "id": "string",
      "folder_id": "string",
      "created_at": "google.protobuf.Timestamp",
      "name": "string",
      "description": "string",
      "labels": "map<string, string>",
      "zone_id": "string",
      "status": "Status",
      "type_id": "string",
      "maintenance_policy": "MaintenancePolicy",
      "scale_policy": {
        // Includes only one of the fields `fixed_scale`
        "fixed_scale": {
          "size": "int64"
        }
        // end of the list of possible fields
      }
    }
  ],
  "next_page_token": "string"
}

Field

Description

host_groups[]

HostGroup

Lists host groups for the specified folder.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListHostGroupsRequest.page_size, use
next_page_token as the value
for the ListHostGroupsRequest.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.

HostGroup

Represents group of dedicated hosts

Field

Description

id

string

ID of the group.

folder_id

string

ID of the folder that the group belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp in RFC3339 text format.

name

string

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

description

string

Description of the group.

labels

object (map<string, string>)

Resource labels as key:value pairs.

zone_id

string

Availability zone where all dedicated hosts are allocated.

status

enum Status

Status of the group.

  • STATUS_UNSPECIFIED
  • CREATING
  • READY
  • UPDATING
  • DELETING

type_id

string

ID of host type. Resources provided by each host of the group.

maintenance_policy

enum MaintenancePolicy

Behaviour on maintenance events.

  • MAINTENANCE_POLICY_UNSPECIFIED
  • RESTART: Restart instance to move it to another host during maintenance
  • MIGRATE: Use live migration to move instance to another host during maintenance

scale_policy

ScalePolicy

Scale policy. Only fixed number of hosts are supported at this moment.

ScalePolicy

Field

Description

fixed_scale

FixedScale

Includes only one of the fields fixed_scale.

FixedScale

Field

Description

size

int64
Previous
Get
Next
Create