Метод listHosts
Возвращает список хостов для указанного кластера SQL Server.
HTTP-запрос
GET https://mdb.api.cloud.yandex.net/mdb/sqlserver/v1alpha/clusters/{clusterId}/hosts
Path-параметры
Параметр | Описание |
---|---|
clusterId | Обязательное поле. Идентификатор кластера SQL Server. Чтобы получить идентификатор кластера SQL Server, используйте запрос list. Максимальная длина строки в символах — 50. |
Query-параметры
Параметр | Описание |
---|---|
pageSize | Максимальное количество результатов на одной странице в ответе. Если количество результатов больше чем page_size , сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Допустимые значения — от 0 до 1000 включительно. |
pageToken | Токен страницы. Установите значение page_token равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
Ответ
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"
}
Поле | Описание |
---|---|
hosts[] | object Список хостов SQL Server. |
hosts[]. name |
string Имя хоста SQL Server. Имя хоста Managed Service for SQL Server назначает во время создания, его нельзя изменить. Длина 1-63 символов. Имя уникально для всех существующих хостов баз данных в Яндекс.Облаке, так как оно определяет полное доменное имя (FQDN) хоста. |
hosts[]. clusterId |
string Идентификатор хоста SQL Server. Этот идентификатор Managed Service for SQL Server генерирует при создании. |
hosts[]. zoneId |
string Идентификатор зоны доступности, в которой находится хост SQL Server. |
hosts[]. resources |
object Ресурсы, выделенные хосту. |
hosts[]. resources. resourcePresetId |
string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
hosts[]. resources. diskSize |
string (int64) Объем хранилища, доступного хосту. |
hosts[]. resources. diskTypeId |
string Тип хранилища для хоста. Возможные значения:
|
hosts[]. role |
string Роль хоста в кластере.
|
hosts[]. health |
string Код работоспособности хоста.
|
hosts[]. services[] |
object Сервисы, предоставляемые хостом. |
hosts[]. services[]. type |
string Тип сервиса, предоставляемого хостом.
|
hosts[]. services[]. health |
string Код состояния доступности сервера.
|
hosts[]. subnetId |
string Идентификатор подсети, к которой принадлежит хост. |
hosts[]. assignPublicIp |
boolean (boolean) Флаг, показывающий статус публичного IP-адреса для этого хоста. |
nextPageToken | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте |