API
Используя наши API, Вы можете создать собственный бизнес White-label, получив весь список функций доступный у Вас в личном кабинете.
Запросы к API зашифрованы SSL и отправляются наиболее привычным и удобным способом – обычным HTTP GET или POST-запросом с ответом в формате JSON.
В настройках своего аккаунта Вы можете задать собственные параметры «Свойства Компьютера», создаваемого через API, а также получить универсальный промокод, дающий 10% скидку для всех серверов, создаваемых с использованием функций API.
Перед тем как отправить какой-либо запрос необходимо получить авторизационный SessionToken. Он может быть как пожизненный, так и сроком действия на 1 сутки.
Разрабатывайте приложения таким образом, чтобы никому из клиентов никогда не передавался Ваш SessionToken. Он должен быть известен только серверной части Вашего приложения и никогда клиентской.
SessionToken действителен до времени своей экспирации, если не будет изменён логин или пароль аккаунта – в таком случае все выданные ранее SessionToken перестают действовать.
Адрес: https://ultravds.com/api/logon/
Параметры запроса:
username – Ваш логин или email
password – пароль от Вашего аккаунта
endless – значение 1 для получения бессрочного токена и 0 для получения на 1 сутки
Пример запроса:
Пример ответа:
{
"rejectReason": 0,
"sessionToken": "58f9b7a373080599a21baf5816b932570d274823ferbfa5f7f3370cef46e0e81",
"expire": "21072014162751"
}
Поля ответа:
rejectReason – числовое значение (код ошибки)
errMessage – текстовое описание ошибки если возникла
sessionToken – авторизационный токен для дальнейшей работы
expire – дата и время (UTC) истечения срока действия токена, если NULL, то бессрочный (формат ddMMyyyyHHmmss)
Коды ошибок:
0 – запрос выполнен успешно
1 – не указан логин/email
2 – не указан пароль
3 – неверная связка логин+пароль
5 – внутренняя ошибка системы
6 – не указан ключ API
7 – неверный ключ API
8 – превышено количество попыток входа. С данным кодом ошибки в ответном сообщении будет добавлен параметр accessDT, содержащий время UTC (ddMMyyyyHHmmss) когда будет возможно отправить повторный запрос авторизации для данного аккаунта.
13 – в аккаунте клиента запрещены авторизации с чужими ключами API
Функция позволяет получить информацию о доступном балансе на сайте с детализацией поступлений и списаний.
Адрес: https://ultravds.com/api/balance/
Параметры запроса:
sessionToken – токен, полученный при авторизации
details – значение 1 для получения подробных деталей поступлений и списаний, 0 - только текущий баланс
Пример запроса:
Пример ответа:
{
"rejectReason": 0,
"amount": 20,
"currency": 1,
"details":
{
"income": 300,
"debited": 280,
"items":
[
{
"type": 2,
"dt": "12012014133846",
"amount": 280,
"currency": 1,
"description": "Сервер u1000 (1x2.2ГГц, 1Гб RAM, 20Гб HDD, 1IP) за период с 12 января 2014 по 12 февраля 2014",
},
{
"type": 1,
"dt": "12012014133846",
"amount": 300,
"currency": 1,
"description": "Пополнение баланса банковской картой Visa / MasterCard",
}
]
}
}
Поля ответа:
rejectReason – числовое значение (код ошибки)
errMessage – текстовое описание ошибки если возникла
amount – сумма доступного баланса
currency – валюта, по которой пересчитан баланс (1 - RUB, 2 - UAH, 3 - USD, 4 - EUR)
details – детализация, если была запрошена:
income – сумма всех поступлений
debited – сумма всех списаний
items – детализация поступлений/списаний:
type – 1 - поступление средств, 2 - списание
dt – дата и время операции (UTC, формат ddMMyyyyHHmmss)
amount – сумма
currency – валюта операции
description – текстовое описание
Коды ошибок:
0 – запрос выполнен успешно
1 – неверный авторизационный токен
2 – не указан авторизационный токен
100 – внутренняя ошибка системы
Данная функция возвращает актуальные тарифные планы и доступные в настоящий момент варианты конфигураций серверов (важно понимать, что возможно отключение создания серверов отдельно на HDD, SSD, премиум или отключено всё по причине, например, технических работ).
По умолчанию функция возвращает только список актуальных тарифных планов, но если Вам требуется какой-либо устаревший тариф, и Вы знаете его ID, то Вы можете его также запросить.
Адрес: https://ultravds.com/api/tariff/
Параметры запроса:
sessionToken – токен, полученный при авторизации
id – ID требуемых тарифных планов через запятую
Пример запроса:
Пример ответа:
{
"rejectReason": 0,
"newServer": true,
"regular": true,
"regularSSD": true,
"premium": true,
"ddosProtection":
{
"regular":
{
"available": true,
"price": 500
}, "premium":
{
"available": false,
"price": null
} },
"items":
[
{
"premium": false,
"id": 4,
"cpu": 60,
"ram": 140,
"drive": {"hdd":4,"ssd":12 },
"ip": 50,
"active": true
},
{
"premium": true,
"id": 8,
"cpu": 90,
"ram": 210,
"drive": {"hdd":6 },
"ip": 50,
"active": true
}
]
}
Поля ответа:
rejectReason – числовое значение (код ошибки)
errMessage – текстовое описание ошибки если возникла
newServer – можно ли создать новый сервер
regular – доступно ли для новых серверов стандартное размещение на HDD
regularSSD – доступно ли для новых серверов стандартное размещение на SSD
premium – доступно ли для новых серверов "премиум" размещение
ddosProtection – информация по доступности услуги защиты от DDoS-атак и стоимости
items – тарифные планы
premium – является ли тарифный план планом "премиум"
id – ID тарифного плана в системе UltraVDS
cpu – стоимость 1 ядра процессора (RUB)
ram – стоимость 1ГБ оперативной памяти (RUB)
drive – стоимость 1ГБ жёсткого диска (RUB) и доступные варианты (HDD, SSD)
ip – стоимость 1 IP-адреса (1 IP на сервер даётся бесплатно, RUB)
active – актуален ли тариф в настоящий момент
Коды ошибок:
0 – запрос выполнен успешно
1 – неверный авторизационный токен
2 – не указан авторизационный токен
100 – внутренняя ошибка системы
Данная функция недоступна по умолчанию и включается только для юридических лиц при условии обязательного заключения партнёрского Договора. Для получения более детальной информации обращайтесь к службе поддержки.
Адрес: https://ultravds.com/api/user/get/
Параметры запроса:
sessionToken – токен, полученный при авторизации
id – ID требуемых пользователей через запятую, либо значение me
Пример запроса:
Пример ответа:
{
"rejectReason": 0,
"result":
[
{
"id": 00000000-1111-2222-3333-555555555555,
"login": "UserLogin",
"orgName": "Название организации",
"firstName": "Иванов",
"lastName": "Иван",
"patronymic": "Иванович",
"gender": 1,
"birthDate": "29061975",
"city":
{
"name": "Москва",
"country": {"name":"Россия","phoneCode":7 },
"lat": 55.751667,
"lng": 37.617778,
},
"postcode": null,
"address": "название улицы и номер дома",
"phone": "9031112233",
"phoneVerified": true,
"email": "user@mail.com",
"emailVerified": true,
"balance": 0,
"currency": 1,
"org": null,
}
]
}
Поля ответа:
rejectReason – числовое значение (код ошибки)
errMessage – текстовое описание ошибки если возникла
result – массив списка пользователей
id – ID пользователя в системе UltraVDS
login – логин пользователя
orgName – название организации (если есть)
firstName – имя
lastName – фамилия
patronymic – отчество
gender – пол: 1 - мужской; 2 - женский
birthDate – дата рождения в формате ddMMyyyy
city – город с привязкой к стране
postcode – почтовый индекс
address – адрес прописки/местонахождения
phone – номер телефона (без кода страны)
phoneVerified – подтверждён ли номер телефона
email – адрес email
emailVerified – подтверждён ли адрес email
balance – баланс на счёте пользователя
currency – валюта счёта пользователя: 1 - рубли; 2 - гривны; 3 - доллары США; 4 - евро
org – детальзация по юр. лицу пользователя
Коды ошибок:
0 – запрос выполнен успешно
3 – неверный авторизационный токен или нет доступа к управлению пользователями
6 – неверные параметры запроса
1000 – внутренняя ошибка системы
Данная функция недоступна по умолчанию и включается только для юридических лиц при условии обязательного заключения партнёрского Договора. Для получения более детальной информации обращайтесь к службе поддержки.
Адрес: https://ultravds.com/api/user/create/ и https://ultravds.com/api/user/update/
Параметры запроса:
sessionToken – токен, полученный при авторизации
id – ID пользователя в системе UltraVDS
login – логин пользователя
password – пароль для пользователя (только если создаётся новый)
email – адрес email
phone – номер телефона
orgName – название организации
firstName – имя
lastName – фамилия
patronymic – отчество
gender – пол: 1 - мужской; 2 - женский
birthDate – дата рождения в формате dd.MM.yyyy
country – название страны (по умолчанию Россия если поле пустое)
city – название города
postcode – почтовый индекс
address – адрес прописки/местонахождения
Пример запроса:
Пример ответа:
{
"rejectReason": 0,
"result":null
}
Поля ответа:
rejectReason – числовое значение (код ошибки)
errMessage – текстовое описание ошибки если возникла
result – объект пользователя (не NULL если успешный результат)
Коды ошибок:
0 – запрос выполнен успешно
3 – неверный авторизационный токен или нет доступа к управлению пользователями
4 – передано пустое значение поля password (при создании)
5 – слишком простой или короткий пароль
6 – неверные параметры запроса
7 – пользователь не найден, либо нет прав на редактирование
11 – передано пустое значение поля login
12 – поле login содержит недопустимые символы
13 – данный логин не может быть использован
14 – логин уже занят другим пользователем
21 – передано пустое значение поля email
22 – неверный формат адреса email
23 – адрес email уже использовался в другом аккаунте
31 – передано пустое значение поля phone
32 – некорректно (неполно) указан номер телефона
33 – номер телефона уже использовался в другом аккаунте
1000 – внутренняя ошибка системы
Данная функция недоступна по умолчанию и включается только для юридических лиц при условии обязательного заключения партнёрского Договора. Для получения более детальной информации обращайтесь к службе поддержки.
Адрес: https://ultravds.com/api/user/change_password/
Параметры запроса:
sessionToken – токен, полученный при авторизации
id – ID пользователя в системе UltraVDS
password – новый пароль для пользователя
Пример запроса:
Пример ответа:
{
"rejectReason": 0,
"result":null
}
Поля ответа:
rejectReason – числовое значение (код ошибки)
errMessage – текстовое описание ошибки если возникла
result – объект пользователя (не NULL если успешный результат)
Коды ошибок:
0 – запрос выполнен успешно
3 – неверный авторизационный токен или нет доступа к управлению пользователями
4 – передано пустое значение поля password
5 – слишком простой или короткий пароль
6 – неверные параметры запроса
7 – пользователь не найден, либо нет прав на редактирование
1000 – внутренняя ошибка системы
Данная функция недоступна по умолчанию и включается только для юридических лиц при условии обязательного заключения партнёрского Договора. Для получения более детальной информации обращайтесь к службе поддержки.
Адрес: https://ultravds.com/api/user/remove/
Параметры запроса:
sessionToken – токен, полученный при авторизации
id – ID пользователя в системе UltraVDS
Пример запроса:
Пример ответа:
{
"rejectReason": 0,
"result":null
}
Поля ответа:
rejectReason – числовое значение (код ошибки)
errMessage – текстовое описание ошибки если возникла
result – объект пользователя (не NULL если успешный результат)
Коды ошибок:
0 – запрос выполнен успешно
3 – неверный авторизационный токен или нет доступа к управлению пользователями
6 – неверные параметры запроса
7 – пользователь не найден, либо нет прав на удаление
40 – у пользователя есть серверы в личном кабинете
1000 – внутренняя ошибка системы
По умолчанию функция возвращает информацию обо всех Ваших серверах. Если Вам требуется получить информацию только о каких-то конкретно, Вы можете указать дополнительно их ID (настоятельно рекомендуется).
Адрес: https://ultravds.com/api/server/
Параметры запроса:
sessionToken – токен, полученный при авторизации
userId – ID пользователя, по которому нужно получить сервера (если доступно)
id – ID требуемых серверов через запятую
Пример запроса:
Пример ответа:
{
"rejectReason": 0,
"items":
[
{
"id": 1937,
"cpu": 2,
"ram": 2,
"drive": [ {"type":1,"capacity":60 } ],
"ip":
{
"count": 1,
"differentSubnets": false,
"assigned": [ "127.0.0.1" ],
},
"premium": false,
"tariff":
{
"premium": false,
"id": 4,
"cpu": 60,
"ram": 140,
"drive": {"hdd":4,"ssd":12 },
"ip": 50,
"active": true
},
"paymentPeriod": 3,
"discount":
{
"paymentPeriod": 0.05,
"promocode": 0.1
},
"state": 100,
"addDT": "14062014162328",
"createDT": "14062014162615",
"createProgress": 100,
"createState": 100,
"defaultAdminPassword": "ib4M7Fu3c",
"configurationUpdating": false,
"limitedTrafficMbps": null,
"limitedCPU": null,
"running": true,
"paid": true,
"paidTill": "14082014162329",
"stat":
{
"traffic": {"value":21,"limit":153600,"state":1 },
"trafficOutbound": {"value":5,"limit":153600,"state":1 },
"trafficInbound": {"value":16,"limit":153600,"state":1 },
"avgDataRead": {"value":52,"limit":18432,"state":1 },
"avgDataWritten": {"value":6,"limit":9216,"state":1 },
"avgIOPS": {"value":1,"limit":250,"state":1 },
"avgCPU": {"value":0,"limit":40,"state":1 }
},
"notifications":
[
{
"id": 3829,
"type": 3,
"blocked": true,
"message": "<div style="margin-bottom:6px;">Зафиксирован большой входящий мусорный трафик: <b>57 Гб</b></div><div style="margin-bottom:6px;">Это может быть причиной...",
"dt": "21062014061539"
}
], "configurationChangeable": true,
"canRecreate": true
}
]
}
Поля ответа:
rejectReason – числовое значение (код ошибки)
errMessage – текстовое описание ошибки если возникла
items – массив серверов
id – ID сервера в системе UltraVDS, формирующий название uXXXX
cpu – количество ядер процессора
ram – количество ГБ оперативной памяти
drive – установленные жёсткие диски, их тип (1 - HDD, 3 - SSD) и объём в ГБ
ip – информация по IP-адресам сервера
count – затребованное кличество адресов
differentSubnets – обязателно ли назначение из разных подсетей
assigned – массив назначенных адресов
premium – является ли сервер сервером с "премиум" размещением
tariff – детали тарифного плана
premium – является ли тарифный план планом "премиум"
id – ID тарифного плана в системе UltraVDS
cpu – стоимость 1 ядра процессора (RUB)
ram – стоимость 1ГБ оперативной памяти (RUB)
drive – стоимость 1ГБ жёсткого диска (RUB) с разделением по HDD и SSD
ip – стоимость 1 IP-адреса (1 IP на сервер даётся бесплатно, RUB)
active – актуален ли тариф в настоящий момент
paymentPeriod – 1 - тест; 2 - 1 месяц; 3 - 3 месяца; 4 - 6 месяцев; 5 - 1 год
discount – относящиеся к серверу скидки, null если их нет
paymentPeriod – скидка за выбранный период оплаты, %
promocode – скидка по промокоду, %
state – 1 - новый; 2 - сконфигурирован; 3 - контактные данные не подтверждены; 4 - нет доступных ресурсов; 5 - не оплачен; 6 - заблокирован за нарушение; 100 - готов к работе
addDT – дата и время добавления (UTC в формате ddMMyyyyHHmmss)
createDT – дата и время завершения создания (UTC в формате ddMMyyyyHHmmss), null если не создан
createProgress – значение от 0 до 100 состояния создания сервера
createState – 1 - в ожидании; 2 - запуск начала; 3 - копирование файлов; 4 - запуск системы; 5 - конфигурирование; 6 - перезагрузка; 100 - завершено
defaultAdminPassword – пароль, созданный по умолчанию для пользователя Administrator
configurationUpdating – идёт ли процесс изменения конфигурации сервера
limitedTrafficMbps – заданное ограничение на трафик (Mbps)
limitedCPU – заданное ограчениче на производительность процессора (от 0 до 100)
running – запущен ли сервер
paid – оплачен ли сервер
paidTill – до какого времени сервер оплачен (UTC в формате ddMMyyyyHHmmss)
stat – базовая инфомация по использованию ресурсов; state: 1 - нагрузка оптимальная; 2 - близка к границе лимита; 3 - превышена
traffic – суммарный трафик за последние 24 часа, МБ
trafficOutbound – исходящий трафик за последние 24 часа, МБ
trafficInbound – входящий трафик за последние 24 часа, МБ
avgDataRead – средний за 10 часов объём считываемых данных, МБ
avgDataWritten – средний за 10 часов объём записываемых данных, МБ
avgIOPS – средняя за 10 часов дисковая нагрузка, IOPS
avgCPU – средняя за 24 часа нагрузка на процессор (от 0 до 100)
notifications – уведомления по работе сервера
id – системное ID уведомления
type – 1 - информационное; 2 - предупреждение; 3 - нарушение
blocked – повлекло ли уведомление за собой блокировку
message – текст сообщения в формате HTML
dt – дата и время уведомления (UTC в формате ddMMyyyyHHmmss)
configurationChangeable – возможно ли изменить конфигурацию данного сервера
canRecreate – возможно ли пересоздать данный сервер с нуля
Коды ошибок:
0 – запрос выполнен успешно
1 – неверный авторизационный токен
2 – не указан авторизационный токен
100 – внутренняя ошибка системы
Функция позволяет получить данные для построения графиков нагрузки, аналогично отображаемым в личном кабинете.
Запрос возможен только для одного сервера за раз.
Адрес: https://ultravds.com/api/server/stat/
Параметры запроса:
sessionToken – токен, полученный при авторизации
id – ID сервера, по которому требуется подучить статистику
Пример запроса:
Пример ответа:
{
"rejectReason": 0,
"id": 1937,
"cpu":
[
{
"date": "07072014",
"avgLoad": 0
},
{
"date": "08072014",
"avgLoad": 1
}
],
"drive":
[
{
"time": "1700",
"avgRead": 52,
"avgWritten": 5,
"avgIOPS": 1
},
{
"time": "1800",
"avgRead": 52,
"avgWritten": 6,
"avgIOPS": 1
}
],
"traffic":
[
{
"date": "07072014",
"inbound": 0,
"outbound": 0
},
{
"date": "08072014",
"inbound": 8,
"outbound": 1
}
]
}
Поля ответа:
rejectReason – числовое значение (код ошибки)
errMessage – текстовое описание ошибки если возникла
id – ID сервера, по которому запрошена статистика
cpu – детали процессорной нагрузки по дням
date – день (UTC в формате ddMMyyyy)
avgLoad – средняя общая нагрузка на CPU (от 0 до 100)
drive – детали процессорной нагрузки по дням
time – час (UTC в формате HHmm)
avgRead – средний объём читаемых в час данных за последние 10 часов, МБ
avgWritten – средний объём записываемых в час данных за последние 10 часов, МБ
avgIOPS – средняя нагрузка на диск за последние 10 часов, IOPS
traffic – детали трафика по дням
date – день (UTC в формате ddMMyyyy)
inbound – входящий трафик, МБ
outbound – исходящий трафик, МБ
Коды ошибок:
0 – запрос выполнен успешно
1 – неверный авторизационный токен
2 – не указан авторизационный токен
4 – виртуальный сервер не найден по переданному ID
100 – внутренняя ошибка системы
Функция позволяет получить текущее изображение на экране сервера. Доступные размеры по ширине – от 64 до 640, высоте – от 48 до 480.
Ввиду кэширования результатов, запрашивать изображение чаще, чем раз в 10 секунд не имеет смысла.
Адрес: https://ultravds.com/api/server/image/
Параметры запроса:
sessionToken – токен, полученный при авторизации
id – ID сервера, изображение экрана которого требуется получить
width – размер изображения по ширине
height – размер изображения по высоте
Пример запроса:
Пример ответа:
{
"rejectReason": 0,
"id": 1937,
"state": 100,
"running": true,
"imageBase64": "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAMCAg..."
}
Поля ответа:
rejectReason – числовое значение (код ошибки)
errMessage – текстовое описание ошибки если возникла
id – ID сервера, изображение экрана которого запрошено
state – 1 - новый; 2 - сконфигурирован; 3 - контактные данные не подтверждены; 4 - нет доступных ресурсов; 5 - не оплачен; 6 - заблокирован за нарушение; 100 - готов к работе
running – запущен ли сервер
imageBase64 – массив байт изображения в формате Base64
Если значение поля state не равно 100 или running не равно true, то в поле imageBase64 будет возвращён null.
Коды ошибок:
0 – запрос выполнен успешно
1 – неверный авторизационный токен
2 – не указан авторизационный токен
4 – виртуальный сервер не найден по переданному ID
100 – внутренняя ошибка системы
Так как процесс копирования и конфигурирования системы оказывает достаточно большую нагрузку на дисковую систему, при отладке функции, пожалуйста, создавайте сервера на SSD. Но даже на SSD ограничитесь самым минимальным количеством вызовов.
При создании и последующем удалении более 10 серверов в сутки на Ваш аккаунт может быть наложен временный запрет на создание новых серверов.
Адрес: https://ultravds.com/api/server/create/
Параметры запроса:
sessionToken – токен, полученный при авторизации
userId – ID пользователя, которому нужно создать сервер (если доступно)
premium – 1 для премиум размещения и 0 для стандартного
cpu – количество ядер процессора
ram – объём оперативной памяти, ГБ
drive – объём жёсткого диска, ГБ
ssd – 1 для размещения на SSD, 0 для HDD
ip – требуемое количество IP-адресов
differentSubnetsIP – обязателно ли назначение IP из разных подсетей (1 - да, 0 - нет)
ddosProtection – требуется ли для создаваемого сервера защита от DDoS-атак (1 - да, 0 - нет)
template – ID Вашего шаблона устанавливаемой операционной системы (если есть)
paymentPeriod – 2 - 1 месяц; 3 - 3 месяца; 4 - 6 месяцев; 5 - 1 год
promocode – промокод для получения постоянной скидки
computerName – имя компьютера создаваемого виртуального сервера. Если не задано, то устанавливается по умолчанию LOGIN-uXXXX
Пример запроса:
Пример ответа:
{
"rejectReason": 0,
"id": 1937,
"cost": 396
}
Поля ответа:
rejectReason – числовое значение (код ошибки)
errMessage – текстовое описание ошибки если возникла
id – ID нового сервера
cost – стоимость сервера за выбранный период с учётом всех скидок (RUB)
После получения успешного ответа от системы запускается процесс создания виртуального сервера, который можно отслеживать, запрашивая информацию по серверу, как описано выше в пункте "Мои серверы".
Коды ошибок:
0 – запрос выполнен успешно
1 – неверный авторизационный токен
2 – неверно передано количество ядер процессора
3 – неверно передан объём оперативной памяти
4 – неверно передан объём жёсткого диска
5 – неверно передано количество IP-адресов
6 – неверный период оплаты или промокод
7 – не удалось определить актуальный тарифный план (внутренняя ошибка системы)
8 – ошибка при сохранении данных (внутренняя ошибка системы)
10 – создание новых серверов запрещено для Вашего аккаунта
13 – создание нового сервера невозможно
17 – нет доступных ресурсов для требуемой конфигурации
19 – нет достаточного количества средств на балансе
31 – не указан авторизационный токен
33 – имя компьютера содержит недопустимые символы
100 – другая внутренняя ошибка системы
Процесс изменения конфигурации асинхронный, то есть после успешного ответа от системы конфигурация ещё не изменена и может не измениться, если в процессе возникнут какие-либо ошибки.
После получения успешного ответа отслеживайте состояние сервера по полю configurationUpdating, а также его конфигурацию, как описано выше в пункте "Мои серверы". Если после принятия полем configurationUpdating значения false конфигурация не изменилась, значит в процессе изменения конфигурации возникла ошибка.
Адрес: https://ultravds.com/api/server/update/configuration/
Параметры запроса:
sessionToken – токен, полученный при авторизации
id – ID виртуального сервера для изменения
cpu – количество ядер процессора
ram – объём оперативной памяти, ГБ
drive – объём жёсткого диска, ГБ
ip – требуемое количество IP-адресов
differentSubnetsIP – обязателно ли назначение IP из разных подсетей
Пример запроса:
Пример ответа:
Поля ответа:
rejectReason – числовое значение (код ошибки)
errMessage – текстовое описание ошибки если возникла
Коды ошибок:
0 – запрос выполнен успешно
1 – неверный авторизационный токен
2 – неверно передано количество ядер процессора
3 – неверно передан объём оперативной памяти
4 – неверно передан объём жёсткого диска
5 – неверно передано количество IP-адресов
6 – виртуальный сервер не найден по переданному ID
10 – изменение конфигурации серверов запрещено для Вашего аккаунта
13 – сервер в неактивном состоянии
14 – в настоящий момент уже идёт процесс изменения конфигурации
15 – текущий расчётный период истекает менее чем через 30 минут, изменение конфигурации невозможно
16 – текущий расчётный период истёк
17 – нет доступных ресурсов для требуемой конфигурации
19 – нет достаточного количества средств на балансе
20 – достигнут суточный лимит изменений конфигурации для данного сервера
21 – достигнут месячный лимит изменений конфигурации для данного сервера
26 – изменение конфигурации недоступно для данного сервера
31 – не указан авторизационный токен
100 – внутренняя ошибка системы
Как и при изменении расчётного периода через личный кабинет, выполнение данной функции не влечёт за собой снятие средств с баланса. Когда текущий расчётный период подойдёт к концу, только тогда сервер продлится в соответствии с указанным новым периодом.
Адрес: https://ultravds.com/api/server/update/payment_period/
Параметры запроса:
sessionToken – токен, полученный при авторизации
id – ID виртуального сервера для изменения
paymentPeriod – 2 - 1 месяц; 3 - 3 месяца; 4 - 6 месяцев; 5 - 1 год
Пример запроса:
Пример ответа:
Поля ответа:
rejectReason – числовое значение (код ошибки)
errMessage – текстовое описание ошибки если возникла
Коды ошибок:
0 – запрос выполнен успешно
1 – неверный авторизационный токен
2 – не указан авторизационный токен
4 – виртуальный сервер не найден по переданному ID
8 – в настоящий момент идёт процесс изменения конфигурации
100 – внутренняя ошибка системы
Данная функция включает в себя множество простых задач, таких как: включение, выключение, перезагрузка, завершение работы, задание нового пароля администратора, пересоздание сервера (сброс системы), удаление.
Все функции, кроме пересоздания виртуального сервера, выполняются и режиме реального времени и гарантированно успешно завершаются при получении Вами сообщения без ошибки.
Адрес: https://ultravds.com/api/server/command/
Параметры запроса:
sessionToken – токен, полученный при авторизации
id – ID виртуального сервера для изменения
type – тип команды:
start – включить сервер
stop – выключить сервер (аварийно)
shutdown – завершение работы
reset – перезагрузка (аварийно)
new_password – задать новый пароль пользователя Administrator
recreate – пересоздать виртуальный сервер
remove – удалить виртуальный сервер
Пример запроса:
Пример ответа:
Поля ответа:
rejectReason – числовое значение (код ошибки)
errMessage – текстовое описание ошибки если возникла
Коды ошибок:
0 – запрос выполнен успешно
1 – неверный авторизационный токен
2 – не указан авторизационный токен
4 – виртуальный сервер не найден по переданному ID или неверная команда
6 – сервер ещё не создан, либо заблокирован
7 – для выполнения данной команды сервер должен быть запущен
8 – в настоящий момент идёт процесс изменения конфигурации
10 – текущий расчётный период истекает менее чем через 30 минут, пересоздание сервера невозможно
11 – текущий расчётный период истёк
12 – пересоздание недоступно для данного виртуального сервера
13 – достигнут суточный лимит пересозданий для данного сервера
14 – достигнут месячный лимит пересозданий для данного сервера
100 – внутренняя ошибка системы
|
Для клиентов
Поддержка
+7 (495) 135-04-44
[включите JavaScript]
|
