Method listHosts
Retrieves a list of hosts for the specified SQL Server cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/mdb/sqlserver/v1/clusters/{clusterId}/hosts
Path parameters
| Parameter | Description |
|---|---|
| clusterId | Required. ID of the SQL Server cluster. To get the SQL Server 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 page_size, 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 page_token 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 SQL Server hosts. |
| hosts[]. name |
string Name of the SQL Server host. The host name is assigned by Managed Service for SQL Server 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 SQL Server host. The ID is assigned by Managed Service for SQL Server at creation time. |
| hosts[]. zoneId |
string ID of the availability zone where the SQL Server 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:
|
| hosts[]. role |
string Role of the host in the cluster.
|
| hosts[]. health |
string Status code of the aggregated health of the host.
|
| hosts[]. services[] |
object Services provided by the host. |
| hosts[]. services[]. type |
string Type of the service provided by the host.
|
| hosts[]. services[]. health |
string Status code of server availability.
|
| 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 Token that allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the |