ECSS-10, версия 3.11
Быстрые ссылки
Дерево страниц
Перейти к концу метаданных
Переход к началу метаданных

Hc_restfs_domain_autocleaner_add_rule

Команда предназначена для добавления определенному домену правил автоматической подчистки устаревших файлов.

Аналог команды в CoCon:

domain/<DOMAIN-NAME>/restfs/autocleaner/add-rule

Метод HTTP-запроса:

POST

Шаблон HTTP-запроса:

http://host:port/commands/restfs_domain_autocleaner_add_rule

Код HTTP-ответа:

  • 201 – в случае успеха;
  • 200 – в случае ошибки.

XSD-схема XML-запроса/ответа:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">

    <!-- in -->
    <xs:element name="in">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="request" minOccurs="1" maxOccurs="1">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element name="server" minOccurs="1" maxOccurs="unbounded">
                                <xs:complexType>
                                    <xs:sequence>
                                        <xs:element name="rule" minOccurs="1" maxOccurs="unbounded">
                                            <xs:complexType>
                                                <xs:attribute name="position" type="xs:nonNegativeInteger" use="optional"/>
                                                <xs:attribute name="file_path" type="xs:string" use="required"/>
                                                <xs:attribute name="file_mask" type="xs:string" use="required"/>
                                                <xs:attribute name="outdate" type="xs:nonNegativeInteger" use="required"/>
                                            </xs:complexType>
                                        </xs:element>
                                    </xs:sequence>
                                    <xs:attribute name="name" type="serverType" use="required"/>
                                </xs:complexType>
                            </xs:element>
                        </xs:sequence>
                        <xs:attribute name="domain" type="xs:string" use="required"/>
                    </xs:complexType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="serverType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="fax"/>
            <xs:enumeration value="call"/>
            <xs:enumeration value="sounds"/>
            <xs:enumeration value="voicemail"/>
        </xs:restriction>
    </xs:simpleType>

    <!-- out -->
    <xs:element name="out">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="error" type="errorType" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

</xs:schema>

Пример:

Запрос: http://192.168.23.34:9999/commands/restfs_domain_autocleaner_add_rule

<in>
  <request domain="DOMAIN">
    <server name="fax">
      <rule position="1" file_path="path1" file_mask="mask1" outdate="1"/>
      <rule position="3" file_path="path3" file_mask="mask3*" outdate="10"/>
      <rule position="2" file_path="path2" file_mask="mask2" outdate="100"/>
    <server/>
    <server name="call">
      <rule position="2" file_path="path3" file_mask="0*" outdate="11"/>
      <rule position="22" file_path="path4" file_mask="*.dets" outdate="180"/>
    </server>
  </request>
</in>

Ответ:

status: 201
content:

Hc_restfs_domain_autocleaner_change_rule

Команда предназначена для изменения определенных правил автоматической подчистки устаревших файлов на выбранном домене.

Аналог команды в CoCon:

domain/<DOMAIN-NAME>/restfs/autocleaner/change-rule

Метод HTTP-запроса:

POST

Шаблон HTTP-запроса:

http://host:port/commands/restfs_domain_autocleaner_change_rule

Код HTTP-ответа:

  • 201 – в случае успеха;
  • 200 – в случае ошибки.

XSD-схема XML-запроса/ответа:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">

    <xs:include schemaLocation="error.xsd"/>

    <!-- in -->
    <xs:element name="in">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="request" minOccurs="1" maxOccurs="1">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element name="server" minOccurs="1" maxOccurs="unbounded">
                                <xs:complexType>
                                    <xs:sequence>
                                        <xs:element name="rule" minOccurs="1" maxOccurs="unbounded">
                                            <xs:complexType>
                                                <xs:attribute name="position" type="xs:nonNegativeInteger" use="required"/>
                                                <xs:attribute name="file_path" type="xs:string" use="optional"/>
                                                <xs:attribute name="file_mask" type="xs:string" use="optional"/>
                                                <xs:attribute name="outdate" type="xs:nonNegativeInteger" use="optional"/>
                                            </xs:complexType>
                                        </xs:element>
                                    </xs:sequence>
                                    <xs:attribute name="name" type="serverType" use="required"/>
                                </xs:complexType>
                            </xs:element>
                        </xs:sequence>
                        <xs:attribute name="domain" type="xs:string" use="required"/>
                    </xs:complexType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="serverType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="fax"/>
            <xs:enumeration value="call"/>
            <xs:enumeration value="sounds"/>
            <xs:enumeration value="voicemail"/>
        </xs:restriction>
    </xs:simpleType>

    <!-- out -->
    <xs:element name="out">
        <xs:complexType>
            <xs:choice>
                <xs:element name="error" type="errorType" minOccurs="0" maxOccurs="unbounded"/>
            </xs:choice>
        </xs:complexType>
    </xs:element>
</xs:schema>

Пример:

Запрос: http://192.168.23.34:9999/commands/restfs_domain_autocleaner_change_rule

<in>
  <request domain="DOMAIN">
    <server name="fax">
      <rule position="1" file_path="path1" file_mask="mask1" outdate="1"/>
      <rule position="3" file_path="path3" file_mask="mask3*" outdate="10"/>
      <rule position="2" file_path="path2" file_mask="mask2" outdate="100"/>
    <server/>
    <server name="call">
      <rule position="2" file_path="path3" file_mask="0*" outdate="11"/>
      <rule position="22" file_path="path4" file_mask="*.dets" outdate="180"/>
    </server>
  </request>
</in>

Ответ:

status: 201
content:

Hc_restfs_domain_autocleaner_remove_rule

Команда предназначена для удаления определенных правил автоматической подчистки устаревших файлов на выбранном домене.

Аналог команды в CoCon:

domain/<DOMAIN-NAME>/restfs/autocleaner/remove-rule

Метод HTTP-запроса:

POST

Шаблон HTTP-запроса:

http://host:port/commands/restfs_domain_autocleaner_remove_rule

Код HTTP-ответа:

  • 201 – в случае успеха;
  • 200 – в случае ошибки.

XSD-схема XML-запроса/ответа:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">

    <xs:include schemaLocation="error.xsd"/>

    <!-- in -->
    <xs:element name="in">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="request" minOccurs="1" maxOccurs="1">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element name="server" minOccurs="1" maxOccurs="unbounded">
                                <xs:complexType>
                                    <xs:attribute name="name" type="serverType" use="required"/>
                                    <xs:attribute name="path" type="xs:string" use="required"/>
                                </xs:complexType>
                            </xs:element>
                        </xs:sequence>
                        <xs:attribute name="domain" type="xs:string" use="required"/>
                    </xs:complexType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="serverType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="fax"/>
            <xs:enumeration value="call"/>
            <xs:enumeration value="sounds"/>
            <xs:enumeration value="voicemail"/>
        </xs:restriction>
    </xs:simpleType>

    <xs:complexType name="clusterType">
        <xs:sequence>
            <xs:element name="file" minOccurs="0" maxOccurs="unbounded">
                <xs:complexType>
                    <xs:attribute name="type" type="xs:string" use="required"/>
                    <xs:attribute name="name" type="xs:string" use="required"/>
                    <xs:attribute name="size" type="xs:string" use="required"/>
                </xs:complexType>
            </xs:element>
        </xs:sequence>
        <xs:attribute name="name" type="xs:string" use="required"/>
    </xs:complexType>

    <!-- out -->
    <xs:element name="out">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="server" type="clusterType" minOccurs="0" maxOccurs="unbounded"/>
                <xs:element name="error" type="errorType" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

</xs:schema>

Пример:

Запрос: http://192.168.23.34:9999/commands/restfs_domain_autocleaner_remove_rule

<in>
  <request domain="DOMAIN">
    <server name="fax">
      <rule position="1"/>
      <rule position="3"/>
      <rule position="2"/>
    <server/>
    <server name="call">
      <rule position="2"/>
      <rule position="22"/>
    </server>
  </request>
</in>

Ответ:

status: 201
content:

Hc_restfs_domain_autocleaner_info

Команда предназначена для просмотра списка правил автоподчистки на определенном домене.

Аналог команды в CoCon:

domain/<DOMAIN-NAME>/restfs/autocleaner/info

Метод HTTP-запроса:

POST

Шаблон HTTP-запроса:

http://host:port/commands/restfs_domain_autocleaner_info

Код HTTP-ответа:

  • 201 – в случае успеха;
  • 200 – в случае ошибки.

XSD-схема XML-запроса/ответа:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">

    <xs:include schemaLocation="error.xsd"/>

    <!-- in -->
    <xs:element name="in">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="request" minOccurs="1" maxOccurs="1">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element name="server" minOccurs="1" maxOccurs="unbounded">
                                <xs:complexType>
                                    <xs:attribute name="name" type="serverType" use="required"/>
                                </xs:complexType>
                            </xs:element>
                        </xs:sequence>
                        <xs:attribute name="domain" type="xs:string" use="required"/>
                    </xs:complexType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="serverType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="fax"/>
            <xs:enumeration value="call"/>
            <xs:enumeration value="sounds"/>
            <xs:enumeration value="voicemail"/>
        </xs:restriction>
    </xs:simpleType>

    <!-- out -->
    <xs:element name="out">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="server" minOccurs="0" maxOccurs="unbounded">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element name="rule" minOccurs="0" maxOccurs="unbounded">
                                <xs:complexType>
                                    <xs:attribute name="position" type="xs:integer" use="required"/>
                                    <xs:attribute name="file_path" type="xs:string" use="required"/>
                                    <xs:attribute name="file_mask" type="xs:string" use="required"/>
                                    <xs:attribute name="outdate" type="xs:string" use="required"/>
                                </xs:complexType>
                            </xs:element>
                        </xs:sequence>
                        <xs:attribute name="name" type="xs:string" use="required"/>
                        <xs:attribute name="peer" type="xs:string" use="required"/>
                    </xs:complexType>
                </xs:element>
                <xs:element name="error" type="errorType" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

</xs:schema>

Пример:

Запрос: http://192.168.1.21:9999/commands/restfs_domain_autocleaner_info

<in>
  <request domain="biysk.local">
    <server name="call"/>
  </request>
</in>

Ответ:

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_restfs_domain_autocleaner_info.xsd">
    <server name="call" peer="http://system.restfs.ecss:9990">
        <rule position="1" file_path="fax" file_mask="*.pdf" outdate="180"/>
        <rule position="2" file_path="records" file_mask="*.wav" outdate="180"/>
    </server>
</out>
  • Нет меток