Managed Service for MySQL API, gRPC: ClusterService.ListHosts
Retrieves a list of hosts for a cluster.
gRPC request
rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)
ListClusterHostsRequest
{
"clusterId": "string",
"pageSize": "int64",
"pageToken": "string"
}
Field |
Description |
clusterId |
string Required field. ID of the cluster to list hosts for. To get this ID, make a ClusterService.List request. |
pageSize |
int64 The maximum number of results per page to return. If the number of available results is larger than |
pageToken |
string Page token that can be used to iterate through multiple pages of results. To get the next page of results, set |
ListClusterHostsResponse
{
"hosts": [
{
"name": "string",
"clusterId": "string",
"zoneId": "string",
"resources": {
"resourcePresetId": "string",
"diskSize": "int64",
"diskTypeId": "string"
},
"role": "Role",
"health": "Health",
"services": [
{
"type": "Type",
"health": "Health"
}
],
"subnetId": "string",
"assignPublicIp": "bool",
"replicationSource": "string",
"backupPriority": "int64",
"priority": "int64"
}
],
"nextPageToken": "string"
}
Field |
Description |
hosts[] |
List of hosts in the cluster. |
nextPageToken |
string The token that can be used to get the next page of results. If the number of results is larger than ListClusterHostsRequest.pageSize, use the Each of the subsequent ClusterService.ListHosts requests should use the |
Host
Field |
Description |
name |
string Name of the host. This name is assigned by the platform at the time of creation. |
clusterId |
string ID of the cluster the host belongs to. |
zoneId |
string ID of the availability zone where the host resides. |
resources |
Resources allocated to the host. |
role |
enum Role Role of the host in the cluster. If the field has default value, it is not returned in the response.
|
health |
enum Health Aggregated health of the host. If the field has default value, it is not returned in the response.
|
services[] |
List of services provided by the host. |
subnetId |
string ID of the subnet that the host belongs to. |
assignPublicIp |
bool Flag that shows if public IP address is assigned to the host so that the host can be accessed from the internet. |
replicationSource |
string Name of the host to be used as the replication source for cascading replication. |
backupPriority |
int64 Host backup priority. |
priority |
int64 Host master promotion priority. |
Resources
Cluster resource preset.
Field |
Description |
resourcePresetId |
string ID of the resource preset that defines available computational resources (vCPU, RAM, etc.) for a cluster host. All available presets are listed in the documentation. |
diskSize |
int64 Volume of the storage (for each cluster host, in bytes). |
diskTypeId |
string Type of the storage. Possible values:
See the documentation for details. |
Service
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.
|
health |
enum Health Aggregated health of the service. If the field has default value, it is not returned in the response.
|