GB/T 31916.2-2015Information technology—Cloud data storage and management—Part 2: Object-based cloud storage application interface (English PDF)

3.1 Terms and Definitions

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

3.1.1 Container

status, quota and operation authorization can be implemented.

5.1 Overview

General requirements of object-based cloud storage application interface include 8 items of requirements, namely, interface protocol, identity authentication management, access control, status code information description, supplementary error message, public request header, public response header and error message description.

Specifically speaking, 4 items of requirements (interface protocol, identity authentication management, status code information description and error message description) shall comply with the stipulations of Chapter 5 in GB/T 31916.1-2015.

5.2 Access Control

Object-based cloud storage shall provide access control mechanism. The management of access control may be implemented through modes like ACL. Please refer to Appendix A for ACL-based access control.

5.3 Supplementary Error Message

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

5.4 Public Request Header

The time format of object-based cloud storage application interface shall comply with the format stipulated in GB/T 7408-2005.

Please refer to Table 1 for a description of HTTP request header format (see RFC 2616).

6.1 Overview

Object-based cloud storage application interface includes related functions of container and related functions of object. Related functions of container shall include:

a) Create container;

b) Delete container;

c) Acquire user's all containers;

d) Acquire the list of objects in the container.

When ACL mode is adopted for user's access control, related functions of container shall also include:

e) Acquire container's authorization;

f) Set up container's authorization. Related functions of object shall include:

a) Create object;

b) Delete object;

c) Acquire object;

d) Acquire object attribute;

e) Set up object attribute.

When ACL mode is adopted for user's access control, related functions of object shall also include:

f) Acquire object's authorization;

g) Set up object's authorization.

6.2 Related Functions of Container

6.2.1 Create container

error message.

6.2.4.7 Response parameter

Null.

6.2.4.8 Response message body parameters

Please refer to Table 7 for information that response message body parameters shall include.

Optional Character String Whether the returned result is all the result;

6.2.5.1 Functional description

When ACL mode (see Appendix A) is adopted for access control, user utilizes the current interface to acquire container's ACL. User shall have access permission to container, otherwise, it is impossible to acquire the result. The target of operation shall be expressed in URI, which is constituted of, in which, "ContainerName" is the name of container; "acl" indicates that the target of this operation is the access control list.

6.2.5.2 Request message header

6.2.5.3 Request parameter

Null.

6.2.5.4 Additional domain of message header

Null.

6.2.5.5 Request body parameter

Null.

6.2.5.6 Response message code

Status code shall be returned in accordance with definition. If it is successful, return 200. If it fails, in accordance with the cause, set up status code and supplementary error message.

6.2.5.7 Response parameter

Null.

6.2.5.8 Response message body parameters

Please refer to Table 8 for information that response message body parameters shall include.

6.3 Related Functions of Object

6.3.2.2 Request message header

6.3.2.3 Request parameter

Null.

6.3.2.4 Additional domain of message header

Null.

6.3.2.5 Request body parameter

Null.

6.3.2.6 Response message code

Status code shall be returned in accordance with definition. If it is successful, return 204. If it fails, in accordance with the cause, set up status code and supplementary error message.

6.3.2.7 Response parameter

Null.

6.3.2.8 Response message body parameter

Null.

6.3.2.9 Examples of message

Please refer to Example 1 for request message. Example 1: Please refer to Example 2 for response message. Example 2: […]

6.3.3.8 Response message body parameter

Null.

6.3.3.9 Examples of message

Please refer to Example 1 for request message. Example 1: Please refer to Example 2 for response message. Example 2: […]

6.3.4 Acquire object attribute

6.3.4.1 Functional description

In accordance with appointed URI, read the attribute value of a certain object. User shall pass legitimate identity authentication; user shall have READ permission to the object.

6.3.4.2 Request message header

Method 1: use GET method; response message returns result through message body.

Method 2: use HEAD method; response message returns result through message header.

6.3.4.3 Request parameter

Example 1: Please refer to Example 2 for response message. Example 2: […]

6.3.6 Acquire object permission

6.3.6.1 Functional description

When ACL mode (see Appendix A) is adopted for access control, user utilizes the current interface to acquire object's ACL; the return message shall include permission control list of the appointed object. User shall have permission to the appointed object.

6.3.6.2 Request message header

6.3.6.3 Request parameter

Null.

6.3.6.4 Additional domain of message header

Null.

6.3.6.5 Request body parameter

Null.