PowerScale OneFS API Reference

PDF

Create a file object

Creates a file object with a given path. The file is either successfully created in whole, or no file is created at all. Partial files cannot be created.

Request syntax

PUT /namespace/<access_point>/<file_path>[?overwrite=<Boolean>] HTTP/1.1
Host <hostname>[:<port>]
Content-Length : <length>
Date: <date>
Authorization: <signature>

[Message Body]

Request query parameters


Parameter Name	Description	Default	Type	Required
overwrite	If the overwrite parameter is set to true, the preset user attributes and ACLs of the file are deleted and replaced with the user-specified attributes and ACLs from the header. If the overwrite parameter is set to false and the file exists, an error message is returned. If the file does not exist, the file is created and set with the user-specified attributes and ACLs from the header.	True	Boolean	No

Request headers


Header Name	Description	Default	Type	Required
Content-Encoding	Specifies the content encoding that was applied to the object content, so that decoding can be applied when retrieving the content.	None	String	No
Content-Type	Specifies a standard MIME-type description of the content format.	binary/octet-stream	String	Conditional
x-isi-ifs-target-type	Specifies the resource type. This value can be container or object.	None	String	Yes. The value must be set to 'object.'
x-isi-ifs-access-control	Specifies a predefined ACL value or POSIX mode with a string in octal string format.	0600 (read, write with owner permissions).	String	No
x-isi-ifs-attr-<attr_name>	Specifies the extended attributes that were set in the message header. The attributes names are stored in upper case, and all dashes (-) are converted to underscores (_).	None	String	No

Response headers

This call returns common response headers.

Response body

No message body is returned upon success.

Example request

PUT /namespace/ifs/my_folder/picture.jpg HTTP/1.1
Host my_cluster:8080
x-isi-ifs-target-type: object
Content-Type: image/jpeg
Content-Length: 65536
Date: Thu Sep 22 16:06:32 GMT 2011
Authorization: <signature>

[Byte Streams of pictue.jpg]

Example response

HTTP/1.1 201 Created
Date: Thu, 22 Sep 2011 12:00:00 GMT
Content-Length: <length>
Connection: close
Server: Apache2/2.2.19