Yandex Cloud
Search
Contact UsGet started
  • Services
  • Solutions
  • Why Yandex Cloud
  • Blog
  • Pricing
  • Documentation
Language / Region
Yandex project
© 2023 Intertech Services AG
Yandex Compute Cloud
  • Yandex Container Solution
  • Access management
    • Authentication in the API
      • Overview
        • Overview
        • create
        • delete
        • get
        • list
        • listHosts
        • listInstances
        • listOperations
        • update
  1. API reference
  2. REST
  3. HostGroup
  4. listHosts

Compute Cloud API, REST: HostGroup.listHosts

Written by
Yandex Cloud
  • HTTP request
  • Path parameters
  • Query parameters
  • Response

Lists hosts that belongs to the specified host group.

HTTP requestHTTP request

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

Path parametersPath parameters

Parameter Description
hostGroupId

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

The maximum string length in characters is 50.

Query parametersQuery parameters

Parameter Description
pageSize

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

The maximum value is 1000.

pageToken

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

The maximum string length in characters is 100.

ResponseResponse

HTTP Code: 200 - OK

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

Lists hosts for the specified host group.

hosts[].
id
string

ID of the host.

hosts[].
status
string

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

hosts[].
serverId
string

ID of the physical server that the host belongs to.

hosts[].
replacement
object

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

hosts[].
replacement.
hostId
string

ID of the host which replaces this one.

hosts[].
replacement.
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).

nextPageToken string

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

Was the article helpful?

Previous
list
Next
listInstances
Language / Region
Yandex project
© 2023 Intertech Services AG
In this article:
  • HTTP request
  • Path parameters
  • Query parameters
  • Response