Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Compute Cloud API, REST: HostGroup.ListHosts

Written by
Updated at November 26, 2024

Lists hosts that belongs to the specified host group.

HTTP request

GET https://compute.api.cloud.yandex.net/compute/v1/hostGroups/{hostGroupId}/hosts

Path parameters

Field

Description

hostGroupId

string

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

Query parameters

Field

Description

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize,
the service returns a ListHostGroupHostsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

pageToken

string

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

Response

HTTP Code: 200 - OK

{
  "hosts": [
    {
      "id": "string",
      "status": "string",
      "serverId": "string",
      "replacement": {
        "hostId": "string",
        "deadlineAt": "string"
      }
    }
  ],
  "nextPageToken": "string"
}

Field

Description

hosts[]

Host

Lists hosts for the specified host group.

nextPageToken

string

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

Host

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

serverId

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.

Replacement

Field

Description

hostId

string

ID of the host which replaces this one.

deadlineAt

string (date-time)

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

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
Previous
ListInstances
Next
UpdateHost