Method listHosts

Retrieves a list of hosts for the specified MySQL cluster.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-mysql/v1/clusters/{clusterId}/hosts

Path parameters

Parameter Description
clusterId Required. ID of the MySQL cluster. To get the MySQL cluster ID use a list request. The maximum string length in characters is 50.

Query 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. Acceptable values are 0 to 1000, inclusive.
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.

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": true
    }
  ],
  "nextPageToken": "string"
}
Field Description
hosts[] object

List of MySQL hosts.

hosts[].
name
string

Name of the MySQL host. The host name is assigned by Managed Service for MySQL at creation time, and cannot be changed. 1-63 characters long.

The name is unique across all existing database hosts in Yandex.Cloud, as it defines the FQDN of the host.

hosts[].
clusterId
string

ID of the MySQL host. The ID is assigned by Managed Service for MySQL at creation time.

hosts[].
zoneId
string

ID of the availability zone where the MySQL host resides.

hosts[].
resources
object

Resources allocated to the host.

hosts[].
resources.
resourcePresetId
string

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

hosts[].
resources.
diskSize
string (int64)

Volume of the storage available to a host.

hosts[].
resources.
diskTypeId
string

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

  • network-ssd — network SSD drive,
  • local-ssd — local SSD storage.
hosts[].
role
string

Role of the host in the cluster.

  • ROLE_UNKNOWN: Role of the host in the cluster is unknown.
  • MASTER: Host is the master MySQL server in the cluster.
  • REPLICA: Host is a replica MySQL server in the cluster.
hosts[].
health
string

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.
hosts[].
services[]
object

Services provided by the host.

hosts[].
services[].
type
string

Type of the service provided by the host.

  • MYSQL: The host is a MySQL server.
hosts[].
services[].
health
string

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.
hosts[].
subnetId
string

ID of the subnet that the host belongs to.

hosts[].
assignPublicIp
boolean (boolean)

Flag showing public IP assignment status to this host.

nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the 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.