Функции услуги «XEN-Хостинг»

Модуль: xen_hosting

Показать свойства услуги

Позволяет узнать свойства услуги.

Функция: show_xen_hosting_properties

Пример GET запроса:

https://api.codeblast.ru/xen_hosting/show_xen_hosting_properties?token_data=data:string
                                                                &xen_hosting_id=1

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <xen_hosting_vm_name>vhost7</xen_hosting_vm_name>
    <xen_hosting_vm_fqdn>vhost7.s01.codeblast</xen_hosting_vm_fqdn>
    <xen_hosting_ssh_port>22007</xen_hosting_ssh_port>
    <xen_hosting_user_name>root</xen_hosting_user_name>
    <xen_hosting_user_password>***</xen_hosting_user_password>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "xen_hosting_vm_name": "vhost7",
  "xen_hosting_vm_fqdn": "vhost7.s01.codeblast.ru",
  "xen_hosting_ssh_port": "22007",
  "xen_hosting_user_name": "root",
  "xen_hosting_user_password": "***",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен
xen_hosting_id number id заказа услуги

Поля ответа:

Поле Тип Описание
xen_hosting_vm_name number имя сервера
xen_hosting_vm_fqdn string доменное имя сервера
xen_hosting_ssh_port number порт управления сервером (SSH)
xen_hosting_user_name string имя пользователя
xen_hosting_user_password string пароль пользователя
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
REG_XEN_HOSTING_ID ошибка ввода id заказа услуги
"[0-9]{1,20}"
AUTHORIZATION_FAIL ошибка авторизации
ORDER_NOT_EXISTS услуга не заказана
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Привязка сайтов

Создать привязку сайта

Позволяет привязать сайт к виртуальному серверу. Эта функция даёт указание внешнему HTTP шлюзу перенаправлять запросы о данном сайте на выбранный виртуальный сервер. На каждый виртуальный сервер можно создать не более 500 привязок сайтов.

Функция: create_xen_alias

Пример GET запроса:

https://api.codeblast.ru/xen_hosting/create_xen_alias?token_data=data:string
                                                     &xen_hosting_id=4
                                                     &xen_alias_name=demo.ru

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <xen_alias_id>425</xen_alias_id>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "xen_alias_id": "425",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен
xen_hosting_id number id заказа услуги
xen_alias_name number имя домена

Поля ответа:

Поле Тип Описание
xen_alias_id number id привязки сайта
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
REG_XEN_HOSTING_ID ошибка ввода id заказа услуги
"[0-9]{1,20}"
REG_XEN_ALIAS_NAME ошибка ввода имени домена
"[a-zа-яё0-9][a-zа-яё0-9\.\-\_]{0,125}[a-zа-яё]"
AUTHORIZATION_FAIL ошибка авторизации
ORDER_NOT_EXISTS услуга не заказана
XEN_ALIAS_NAME_EXISTS привязка с таким именем домена уже существует
MANY_XEN_ALIAS достигнут лимит заказа
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Удалить привязку сайта

Удаляет привязку сайта.

Функция: delete_xen_alias

Пример GET запроса:

https://api.codeblast.ru/xen_hosting/delete_xen_alias?token_data=data:string
                                                     &xen_alias_id=425

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен
xen_alias_id number id привязки сайта

Поля ответа:

Поле Тип Описание
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
REG_XEN_ALIAS_ID ошибка ввода id привязки сайта
"[0-9]{1,20}"
AUTHORIZATION_FAIL ошибка авторизации
XEN_ALIAS_NOT_EXISTS привязки сайта не существует
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Изменить привязку сайта

Изменяет привязку сайта.

Функция: change_xen_alias

Пример GET запроса:

https://api.codeblast.ru/xen_hosting/change_xen_alias?token_data=data:string
                                                     &xen_alias_id=425
                                                     &xen_alias_name=newdemo.ru

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен
xen_alias_id number id привязки сайта
xen_alias_name string имя домена

Поля ответа:

Поле Тип Описание
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
REG_XEN_ALIAS_ID ошибка ввода id привязки сайта
"[0-9]{1,20}"
REG_XEN_ALIAS_NAME ошибка ввода имени домена
"[a-zа-яё0-9][a-zа-яё0-9\.\-\_]{0,125}[a-zа-яё]"
AUTHORIZATION_FAIL ошибка авторизации
XEN_ALIAS_NAME_EXISTS привязка с таким именем домена уже существует
XEN_ALIAS_NOT_EXISTS привязки сайта не существует
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Показать привязку сайта

Получение, имени домена, даты и времени создания привязки.

Функция: show_xen_alias

Пример GET запроса:

https://api.codeblast.ru/xen_hosting/show_xen_alias?token_data=data:string
                                                   &xen_alias_id=425

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <xen_hosting_id>4</xen_hosting_id>
    <xen_alias_name>demo.ru</xen_alias_name>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "xen_hosting_id": "4",
  "xen_alias_name": "demo.ru",
  "xen_alias_datetime": "2014-10-20 18:26:27",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен
xen_alias_id number id привязки сайта

Поля ответа:

Поле Тип Описание
xen_hosting_id number id заказа услуги
xen_alias_name string имя домена привязки сайта
xen_alias_datetime datetime дата и время создания привязки сайта
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
REG_XEN_ALIAS_ID ошибка ввода id привязки сайта
"[0-9]{1,20}"
AUTHORIZATION_FAIL ошибка авторизации
XEN_ALIAS_NOT_EXISTS привязки сайта не существует
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Перечислить id привязок сайтов

Получение списка id привязок сайтов.

Функция: list_xen_alias_id

Пример GET запроса:

https://api.codeblast.ru/xen_hosting/list_xen_alias_id?token_data=data:string
                                                      &xen_hosting_id=1

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <list_xen_alias_id>
        <xen_alias_id>425</xen_alias_id>
        <xen_alias_id>782</xen_alias_id>
    </list_xen_alias_id>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "list_xen_alias_id": [
    "425",
    "782"
  ],
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен
xen_hosting_id number id заказа услуги

Поля ответа:

Поле Тип Описание
xen_alias_id number id привязки сайта
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
REG_XEN_HOSTING_ID ошибка ввода id заказа услуги
"[0-9]{1,20}"
AUTHORIZATION_FAIL ошибка авторизации
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет