Дерево страниц
Перейти к концу метаданных
Переход к началу метаданных

Hc_restfs_list_clusters

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

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

restfs/<RESTFS-CLUSTERNAME>/list

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

POST

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

http://host:port/commands/restfs_list_clusters

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

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

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="cluster" minOccurs="1" maxOccurs="unbounded">
                                <xs:complexType>
                                    <xs:attribute name="name" type="xs:string" use="required"/>
                                    <xs:attribute name="path" type="xs:string" use="required"/>
                                </xs:complexType>
                            </xs:element>
                        </xs:sequence>
                    </xs:complexType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <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="cluster" 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://host:port/commands/restfs_list_clusters

<in>
    <request>
        <cluster name="default" path="/domain"/>
        <cluster name="default" path="domain"/>
        <cluster name="default" path=""/>
    </request>
</in>

Ответ:

status: 201
content: 
<?xml version="1.0"?>
<out xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_restfs_list_clusters.xsd">
    <cluster name="default"><file type="directory" name=" domain" size="0"/>
        <file type="directory" name="domain" size="0"/>
        <file type="directory" name="system" size="0"/>
        <file type="regular" name="cleaner.json" size="186"/>
    </cluster>
    <cluster name="default">
        <file type="directory" name="ivan.local" size="0"/>
        <file type="directory" name="test.domain" size="0"/>
    </cluster>
    <cluster name="default">
        <file type="directory" name="ivan.local" size="0"/>
        <file type="directory" name="test.domain" size="0"/>
    </cluster>
</out>
  • Нет меток