Managed Service for Redis API, REST: Cluster.ListHosts

Field

Description

clusterId

string

Required field. ID of the Redis cluster.
To get the Redis cluster ID use a ClusterService.List request.

The maximum string length in characters is 50.

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.

pageToken

string

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

The maximum string length in characters is 100.

Field

Description

hosts[]

Host

List of hosts for the cluster.

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.

Field

Description

name

string

Required field. Name of the Redis 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

Required field. ID of the Redis cluster. The ID is assigned by MDB at creation time.

zoneId

string

Required field. ID of the availability zone where the Redis host resides.

subnetId

string

ID of the subnet that the host belongs to.

resources

Resources

Required field. Resources allocated to the Redis host.

role

enum (Role)

Required field. Role of the host in the cluster. If the field has default value, it is not returned in the response.

• ROLE_UNKNOWN: Role of the host in the cluster is unknown. Default value.
• MASTER: Host is the master Redis server in the cluster.
• REPLICA: Host is a replica (standby) Redis server in the cluster.

health

enum (Health)

Required field. Aggregated health of the host. If the field has default value, it is not returned in the response.

• HEALTH_UNKNOWN: Health of the host is unknown. Default value.
• 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.

shardName

string

Name of the shard that the host belongs to.

replicaPriority

string (int64)

A replica with a low priority number is considered better for promotion.
A replica with priority of 0 will never be selected by Redis Sentinel for promotion.
Works only for non-sharded clusters. Default value is 100.

assignPublicIp

boolean

Flag showing public IP assignment status to this host.

Field

Description

resourcePresetId

string

Required field. 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-ssd - network SSD drive,
• local-ssd - local SSD storage.

Field

Description

type

enum (Type)

Type of the service provided by the host. If the field has default value, it is not returned in the response.

• REDIS: The host is a Redis server.
• ARBITER: The host provides a Sentinel-only service (a quorum node).
• REDIS_CLUSTER: The host is a Redis Cluster node.

health

enum (Health)

Required field. Aggregated health of the service. If the field has default value, it is not returned in the response.

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