Valid

GB/T 31916.3-2018Information technology—Cloud data storage and management—Part 3: Distributed file storage application interface (English PDF)

信息技术云数据存储和管理第3部分：分布式文件存储应用接口

Preview PDF

This is a limited preview

Buy now to download the full PDF (130 pages)

Need quotation for your management?

Get a formal quotation for GB/T 31916.3-2018 in 30 minutes.

Issued by

SAMR; SAC

Level / Type

National · Recommended

Issue date

June 7, 2018

Implementation date

January 1, 2019

Scope

GB/T 31916.3-2018 is the English-translated version of 信息技术云数据存储和管理第3部分：分布式文件存储应用接口.

GB/T 31916.3-2018 defines the application interface of distributed file storage in cloud data storage and management. It places the interface at the application layer, above the operating system, and describes a system made of metadata servers, data storage, monitoring servers and clients.

General requirements cover naming rules, supplementary error messages and public request and response headers.

The interfaces follow: files (create, delete, upload, download, append, copy, rename, search, read, write and more), folders, the recycle bin, extended attributes, snapshots and access control lists, each with its request URL, headers, parameters, status codes and response.

File, folder and recycle bin interfaces are required and the others optional, which decides whether a system can claim complete compliance, compliance or neither. It was issued on 7 June 2018 and has applied since 1 January 2019.

Found what you need?

Document preview — GB/T 31916.3-2018

National Standard of the People's Republic of China

ICS: 35.100.05
Classification: L 79

Issued by: State Administration for Market Regulation; Standardization Administration of the PRC

Foreword5
1 Scope6
2 Compliance6
3 Normative References6
4 Terms, Definitions and Abbreviations7
4.1 Terms and Definitions7
4.2 Abbreviations7
5 Interface Positioning and System Structure of Distributed File Storage7
5.1 Interface Positioning of Distributed File Storage7
5.2 System Structure of Distributed File Storage8
6 General Requirements of Application Interface9
6.1 Overview9
6.2 Naming Rules9
6.3 Supplementary Error Message10
6.4 Public Request Header10
6.5 Public Response Header10
7 Requirements of File Interface10
7.1 Overview10
7.2 Create File11
7.3 Delete File14
7.4 Upload File16
7.5 Download File19
7.6 Append File22
7.7 Copy File24
7.8 Rename File27
7.9 View File Status29
7.10 Modify File Attribute32
7.11 File Search35
7.12 File Read37
7.13 File Write40
8 Requirements of Folder Interface42
8.1 Overview42
8.2 Create Folder42
8.3 Delete Folder45
8.4 Upload Folder47
8.5 Download Folder50
8.6 Copy Folder52
8.7 Rename Folder55
8.8 View Folder Status57
8.9 Modify Folder Attribute59
8.10 Folder Search62
8.11 List Folder Content64
9 Requirements of Recycle Bin Interface66
9.1 Overview66
9.2 Recover Files in Recycle Bin67
9.3 Query Files in Recycle Bin69
9.4 Final Delete Files in Recycle Bin71
9.5 Clear Trash73
9.6 Recover All75
10 Requirements of Extended Attribute Interface77
10.1 Overview77
10.2 Set Extended Attribute77
10.3 Delete Extended Attribute80
10.4 Read Extended Attribute82
10.5 List Extended Attribute85
11 Requirements of Snapshot Interface87
11.1 Overview87
11.2 Create Snapshot87
11.3 Delete Snapshot89
11.4 List Snapshot91
11.5 Rename Snapshot94
12 Requirements of Access Control List Interface96
12.1 Overview96
12.2 Add ACL Rule97
12.3 Read ACL99
12.4 Modify ACL Rule102
12.5 Delete ACL105
12.6 Delete ACL Rule106
12.7 Delete Default ACL Rule108
Appendix A (normative) Distributed File Storage Management Interface111
Appendix B (normative) Supplementary Error Message130

1 Scope

This Part of GB/T 31916 provides an architecture of distributed file storage; stipulates general requirements and application interface of distributed file storage.

This Part is applicable to the design, development, testing and application of distributed file storage.

2 Compliance

The interface defined in this Part can be divided into required and optional. Specifically speaking, file interface, folder interface and recycle bin interface are required, while others are optional. Parameters commanded by each interface might contain required parameters and optional parameters. Compliance contains the following circumstances.

a) A system implements all the interfaces (including required interfaces and optional interfaces), which may be claimed as complete compliance with this Part.

b) A system implements all the required interfaces, which may be claimed as compliance with this Part.

c) A system does not implement all the required interfaces, which may be claimed as non-compliance with this Part.

3 Normative References

The following documents are indispensable to the application of this document. In terms of references with a specified date, only versions with a specified date are applicable to this document. In terms of references without a specified date, the latest version (including all the modifications) is applicable to this document.

GB/T 7408-2005 Data Elements and Interchange Formats - Information Interchange - Representation of Dates and Times;

GB/T 31916.1-2015 Information Technology - Cloud Data Storage and Management - Part 1: General;

RFC 822 Standard for the Format of ARPA Internet Text Messages;

RFC 2616 Hypertext Transfer Protocol HTTP/1.1;

RFC 7159 The JavaScript Object Notation (JSON) Data Interchange Format

4 Terms, Definitions and Abbreviations

4.1 Terms and Definitions

What is defined in GB/T 31916.1-2015 and the following terms and definitions are applicable to this document.

4.1.1 Distributed file system

Distributed file system is a file system, which is installed on the operating system as an application. Its storage resource is distributed on different computer nodes and connected through the computer network.

4.2 Abbreviations

The following abbreviations are applicable to this document. […]

5 Interface Positioning and System Structure of Distributed File Storage

5.1 Interface Positioning of Distributed File Storage

The positioning of distributed file storage interface in the application layer is shown in Figure 1. From the perspective of the operating system, the application-layer distributed file storage, which is an application of the traditional operating system, does not involve relevant operation of the kernel of the operating system. Thus, distributed file storage's dependence and restriction of the operating system is avoided.

5.2 System Structure of Distributed File Storage

System structure of distributed file storage includes. metadata server, data storage data, monitoring server and client-side. Figure 2 demonstrates a general architecture of distributed file storage.

6 General Requirements of Application Interface

6.1 Overview

General requirements of distributed file storage application interface include 8 items of content, namely, interface protocol, identity security management, naming rules, description of status code message, supplementary error message, public request header, public response header and description of error message.

6.2 Naming Rules

Naming rules of all the files, folds and paths are as follows. […]

6.3 Supplementary Error Message

Error response of distributed file storage is relatively complicated. HTTP status code needs a description of supplementary error message. The format of error message shall comply with the requirements in 5.4 in GB/T 31916.1-2015. Please refer to Appendix B for a description of supplementary error message.

6.4 Public Request Header

Information that public request header shall include is shown in Table 1 (see RFC 2616).

7 Requirements of File Interface

7.1 Overview

File interface of distributed file storage is an interface that conducts operation of files in the system, including create file, delete file, upload file, download file, append file, copy file, rename file, view file status, modify file attributes, file search, file read, and file write. File interface is required.

7.2 Create File

7.2.1 Functional description

The operating parameter of create file is. CreateFile, which is used to create files in distributed file storage. The created file name shall be unique in the folder.

7.2.2 Definition of request

7.2.3 Request URL

In which, [Account] signifies account ID. [Path] signifies the location of created file.

7.2.4 Request message header

Define it in accordance with public request header.

7.2.5 Request message parameters

Please refer to Table 3 for request message parameters.

7.2.6 Request message body

Null.

7.2.7 Response status code

Please refer to Table 4 for response status code and its description.

7.2.8 Definition of response

7.2.9 Response message header

Define it in accordance with public response header.

7.2.10 Response message body

Please refer to Table 5 for a description of various parameters in response message body.

7.2.11 Examples of request and response message

Examples of request message and response message are as follows. […]

7.3 Delete File

7.3.1 Functional description

The operating parameter of delete file is. DeleteFile, which is used to delete file. When deleting a file, the system shall place it into the recycle bin.

7.3.2 Definition of request

7.3.3 Request URL

In which, [Account] signifies account ID. [Path] signifies the location of file.

7.3.4 Request message header

Define it in accordance with public request header.

7.3.5 Request message parameters

Please refer to Table 6 for request message parameters.

7.3.6 Request message body

Null.

7.3.7 Response status code

Please refer to Table 7 for response status code and its description.

7.4 Upload File

7.4.1 Functional description

The operating parameter of upload file is. UploadFile, which is used to upload local file to distributed file storage.

7.4.2 Definition of request

7.4.3 Request URL

In which, [Account] signifies account ID. [Path] signifies the location of folder, where file is uploaded to.

7.4.4 Request message header

Define it in accordance with public request header.

7.5 Download File

7.6 Append File

7.6.1 Functional description

The operating parameter of append file is. AppendFile, which is used to append file in distributed file storage.

7.6.2 Definition of request

7.6.3 Request URL

In which, [Account] signifies account ID. [Path] signifies the location of file.

7.6.4 Request message header

Define it in accordance with public request header.

7.7 Copy File

7.7.1 Functional description

The operating parameter of copy file is. CopyFile, which is used to copy file in distributed file storage.

7.7.2 Definition of request

7.7.3 Request URL

In which, [Account] signifies account ID. [Path] signifies the location of file to be copied.

7.7.4 Request message header

Define it in accordance with public request header.

7.8 Rename File

7.8.1 Functional description

The operating parameter of rename file is. RenameFile, which is used to rename file in distributed file storage.

7.8.2 Definition of request

7.8.3 Request URL

In which, [Account] signifies account ID. [Path] signifies the path of file to be renamed.

7.8.4 Request message header

Define it in accordance with public request header.

7.8.5 Request message parameters

Please refer to Table 21 for request message parameters.

8 Requirements of Folder Interface

8.1 Overview

Folder interface of distributed file storage is an interface that conducts operation of folder in the system, including create folder, delete folder, upload folder, download folder, copy folder, rename folder, review folder status, modify folder attribute, folder search and list folder content. Folder interface is required.

8.2 Create Folder

8.2.1 Functional description

The operating parameter of create folder is. Mkdir, which is used to create folders in distributed file storage. The created folder name shall be unique in the parent folder.

8.2.2 Definition of request

8.2.3 Request URL

In which, [Account] signifies account ID. [Path] signifies the location of created folder.

8.2.4 Request message header

Define it in accordance with public request header.

8.2.5 Request message parameters

Please refer to Table 38 for request message parameters.

8.2.8 Definition of response

8.2.9 Response message header

Define it in accordance with public response header.

8.2.10 Response message body

Please refer to Table 40 for a description of various parameters in response message body.

8.6 Copy Folder

8.6.1 Functional description

The operating parameter of copy folder is. CopyFolder, which is used to copy folder in distributed file storage.

8.6.2 Definition of request

8.6.3 Request URL

In which, [Account] signifies account ID. [Path] signifies the location of folder to be copied.

8.6.4 Request message header

Define it in accordance with public request header.

9 Requirements of Recycle Bin Interface

9.1 Overview

Recycle bin interface of distributed file storage is an interface that conducts operation of recycle bin in the system. As a special folder in the system, recycle bin is used to store files and folders deleted by user. Recycle bin interface includes recover file, query trash, final delete file, clear trash and recover all. Recycle bin interface is required.

9.2 Recover Files in Recycle Bin

9.3 Query Files in Recycle Bin

9.3.1 Functional description

The operating parameter of query files in recycle bin is. QueryTrash, which is used to query file or folder information in the recycle bin.

9.3.2 Definition of request

9.3.3 Request URL

In which, [Account] signifies account ID.

9.3.4 Request message header

Define it in accordance with public request header.

9.5 Clear Trash

9.5.1 Functional description

The operating parameter of empty the recycle bin is. ClearTrash, which is used to empty files or folders in the recycle bin.

9.5.2 Definition of request

9.5.3 Request URL

In which, [Account] signifies account ID.

9.5.4 Request message header

Define it in accordance with public request header.

9.6 Recover All

9.6.1 Functional description

The operating parameter of recover all is. RecoverAll, which is recover all the files or folders in the recycle bin.

9.6.2 Definition of request

9.6.3 Request URL

In which, [Account] signifies account ID.

9.6.4 Request message header

Define it in accordance with public request header. […]

......
This preview omits tables, figures, formulas and parts of the technical clauses. The complete document — 130 pages — is available in the English PDF.

Referenced standards

Normative references

RFC 822 · RFC 2616 · RFC 7159

Similar standards

GB/T 45225-2025|GB/T 45399-2025|GB/T 45400-2025|GB/T 43862-2024|GB/T 40020-2021|GB/T 40021-2021

How to Download GB/T 31916.3-2018

1
Add to cart
Click "Download PDF" on this page and choose "Buy this standard". You can add more standards before checkout.
2
Checkout
Enter your email and billing details. Payment is processed securely by Stripe (cards or bank transfer). Prefer bank details? Request a quotation (min. order $300).
3
Instant delivery (0–9 sec)
Delivery is automatic: within seconds of payment you'll receive an email with a secure download link. The link stays valid for 72 hours.
4
Invoice included
A tax invoice is attached to the confirmation email. Need a custom invoice? Contact us.