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

Модуль: mysql_hosting

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

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

Функция: show_mysql_hosting_properties

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

https://api.codeblast.ru/mysql_hosting/show_mysql_hosting_properties?token_data=data:string
                                                                    &mysql_hosting_id=1

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

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <mysql_hosting_base_name>b01300</mysql_hosting_base_name>
    <mysql_hosting_server_host>mysql2.s01.codeblast.ru</mysql_hosting_server_host>
    <mysql_hosting_server_port>3306</mysql_hosting_server_port>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

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

{
  "mysql_hosting_base_name": "b01300",
  "mysql_hosting_server_host": "mysql2.s01.codeblast.ru",
  "mysql_hosting_server_port": "3306",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

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

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

Поля ответа:

Поле Тип Описание
mysql_hosting_base_name number имя базы данных
mysql_hosting_server_host string доменное имя сервера базы даннных
mysql_hosting_server_port number порт сервера базы даннных
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

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

Пользователи

Создать пользователя

Позволяет создать пользователя для доступа к базе данных. На каждую базу данных можно создать не более 10 пользователей.

Функция: create_mysql_user

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

https://api.codeblast.ru/mysql_hosting/create_mysql_user?token_data=data:string
                                                        &mysql_hosting_id=4
                                                        &mysql_user_postfix=user1
                                                        &mysql_user_password=dbPassw0rd

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

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

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

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

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

Поле Тип Описание
token_data string токен
mysql_hosting_id number id заказа услуги
mysql_user_postfix number окончание имени пользователя
mysql_user_password string пароль пользователя

Поля ответа:

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

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
REG_MYSQL_HOSTING_ID ошибка ввода id заказа услуги
"[0-9]{1,20}"
REG_MYSQL_USER_POSTFIX ошибка ввода имени пользователя
"[a-z0-9]{2,16}"
REG_MYSQL_USER_PASSWORD ошибка ввода пароля пользователя
"[a-zA-Z0-9]{8,24}"
AUTHORIZATION_FAIL ошибка авторизации
ORDER_NOT_EXISTS услуга не заказана
MYSQL_USER_NAME_EXISTS пользователь с таким именем уже существует
MANY_MYSQL_USERS достигнут лимит заказа
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Удалить пользователя

Удаляет пользователя базы данных.

Функция: delete_mysql_user

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

https://api.codeblast.ru/mysql_hosting/delete_mysql_user?token_data=data:string
                                                        &mysql_user_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 токен
mysql_user_id number id пользователя

Поля ответа:

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

Коды ошибок:

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

Изменить пароль пользователя

Изменяет пароль пользователя базы данных.

Функция: change_mysql_user_password

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

https://api.codeblast.ru/mysql_hosting/change_mysql_user_password?token_data=data:string
                                                                 &mysql_user_id=425
                                                                 &mysql_user_password=dbPassw0rd

Пример 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 токен
mysql_user_id number id пользователя
mysql_user_password string пароль пользователя

Поля ответа:

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

Коды ошибок:

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

Показать пользователя

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

Функция: show_mysql_user

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

https://api.codeblast.ru/mysql_hosting/show_mysql_user?token_data=data:string
                                                      &mysql_user_id=425

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

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

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

{
  "mysql_hosting_id": "4",
  "mysql_user_name": "b01300_user1",
  "mysql_user_password": "dbPassw0rd",
  "mysql_user_datetime": "2014-10-20 18:26:27",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

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

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

Поля ответа:

Поле Тип Описание
mysql_hosting_id number id заказа услуги
mysql_user_name string имя пользователя
mysql_user_password string пароль пользователя
mysql_user_datetime datetime дата и время создания пользователя
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

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

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

Получение списка id пользователей базы данных.

Функция: list_mysql_user_id

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

https://api.codeblast.ru/mysql_hosting/list_mysql_user_id?token_data=data:string
                                                         &mysql_hosting_id=1

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

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

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

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

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

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

Поля ответа:

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

Коды ошибок:

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

Метрики

Использование диска

Позволяет отобразить метрики использования дискового пространства. Метрики измеряются в мегабайтах и формируются за последние 7 дней с интервалом в 5 минут.

Функция: list_mysql_metric_hdd

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

https://api.codeblast.ru/mysql_hosting/list_mysql_metric_hdd?token_data=data:string
                                                            &mysql_hosting_id=4

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

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

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

{
  "list_mysql_metric_hdd": [
    "5",
    "6",
    "7",
    "8"
  ],
  "error_code": "OK",
  "error_text": "ошибок нет"
}

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

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

Поля ответа:

Поле Тип Описание
mysql_metric_hdd array:number метрики использования дискового пространства
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

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