Hc_oct_cp_options - Управление системными настройками ecss-core
Hc_oct_cp_options_clean
Команда сброса системных настроек ECSS-CORE.
Аналог команды в CoCon:
domain/<DOMAIN>/core/system/clean
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/oct_cp_options_clean
Код HTTP-ответа:
- 200 – в случае успеха;
- 404 – в случае ошибки.
XSD-схема XML-запроса/ответа:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:annotation>
<xs:documentation xml:lang="en">
Clean value of requested property(es).
</xs:documentation>
</xs:annotation>
<xs:include schemaLocation="error.xsd" />
<xs:include schemaLocation="ecm_common.xsd" />
<!-- resultType-->
<xs:complexType name="resultType">
<xs:all>
<xs:element name="domain_options" type="domainCleanOutType" minOccurs="1"/>
</xs:all>
</xs:complexType>
<!-- in-->
<xs:element name="in">
<xs:complexType>
<xs:sequence>
<xs:element name="request">
<xs:complexType>
<xs:all>
<xs:element name="domain_options" type="domainCleanInType" minOccurs="1"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- out -->
<xs:element name="out">
<xs:complexType>
<xs:choice>
<xs:element name="result" type="resultType"/>
<xs:element name="error" type="errorType"/>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
CODE
Пример:
Запрос:
http://192.168.1.21:9999/commands/oct_cp_options_clean
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="oct_cp_options_clean.xsd">
<request>
<domain_options>
<system/>
<domain name="test.ats">
<option name="amqp_cp_acp_ttl"/>
<option name="amqp_cp_acpr_ttl"/>
<option name="max_hops_count"/>
</domain>
</domain_options>
</request>
</in>
CODE
Код ответа:
200
Ответ:
<?xml version="1.0"?>
<out xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="oct_cp_options_clean.xsd">
<result>
<domain_options>
<system/>
<domain name="test.ats">
<success option="amqp_cp_acp_ttl"/>
<success option="amqp_cp_acpr_ttl"/>
<success option="max_hops_count"/>
</domain>
</domain_options>
</result>
</out>
CODE
Hc_oct_cp_options_info
Команда просмотра информации о подсистеме RADIUS авторизации (access).
Аналог команды в CoCon:
domain/<DOMAIN>/core/system/info
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/oct_cp_options_info
Код HTTP-ответа:
- 200 – в случае успеха;
- 404 – в случае ошибки.
XSD-схема XML-запроса/ответа:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:annotation>
<xs:documentation xml:lang="en">
Show value of requested property(es).
</xs:documentation>
</xs:annotation>
<xs:include schemaLocation="error.xsd" />
<xs:include schemaLocation="ecm_common.xsd" />
<xs:complexType name="coreCPOptionsType">
<xs:complexContent>
<xs:extension base="baseOptionsType">
<xs:attribute name="max_hops_count" type="integerType" use="optional" />
<xs:attribute name="amqp_cp_acpr_ttl" type="integerType" use="optional" />
<xs:attribute name="amqp_cp_acp_ttl" type="integerRangeType" use="optional" />
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- resultType-->
<xs:complexType name="resultType">
<xs:all>
<xs:element name="domain_options" type="domainInfoOutType" minOccurs="1"/>
</xs:all>
</xs:complexType>
<!-- in-->
<xs:element name="in">
<xs:complexType>
<xs:sequence>
<xs:element name="request">
<xs:complexType>
<xs:all>
<xs:element name="domain_options" type="domainInfoInType" minOccurs="1"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- out -->
<xs:element name="out">
<xs:complexType>
<xs:choice>
<xs:element name="result" type="resultType"/>
<xs:element name="error" type="errorType"/>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
XML
Пример:
Запрос:
http://192.168.1.21:9999/commands/oct_cp_options_info
<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="oct_cp_options_info.xsd">
<request>
<domain_options domain="test.ats"/>
</request>
</in>
CODE
Код ответа:
200
Ответ:
<?xml version="1.0"?>
<out xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="oct_cp_options_info.xsd">
<result>
<domain_options>
<system>
<options xs:type="coreCPOptionsType"/>
</system>
<domain name="test.ats">
<options amqp_cp_acp_ttl="30000" amqp_cp_acpr_ttl="4000" max_hops_count="5" xs:type="coreCPOptionsType"/>
</domain>
</domain_options>
</result>
</out>
CODE
Hc_oct_cp_options_set
Команда изменения системных настроек ECSS-CORE.
Аналог команды в CoCon:
domain/<DOMAIN>/core/system/set
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/oct_cp_options_set
Код HTTP-ответа:
- 200 – в случае успеха;
- 404 – в случае ошибки.
XSD-схема XML-запроса/ответа:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:annotation>
<xs:documentation xml:lang="en">
Set value of requested property(es).
</xs:documentation>
</xs:annotation>
<xs:include schemaLocation="error.xsd" />
<xs:include schemaLocation="ecm_common.xsd" />
<xs:complexType name="coreCPOptionsType">
<xs:complexContent>
<xs:extension base="baseOptionsType">
<xs:attribute name="max_hops_count" type="integerType" use="optional" />
<xs:attribute name="amqp_cp_acpr_ttl" type="integerType" use="optional" />
<xs:attribute name="amqp_cp_acp_ttl" type="integerRangeType" use="optional" />
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- resultType-->
<xs:complexType name="resultType">
<xs:all>
<xs:element name="domain_options" type="domainSetOutType" minOccurs="1"/>
</xs:all>
</xs:complexType>
<!-- in-->
<xs:element name="in">
<xs:complexType>
<xs:sequence>
<xs:element name="request">
<xs:complexType>
<xs:all>
<xs:element name="domain_options" type="domainSetInType" minOccurs="1"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- out -->
<xs:element name="out">
<xs:complexType>
<xs:choice>
<xs:element name="result" type="resultType"/>
<xs:element name="error" type="errorType"/>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
CODE
Пример:
Запрос:
http://192.168.1.21:9999/commands/oct_cp_options_set
<?xml version="1.0"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="oct_cp_options_set.xsd">
<request>
<domain_options>
<system>
<options xs:type="coreCPOptionsType"/>
</system>
<domain name="test.ats">
<options amqp_cp_acp_ttl="30000" amqp_cp_acpr_ttl="4000" max_hops_count="5" xs:type="coreCPOptionsType"/>
</domain>
</domain_options>
</request>
</in>
CODE
Код ответа:
200
Ответ:
<?xml version="1.0"?>
<out xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="oct_cp_options_set.xsd">
<result>
<domain_options>
<system/>
<domain name="test.ats">
<success option="amqp_cp_acp_ttl"/>
<success option="amqp_cp_acpr_ttl"/>
<success option="max_hops_count"/>
</domain>
</domain_options>
</result>
</out>
CODE