Связаться с намиПодключиться

Managed Service for SPQR API, REST: Cluster.ListHosts

Статья создана
Обновлена 3 октября 2025 г.

Retrieves a list of hosts for the specified cluster.

HTTP request

GET https://mdb.api.yandexcloud.kz/managed-spqr/v1/clusters/{clusterId}/hosts

Path parameters

Field

Description

clusterId

string

Required field. ID of the SPQR cluster.
To get the SPQR cluster ID, use a ClusterService.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 ListClusterHostsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Acceptable values are 0 to 1000, inclusive. Default value: 100.

pageToken

string

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

Response

HTTP Code: 200 - OK

{
  "hosts": [
    {
      "name": "string",
      "clusterId": "string",
      "zoneId": "string",
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "string",
        "diskTypeId": "string"
      },
      "role": "string",
      "health": "string",
      "services": [
        {
          "type": "string",
          "health": "string"
        }
      ],
      "subnetId": "string",
      "assignPublicIp": "boolean",
      "type": "string",
      "walleLink": "string",
      "stateReason": "string",
      "system": {
        "cpu": {
          "timestamp": "string",
          "used": "string"
        },
        "memory": {
          "timestamp": "string",
          "used": "string",
          "total": "string"
        },
        "disk": {
          "timestamp": "string",
          "used": "string",
          "total": "string"
        }
      },
      "shardName": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

hosts[]

Host

List of Host resources.

nextPageToken

string

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

Host

Field

Description

name

string

Name of the SPQR host. The host name is assigned by MDB at creation time, and cannot be changed.
1-63 characters long.

The name is unique across all MDB hosts that exist on the platform, as it defines the FQDN of the host.

clusterId

string

The ID of the SPQR cluster that the host belongs to.

zoneId

string

ID of the availability zone where the SPQR host resides.

resources

Resources

Resources allocated to the SPQR host.

role

enum (Role)

Role of the host in the cluster.

  • ROLE_UNKNOWN: Role of the host in the cluster is unknown.
  • PRIMARY: Host is the primary SPQR server in the cluster.
  • SECONDARY: Host is a secondary SPQR server in the cluster.
  • MASTER: Host is the master PostgreSQL server in the cluster.
  • REPLICA: Host is a replica (standby) PostgreSQL server in the cluster.

health

enum (Health)

Status code of the aggregated health of the host.

  • HEALTH_UNKNOWN: Health of the host is unknown.
  • ALIVE: The host is performing all its functions normally.
  • DEAD: The host is inoperable, and cannot perform any of its essential functions.
  • DEGRADED: The host is degraded, and can perform only some of its essential functions.

services[]

Service

Services provided by the host.

subnetId

string

ID of the subnet that the host belongs to.

assignPublicIp

boolean

Flag showing public IP assignment status to this host.

type

enum (Type)

Host type

  • TYPE_UNSPECIFIED
  • ROUTER: A SPQR Router host.
  • COORDINATOR: A SPQR Coordinator host.
  • INFRA: A SPQR Infra host (router+coordinator)
  • POSTGRESQL: A PostgreSQL host.
  • EXTERNAL_POSTGRESQL: An External PostgreSQL host.
  • MDB_POSTGRESQL: A Managed PostgreSQL host

walleLink

string

link to wall-e (porto only)

stateReason

string

host state reason from cms (porto only)

system

SystemMetrics

System metrics

shardName

string

Shard which this host belongs to.

Resources

Field

Description

resourcePresetId

string

ID of the preset for computational resources available to a host (CPU, memory etc.).
All available presets are listed in the documentation.

diskSize

string (int64)

Volume of the storage available to a host, in bytes.

diskTypeId

string

Type of the storage environment for the host.
Possible values:

  • network-hdd - network HDD drive,
  • network-ssd - network SSD drive,
  • local-ssd - local SSD storage.

Service

Field

Description

type

enum (Type)

Type of the service provided by the host.

  • TYPE_UNSPECIFIED
  • ROUTER: The host is running a SPQR Router.
  • COORDINATOR: The host is running a SPQR Coordinator.
  • INFRA: The host is running a SPQR router and coordinator
  • POSTGRESQL: The host is running a PostgreSQL.
  • EXTERNAL_POSTGRESQL: The host is running a PostgreSQL.
  • MDB_POSTGRESQL: The host is running a PostgreSQL

health

enum (Health)

Status code of server availability.

  • HEALTH_UNKNOWN: Health of the server is unknown.
  • ALIVE: The server is working normally.
  • DEAD: The server is dead or unresponsive.

SystemMetrics

Field

Description

cpu

CPUMetric

memory

MemoryMetric

disk

DiskMetric

CPUMetric

Field

Description

timestamp

string (int64)

used

string

MemoryMetric

Field

Description

timestamp

string (int64)

used

string (int64)

total

string (int64)

DiskMetric

Field

Description

timestamp

string (int64)

used

string (int64)

total

string (int64)
Предыдущая
ListBackups
Следующая
AddHosts