Hc_tc_options - Управление настройками телеконференции уровня кластера ядра
Hc_tc_options_clean
Команда сброса настроек телеконференции уровня кластера ядра.
Аналог команды в CoCon:
system/tc/clean
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/tc_options_clean
Код HTTP-ответа:
- 200 – в случае успеха;
- 404 – в случае ошибки.
XSD-схема XML-запроса/ответа:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:include schemaLocation="error.xsd"/>
<xs:include schemaLocation="ecm_common.xsd"/>
<!-- in -->
<xs:element name="in">
<xs:complexType>
<xs:all>
<xs:element name="request">
<xs:complexType>
<xs:all>
<xs:element name="ns_options" type="nsCleanInType"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:all>
</xs:complexType>
</xs:element>
<!-- out -->
<xs:element name="out">
<xs:complexType>
<xs:choice>
<xs:element name="result">
<xs:complexType>
<xs:sequence>
<xs:element name="ns_options" type="nsCleanOutType"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="error" type="errorType"/>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
CODE
Пример:
Запрос:
http://192.168.1.21:9999/commands/tc_options_clean
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tc_options_clean.xsd">
<request>
<ns_options>
<system/>
<node name="core1@Artem-Work-PC">
<option name="count_active_channels"/>
<option name="enabled"/>
<option name="mysql_database"/>
<option name="mysql_enabled"/>
<option name="mysql_host"/>
<option name="mysql_password"/>
<option name="mysql_port"/>
<option name="mysql_timeout"/>
<option name="mysql_user"/>
</node>
</ns_options>
</request>
</in>
CODE
Код ответа:
200
Ответ:
<?xml version="1.0"?>
<out xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tc_options_clean.xsd">
<result>
<ns_options>
<system/>
<node name="core1@Artem-Work-PC">
<success option="count_active_channels"/>
<success option="enabled"/>
<success option="mysql_database"/>
<success option="mysql_enabled"/>
<success option="mysql_host"/>
<success option="mysql_password"/>
<success option="mysql_port"/>
<success option="mysql_timeout"/>
<success option="mysql_user"/>
</node>
</ns_options>
</result>
</out>
CODE
Hc_tc_options_info
Команда просмотра информации свойствах телеконференции уровня кластера ядра.
Аналог команды в CoCon:
system/tc/info
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/tc_options_info
Код HTTP-ответа:
- 200 – в случае успеха;
- 404 – в случае ошибки.
XSD-схема XML-запроса/ответа:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:include schemaLocation="error.xsd"/>
<xs:include schemaLocation="ecm_common.xsd"/>
<!-- tcOptionsType -->
<xs:complexType name="tcOptionsType">
<xs:complexContent>
<xs:extension base="baseOptionsType">
<xs:attribute name="enabled" type="booleanType"/>
<xs:attribute name="count_active_channels" type="stringType">
<xs:annotation>
<xs:documentation xml:lang="en">
infinity | pos_integer()
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="mysql_enabled" type="booleanType"/>
<xs:attribute name="mysql_host" type="stringType"/>
<xs:attribute name="mysql_port" type="inetPortType"/>
<xs:attribute name="mysql_user" type="stringType"/>
<xs:attribute name="mysql_password" type="stringType">
<xs:annotation>
<xs:documentation xml:lang="en">
In case of strong security restrictions password may be shown as ********
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="mysql_database" type="stringType"/>
<xs:attribute name="mysql_timeout" type="integerType"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- in -->
<xs:element name="in">
<xs:complexType>
<xs:all>
<xs:element name="request">
<xs:complexType>
<xs:all>
<xs:element name="ns_options" type="nsInfoInType"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:all>
</xs:complexType>
</xs:element>
<!-- out -->
<xs:element name="out">
<xs:complexType>
<xs:choice>
<xs:element name="result">
<xs:complexType>
<xs:sequence>
<xs:element name="ns_options" type="nsInfoOutType"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="error" type="errorType"/>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
XML
Пример:
Запрос:
http://192.168.1.21:9999/commands/tc_options_info
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tc_options_info.xsd">
<request>
<ns_options node="core1@ecss1"/>
</request>
</in>
CODE
Код ответа:
200
Ответ:
<?xml version="1.0"?>
<out
xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tc_options_info.xsd">
<result>
<ns_options>
<system>
<options xs:type="tcOptionsType"/>
</system>
<node name="core1@ecss1">
<options xs:type="tcOptionsType" mysql_user="history_db" mysql_timeout="300000" mysql_port="3306" mysql_password="********" mysql_host="tc.mysql.ecss" mysql_enabled="true" mysql_database="history_db" enabled="true" count_active_channels="infinity"/>
</node>
</ns_options>
</result>
</out>
CODE
Hc_tc_options_set
Команда изменения настроек телеконференции уровня кластера ядра.
Аналог команды в CoCon:
system/tc/set
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/tc_options_set
Код HTTP-ответа:
- 200 – в случае успеха;
- 404 – в случае ошибки.
XSD-схема XML-запроса/ответа:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:include schemaLocation="error.xsd"/>
<xs:include schemaLocation="ecm_common.xsd"/>
<!-- tcOptionsType -->
<xs:complexType name="tcOptionsType">
<xs:complexContent>
<xs:extension base="baseOptionsType">
<xs:attribute name="enabled" type="booleanType"/>
<xs:attribute name="count_active_channels" type="stringType">
<xs:annotation>
<xs:documentation xml:lang="en">
infinity | pos_integer()
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="mysql_enabled" type="booleanType"/>
<xs:attribute name="mysql_host" type="stringType"/>
<xs:attribute name="mysql_port" type="inetPortType"/>
<xs:attribute name="mysql_user" type="stringType"/>
<xs:attribute name="mysql_password" type="stringType"/>
<xs:attribute name="mysql_database" type="stringType"/>
<xs:attribute name="mysql_timeout" type="integerType"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- in -->
<xs:element name="in">
<xs:complexType>
<xs:all>
<xs:element name="request">
<xs:complexType>
<xs:all>
<xs:element name="ns_options" type="nsSetInType"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:all>
</xs:complexType>
</xs:element>
<!-- out -->
<xs:element name="out">
<xs:complexType>
<xs:choice>
<xs:element name="result">
<xs:complexType>
<xs:sequence>
<xs:element name="ns_options" type="nsSetOutType"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="error" type="errorType"/>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
CODE
Пример:
Запрос:
http://192.168.1.21:9999/commands/tc_options_set
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tc_options_set.xsd">
<request>
<ns_options>
<system>
<options xs:type="tcOptionsType"/>
</system>
<node name="core1@Artem-Work-PC">
<options count_active_channels="infinity" enabled="true" mysql_database="history_db" mysql_enabled="false" mysql_host="tc.mysql.ecss" mysql_password="history_db" mysql_port="3306" mysql_timeout="300000" mysql_user="history_db" xs:type="tcOptionsType"/>
</node>
</ns_options>
</request>
</in>
CODE
Код ответа:
200
Ответ:
<?xml version="1.0"?>
<out xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tc_options_set.xsd">
<result>
<ns_options>
<system/>
<node name="core1@Artem-Work-PC">
<success option="count_active_channels"/>
<success option="enabled"/>
<success option="mysql_database"/>
<success option="mysql_enabled"/>
<success option="mysql_host"/>
<success option="mysql_password"/>
<success option="mysql_port"/>
<success option="mysql_timeout"/>
<success option="mysql_user"/>
</node>
</ns_options>
</result>
</out>
CODE